| OID symbolic | OID numeric | Type | Access | Description |
|---|
| ciscoCableMeteringMIB | 1.3.6.1.4.1.9.9.424 | | | This is the MIB module for Usage Based Metering for the
DOCSIS-compliant Cable Modem Termination Systems (CMTS).
Usage Based Metering is a software feature provided in the
CMTS so that cable operators can perform subscriber
account management and metering in a uniform and
consistent manner.
It involves the implementation of Subscriber Account
Management Interface Specification (SAMIS) as defined by
DOCSIS-OSSI specification. Usage-Based Metering is
essential in the processing of bills based on services
rendered to and consumed by paying subscribers. The SAMIS
specification focuses primarily on bandwidth centric
usage-based metering scenarios.
The DOCSIS 1.1 RFI specification provides a mechanism for
a Cable Modem (CM) to register with its Cable Modem
Termination System (CMTS) and to configure itself based
on external Quality of Service (QoS) parameters when it
is powered up or reset. The principal mechanism for
providing enhanced QoS is to classify packets traversing
the RF MAC interface into a Service Flow.
A Service Flow is a unidirectional flow of packets that is
provided a particular Quality of Service.
The mediation system can then rate the charges differently
for each of the Service Flow traffic counts based on
its Service Class. Thus, the mediation system obtains from
the CMTS the traffic counts for each named Service Flow
(identified by SFID) that a subscribers CM uses during
the metering data collection interval. The Usage Based
Metering requirement is that the CMTS must be able to
provide formatted Subscriber Usage
Metering Records for all subscribers attached to the CMTS,
on demand to an external collection system. Optionally,
the metering records can be stored locally so that it is
available via ftp to the external collection server.
The CMTS provides two configuration options to handle the
export of metering data.
Local :
Store the record locally on the CMTS after collection. The
metering system should then(operating at its own schedule)
take the file out of the CMTS and is also responsible for
deletion of the local file on the CMTS. The deletion of
the file is an indication to the metering collector to
start construction of the new metering record which will
then be written to the local filesystem and the cycle
continues.
Streaming:
Stream the records to an external collection system as
they get generated. The time interval in which the record
will be generated is configurable at the CMTS. A secure
and reliable stream is used to transport the metering
record out of the CMTS.
In case the connection to external metering system is
not possible, CMTS will retry establishing channel for a
max specified times.
The MIB allows for configuration of the parameters that
control the metering record collection like interval,
amount of metering information required, location or IP
address of the collection server, and metering filename.
In addition it provides for some important notificatons to
the NMS to indicate the success/failure of the
metering collection. |
| ciscoCableMeteringMIBNotifs | 1.3.6.1.4.1.9.9.424.0 | | | |
| NTF ccmtrCollectionNotification | 1.3.6.1.4.1.9.9.424.0.1 | | | A notification that is sent to indicate the success or
failure in creating the metering record file or streaming
it to the collection server.
ccmtrCollectionStatus represents the success or
failure of the export.
ccmtrCollectionDestination and ccmtrCollectionTimestamp
represent the destinaton and timestamp of the export in
both the success and failure scenerios.
The receipt of this notification is
an indication to the collection server that the file can be
accessed via ftp or any file transfer protocol in the case
of local storage. |
| ciscoCableMeteringMIBObjects | 1.3.6.1.4.1.9.9.424.1 | | | |
| ccmtrMeteringConfig | 1.3.6.1.4.1.9.9.424.1.1 | | | |
| INT ccmtrCollectionType | 1.3.6.1.4.1.9.9.424.1.1.1 | INTEGER | read-write | Current method of export for metering data.
The enumerations are:
none(1) : Metering collection has not been enabled.
local(2) : Store the collected metering records locally
on the CMTS.
stream(3) : Stream the metering records to an external
collection or mediation server.
ipdr(4) : Stream the metering records to an ipdr (Internet
Proticol Detail Record)collector. |
| STR ccmtrCollectionFilesystem | 1.3.6.1.4.1.9.9.424.1.1.2 | SnmpAdminString | read-write | The filesystem where metering records are to be stored.
This object makes sense only if ccmtrCollectionType object
is local which indicates that the metering records are
to be stored in the local filesystem.
When ccmtrCollectionType is 'stream' this object will
retain its set value though it will not be used. |
| ccmtrCollectionTable | 1.3.6.1.4.1.9.9.424.1.1.3 | | not-accessible | This table is used only if ccmtrCollectionType object is
stream which indicates that the metering records are to
be streamed to an external collection server.
It contains IP address information of the collection
server. In addition it contains other configurable
parameters like interval, retries etc needed for
streaming the metering records. |
| ccmtrCollectionEntry | 1.3.6.1.4.1.9.9.424.1.1.3.1 | | not-accessible | A set of IP attributes of the mediation or
collection server and configuration parameters for
streaming the metering records.
An entry in this table exists for each configured
mediation or collection server. |
| CCM ccmtrCollectionID | 1.3.6.1.4.1.9.9.424.1.1.3.1.1 | CcmtrCollectionServer | not-accessible | Identification of a IP address and port number
associated with the mediation or collection server.
The ccmtrCollectionID is used in determining the order
of the IP address, port number to which the streaming will
take place. The primary represents the first
collection server and secondary represents the
second collection server if streaming to the primary
failed for any reason. Thus primary entry
must be created before the secondary. |
| IPt ccmtrCollectionIpAddrType | 1.3.6.1.4.1.9.9.424.1.1.3.1.2 | InetAddressType | read-create | The type of internet address of ccmtrCollectionIpAddress. |
| IP ccmtrCollectionIpAddress | 1.3.6.1.4.1.9.9.424.1.1.3.1.3 | InetAddress | read-create | The IP address of the collection server. It will be of
type as referred by ccmtrCollectionIpAddrType.
The ccmtrCollectionPort should be also valid along with
ccmtrCollectionIpAddress for a row to be created. The
primary collection server IP address represented by
ccmtrCollectionID equal to 1 must be created before the
secondary collection server IP address. |
| INE ccmtrCollectionPort | 1.3.6.1.4.1.9.9.424.1.1.3.1.4 | InetPortNumber | read-create | The port number of the collection server. This port number
chosen should not be any of the well defined ports.
The ccmtrCollectionIpAddress should be also valid along
with ccmtrCollectionPort for a row to be created. The
primary collection server port represented by
ccmtrCollectionID equal to 1 must be created before the
secondary collection server port. |
| ROW ccmtrCollectionRowStatus | 1.3.6.1.4.1.9.9.424.1.1.3.1.8 | RowStatus | read-create | Controls and reflects the status of rows in this table.
It can use used for creation, modifying and deleting
entries in this table.
The ccmtrCollectionPort should also be valid along with
ccmtrCollectionIpAddress for a row to be created.
The ccmtrCollectionID 1 represents the primary
collection server and ccmtrCollectionID 2 represents the
secondary collection server. Thus ccmtrCollectionID of 1
must be created before the ccmtrCollectionID of 2. |
| U32 ccmtrCollectionInterval | 1.3.6.1.4.1.9.9.424.1.1.4 | Unsigned32 | read-write | The interval in which the metering information is
collected.
This object makes sense only if ccmtrCollectionType object
is stream which indicates that the metering records
are to be streamed to an external collection server.
This object is deprecated and replaced by
ccmtrCollectionRevInterval. While retrieving the value of
ccmtrCollectionInterval, the minimum value of 15 will be
returned if the value of ccmtrCollectionRevInterval is lower
than 15. |
| U32 ccmtrCollectionRetries | 1.3.6.1.4.1.9.9.424.1.1.5 | Unsigned32 | read-write | The number of retries to stream the metering records to
the external collection server before an error is flagged.
This object makes sense only if ccmtrCollectionType object
is stream which indicates that the metering records
are to be streamed to an external collection server. |
| T/F ccmtrCollectionSecure | 1.3.6.1.4.1.9.9.424.1.1.6 | TruthValue | read-write | An indication of whether the streaming to the collection
server should be secure or not. The value of true
indicates that the streaming will be secure and false
indicates non-secure.
However the secure option is available only if the image
on the CMTS allows for security.
This object makes sense only if ccmtrCollectionType object
is stream which indicates that the metering records
are to be streamed to an external collection server. |
| T/F ccmtrCollectionCpeList | 1.3.6.1.4.1.9.9.424.1.1.7 | TruthValue | read-write | An indication if one would like the metering records to
contain the CPE(Customer premises equipment) IP addresses.
This option is provided to improve performance.
By default, this object is true which means the CPE
information will always be present. |
| T/F ccmtrCollectionAggregate | 1.3.6.1.4.1.9.9.424.1.1.8 | TruthValue | read-write | An indication if one would like only aggregate Service Flow
information per Cable Modem to be recorded. In this case
the record will have a SFID of 0 and a blank Service Class
Name. The distinction between upstream and downstream will
however be maintained. The counters present in the metering
records in this case will be the aggregate. i.e., sum of all
upstream/downstream service flows. By default, this object
is false which means that the metering records will
contain service flow counter information for all service
flows per CM. |
| NUM ccmtrCollectionSrcIfIndex | 1.3.6.1.4.1.9.9.424.1.1.9 | InterfaceIndexOrZero | read-write | The ifIndex of the interface which will be used as the source
interface for the billing packets.
When ccmtrCollectionType is 'local', the IP address of this
source interface will be used as the CMTS IP address in the
billing packets. When ccmtrCollectionType is 'stream', the
source IP address of the billing packets as well as the CMTS IP
address in billing packets will be changed to the IP address of
this interface. In both the cases, the mac address of the source
interface would be used in the billing packet headers.
A value of zero on this object indicates that the source
interface is not specifically configured and the system will
determine the source interface to use for billing packets
dynamically. This object can only be set when
ccmtrCollectionType is either 'local' or 'stream'. |
| U32 ccmtrCollectionRevInterval | 1.3.6.1.4.1.9.9.424.1.1.10 | Unsigned32 | read-write | The interval at which the metering information is
collected.
This object is of significance only if ccmtrCollectionType
object is 'stream' which indicates that the metering records
are to be streamed to an external collection server. |
| U32 ccmtrCollectionDataPerSession | 1.3.6.1.4.1.9.9.424.1.1.11 | Unsigned32 | read-write | This object specifies the number of service flow data
that would be collected at a Cable linecard in one session.
ccmtrCollectionDataPerSession together with
ccmtrCollectionDataTimer aims to control as well as
throttle the rate of export of the service flow data from the
Cable linecard to the Route Processor. This means that a Cable
linecard would collect ccmtrCollectionDataPerSession number of
service flow data and then pause for ccmtrCollectionDataTimer
before resuming collection. The cable linecard to route
processor throttling in turn affects the time to export all of
the service flow data from the CMTS to a collection server.
Time to export (minutes) =
(total flows in system * ccmtrCollectionDataTimer) /
(ccmtrCollectionDataPerSession * 1000 * 60)
This object cannot be modified during data export from the CMTS
to a collection server. |
| U32 ccmtrCollectionDataTimer | 1.3.6.1.4.1.9.9.424.1.1.12 | Unsigned32 | read-write | This object specifies the time interval before the start of the
next session of service flow data collection at a Cable
linecard.
After collection of ccmtrCollectionDataPerSession service flow
data at a Cable linecard, the linecard would resume collection
only after an interval of ccmtrCollectionDataTimer milliseconds.
This object cannot be modified during data export from the CMTS
to a collection server. |
| ccmtrMetering | 1.3.6.1.4.1.9.9.424.1.2 | | | |
| CCM ccmtrCollectionStatus | 1.3.6.1.4.1.9.9.424.1.2.1 | CcmtrStatus | read-only | The status of the last metering data export. It indicates
the success or failure of writing the metering record file
or streaming the record to the collection server. |
| STR ccmtrCollectionDestination | 1.3.6.1.4.1.9.9.424.1.2.2 | SnmpAdminString | read-only | It represents the name of the file that is created to
store the metering record or the IP address and port
number to which the metering information was streamed in
both the success and failure scenerios.
In the case of local storage it is the filename generated
as the CMTS host name followed by the timestamp when the
file was created.
The file will be stored in the filesystem as specified in
ccmtrCollectionFilesystem.
In the case of streaming it is the IP address and port
number in the format IPADDRESS:PORT# to which the last
streaming took place. |
| DAT ccmtrCollectionTimestamp | 1.3.6.1.4.1.9.9.424.1.2.3 | DateAndTime | read-only | The time when the last metering record was exported
successfully or with some failure. |
| T/F ccmtrMeteringNotifEnable | 1.3.6.1.4.1.9.9.424.1.2.4 | TruthValue | read-write | An indication of whether the notifications associated
with metering are enabled or disabled.
true indicates the notification is enabled and
false indicates the notification is disabled. |
| ciscoCableMeteringMIBConformance | 1.3.6.1.4.1.9.9.424.3 | | | |
| ciscoCableMeteringMIBCompliances | 1.3.6.1.4.1.9.9.424.3.1 | | | |
| ciscoCableMeteringCompliance | 1.3.6.1.4.1.9.9.424.3.1.1 | | | The compliance statement for CMTS devices that implement
the Usage Based Metering feature.
This compliance is deprecated by
ciscoCableMeteringComplianceRev1. |
| ciscoCableMeteringComplianceRev1 | 1.3.6.1.4.1.9.9.424.3.1.2 | | | The compliance statement for CMTS devices that implement
the Usage Based Metering feature. |
| ciscoCableMeteringMIBGroups | 1.3.6.1.4.1.9.9.424.3.2 | | | |
| ccmtrMeteringObjGroup | 1.3.6.1.4.1.9.9.424.3.2.1 | | | Group of objects implemented in CMTS
providing for usage based metering configuration
and notification information.
This group is deprecated by ccmtrMeteringObjGroupRev1. |
| ccmtrMeteringNotifCtrlGroup | 1.3.6.1.4.1.9.9.424.3.2.2 | | | The notification control which a
CISCO-CABLE-METERING-MIB
is required to implement. |
| ccmtrMeteringNotifGroup | 1.3.6.1.4.1.9.9.424.3.2.3 | | | The notification which a CISCO-CABLE-METERING-MIB
is required to implement. |
| ccmtrMeteringObjGroupRev1 | 1.3.6.1.4.1.9.9.424.3.2.4 | | | Group of objects implemented in CMTS providing for usage based
metering configuration and notification information. |
| ccmtrMeteringSrcIntfObjGroup | 1.3.6.1.4.1.9.9.424.3.2.5 | | | Group of objects implemented in CMTS to define the source
interface for the billing packets. |
| ccmtrMeteringRateCtrlObjGroup | 1.3.6.1.4.1.9.9.424.3.2.6 | | | Group of objects implemented in CMTS to control as well as
throttle the rate of export of the service flow data. |
