Downloads |
 Feedback
|
Table Of Contents
Usage Based Billing for the Cisco CMTS
Prerequisites for Usage-Based Billing
Restrictions for Usage-Based Billing
Information About Usage-Based Billing
Usage-Based Billing and DOCSIS Support on the Cisco CMTS
How to Configure the Usage-Based Billing Feature
Enabling Usage-Based Billing Feature (File Mode)—Using CLI Commands
Enabling Usage-Based Billing Feature (File Mode)—Using SNMP Commands
Enabling Usage-Based Billing Feature (Streaming Mode)—Using CLI Commands
Enabling Usage-Based Billing Feature (Streaming Mode)—Using SNMP Commands
Enabling and Configuring Secure Copy (optional)
Configuring the Cisco CMTS for SSL Operation
Retrieving Records from a Cisco CMTS in File Mode
Disabling the Usage-Based Billing Feature
Configuring Certified SSL Servers for Usage-Based Billing
Generating SSL Server Certification
Configuring and Testing the Cisco CMTS for Certified SSL Server Support
Monitoring the Usage-Based Billing Feature
Configuration Examples for Usage-Based Billing
File Mode Configuration (with Secure Copy)
Non-Secure Streaming Mode Configuration
Secure Streaming Mode Configuration
cable metering source-interface
snmp-server enable traps cable
ipdr session (global configuration)
Usage Based Billing for the Cisco CMTS
Document Revision History
This document describes the Usage-Based Billing feature for the Cisco Cable Modem Termination System (CMTS), which provides subscriber account and billing information in the Subscriber Account Management Interface Specification (SAMIS) format. The SAMIS format is specified by the Data-over-Cable Service Interface Specifications (DOCSIS) Operations Support System Interface (OSSI) specification.
Feature Specifications for Usage-Based Billing
Release 12.3(9a)BC
This feature was introduced on Cisco uBR7246VXR and Cisco uBR10012 universal broadband routers.
Feature support includes the new CISCO-CABLE-METERING-MIB, which contains objects that provide subscriber account and billing information in the Subscriber Account Management Interface Specification (SAMIS) format.
Release 12.3(17a)BC
This feature includes additional MIBs that support OSSI specifications as well as enhanced billing reports. For more information about DOCSIS 2.0, see the Cable Labs document t Data-Over-Cable Service Interface Specifications DOCSIS 2.0 Operations Support System Interface Specification.
Support for Secure Socket Layer (SSL) Servers introduced with certification support.
12.3(21)BC
This feature provides enhancements to specify the source interface for billing packets in the Subscriber Account Management Interface Specification (SAMIS).
The cable metering source-interface <interface> command was introduced.
Support also includes a new object ccmtrCollectionSrcIfIndex in CISCO-CABLE-METERING-MIB.my.
12.2(33)SCB
SAMIS over Internet Protocol Detail Record (IPDR) was introduced.
Finding Support Information for Platforms and Cisco IOS Software Images
Use Cisco Feature Navigator to find information about platform support and Cisco IOS software image support. Access Cisco Feature Navigator at http://www.cisco.com/go/fn. You must have an account on Cisco.com. If you do not have an account or have forgotten your username or password, click Cancel at the login dialog box and follow the instructions that appear.
Contents
This document includes the following major sections:
•
Prerequisites for Usage-Based Billing
•
•
•
•
•
Prerequisites for Usage-Based Billing
The Usage-Based Billing feature has the following prerequisites:
•
•
•
•
•
•
•
–
Tip
–
Restrictions for Usage-Based Billing
The Usage-Based Billing feature has the following restrictions and limitations:
•
•
–
–
•
•
•
After the file write operation is complete, the source-interface command (cable metering source-interface) can then be configured; and the metering file in the bootflash would need to be removed so that billing packets have the source-interface's IP address.
Note
•
Information About Usage-Based Billing
This section describes the Usage-Based Billing feature:
•
Feature Overview
The Usage-Based Billing feature provides a standards-based, open application approach to recording and retrieving traffic billing information for DOCSIS networks. When enabled, this feature provides the following billing information about the cable modems and customer premises equipment (CPE) devices that are using the cable network:
•
•
•
•
•
Billing records are maintained in a standardized text format that the service provider can easily integrate into their existing billing applications. Service providers can use this information to determine which users might be potential customers for service upgrades, as well as those customers that might be trying to exceed their SLA limits on a regular basis.
Usage-Based Billing and DOCSIS Support on the Cisco CMTS
The Usage-Based Billing feature supports these DOCSIS features on the Cisco CMTS:
•
•
•
•
•
•
Standards
The Usage-Based Billing feature is based on several open standards, allowing it to be supported by a wide range of commercial and custom-written billing applications. The following standards provide the major guidelines for writing and using the billing records that the CMTS produces:
•
•
•
Tip
Modes of Operation
The Usage-Based Billing feature can operate in two modes:
•
The remote application can use the Secure Copy Protocol (SCP) or the Trivial File Transfer Protocol (TFTP) to transfer the file. After a successful transfer, the remote application then deletes the billing record file, which signals the CMTS that it can create a new file. The remote application can either periodically log into the CMTS to transfer the billing record file, or it can wait until the CMTS sends an SNMPv3 trap to notify the application that a billing record file is available.
•
If the CMTS fails to establish a successful connection with the external server, it retries the connection between 1 and 3 times, depending on the configuration. If the CMTS continues to be unable to connect with the external server, the CMTS can send an SNMPv3 trap to notify an SNMP manager that this failure occurred.
In streaming mode, you configure the CMTS to transmit the billing record file at regular intervals. Typically, the interval chosen would depend on the number of cable modems and the size of the billing record files that the CMTS produces.
Billing Record Format
Each billing record is an ASCII text file using XML formatting to encode the billing record objects that are required by the DOCSIS specifications. This file can be read by any billing application that can be configured to parse XML data files.
Table 1 lists the objects that are contained in each billing record that the CMTS generates. This table shows the object's name, as it appears in the billing record, and a description of that object.
Note
The following example shows a sample IPDR billing record for a downstream service flow:
<?xml version="1.0" encoding="UTF-8"?>
<IPDRDoc xmlns="http://www.ipdr.org/namespaces/ipdr"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="DOCSIS-3.1-B.0.xsd"docId="C341A679-0000-0000-0000-000BBF54D000"creationTime="2002-05-25T14:41:29Z"IPDRRecorderInfo="CMTS01"version="3.1"></IPDR><IPDR xsi:type="DOCSIS-Type"><IPDRcreationTime>2003-09-18T16:52:34Z</IPDRcreationTime><CMTShostname>R7519-UBR7246.cisco.com</CMTShostname><CMTSipAddress>1.8.8.21</CMTSipAddress><CMTSsysUpTime>287315 </CMTSsysUpTime><CMTScatvIfName>Cable8/0/0</CMTScatvIfName><CMTScatvIfIndex>13</CMTScatvIfIndex><CMTSupIfName>Ca8/0/0-upstream0</CMTSupIfName><CMTSupIfType>129</CMTSupIfType><CMTSdownIfName>Ca8/0/0-downstream</CMTSdownIfName><CMmacAddress>00-00-39-AB-D4-53</CMmacAddress><CMdocsisMode>1.0</CMdocsisMode><CMipAddress>3.8.21.3</CMipAddress><CPEipAddress></CPEipAddress><RecType>1</SFtype><serviceIdentifier>3</serviceIdentifier><serviceClassName></serviceClassName><serviceDirection>2</serviceDirection><serviceOctetsPassed>23457</ServiceOctetsPassed><servicePktsPassed>223</ServicePktsPassed><serviceSlaDropPkts>2</serviceSlaDropPkts><serviceSlaDelayPkts>0</serviceSlaDelayPkts><serviceTimeCreated>11000</serviceTimeCreated><serviceTimeActive>15890</serviceTimeActive></IPDR></IPDRDoc>The following example shows a sample IPDR billing record for an upstream service flow:
<?xml version="1.0" encoding="UTF-8"?>
<IPDRDoc xmlns="http://www.ipdr.org/namespaces/ipdr"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="DOCSIS-3.1-B.0.xsd"docId="docId="C3146152-0000-0000-0000-000BBF7D5800"creationTime="2003-09-18T16:52:34Z"IPDRRecorderInfo="CMTS01-UBR7246.cisco.com"version="3.1"><IPDR xsi:type=" DOCSIS-Type"><IPDRcreationTime>2003-09-18T16:52:34Z</IPDRcreationTime><CMTShostname>R7519-UBR7246.cisco.com</CMTShostname><CMTSipAddress>1.8.8.21</CMTSipAddress><CMTSsysUpTime>287315 </CMTSsysUpTime><CMTScatvIfName>Cable8/0/0</CMTScatvIfName><CMTScatvIfIndex>13</CMTScatvIfIndex><CMTSupIfName>Ca8/0/0-upstream0</CMTSupIfName><CMTSupIfType>129</CMTSupIfType><CMTSdownIfName>Ca8/0/0-downstream</CMTSdownIfName><CMmacAddress>00-00-39-18-8A-4D</CMmacAddress><CMdocsisMode>1.0</CMdocsisMode><CMipAddress>3.8.21.14</CMipAddress><CPEipAddress></CPEipAddress><RecType>1</SFtype><serviceIdentifier>3</serviceIdentifier><serviceClassName></serviceClassName><serviceDirection>1</serviceDirection><serviceOctetsPassed>1404</ServiceOctetsPassed><servicePktsPassed>6</ServicePktsPassed><serviceSlaDropPkts>0</serviceSlaDropPkts><serviceSlaDelayPkts>0</serviceSlaDelayPkts><serviceTimeCreated>11000</serviceTimeCreated><serviceTimeActive>15890</serviceTimeActive></IPDR></IPDRDoc>SNMP Support
Cisco IOS Release 12.3(9a)BC supports the CISCO-CABLE-METERING-MIB MIB, which provides the following SNMPv3 support for the Usage-Based Billing feature:
•
•
•
–
–
–
For more information on this support, see the CISCO-CABLE-METERING-MIB.
In addition, information about deleted service flows (DOCSIS 1.1 service flows only) is maintained in the docsQosServiceFlowLogTable in the DOCS-QOS-MIB. (Logging of deleted service flows must be enabled using the cable sflog global configuration command.)
Benefits
The Usage-Based Billing feature provides the following benefits to cable service providers and their partners and customers:
•
•
How to Configure the Usage-Based Billing Feature
This section describes the following tasks that are required to implement the Usage-Based Billing feature:
•
•
•
•
•
•
•
•
•
Enabling Usage-Based Billing Feature (File Mode)—Using CLI Commands
This section describes how to enable and configure the Usage-Based Billing feature so that it operates in file mode, where it writes the billing record files to a local file system. The billing application must then log into the Cisco CMTS and retrieve the billing record files on a regular basis.
SUMMARY STEPS
1.
2.
3.
4.
5.
6.
7.
DETAILED STEPS
Enabling Usage-Based Billing Feature (File Mode)—Using SNMP Commands
This section describes how to enable and configure the Usage-Based Billing feature so that it operates in file mode and writes the billing record files to a local file system. The billing application must then log into the Cisco CMTS and retrieve the billing record files on a regular basis.
SUMMARY STEPS
To configure the Cisco CMTS for Usage-Based Billing feature in file mode, you must set a number of objects in the CISCO-CABLE-METERING-MIB. Table 2 describes each of these objects, and whether they are required or optional.
Note
http://www.cisco.com/en/US/docs/ios/cable/command/reference/cbl_book.html
DETAILED STEPS
Note
Step 1
workstation# setany -v2c ip-address rw-community-string ccmtrCollectionType.0 -i 2workstation#Step 2
workstation# setany -v2c ip-address rw-community-string ccmtrCollectionFilesystem.0 -D disk0:workstation#Step 3
workstation# setany -v2c ip-address rw-community-string ccmtrCollectionCpeList.0 -i 2workstation#Step 4
workstation# setany -v2c ip-address rw-community-string ccmtrCollectionAggregate.0 -i 1workstation#Step 5
workstation# setany -v2c ip-address rw-community-string ccmtrtrCollectionSrcIfIndex.0 -i 1workstation#
Examples
The following example shows the Usage-Based Billing feature being configured using SNMP commands. The following display shows that a Cisco CMTS router at IP address 10.8.8.21 is configured with the default configuration (the Usage-Based Billing feature is disabled):
workstation# getmany -v2c 10.8.8.21 rw-string ciscoCableMeteringMIBccmtrCollectionType.0 = none(1)ccmtrCollectionFilesystem.0 =ccmtrCollectionCpeList.0 = true(1)ccmtrCollectionAggregate.0 = false(2)ccmtrCollectionStatus.0 = 0ccmtrCollectionDestination.0 =ccmtrCollectionTimestamp.0 = 00 00 00 00 00 00 00 00ccmtrCollectionNotifEnable.0 = true(1)workstation#The following SNMP commands are then given to enable the Usage-Based Billing feature and to configure it for file mode:
workstation# setany -v2c 10.8.8.21 rw-string ccmtrCollectionType.0 -i 2workstation# setany -v2c 10.8.8.21 rw-string ccmtrCollectionFilesystem.0 -D disk1:workstation#These commands add the following line to the router's running configuration file:
Router# show running-config | include meteringcable metering filesystem disk1:Router#The following SNMP display shows the new configuration, after the Cisco CMTS has successfully written a billing record:
workstation# getmany -v2c 10.8.8.21 rw-string ciscoCableMeteringMIBccmtrCollectionType.0 = local(2)ccmtrCollectionFilesystem.0 = disk1:ccmtrCollectionCpeList.0 = true(1)ccmtrCollectionAggregate.0 = false(2)ccmtrCollectionStatus.0 = success(1)ccmtrCollectionDestination.0 = disk1:UBR7246.cisco.com-20030925-185827ccmtrCollectionTimestamp.0 = 07 d3 09 19 12 3a 1c 00ccmtrCollectionNotifEnable.0 = true(1)workstation#Enabling Usage-Based Billing Feature (Streaming Mode)—Using CLI Commands
This section describes how to enable and configure the Usage-Based Billing feature so that it operates in streaming mode, where it regularly transmits the billing records to an external server for use by the billing application.
SUMMARY STEPS
1.
2.
3.
4.
5.
6.
7.
DETAILED STEPS
Enabling Usage-Based Billing Feature (Streaming Mode)—Using SNMP Commands
This section describes how to use SNMP commands to enable and configure the Usage-Based Billing feature so that it operates in streaming mode, where it regularly transmits the billing records to an external server for use by the billing application.
SUMMARY STEPS
To configure the Cisco CMTS for Usage-Based Billing feature in streaming mode, you must set a number of objects in the CISCO-CABLE-METERING-MIB. Table 3 describes each of these objects, and whether they are required or optional.
Note
http://www.cisco.com/en/US/docs/ios/cable/command/reference/cbl_book.html
DETAILED STEPS
Note
Step 1
workstation# setany -v2c ip-address rw-community-string ccmCollectionType.0 -i 3workstation#Step 2
workstation# setany -v2c ip-address rw-community-string ccmCollectionIpAddress.1 -o '0a 08 06 0b'workstation# setany -v2c ip-address rw-community-string ccmCollectionPort.1 -g 6789workstation#Step 3
workstation# setany -v2c ip-address rw-community-string ccmCollectionIpAddress.1 -o '0a 08 06 0c'workstation# setany -v2c ip-address rw-community-string ccmCollectionPort.1 -g 7000workstation#Step 4
workstation# setany -v2c ip-address rw-community-string ccmCollectionSecure.1 -i 2workstation# setany -v2c ip-address rw-community-string ccmCollectionInterval.1 -i 45workstation# setany -v2c ip-address rw-community-string ccmCollectionRetries.1 -i 3workstation#Step 5
workstation# setany -v2c ip-address rw-community-string ccmCollectionCpeList.0 -i 2workstation#Step 6
workstation# setany -v2c ip-address rw-community-string ccmCollectionAggregate.0 -i 1workstation#Step 7
workstation# setany -v2c ip-address rw-community-string ccmtrCollectionSrcIfIndex.0 -i 1workstation#
Examples
The following example shows the Usage-Based Billing feature being configured using SNMP commands. The following display shows that a Cisco CMTS router at IP address 10.8.8.21 is configured with the default configuration (the Usage-Based Billing feature is disabled):
workstation# getmany -v2c 10.8.8.21 rw-string ciscoCableMeteringMIBccmCollectionType.0 = none(1)ccmCollectionFilesystem.0 =ccmCollectionCpeList.0 = true(1)ccmCollectionAggregate.0 = false(2)ccmCollectionStatus.0 = 0ccmCollectionDestination.0 =ccmCollectionTimestamp.0 = 00 00 00 00 00 00 00 00ccmCollectionNotifEnable.0 = true(1)workstation#The following SNMP commands are then given to enable the Usage-Based Billing feature and to configure it for streaming mode:
workstation# setany -v2c 10.8.8.21 rw-string ccmCollectionType.0 -i 3workstation# setany -v2c 10.8.8.21 rw-string ccmCollectionIpAddress.1 -o '0a 08 06 0b'workstation# setany -v2c 10.8.8.21 rw-string ccmCollectionPort.1 -g 6789workstation# setany -v2c 10.8.8.21 rw-string ccmCollectionSecure.1 -i 2workstation# setany -v2c 10.8.8.21 rw-string ccmCollectionRetries.1 -i 3workstation# setany -v2c 10.8.8.21 rw-string ccmCollectionInterval.1 -i 45workstation#These commands add the following line to the router's running configuration file:
Router# show running-config | include meteringcable metering destination 10.8.6.11 6789 3 45 non-secureRouter#The following SNMP display shows the new configuration:
workstation# getmany -v2c 10.8.8.21 rw-string ciscoCableMeteringMIBccmCollectionType.0 = stream(3)ccmCollectionFilesystem.0 =ccmCollectionIpAddrType.1 = ipv4(1)ccmCollectionIpAddress.1 = 0a 08 06 0bccmCollectionPort.1 = 6789ccmCollectionInterval.1 = 45ccmCollectionRetries.1 = 3ccmCollectionSecure.1 = false(2)ccmCollectionRowStatus.1 = active(1)ccmCollectionCpeList.0 = true(1)ccmCollectionAggregate.0 = false(2)ccmCollectionStatus.0 = 0ccmCollectionDestination.0 =ccmCollectionTimestamp.0 = 00 00 00 00 00 00 00 00ccmCollectionNotifEnable.0 = true(1)workstation#Enabling and Configuring Secure Copy (optional)
This section describes how to configure the CMTS for the Secure Copy Protocol (SCP), to allow an external server to log into the CMTS and copy the billing records from the Cisco CMTS to the external server.
Note
SUMMARY STEPS
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
DETAILED STEPS
Step 1
enable
Example:Router> enable
Router#
Enables privileged EXEC mode. Enter your password if prompted.
Step 2
configure terminal
Example:Router# configure terminal
Router(config)#
Enters global configuration mode.
Step 3
aaa new-model
Example:Router(config)# aaa new-model
Router(config)#
Enables the Authentication, Authorization, and Accounting (AAA) access control model.
Step 4
aaa authentication login {default | list-name} method1 [method2 ...]
Example:Router(config)# aaa authentication login default enable
Router(config)#
Enables AAA access control authentication at login, using the following parameters:
•
•
•
Valid methods include enable, line, and local.
Note
Step 5
aaa authorization exec {default | list-name} method1 [method2 ...]
Example:Router(config)# aaa authorization exec default local
Router(config)#
Configures the CMTS to allow users to run an EXEC shell and access the CLI to run the Secure Copy commands.
•
•
•
Valid methods include local.
Note
Step 6
username name privilege level password encryption-type password
Example:Router(config)# username billingapp privilege 15 password 7 billing-password
Router(config)#
(Optional) Creates a user account for login access and specifies the privilege level and password for that account:
•
•
•
•
Note
Step 7
ip ssh time-out seconds
Example:Router(config)# ip ssh time-out 120
Router(config)#
Enables Secure Shell (SSH) access on the Cisco CMTS, which is required for SCP use. The seconds parameter specifies the maximum time allowed for SSH authentication, in seconds, with a valid range of 0 to 120 seconds, with a default of 120 seconds.
Step 8
ip ssh authentication-retries n
Example:Router(config)# ip ssh authentication-retries 3
Router(config)#
Specifies the maximum number of login attempts a user is allowed before the router disconnects the SSH session. The valid range is 1 to 5, with a default of 3 attempts.
Step 9
ip scp server enable
Example:Router(config)# ip scp server enable
Router(config)#
Enables SCP access on the Cisco CMTS.
Step 10
end
Example:Router(config)# end
Router#
Exits global configuration mode and returns to privileged EXEC mode.
Configuring the Cisco CMTS for SSL Operation
This section describes the procedures to configure the Cisco CMTS for secure socket layer (SSL) operation, so that the Usage-Based Billing feature can use an SSL connection to transfer the billing record files in streaming mode.
Note
Prerequisites
•
•
SUMMARY STEPS
To prepare the Cisco CMTS router for SSL operation, you must perform the following configuration steps:
•
•
•
•
•
•
For the detailed steps in performing these procedures, see the Configuring Certification Authority Interoperability chapter in the IP Security and Encryption section of the Cisco IOS Security Configuration Guide, Release 12.2, at the following URL:
http://www.cisco.com/en/US/docs/ios/12_2/security/configuration/guide/fsecur_c.htmlRetrieving Records from a Cisco CMTS in File Mode
When the Usage-Based Billing feature is enabled and configured for File mode, the billing application server must regularly retrieve the billing records from the Cisco CMTS. This is typically done by a script that either logs in to the Cisco CMTS and uses CLI commands to transfer the file, or by a script that uses SNMP commands to transfer the file.
When using CLI commands, the procedure is typically as follows:
1.
2.
a.
Note
b.
3.
The following sections show examples of how this can be done, using each method.
Tip
Using SCP
To transfer billing records using SCP, you must first enable and configure the router for SCP operation, using the procedure given in the "Enabling and Configuring Secure Copy (optional)" section. Then, the application server must log in to the Cisco CMTS and use the copy command at the privileged EXEC prompt. The copy command needs to specify the location of the billing record on the local filesystem and the destination server for the SCP transfer.
The following example shows a typical session where a billing record on slot0 is transferred to an FTP server with the hostname of billserver.mso-example.com:
CMTS01# copy slot0:CMTS01_20030211-155025 scp://billingapp-server.mso-example.com/Address or name of remote host [billingapp-server.mso-example.com]?Destination username [billing-app]?Destination filename [CMTS01_20030211-155025]?Writing CMTS01_20030211-155025Password: billing-password!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!![OK - 1403352/1024 bytes]1403352 bytes copied in 17.204 secs (85631 bytes/sec)CMTS01# delete slot0:CMTS01_20030211-155025CMTS01# squeeze slot0:CMTS01#
Note
Using TFTP
To transfer billing records using TFTP, you must first configure an external workstation to be a TFTP server. For security, the TFTP server should be isolated from the Internet or any external networks, so that only authorized TFTP clients, such as the Cisco CMTS router, can access the server.
To transfer the billing records, the application server must log in to the Cisco CMTS and use the copy command at the privileged EXEC prompt. The copy command needs to specify the location of the billing record on the local filesystem and the destination server for the TFTP transfer.
The following example shows a typical session where a billing record on slot0 is transferred to an TFTP server with the hostname of billserver.mso-example.com.
CMTS01# copy slot0:CMTS01_20030211-155025 tftp://billingapp-server.mso-example.com/incomingAddress or name of remote host [billingapp-server.mso-example.com]?Destination username [billing-app]?Destination filename [CMTS01_20030211-155025]?Writing CMTS01_20030211-155025!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!![OK - 1102348/1024 bytes]1102348 bytes copied in 14.716 secs (63631 bytes/sec)CMTS01# delete slot0:CMTS01_20030211-155025CMTS01# squeeze slot0:CMTS01#
Note
Using SNMP
To transfer billing record file using SNMP commands, you must set a number of objects in the CISCO-FLASH-MIB to transfer the file to a TFTP server. After the file has been successfully transferred, you can then use SNMp commands to delete the billing record file.
Note
SUMMARY STEPS
To transfer a billing record file to a TFTP server, using SNMP commands, you must set a number of objects in the CISCO-FLASH-MIB. Table 4 describes each of these objects, and whether they are required or optional.
After transferring the billing records file, you must then set a number of objects in the CISCO-FLASH-MIB to delete the file, so that the Cisco CMTS can begin writing a new file. If the Flash memory is not ATA-compatible, you must also set a number of objects to squeeze the Flash memory, so as to make the deleted space available for new files. Table 5 describes each of these objects, and whether they are required or optional.
DETAILED STEPS
Note
Copying the Billing Record File to the TFTP Server
Step 1
Step 2
workstation# setany -v2c ip-address rw-community-string ciscoFlashCopyEntryStatus.582 -i 5workstation#Step 3
workstation# setany -v2c ip-address rw-community-string ciscoFlashCopyCommand.582 -i 3workstatioN#Step 4
workstation# setany -v2c ip-address rw-community-string ciscoFlashCopyServerAddress.582 -a "172.20.12.193"workstatioN#Step 5
workstation# setany -v2c ip-address rw-community-string ciscoFlashCopySourceName.582 -D "slot0:CMTS01_20030211-155025"workstation#Step 6
workstation# setany -v2c ip-address rw-community-string ciscoFlashCopyDestinationName.582 -D "/cmts01-billing/billing-file"workstation#Step 7
workstation# setany -v2c ip-address rw-community-string ciscoFlashCopyEntryStatus.582 -i 1workstation#Step 8
workstation# getmany -v2c ip-address rw-community-string ciscoFlashCopyStatus.582ciscoFlashCopyStatus.582 = copyInProgress(1)workstation# getmany -v2c ip-address rw-community-string ciscoFlashCopyStatus.582ciscoFlashCopyStatus.582 = copyInProgress(1)workstation# getmany -v2c ip-address rw-community-string ciscoFlashCopyStatus.582ciscoFlashCopyStatus.582 = copyOperationSuccess(2)workstation#If the file transfer fails, the most common status values that are reported by the ciscoFlashCopyStatus object are:
•
•
•
•
•
Step 9
workstation# setany -v2c ip-address rw-community-string ciscoFlashCopyEntryStatus.582 -i 6workstation#Deleting the Billing Record File
After the billing record file has been successfully transferred, use the following procedure to delete the billing record on the Cisco CMTS flash file system, so that the Cisco CMTS can write the new billing record.
Step 1
workstation# setany -v2c ip-address rw-community-string ciscoFlashMiscOpEntryStatus.31 -i 5workstation# setany -v2c ip-address rw-community-string ciscoFlashMiscOpCommand.31 -i 3workstation# setany -v2c ip-address rw-community-string ciscoFlashMiscOpDestinationName.31 -D "/cmts01-billing/CMTS01_20030211-155025"workstation# setany -v2c ip-address rw-community-string ciscoFlashMiscOpEntryStatus.31 -i 1workstation#Step 2
workstation# getmany -v2c ip-address rw-community-string ciscoFlashMiscOpStatus.31ciscoFlashCopyStatus.31 = miscOpInProgress(1)workstation# getmany -v2c ip-address rw-community-string ciscoFlashMiscOpStatus.31ciscoFlashCopyStatus.582 = miscOpOperationSuccess(2)workstation#Step 3
workstation# setany -v2c ip-address rw-community-string ciscoFlashMiscOpEntryStatus.32 -i 5workstation# setany -v2c ip-address rw-community-string ciscoFlashMiscOpCommand.32 -i 5workstation# setany -v2c ip-address rw-community-string ciscoFlashMiscOpDestinationName.32 -D slot0:workstation# setany -v2c ip-address rw-community-string ciscoFlashMiscOpEntryStatus.32 -i 1workstation#
Examples
The following SNMP commands transfer a file named CMTS01_20030211-155025 to a TFTP server at the IP address 10.10.31.3. After the file is successfully transferred, the row entry for this copy command is deleted.
workstation# setany -v2c 10.8.8.21 rw-string ciscoFlashCopyEntryStatus.582 -i 5workstation# setany -v2c 10.8.8.21 rw-string ciscoFlashCopyCommand.582 -i 3workstation# setany -v2c 10.8.8.21 rw-string ciscoFlashCopyServerAddress.582 -a "10.10.31.3"workstation# setany -v2c 10.8.8.21 rw-string ciscoFlashCopySourceName.582 -D "slot0:CMTS01_20030211-155025"workstation# setany -v2c 10.8.8.21 rw-string ciscoFlashCopyDestinationName.582 -D "/cmts01-billing/CMTS01_20030211-155025"workstation# setany -v2c 10.8.8.21 rw-string ciscoFlashCopyEntryStatus.582 -i 1workstation# getmany -v2c 10.8.8.21 rw-string ciscoFlashCopyStatus.582ciscoFlashCopyStatus.582 = copyInProgress(1)workstation# getmany -v2c 10.8.8.21 rw-string ciscoFlashCopyStatus.582ciscoFlashCopyStatus.582 = copyOperationSuccess(2)workstation# setany -v2c 10.8.8.21 rw-string ciscoFlashCopyEntryStatus.582 -i 6workstation#The following commands show a billing record file being deleted on the Cisco CMTS file system, and the deleted file space being recovered by a squeeze operation:
workstation# setany -v2c 10.8.8.21 rw-string ciscoFlashMiscOpEntryStatus.31 -i 5workstation# setany -v2c 10.8.8.21 rw-string ciscoFlashMiscOpCommand.31 -i 3workstation# setany -v2c 10.8.8.21 rw-string ciscoFlashMiscOpDestinationName.31 -D "/cmts01-billing/CMTS01_20030211-155025"workstation# setany -v2c 10.8.8.21 rw-string ciscoFlashMiscOpEntryStatus.31 -i 1workstation# getmany -v2c 10.8.8.21 rw-string ciscoFlashMiscOpStatus.31ciscoFlashCopyStatus.31 = miscOpInProgress(1)workstation# getmany -v2c 10.8.8.21 rw-string ciscoFlashMiscOpStatus.31ciscoFlashCopyStatus.582 = miscOpOperationSuccess(2)workstation# setany -v2c 10.8.8.21 rw-string ciscoFlashMiscOpEntryStatus.32 -i 5workstation# setany -v2c 10.8.8.21 rw-string ciscoFlashMiscOpCommand.32 -i 5workstation# setany -v2c 10.8.8.21 rw-string ciscoFlashMiscOpDestinationName.32 -D slot0:workstation# setany -v2c 10.8.8.21 rw-string ciscoFlashMiscOpEntryStatus.32 -i 1workstation#Disabling the Usage-Based Billing Feature
This section describes how to disable the Usage-Based Billing. Giving this command immediately stops the collection of billing information. If a billing record is currently written or being streamed to an external server, the CMTS completes the operation before disabling the usage-based billing feature.
SUMMARY STEPS
1.
2.
3.
4.
5.
6.
7.
DETAILED STEPS
Configuring Certified SSL Servers for Usage-Based Billing
Cisco IOS Release 12.3(17a)BC introduces support for the Secure Socket Layer (SSL) Server, used with the Usage-Based Billing feature of the Cisco CMTS. Usage-Based Billing implements the DOCSIS Subscriber Account Management Interface Specification (SAMIS) format.
This new capability enables the configuration of the SSL server between the Cisco CMTS and a collection server. Certificate creation steps and debug commands are added or enhanced to support the SSL Server and certificates. This section describes general steps.
Refer also to the "Configuring the Cisco CMTS for SSL Operation" section.
Generating SSL Server Certification
These general steps describe the creation and implementation of certification for the Secure Socket Layer (SSL) Server.
1.
2.
3.
4.
5.
6.
7.
8.
Configuring and Testing the Cisco CMTS for Certified SSL Server Support
Perform the following steps to configure the Cisco router to support the SSL Server and certification.
SUMMARY STEPS
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
DETAILED STEPS
Step 1
enable
Example:Router> enable
Enables privileged EXEC mode.
•
Step 2
configure terminal
Example:Router# config t
Enters global configuration mode.
Step 3
ip domain name domain
Example:Router(config)# ip domain name Cisco.comDefines a default domain name that the Cisco IOS software uses to complete unqualified host names (names without a dotted-decimal domain name). Do not include the initial period that separates an unqualified name from the domain name.
•
Note
Step 4
Generates RSA key pairs.
Note
Step 5
Router(config)# Ctrl-Z
Router#
Returns to privileged EXEC mode.
Step 6
Verifies the certificate is valid and operational on the Cisco CMTS.
Step 7
Displays the available certificates on the Cisco CMTS.
Step 8
configure terminal
Example:Router# config t
Router(config)#
Enters global configuration mode.
Step 9
Defines the destination IP address for cable metering, to be used with the certificate.
Step 10
Tests cable metering in light of the supported SSL server and metering configuration.
Monitoring the Usage-Based Billing Feature
To display the most current billing record, use the show cable metering-status command. The following example shows typical output when usage-based billing is configured to write the billing records to a local file system:
CMTS01# show cable metering-statusdestination complete-time flow cpe statusaggr suppressdisk0:R7519-UBR7246-20000308-004428 Jun 12 09:33:05 No No successCMTS01#The following example shows a typical output for the show cable metering-status command when usage-based billing is configured to stream the billing records to an external server:
Router# show cable metering-statusdestination complete-time flow cpe statusaggr supp10.11.37.2 :1234 Jun 12 09:33:05 No No successRouter#The following example shows a typical output for the show cable metering-status command using verbose option:
Router# show cable metering-status verboseLast export statusDestination : disk0:sunethra10k-20070129-190423Complete Time : Jan29 19:04:38Flow Aggregate : NoCpe list suppression : NoSource interface : FastEthernet0/0/0Status of last export : successCurrent export status : In progressThe following example shows a typical output for the show cable metering-status command when usage-based billing is configured to use the Internet Protocol Detail Record (IPDR) Exporter to stream the billing records to an external server:
Router# show cable metering-statusdestination complete-time flow cpe statusaggr suppIPDR_Session1 Jun 12 09:33:05 N/A N/A successThe following example shows a typical output for for the verbose form of the show cable metering-status command when usage-based billing is configured to use the IPDR Exporter to stream the billing records to an external server:
Router# show cable metering-status verboseLast export statusDestination : IPDR_Session1Complete Time : Jun 12 09:36:05Status of last export : success
Note
Tip
To display information about the state of the IPDR Exporter, use the show ipdr exporter command. The following example shows typical output:
Router#configure terminalRouter#show ipdr exporterIPDR exporter is started.Configuration Examples for Usage-Based Billing
This section lists the following sample configurations for the Usage-Based Billing feature:
•
•
•
File Mode Configuration (with Secure Copy)
The following excerpt from a configuration file shows a typical configuration for the Usage-Based Billing feature when operating in file mode and enabling Secure Copy (SCP) for file transfers.
!cable metering filesystem disk1:snmp-server enable traps cable metering...aaa new-modelaaa authentication login default group tacacs+aaa authorization exec default group tacacs+username billingapp level 15 password 7 billing-passwordip ssh time-out 120ip ssh authentication-retries 3ip scp server enableNon-Secure Streaming Mode Configuration
The following excerpt from a configuration file shows a typical configuration for the Usage-Based Billing feature when operating in streaming mode and specifying both a primary and a secondary external server. The data is sent using standard TCP packets, without any security.
cable metering destination 10.10.10.171 5321 10.10.10.173 5321 2 30 non-securesnmp-server enable traps cable meteringThe following excerpt from a configuration file shows a typical configuration for the Usage-Based Billing feature when operating in streaming mode and specifying only a primary external server:
cable metering destination 10.10.11.181 6789 2 30 non-securesnmp-server enable traps cable metering
Note
Secure Streaming Mode Configuration
The following excerpt from a configuration file shows a typical configuration for the Usage-Based Billing feature when operating in streaming mode and specifying only a primary external server. Secure socket layer (SSL) TCP connections are used to transmit the data, which requires the configuration of a digital certificate.
cable metering destination 10.10.11.181 6789 2 30 secure cpe-list-suppresssnmp-server enable traps cable metering...crypto ca trustpoint SSL-CERT!crypto ca certificate chain SSL-CERTcertificate ca 00308204A6 3082038E A0030201 02020100 300D0609 2A864886 F70D0101 040500308198310B 30090603 55040613 02555331 13301106 03550408 130A4361 6C69666F726E6961 3111300F 06035504 07130853 616E204A 6F736531 1C301A06 0355040A13134369 73636F20 53797374 656D732C 20496E63 2E311130 0F060355 040B13084361626C 65204255 310E300C 06035504 03130553 65656D61 3120301E 06092A86...3E65DBBA 337627E8 589980D6 C8836C7E 3D3C3BC1 F21973BF 7B287D7A 13B16DA202B2B180 C2A125C7 368BDA4C 0B8C81B7 7D5BEFF9 A6618140 1E95D19E BD0A84F5B43702AB 39B5E632 87BA36AC A3A8A827 C5BAC0F1 B24B8F4D 55615C49 5B6E4B61B15CC48A 8EF566C8 6E449B49 BF8E9165 317C1734 9A48A240 78A356B5 403E9E9B88A51F5B 0FE38CC2 F431quit!
Note
Additional References
For additional information related to Usage-Based Billing, refer to the following references:
Related Documents
CMTS Command Reference
Cisco IOS CMTS Cable Command Reference Guide, at the following URL:
http://www.cisco.com/en/US/docs/ios/cable/command/reference/cbl_book.htmlCisco IOS Release 12.2 Command Reference
Cisco IOS Release 12.2 Configuration Guides and Command References, at the following URL:
http://www.cisco.com/en/US/products/sw/iosswrel/ps1835/products_installation_and_configuration_guides_list.htmlhttp://www.cisco.com/en/US/products/sw/iosswrel/ps1835/prod_command_reference_list.html
Secure Copy (SCP) Configuration
Secure Copy feature module, at the following URL:
http://www.cisco.com/en/US/docs/ios/redirect/eol.htmlCisco IOS Release 12.2 T Command Reference, Other Security Features, Secure Shell Commands, at the following URL:
http://www.cisco.com/en/US/docs/ios/redirect/eol.htmlSecure Sockets Layer (SSL)
Introduction to Secure Sockets Layer white paper, at the following URL:
http://www.cisco.com/en/US/tech/tk583/tk618/tech_white_papers_list.htmlIPDR.org Software Reference Libraries
IPDR.org project page, at the following URL:
http://sourceforge.net/projects/ipdr/index.html
Standards
NDM-U v3.1.1
Network Data Management - Usage (NDM-U) For IP-Based Services, Version 3.1.1 (http://www.ipdr.org)
Data-over-Cable Service Interface Specifications Radio Frequency Interface Specification, version 1.1 (http://www.cablelabs.com/cablemodem/)
Data-Over-Cable Service Interface Specifications DOCSIS 2.0 Operations Support System Interface (OSSI) Specification (http://www.cablelabs.com/cablemodem/)
XML Schema
Extensible Markup Language (XML) schema ( http://www.w3.org)
1 Not all supported standards are listed.
MIBs
To locate and download MIBs for selected platforms, Cisco IOS releases, and feature sets, use Cisco MIB Locator found at the following URL:
1 Not all supported MIBs are listed.
RFCs
Technical Assistance
Command Reference
This section documents the following new or modified commands that are needed to document the Usage-Based Billing feature.
•
•
•
Note
cable metering destination
To enable usage-based billing and to stream the billing records to an external collection server, use the cable metering destination command in global configuration mode. To disable usage-based billing, use the no form of this command.
cable metering destination ip-address port [ip-address2 port2] retries minutes {non-secure | secure} [cpe-list-suppress] [flow-aggregate]
no cable metering
Syntax Description
Defaults
Usage billing is disabled. When enabled, CPE IP addresses (a maximum of five per cable modem) are included in the billing records by default.
Command Modes
Global configuration
Command History
Usage Guidelines
The cable metering destination command enables usage-based filling and configures it for streaming mode, where the Cisco CMTS creates the billing records and regularly sends them to an external server for use by the billing application.
The Cisco CMTS attempts to establish a connection with the first (primary) external server, and if this fails, the CMTS sends an SNMP trap about the failure. The Cisco CMTS retries the connection for the number of times specified in the cable metering destination command, and if all of those attempts fail, the Cisco CMTS switches to the secondary external server, if configured. The Cisco CMTS repeats this sequence at every interval, and always tries to connect to the primary server first before attempting to use the secondary server.
Tip
Note
If the CMTS cannot transmit the billing record to the external server, and if metering traps have been enabled using the snmp-server enable traps cable metering command, the CMTS sends an SNMP trap to the SNMP manager describing the reason for the failure. Typically, the reason is either that a timeout occurred with the external server, or that the billing record no longer exists on the local filesystem. An SNMP trap is sent for each connection failure.
To disable usage-based billing, use the no cable metering command. This immediately stops the collection of billing information, except when the billing records are currently being streamed to the external server. If a billing operation is in progress when you give the no cable metering command, the system displays the message "CMTS Metering in progress. Ignoring current config." Wait until the billing operation is finished and then reenter the no cable metering command.
Note
Examples
The following example shows how to enable usage-based billing for streaming mode, with the CMTS transmitting the billing records every 60 minutes to the server at the IP address of 10.10.10.37 and TCP port of 5215, using a secure socket layer (SSL) TCP connection. A secondary external service is also defined. The CMTS will retry the connection three times before giving up and switching to the secondary server, as well as sending an SNMPv3 trap to notify the SNMP management system of the failure:
U7246VXR# configure terminalU7246VXR(config)# cable metering destination 10.10.10.37 5215 10.10.10.41 5215 3 60 secureU7246VXR(config)#The following example shows how to enable usage-based billing for streaming mode, with the CMTS transmitting the billing records every 30 minutes to the server at the IP address of 10.10.10.37 and TCP port of 8181, using an unencrypted TCP connection. No secondary server is defined. The CMTS will retry the connection only once before giving up and sending an SNMPv3 trap to notify the SNMP management system of the failure:
Router# configure terminalRouter(config)# cable metering destination 10.10.10.37 8181 1 30 non-secureRouter(config)#The following example shows how to enable usage-based billing, using the same configuration as above, except that the billing records do not include the IP addresses for the CPE devices.
Router# configure terminalRouter(config)# cable metering destination 10.10.10.37 8181 1 30 non-secure cpe-list-suppressRouter(config)#Related Commands
cable metering filesystem
To enable usage-based billing and to write the records to a file on a local file system, use the cable metering filesystem command in global configuration mode. To disable usage-based billing, use the no form of this command.
cable metering filesystem filesys [cpe-list-suppress] [flow-aggregate]
no cable metering
Syntax Description
Defaults
Usage-based billing is disabled. When usage-based billing is enabled, CPE IP addresses (a maximum of five) are included in the billing records by default.
Command Modes
Global configuration
Command History
Usage Guidelines
The cable metering filesystem command enables usage-based filling and configures it for file mode, where the CMTS writes the billing records to the local file system. The system writes the billing record to the filesystem specified by this command, using a file name that consists of the router's hostname followed by a timestamp for when the file was created.
When the CMTS writes a billing record, it can also optionally send an SNMPv3 trap to notify the billing application that a billing record is available for pickup. The billing application can then log into the Cisco CMTS and use the File Transfer Protocol (FTP) or Secure Copy (SCP) to pick up the file.
Note
If the CMTS cannot write the billing record to the local filesystem, and if metering traps have been enabled using the snmp-server enable traps cable metering command, the CMTS sends an SNMP trap to the SNMP manager describing the reason for the failure. Typically, the reason is either that the disk is full or that an disk error occurred (such as no PCMCIA card in the slot).
To disable usage-based billing, use the no cable metering command. This immediately stops the collection of billing information, except when the billing records are currently being written to the local file system. If a billing operation is in progress when you give the no cable metering command, the system displays the message "CMTS Metering in progress. Ignoring current config." Wait until the billing operation is finished and then reenter the no cable metering command.
Examples
The following example shows how to enable usage-based billing, writing the records to a file on the disk0: device.
U7246VXR# configure terminalU7246VXR(config)# cable metering filesystem disk0:U7246VXR(config)#The following example shows how to enable usage-based billing, writing the records to files on the disk2 device on an NPE-G1 processor:
Router# configure terminalRouter(config)# cable metering filesystem disk2:Router(config)#The following example shows how to enable usage-based billing, writing the records to files in Flash Memory. The IP addresses for the CPE devices are not included in the billing records.
Router# configure terminalRouter(config)# cable metering filesystem flash: cpe-list-suppressRouter(config)#Related Commands
cable metering source-interface
To enables specification of the source-interface for the billing packets, use the cable metering source-interface command in privileged EXEC mode. To turn off the specified source-interface, use the no form of this command.
cable metering source-interface interface
no cable metering source-interface interface
Syntax Description
Defaults
Usage billing is disabled. When enabled, CPE IP addresses (a maximum of five per cable modem) are included in the billing records by default.
Command Modes
Global configuration
Command History
Usage Guidelines
The cable metering source-interface command enables the user to specify the source-interface of the usage based billing packets. All billing packets are usually automatically assigned a source-interface, but users using the cable metering source-interface command can set the source-interface to be the ip address of the loopback interface.
If the user does not specify the source-interface configuration, SAMIS will pick the highest IP address of the loopback interface as the source interface. If the loopback interface is not there, then SAMIS will select the highest IP of the physical interface for source interface.
Refer the DDTS for more info CSCek39658.
Note
Note
If the cable metering source-interface command is used when the Usage-Based Billing feature is operating in the File Mode, the CMTS IP address in the billing packets will be changed to the ip address of the source-interface as specified through cable metering source-interface command or through setting the ccmtrCollectionSrcIfIndex object. The mac address in the billing packets' header will also be changed to the mac address of the source-interface.
If the cable metering source-interface command is used when the Usage-Based Billing feature is operating in the Streaming Mode, the CMTS IP address in the billing packets, as well as the source IP address of the billing packets, will be changed to the ip address of the source-interface as specified through cable metering source-interface command or through setting the ccmtrCollectionSrcIfIndex object. The mac address in the billing packets' header will also be changed to the mac address of the source-interface.
When defining the source-interface, the following possible error checks can be performed to determine if the source-interface that the user has defined is a valid source-interface for metering:
1.
2.
Note
Examples
The following is an example where the source-interface specified was a loopback interface and it had a mac-address of 000C31F6F400 and an ip address of 1.100.100.100.
Router# configure terminalRouter(config)# cable metering source-interface loopback 1.100.100.100<?xmlversion="1.0"encoding="UTF8"?><IPDRDocxmlns="http://www.ipdr.org/namespaces/ipdr" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="DOCSIS-3.5-A.0.xsd" docId="C7B1B20E-0000-0000-0000-000C31F6F400" creationTime="2006-03-02T18:03:58Z" IPDRRecorderInfo="VXR3" version="3.5-A.0"><IPDR xsi:type="DOCSIS-Type"><IPDRcreationTime>2006-03-02T18:03:58Z</IPDRcreationTime><CMTShostn ame>VXR3</CMTShostname><CMTSipAddress>1.100.100.100</CMTSipAddress><CMTSsysUpTime>185867 </CMTSsysUpTime><CMTScatvIfName>Cable4/0</CMTScatvIfName><CMTScatvIfIndex>16</CMTScatvIfIn dex><CMTSupIfName>Ca4/0-upstream0</CMTSupIfName><CMTSupIfType>129</CMTSupIfType><CMTSdownI fName>Ca4/0-downstream</CMTSdownIfName><CMmacAddress>00-07-0E-07-0B-0D</CMmacAddress><CMip Address>11.11.0.2</CMipAddress><CMdocsisMode>1.0</CMdocsisMode><Rectype>1</Rectype><servic eIdentifier>0</serviceIdentifier><serviceClassName></serviceClassName><serviceDirection>1< /serviceDirection><serviceOctetsPassed>6225</serviceOctetsPassed><servicePktsPassed>21</se rvicePktsPassed><serviceSlaDropPkts>0</serviceSlaDropPkts><serviceSlaDelayPkts>1</serviceS laDelayPkts><serviceTimeCreated>0</serviceTimeCreated><serviceTimeActive>0</serviceTimeAct ive></IPDR><IPDR xsi:type="DOCSIS-Type"><IPDRcreationTime>2006-03-02T18:03:58Z</IPDRcreationTime><CMTShostn ame>VXR3</CMTShostname><CMTSipAddress>1.100.100.100</CMTSipAddress><CMTSsysUpTime>185867 </CMTSsysUpTime><CMTScatvIfName>Cable4/0</CMTScatvIfName><CMTScatvIfIndex>16</CMTScatvIfIn dex><CMTSupIfName>Ca4/0-upstream0</CMTSupIfName><CMTSupIfType>129</CMTSupIfType><CMTSdownI fName>Ca4/0-downstream</CMTSdownIfName><CMmacAddress>00-07-0E-07-0B-0D</CMmacAddress><CMip Address>11.11.0.2</CMipAddress><CMdocsisMode>1.0</CMdocsisMode><Rectype>1</Rectype><servic eIdentifier>0</serviceIdentifier><serviceClassName></serviceClassName><serviceDirection>2< /serviceDirection><serviceOctetsPassed>12300</serviceOctetsPassed><servicePktsPassed>29</s ervicePktsPassed><serviceSlaDropPkts>0</serviceSlaDropPkts><serviceSlaDelayPkts>13</servic eSlaDelayPkts><serviceTimeCreated>0</serviceTimeCreated><serviceTimeActive>0</serviceTimeA ctive></IPDR><IPDRDoc.End count="2" endTime="2006-03-02T18:03:59Z"/></IPDRDoc>Router(config)#The following is an example where the source-interface specified was a loopback interface and it had a mac-address of 00027D67DC0 and an ip address of 2.90.100.100.
Router# configure terminalRouter(config)# cable metering source-interface loopback 2.90.100.10Accept 2.90.100.100:42380<?xmlversion="1.0"encoding="UTF8"?><IPDRDocxmlns="http://www.ipdr.org/namespaces/ipdr" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="DOCSIS-3.5-A.0.xsd" docId="C7B701D1-0000-0000-0000-00027D67DC00" creationTime="2006-03-06T18:45:37Z" IPDRRecorderInfo="ubr7246-R7427" version="3.5-A.0"><IPDR xsi:type="DOCSIS-Type"><IPDRcreationTime>2006-03-06T18:45:37Z</IPDRcreationTime><CMTShostn ame>ubr7246-R7427</CMTShostname><CMTSipAddress>2.90.100.100</CMTSipAddress><CMTSsysUpTime> 372172 </CMTSsysUpTime><CMTScatvIfName>Cable3/0</CMTScatvIfName><CMTScatvIfIndex>5</CMTScatvIfInd ex><CMTSupIfName>Ca3/0-upstream0</CMTSupIfName><CMTSupIfType>129</CMTSupIfType><CMTSdownIf Name>Ca3/0-downstream</CMTSdownIfName><CMmacAddress>00-50-04-F9-EF-88</CMmacAddress><CMipA ddress>11.40.1.2</CMipAddress><CMdocsisMode>1.0</CMdocsisMode><Rectype>1</Rectype><service Identifier>3</serviceIdentifier><serviceClassName></serviceClassName><serviceDirection>2</ serviceDirection><serviceOctetsPassed>228392</serviceOctetsPassed><servicePktsPassed>2216< /servicePktsPassed><serviceSlaDropPkts>0</serviceSlaDropPkts><serviceSlaDelayPkts>0</servi ceSlaDelayPkts><serviceTimeCreated>6500</serviceTimeCreated><serviceTimeActive>3648</servi ceTimeActive></IPDR><IPDR xsi:type="DOCSIS-Type"><IPDRcreationTime>2006-03-06T18:45:37Z</IPDRcreationTime><CMTShostn ame>ubr7246-R7427</CMTShostname><CMTSipAddress>2.90.100.100</CMTSipAddress><CMTSsysUpTime> 372172 </CMTSsysUpTime><CMTScatvIfName>Cable3/0</CMTScatvIfName><CMTScatvIfIndex>5</CMTScatvIfInd ex><CMTSupIfName>Ca3/0-upstream0</CMTSupIfName><CMTSupIfType>129</CMTSupIfType><CMTSdownIf Name>Ca3/0-downstream</CMTSdownIfName><CMmacAddress>00-50-04-F9-EF-88</CMmacAddress><CMipA ddress>11.40.1.2</CMipAddress><CMdocsisMode>1.0</CMdocsisMode><Rectype>1</Rectype><service Identifier>4</serviceIdentifier><serviceClassName></serviceClassName><serviceDirection>1</ serviceDirection><serviceOctetsPassed>200134</serviceOctetsPassed><servicePktsPassed>2197< /servicePktsPassed><serviceSlaDropPkts>0</serviceSlaDropPkts><serviceSlaDelayPkts>0</servi ceSlaDelayPkts><serviceTimeCreated>6500</serviceTimeCreated><serviceTimeActive>3648</servi ceTimeActive></IPDR><IPDRDoc.End count="2" endTime="2006-03-06T18:45:37Z"/></IPDRDoc>Closing socket 2.90.100.100:42380Router(config)#Related Commands
debug cable metering
To enable debugging of usage-based billing operations, use the debug cable metering command in privileged EXEC mode. To turn off debugging messages, use the no form of this command.
debug cable metering
no debug cable metering
Syntax Description
This command has no arguments or keywords.
Command Modes
Privileged EXEC
Command History
Examples
The following example shows how to enable debugging for usage-based billing on the Cisco CMTS, and then shows examples of the debugging messages that can be displayed.
Router# debug cable meteringCMTS metering debug is ONRouter#Cannot get Metering CMTS IP/MAC Addresses.CMTS Billing ip address interface name c6/0CMTS SFLOG File BBCMTS_20000708-120931 open failed (23)CMTS Metering open file CMTS0120000708-120931 successfully.CMTS Metering LOCAL data to write 5600, wrote 4800 to file local fileCMTS Metering data to write 6400, wrote 6400 to file B_20000708-120931CMTS Metering invalid FD for metering fileCMTS Metering Produce Metering - END Time= 2002-05-25T14:41:29ZCMTS Metering closed fileCMTS Metering: xml end queue data malloc failed.CMTS Metering file header len=480CMTS Metering: xml header enqueue failed.CMTS Metering: xml header enqueue OK.CMTS Metering: xml end queue data malloc failed.CMTS Metering xml_ending len 128CMTS Metering: xml end enqueue OK.CMTS Metering element header length 440CMTS Metering sflog read buf = 4800CMTS Metering: malloc failed.CMTS Metering: SFLOG file 4800 size tx failed.CMTS Metering: SFLOG tx OK 4800 size.Cmts Metering: SFLOG file doesn't existCMTS Metering abort producing billing due to file open failure.CMTS Metering: enqueue failedCMTS Metering get invalid CM.CMTS Metering valid cm 192.168.100.101, prim sid 13CMTS Metering interval 30Invalid Metering Timer Expired...Stop Timer.Related Commands
show cable metering-status
To display information about the most recent successful usage-based billing operation, use the show cable metering-status command in privileged EXEC mode.
show cable metering-status [verbose]
Syntax Description
Command Modes
Privileged EXEC
Command History
Usage Guidelines
The show cable metering-status command displays information about the most recent successful usage-based billing operation. If usage-based billing is configured for File mode, this command displays the device and file name for the record that was last written. If usage-based billing is configured for Streaming mode, this command displays the IP address and port number for the external server to which the billing record was sent.
Note
Tip
Tip
Examples
The following example shows a typical output for the show cable metering-status command when usage-based billing is configured to write the billing records to a local file system:
Router# show cable metering-statusdestination complete-time flow cpe statusaggr suppdisk0:R7519-UBR7246-200308-004428 Jun 12 09:33:05 No No successThe following example shows a typical output for the show cable metering-status command when usage-based billing is configured to stream the billing records to an external server:
Router# show cable metering-statusdestination complete-time flow cpe statusaggr supp10.11.37.2 :1234 Jun 12 09:33:05 No No successThe following example shows a typical output for the verbose form of the show cable metering-status command:
Router# show cable metering-status verboseDestination : disk0:R7519-UBR7246-20000308-004428Complete Time : Jun 12 09:33:05Flow Aggregate : YesCpe list suppression : YesStatus of last export : successThe following example shows a typical output for the show cable metering-status command when usage-based billing is configured to use the IPDR Exporter to stream the billing records to an external server:
Router# show cable metering-statusdestination complete-time flow cpe statusaggr suppIPDR_Session1 Jun 12 09:33:05 N/A N/A successThe following example shows a typical output for for the verbose form of the show cable metering-status command when usage-based billing is configured to use the IPDR Exporter to stream the billing records to an external server:
Router# show cable metering-status verboseLast export statusDestination : IPDR_Session1Complete Time : Jun 12 09:36:05Status of last export : successThe following example shows the error message that is displayed when you enter the show cable metering-status command but not have enabled usage-based billing:
Router# show cable metering-statusCMTS Metering collection not enabledTable 6 describes the fields displayed by the show cable metering-status command.
Related Commands
snmp-server enable traps cable
To enable the sending of Simple Network Management Protocol (SNMP) traps for cable-related events, use the snmp-server enable traps cable command in global configuration mode. To disable the sending of traps, use the no form of this command.
snmp-server enable traps cable [cm-chover] [cm-onoff] [cm-remote-query] [cmts-event] [enforce-rule] [hccp-failover] [hopping] [metering]
no snmp-server enable traps cable [cm-chover] [cm-onoff] [cm-remote-query] [cmts-event] [enforce-rule] [hccp-failover] [hopping] [metering]
Syntax Description
cm-chover
Enables traps that are sent upon completion of CMTS channel override operations, as defined in CISCO-DOCS-EXT-MIB.
cm-onoff
Enables traps for CM online/offline status changes, as defined in CISCO-DOCS-EXT-MIB.
cm-remote-query
Enables traps that are sent when the remote polling of CMs has been completed, as defined in CISCO-DOCS-REMOTE-QUERY-MIB.
cmts-event
Enables traps for CMTS events, as defined in DOCS-CABLE-DEVICE-MIB and DOCS-CABLE-DEVICE-TRAP-MIB.
enforce-rule
Enables traps that are sent when a user violates their quality of service (QoS) profile, as defined in the CISCO-CABLE-QOS-MONITOR-MIB.
hccp-failover
Enables traps for Hot Standby Connection-to-Connection Protocol (HCCP) redundancy switchover events, as defined in CISCO-CABLE-AVAILABILITY-MIB.
hopping
Enables traps for spectrum hopping events, as defined in CISCO-CABLE-SPECTRUM-MIB.
metering
Enables traps for usage-based billing, as configured with the cable metering commands and defined in CISCO-CABLE-METERING-MIB.
Defaults
No SNMP traps for cable-related events are enabled. You can specify one type of trap or any combination of traps. When the snmp-server enable traps cable command is given without any options, all cable-related traps are enabled.
Command Modes
Global configuration
Command History
12.0(5)T
This command, with the cm-chover and cm-onoff options, was added.
12.0(7)XR2, 12.1(1)T
The cm-remote-query option, along with the CISCO-DOCS-REMOTE-QUERY-MIB MIB, was introduced.
12.1(2)EC1
This command was supported on the 12.1 EC train.
12.1(7)CX1
The hopping and cmts-event options were introduced.
12.2(4)BC1
This command was supported on the Cisco uBR10012 universal broadband router.
12.2(8)BC1
The hccp-failover option was supported on the Cisco uBR10012 router.
12.2(11)BC1
The hccp-failover option was supported on the Cisco uBR7200 series router.
12.2(15)BC1
The enforce-rule option was added to generate traps for subscribers who violate their enforce-rule QoS profile.
12.3(9a)BC
The metering option was added to support usage-based billing, as configured with the cable metering commands, on the Cisco CMTS router.
Usage Guidelines
For other SNMP commands that affect the operation of the CMTS, see the Cisco IOS Configuration Fundamentals Command Reference Guide.
Examples
The following example shows how to enable all traps for cable-related events except HCCP switchovers on the CMTS:
Router# configure terminalRouter(config)# snmp-server enable traps cable cm-chover cm-onoff cm-remote-query cmts-event hoppingRouter(config)#The following example shows how to enable traps for any HCCP switchovers that occur on the CMTS:
Router# configure terminalRouter(config)# snmp-server enable traps cable hccp-failoverRouter(config)#The following example shows how to enable traps for when a user violates the maximum bandwidth for the quality of service (QoS) profile specified by their enforce-rule.
Router# configure terminalRouter(config)# snmp-server enable traps cable enforce-ruleRouter(config)#Related Commands
show ipdr exporter
To display information about the state of the IPDR Exporter, use the show ipdr exporter command in the privileged EXEC mode.
show ipdr exporter
Syntax Description
This command has no keywords or arguments.
Command Default
No default behavior or values.
Command Modes
Privileged EXEC mode
Command History
Usage Guidelines
The show ipdr exporter command displays information about the IPDR Exporter state. The information displayed indicates the Exporter states that are listed below.
•
•
•
Examples
The following example shows the sample output for the show ipdr exporter command.
Router#configure terminalRouter#show ipdr exporterIPDR exporter is started.Related Commands
ipdr exporter start
To enable the CMTS application, to start the Internet Protocol Detail Record (IPDR) Exporter process to connect the exporter and the collector, use the ipdr exporter start command in global configuration mode. To terminate the connection between the exporter and collector, use the no form of this command.
ipdr exporter start
no ipdr exporter start
Syntax Description
This command has no arguments or keywords.
Command Default
By default, the IPDR exporter process will not be started.
Command Modes
Global configuration mode
Command History
Usage Guidelines
This command allows the user to explicitly start the IPDR Exporter and connect to the collector. As a default behavior, the command will initiate all the sessions configured in the Exporter to a "Start" state.
The no form of the command will stop the IPDR Exporter process. The command will also clear the connection with the collector while retaining other configurations.
Examples
The following example starts the IPDR Exporter process on the CMTS.
Router# configure terminalRouter(config)#ipdr exporter startRelated Commands
ipdr session
To start or stop a specific session, use the ipdr session command in the privileged EXEC mode.
ipdr session session_id {start | stop}
Syntax Description
session_id
The unique IPDR session ID.
start
The keyword to start the session.
stop
The keyword to stop the session.
Command Default
No sessions are started.
Command Modes
Privileged EXEC mode
Command History
Usage Guidelines
This command allows the user to start or stop a specific session. This command can be executed only when the IPDR exporter is started.
Note
Examples
The following example enables the user to start a session.
Router# configure terminalRouter(config)#ipdr session 1 startRelated Commands
ipdr session (global configuration)
To enable the CMTS application to add a session to the Internet Protocol Detail Record (IPDR) exporter, use the ipdr session command in global configuration mode. To remove the session, use the no form of this command.
ipdr session session_id session_name session_descr
no ipdr session session_id
Syntax Description
session_id
The unique IPDR session ID.
session_name
The session name. The name should not contain extra spaces.
session_descr
The description of the session.
Command Default
No sessions are added to the IPDR exporter. It depends on the status of the IPDR exporter. After configuring one session;if the status of exporter is started, then the session is started automatically.
Command Modes
Global configuration mode
Command History
Usage Guidelines
This command allows the user to add a session to the IPDR exporter. User should provide session ID, session name and session description for every session.
The no form of the command will remove a specific session. Once a session is removed, the template and other information associated with the session is also lost.
Note
Examples
The following example adds a session to the Exporter.
Router# configure terminalRouter(config)#ipdr session 1 test no_descrRelated Commands
ipdr collector
To configure the Internet Protocol Detail Record (IPDR) Collector details, use the ipdr collector command in global configuration mode. To remove the Collector, use the no form of this command.
ipdr collector collector_name ip_addr [port]
no ipdr collector collector_name
Syntax Description
Command Default
A Collector will not be configured.
Command Modes
Global configuration mode
Command History
Usage Guidelines
This command allows the user to configure an IPDR Collector and authenticate the IPDR protocol. Once the Collector is configured, the Exporter sends data to the Collector. User must provide the collector name and the IP address. Port number is used when an exporter creates an active connection.
The no form of the command will remove a specific IPDR Collector. If the collector is associated with an active session, you should stop the session before using the no command.
Examples
The following example configures a Collector.
Router# configure terminalRouter(config)#ipdr collector federal 192.0.2.0
ipdr associate
To associate the Collector with a session, use the ipdr associate command in global configuration mode. To remove the association, use the no form of this command.
ipdr associate session_id collector_name priority
no ipdr associate session_id collector_name
Syntax Description
Command Default
An association with the session will not be created.
Command Modes
Global configuration mode
Command History
Usage Guidelines
This command allows the user to associate the Collector with a session. Once the Collector is configured, the Exporter sends data to the Collector. IPDR supports redundant collector and consistent streaming continues when a collector is down or not functioning.
The no form of the command will only remove the association for the stopped session.
Note
Examples
The following example configures a Collector.
Router# configure terminalRouter(config)#ipdr associate 1 federal 1Related Commands
ipdr template
To add an Internet Protocol Detail Record (IPDR) template to the IPDR Session, use the ipdr template command in global configuration mode. To remove the template, use the no form of this command.
ipdr template session_id template_name
no ipdr template session_id template_name
Syntax Description
Command Default
Template is not added to the session.
Command Modes
Global configuration mode
Command History
Usage Guidelines
This command allows the user to add an IPDR template to the desired session (based on session ID.)
The no form of the command will remove a specific template from the session.
Note
Examples
The following example adds a template to the session.
Router# configure terminalRouter(config)#ipdr template 1 SAMISRelated Commands
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)
Copyright 2003-2009 Cisco Systems, Inc. All Rights Reserved.
