-
Cisco Content Services Gateway - 2nd Generation Release 2.0 Installation and Configuration Guide, for Cisco IOS Release 12.4(15)MD
-
About This Book
-
Overview
-
Configuring the CSG2
-
Configuring BMA Support
-
Configuring Quota Server Support
-
Configuring Service Support
-
Configuring IPC Support
-
Configuring PSD Support
-
Configuring iSCSI Support
-
Configuring RADIUS Support
-
Configuring Prepaid Support
-
CSG2 Command Reference
-
CSG2 Command History—CSG1 R7 to CSG2 R1
-
CSG2 Command History—CSG2 R1 to CSG2 R2
-
Protocol Compliance Statements for the CSG2
-
CSG2 R2 System Messages
-
Monitoring Notifications
-
Table Of Contents
clear record-storage-module stats
ip csg entries session user max
ip csg quota-server local-port
ip csg quota-server retransmit
ip csg radius reauthorization attribute
ip csg radius start restart session-id
ip csg report radius attribute
meter exclude network-init sip
subscriber-ip http-header forwarded-for
CSG2 Command Reference
This appendix documents the commands necessary to configure and monitor the CSG2. Other commands used with the CSG2 are documented in the following publications:
•
Service and Application Module for IP User Guide for the following commands:
–
–
–
–
–
–
•
•
All of the CSG2 commands are listed below in alphabetical order:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
accounting
To specify accounting and an optional customer string for a CSG2 policy, use the accounting command in CSG2 policy configuration mode. To remove accounting for a policy, use the no form of this command.
accounting [customer-string string]
no accounting [customer-string string]
Syntax Description
customer-string string
(Optional) 1- to 16-byte string to be output to the generated accounting records.
Defaults
The default is no accounting.
Command Modes
CSG2 policy configuration
Command History
12.4(11)MD
This command was migrated from CSG1.
Changes from CSG1: All keywords and arguments except customer-string string were removed.
12.4(15)MD
Support for FTP was added.
Usage Guidelines
This command is required if the CSG2 is to generate call detail records (CDRs) for content that matches the CSG2 policy.
This command is required to enable billing functions (such as CDR generation and prepaid charging) for content that matches a CSG2 policy.
For FTP and Real Time Streaming Protocol (RTSP) accounting, the CSG2 matches prepaid services on the basis of the IP address and port number of the control connection to the FTP or RTSP network IP address.
Examples
The following example shows how to specify accounting and customer strings for a CSG2 policy:
ip csg policy MOVIESaccounting customer-string MOVIESRelated Commands
Defines a policy for qualifying flows for the CSG2 billing services, and enters CSG2 policy configuration mode.
activation
To specify the activation mode for a CSG2 Connection Duration service, use the activation command in CSG2 service configuration mode. To restore the default setting, use the no form of this command.
activation [automatic | user-profile]
no activation
Syntax Description
Defaults
The Connection Duration service is activated only if the billing profile specifies this service as the connect service.
Command Modes
CSG2 service configuration
Command History
Usage Guidelines
This command requires that the service be configured with basis second connect.
Examples
The following example specifies automatic activation for Connection Duration service CONNECT.
ip csg service CONNECTbasis second connectactivation automaticRelated Commands
Configures a CSG2 content billing service, and enters CSG2 service configuration mode.
aoc append url
To specify that the CSG2 is to append the original URL to the redirect URL sent by the quota server on a Content Authorization REDIRECT_URL response for use in Advice of Charge (AoC) URL-rewriting, use the aoc append url command in CSG2 service configuration mode. To restore the default setting, use the no form of this command.
aoc append url
no aoc append url
Syntax Description
This command has no arguments or keywords.
Defaults
The CSG2 does not append the original URL to the redirect URL.
Command Modes
CSG2 service configuration
Command History
Usage Guidelines
Before configuring this command, you must enable AoC by configuring the aoc enable command.
The CSG2 performs this function only for content parsed as connectionless or connection-oriented wireless application protocol (WAP 1.x). For other protocols, the CSG2 ignores this configuration option.
Examples
The following example specifies that the CSG2 is to append the original URL to the redirect URL for use in AoC URL-rewriting:
ip csg service MOVIESaoc enableaoc append urlRelated Commands
aoc confirm
To configure a token for use in Advice of Charge (AoC) URL-rewriting, use the aoc confirm command in CSG2 service configuration mode. To remove the token, use the no form of this command.
aoc confirm token
no aoc confirm
Syntax Description
Defaults
None
Command Modes
CSG2 service configuration
Command History
Usage Guidelines
Before configuring this command, you must enable AoC by configuring the aoc enable command.
URL-rewriting allows a top-off server to append parameters to a URL in order to convey state information to the quota server during a Content Authorization Request. Whenever a Content Authorization Response contains the forward action code, and the URL contains the AoC confirmation token, the token and all trailing characters are removed from the URL before the request is forwarded to the server.
The token is used for HTTP and WAP 1.x content authorization URL-rewriting.
If the token uses the URL-escape format, the redirect URL to which the token is being matched must also use the URL-escape format.
Examples
The following example specifies a token for Advice of Charge (AoC) URL-rewriting:
ip csg service MOVIESaoc enableaoc confirm ?CSG_AOC_OKRelated Commands
aoc enable
To enable Advice of Charge (AoC) URL-rewriting for the CSG2, use the aoc enable command in CSG2 service configuration mode. To restore the default setting, use the no form of this command.
aoc enable
no aoc enable
Syntax Description
This command has no arguments or keywords.
Defaults
The CSG2 does not append the original URL to the redirect URL.
Command Modes
CSG2 service configuration
Command History
12.4(11)MD
This command was migrated from CSG1.
Changes from CSG1: The name of this command changed from authorize content to aoc enable.
Usage Guidelines
This command is not valid if the service is configured with basis second connect.
If this command is configured, the CSG2 alerts the quota server of a new transaction, and allows it to direct the CSG2 to perform any of the following mutually exclusive actions:
•
•
•
Examples
The following example enables AoC URL-rewriting for the CSG2:
ip csg service MOVIESaoc enableRelated Commands
basis
To specify the billing basis for a CSG2 content billing service, use the basis command in CSG2 service configuration mode. To use the default billing basis, use the no form of this command.
basis [byte {ip | tcp} | {fixed | second [connect | transaction]}]
no basis [byte {ip | tcp} | {fixed | second [connect | transaction]}]
Syntax Description
Defaults
The default setting is byte ip (billing charge is a function of the IP data volume processed).
Command Modes
CSG2 service configuration
Command History
12.4(11)MD
This command was migrated from CSG1.
Changes from CSG1: The exclude mms keyword was removed.
12.4(15)MD
The transaction keyword was added.
Usage Guidelines
For TCP billing, configuring basis byte tcp allows counting of only TCP payload and exclusion of overhead for network retransmission. With this option, the CSG2 excludes IP and TCP headers from volume counts. The byte counting is limited to TCP payload. Retransmitted packets are not counted.
Services that are configured with the basis second connect command (that is, for Connection Duration Billing) are subject to the following restrictions:
•
•
For Service Duration Billing:
•
•
•
Note
To enable Connection Duration Billing for a service, configure the service name as a service under one or more billing plans in CSG2 billing configuration mode, then enter the basis second connect command in CSG2 service configuration mode.
Because Internet Message Access Protocol (IMAP) metering is byte-based, you cannot configure both meter include imap and basis fixed or basis second in the same service. Only basis byte is meaningful with meter include imap.
You cannot configure both meter exclude svc-idle and basis byte or basis fixed in the same service. Only basis second is meaningful with meter exclude svc-idle.
Examples
The following example shows how to specify fixed billing for the CSG2 service MOVIES:
ip csg service MOVIESbasis fixedThe following commands are used to configure Service Duration Billing for the OFF_NET service.
ip csg service OFF_NETbasis secondRelated Commands
block
To force the CSG2 to drop packets that do not match a configured billing policy, use the block command in CSG2 content configuration mode. To restore the default behavior, enabling the CSG2 to forward the packets without billing, use the no form of this command.
block
no block
Syntax Description
This command has no arguments or keywords.
Defaults
None
Command Modes
CSG2 content configuration
Command History
Usage Guidelines
By default, if packets do not match any billing policy, the CSG2 forwards the packets without billing. This command causes the CSG2 to drop the packets instead.
Examples
The following example shows how to force the CSG2 to drop packets that do not match any billing policy:
ip csg content MOVIESblockRelated Commands
class
To specify a service class value, use the class command in CSG2 service configuration mode. To remove the service class value, use the no form of this command.
class value
no class value
Syntax Description
Defaults
None
Command Modes
CSG2 service configuration
Command History
Usage Guidelines
The class command is used with fixed-record format to identify a service class value. This value is opaque to the CSG2 and has meaning only for the administrator. It is reported as tariff-class in fixed-record format call detail records (CDRs).
Examples
The following example specifies a class value for the service:
ip csg service FOOclass 7Related Commands
clear ip csg
To clear the CSG2, use the clear ip csg command in privileged EXEC mode.
clear ip csg {counters | sessions user [application] [ip-address ip-mask] | user [all | ip ip-address {global | vrf vrf-name}]}
Syntax Description
Defaults
None
Command Modes
Privileged EXEC
Command History
Usage Guidelines
By default, the CSG2 deletes 1000 User Table entries per second in response to the clear ip csg user all command. To specify a different deletion rate, use the ip csg radius on-off purge command in global configuration mode.
Examples
The following example clears all counters and statistics for the CSG2:
clear ip csg countersThe following example clears all subscriber entries from the CSG2 User Table that are associated with IP address 1.2.3.4:
clear ip csg user ip 1.2.3.4The following example clears all subscriber entries from the CSG2 User Table that are associated with IP address 1.2.3.4 and that are also associated with VRF table AAA:
clear ip csg user ip 1.2.3.4 vrf AAAThe following example clears all sessions for application http and IP address mask 1.2.3.4/32:
clear ip csg sessions user http 1.2.3.4/32Related Commands
clear ip iscsi statistics
To clear current iSCSI statistics, use the clear ip iscsi statistics command in privileged EXEC configuration mode.
clear ip iscsi statistics
Syntax Description
This command has no arguments or keywords.
Command Default
No default behavior or values.
Command Modes
Privileged EXEC
Command History
Examples
The following example clears iSCSI-related statistics:
clear ip iscsi statisticsRelated Commands
clear record-storage-module stats
To clear current record storage module (RSM) statistics, use the clear record-storage-module stats command in privileged EXEC configuration mode.
clear record-storage-module stats
Syntax Description
This command has no arguments or keywords.
Command Default
No default behavior or values.
Command Modes
Privileged EXEC
Command History
Examples
The following example clears RSM-related statistics:
clear record-storage-module statsRelated Commands
client-group (CSG2 content)
To reference a standard access list that is part of a CSG2 content, use the client-group command in CSG2 content configuration mode. To delete the reference, use the no form of this command.
client-group {std-access-list-number | std-access-list-name}
no client-group {std-access-list-number | std-access-list-name}
Syntax Description
std-access-list-number
Standard IP access list number. The ranges are from 1 to 99 and from 1300 to 1999.
std-access-list-name
Standard access list name.
Defaults
All subscribers can access the content.
Command Modes
CSG2 content configuration
Command History
Usage Guidelines
The client-group command is used to qualify subscribers for the CSG2 content. The conditions specified in the referenced access list must be true in order for the flows to be processed by the CSG2 content. If the conditions are not true, the CSG2 determines this to be a content mismatch, and normal content match processing continues (that is, the CSG2 tries to match a less specific content). If no contents are matched, the CSG2 does not process the flow (that is, the CSG2 blocks this traffic flow).
If you reference an access list that includes a deny statement, and that deny statement is matched, then the CSG2 treats the traffic as a content mismatch and normal content processing continues, allowing the traffic to match another less specific content. For example, in the following configuration, packets from from IP address 1.1.1.1 do not match CONTENT1, but they do match CONTENT2:
ip csg content CONTENT1ip anyclient-group 99inservice!ip csg content CONTENT2ip anyinservice!access-list 99 deny 1.1.1.1access-list 99 permit anyYou can use next-hop with client groups as long as a given client group is always sent to the same next hop. You cannot send a given client group to two or more different next hops based on a content.
The CSG2 searches contents with the same IP and VLAN configuration, but different client groups, in numerical order. For example, given two contents with the same IP/VLAN configuration, one referencing client group 4 and the other client group 7, the CSG2 matches the content that references client group 4.
Examples
The following example shows how to reference client group 44 for the CSG2 content MOVIES:
ip csg content MOVIESclient-group 44Related Commands
Configures content for CSG2 services, and enters CSG2 content configuration mode.
Defines a next-hop IP address.
content (CSG2 service)
To configure a content and policy as a member of a CSG2 billing service, and optionally to assign a weight to this content, use the content command in CSG2 service configuration mode. To remove a content name from the billing service, use the no form of this command.
content content-name policy policy-name [weight weight-value]
no content content-name policy policy-name
Syntax Description
Defaults
The default weight-value is 1 quadran.
Command Modes
CSG2 service configuration
Command History
12.4(11)MD
This command was migrated from CSG1.
Changes from CSG1: The weight-name argument was replaced with the weight-value argument.
Usage Guidelines
You must configure a policy before configuring this command.
Content can reference more than one policy. Therefore, you can have multiple content commands with the same content-name argument, but different policy-name arguments.
To make a specific content free, specify a weight-value of 0.
Examples
The following example shows how to configure content for the CSG2 service MOVIES. In this example:
•
•
•
ip csg service MOVIEScontent MOVIES_COMEDY policy MOVIES_COMEDYcontent MOVIES_ACTION policy MOVIES_ACTION weight 2Related Commands
debug ip csg
To set the flags to obtain debugging output for the various CSG2 components, use the debug ip csg command in privileged EXEC mode. To disable the debugging feature, use the no form of this command.
debug ip csg {all | acl number [vrf vrf-name | global] | configuration sync | content | crashinfo | error | frag | ftp | gtp {any | bma [priority] | ipc | psd | quota-server [priority]} | http [detail] | imap | interm | ipc [detail] | iscsi [detail] | other | packet [dump] | policy | pop3 | psd [detail] | qs [detail] | radius [detail] | replicate | rtsp [detail] | service [detail | ha] | session {event | state [detail]} | sip | smtp | stats | tlv | udb [xml] | users | wap [detail] | xml}
no debug ip csg {all | acl number [vrf vrf-name | global] | configuration sync | content | crashinfo | error | frag | ftp | gtp {any | bma [priority] | ipc | psd | quota-server [priority]} | http [detail] | imap | interm | ipc [detail] | iscsi [detail] | other | packet [dump] | policy | pop3 | psd [detail] | qs [detail] | radius [detail] | replicate | rtsp [detail] | service [detail | ha] | session {event | state [detail]} | sip | smtp | stats | tlv | udb [xml] | users | wap [detail] | xml}
Syntax Description
Defaults
The CSG2 generates no debugging output.
Command Modes
Privileged EXEC
Command History
Usage Guidelines
To see most but not all debugging output, use the all option to turn on all debugging flags, and then use the no form of this command to exclude debugging output for any options that are not of interest to you.
Restrict the output of other CSG2 debugging commands to subscribers specified in the ACL.
Once the debug flags are set, they are automatically sent to the CSG2 cards when a configuration is downloaded. Similarly, changes in the debug settings are sent to the CSG2 cards that are being debugged.
Generating debugging output for ACL (that is, configuring the acl keyword) disables all of the following types of debugging:
•
•
•
•
•
•
•
•
•
•
You can use the show debug command to display the debug flag settings.
Note
Examples
The following example shows how to turn on debugging for rtsp and udb:
debug ip csg rtspdebug ip csg udbentries user idle
To set the time after which entries for idle subscribers are deleted from the CSG2 User Table, use the entries user idle command in CSG2 billing configuration mode. To use the default settings, use the no form of this command.
entries user idle duration [pod]
no entries user idle
Syntax Description
Defaults
The default idle duration is 0 seconds, and the CSG2 does not send the RADIUS Packet of Disconnect message when an entry idles out.
Command Modes
CSG2 billing configuration
Command History
12.4(11)MD
This command was migrated from CSG1.
Changes from CSG1: The name of this command changed from entries idle (CSG2 billing) to entries user idle.
Usage Guidelines
The CSG2 User Table identifies all subscribers known to the CSG2. The table is populated on the basis of the contents of RADIUS Accounting Start messages, or from the user database, if either feature is enabled in your configuration.
When setting the entry idle timer, keep the following considerations in mind:
•
•
•
•
•
Examples
The following example shows how to specify an entry idle time of 1 hour for CSG2 billing plan REGULAR:
ip csg billing REGULARentries user idle 3600Related Commands
flags
To specify IP, TCP, or wireless application protocol (WAP) flag bit masks and values for CSG2 Prepaid Error Reimbursement, use the flags command in CSG2 refund configuration mode. To remove the flags, use the no form of this command.
flags {ip mask | tcp mask | wap} value
no flags {ip mask | tcp mask | wap} value
Syntax Description
Defaults
None
Command Modes
CSG2 refund configuration
Command History
Usage Guidelines
The CSG2 supports flag-based refunding for all protocols.
The ip flag values are:
•
–
–
•
–
–
•
The tcp flag values are:
•
–
–
•
–
–
•
–
–
•
–
–
•
–
–
•
–
–
•
–
–
•
–
–
The wap flag values are:
•
•
•
•
Examples
The following example shows how to set flags for IP, TCP, and WAP:
ip csg refund COMPANY-REFUNDflags tcp 43 00flags ip 80 80flags wap 04Related Commands
idle (CSG2 content)
To specify the minimum amount of time that the CSG2 maintains an idle content connection, use the idle command in CSG2 content configuration mode. To restore the default idle duration value, use the no form of this command.
idle duration
no idle duration
Syntax Description
Defaults
The default idle duration is 300 seconds (5 minutes).
Command Modes
CSG2 content configuration
Command History
12.4(11)MD
This command was migrated from CSG1.
Changes from CSG1: The default setting for the duration argument changed from 3600 seconds to 300 seconds.
Usage Guidelines
Real Time Streaming Protocol (RTSP) billing in the CSG2 is based on inspection of the RTSP SETUP and TEARDOWN messages that are exchanged between the subscriber and network. The CSG2 builds the RTSP call detail record (CDR) immediately after the RTSP TEARDOWN signal if the URL exactly matches that from the RTSP SETUP signal. Otherwise, the CSG2 builds the CDR after any condition that causes the flows to be terminated, as when a service_stop is triggered (for example, when the access network sends a RADIUS Accounting Stop for the subscriber).
For RTSP, do not set the idle timer duration to less than 60 seconds.
When using HTTP as the transport for RTSP, the control connection is used sparingly and might time out, causing the stream to become unresponsive. This occurs because the subscriber opens two TCP connections, one for the main content and one for control. The subscriber uses the control connection sparingly, which can cause the connection to time out. To prevent this problem, ensure that the content idle timer has a duration of at least 60 seconds (the default setting is 300 seconds). This is not an issue when using UDP or TCP as the transport.
The CSG2 tracks usage on a per-session basis. User Datagram Protocol (UDP) does not have an end-of-session indicator and simply idles out. For that reason, for UDP and wireless application protocol 1.x (WAP 1.x), setting the content idle timer to a low value (for example, 30) allows the CSG2 to quickly recognize that a session has ended and to generate billing records accordingly. Other service-level features of the CSG2 that count sessions (such as passthrough mode and service-level CDRs) are similarly affected by the content idle timer setting.
For TCP, the CSG2 does not send a reset (RST) until a packet is received.
For a service configured with basis second, make sure the idle timeout value for the content configuration, set using the idle command in CSG2 content configuration mode, does not exceed the service idle timeout value, set using the idle command in CSG2 service configuration mode. Examples of these contents include:
•
•
Examples
The following example shows how to configure a 120-second idle timer for the CSG2 content MOVIES_COMEDY:
ip csg content MOVIES_COMEDYidle 120Related Commands
idle (CSG2 service)
To specify the minimum amount of time that the CSG2 maintains a service with no subscriber sessions, use the idle command in CSG2 service configuration mode. To restore the default idle duration value, use the no form of this command.
idle duration
no idle duration
Syntax Description
Defaults
The default idle duration is 300 seconds (5 minutes).
Command Modes
CSG2 service configuration
Command History
Usage Guidelines
For services configured with basis second, make sure the idle timeout value for the content configurations, set using the idle command in CSG2 content configuration mode, does not exceed the service idle timeout value, set using the idle command in CSG2 service configuration mode. Examples of these contents include:
•
•
If a subscriber's quota for a service is unused for more than the service idle timer duration, the CSG2 assumes that the service is idle and sends a ServiceStop to free up quota.
For RTSP, do not set the idle timer duration to less than 60 seconds.
Examples
The following example shows how to configure a 120-second idle timer for the CSG2 service MOVIES:
ip csg service MOVIESidle 120Related Commands
inservice (CSG2 content)
To activate the content service on each CSG2, use the inservice command in CSG2 content configuration mode. To suspend the content service, use the no form of this command.
inservice
no inservice
Syntax Description
This command has no arguments or keywords.
Defaults
The default value is no inservice.
Command Modes
CSG2 content configuration
Command History
Usage Guidelines
When you activate the inservice command, the CSG2 verifies the parameters semantically. If the CSG2 detects an error, the command fails.
Examples
The following example shows how to place the CSG2 content MOVIES_COMEDY in service:
ip csg content MOVIES_COMEDYinserviceRelated Commands
Configures content for CSG2 services, and enters CSG2 content configuration mode.
ip (CSG2 content)
To define the subset of Layer 3 and Layer 4 flows that can be processed by the CSG2 accounting services, use the ip command in CSG2 content configuration mode. To delete the flow definition, use the no form of this command.
ip {any | ip-address [netmask]} [any | protocol [port-number [last-port-number]]]
no ip {any | ip-address}
Syntax Description
Defaults
If you specify an IP address but no network mask, the default network mask is 255.255.255.255 or /32 (flows to a specific host can be processed).
If you do not specify a protocol, flows of any protocol type can be processed.
If you specify a protocol but no port number, the default port number is 0, which means that flows from any port number can be processed.
The CSG2 parses port numbers only when processing TCP and UDP traffic. For all other protocols, the CSG2 does not track the layer 4 port.
Command Modes
CSG2 content configuration
Command History
Usage Guidelines
This command is required to place content in service.
UDP ports 9200 and 9201 are well-known Wireless Session Protocol (WSP) and Wireless Transaction Protocol (WTP) wireless application protocol (WAP) ports. When a policy with parse protocol wap is associated with a content, use even-numbered UDP ports to designate WSP traffic, and use odd-numbered ports to designate WTP traffic.
Although you can use this command to specify a port number for Layer 3 content (ip any any port-number), the CSG2 does not support Layer 3 content rules. The CSG2 ignores the specified port number, and the show ip csg content command displays the port number as 0.
Examples
The following example shows how to specify that, for content MOVIES_COMEDY, only flows for IP address 172.18.45.0/24 and TCP port 8080 are to be processed by the CSG2 accounting services:
ip csg content MOVIES_COMEDYip 172.18.45.0/24 tcp 8080Related Commands
Configures content for CSG2 services, and enters CSG2 content configuration mode.
ip (iSCSI)
To specify the IP address of an iSCSI target in the target interface profile on the CSG2, use the ip command in iSCSI configuration mode. To remove the IP address configuration, use the no form of the command.
ip ip-address
no ip ip-address
Syntax Description
Command Default
No default behavior or values.
Command Modes
iSCSI configuration
Command History
Usage Guidelines
Only one target can be defined per profile.
Examples
The following example configures an iSCSI target interface profile with the name targetA to a SCSI target with the IP address 10.0.0.1.
gprs iscsi targetAname iqn.2002-10.edu.abc.iol.iscsi.draft20-target:1ip 10.0.0.1port 3260Related Commands
ip csg billing
To define a CSG2 billing plan, and to enter CSG2 billing configuration mode, use the ip csg billing command in global configuration mode. To delete the billing plan, use the no form of this command.
ip csg billing billing-plan-name
no ip csg billing billing-plan-name
Syntax Description
Defaults
None
Command Modes
Global configuration
Command History
Usage Guidelines
You can define up to 128 billing plans.
The characteristics of each billing plan are defined by the following commands:
•
Examples
The following example shows how to define a CSG2 billing plan named REGULAR:
ip csg billing REGULARRelated Commands
ip csg bma
To configure the Billing Mediation Agents (BMAs) to which the CSG2 is to send billing records, use the ip csg bma command in CSG2 global configuration mode. To remove a BMA from the list of agents, use the no form of this command.
ip csg bma [vrf vrf-name] ip-address port-number priority
no ip csg bma [vrf vrf-name] ip-address port-number
Syntax Description
Defaults
Active and standby BMAs are not defined.
If no VRF table is specified, the CSG2 uses the global routing table to communicate with the BMA.Command Modes
Global configuration
Command History
Usage Guidelines
You must specify the BMA local port using the ip csg bma local-port command before you enter the ip csg bma command.
Accounting records are sent only to the agents identified in the ip csg bma command. This provides a measure of security to ensure that records are not sent to unauthorized systems.
General packet radio service (GPRS) tunneling protocol (GTP) prime (GTP') does not support nodealive or redirect for multiple agents with the same IP address.
Note
Examples
The following example shows how to configure a BMA with priority 10 that uses VRF table BMAVRF:
ip csg bma vrf BMAVRF 1.2.3.4 5555 10Related Commands
ip csg bma activate
To enable support for multiple active Billing Mediation Agents (BMAs), use the ip csg bma activate command in CSG2 global configuration mode. To disable support for multiple active BMAs, use the no form of this command.
ip csg bma activate [number [sticky seconds]]
no ip csg bma activate [number [sticky seconds]]
Syntax Description
Defaults
The default value for number is 1.
The default value for seconds is 30.
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command to load-balance CDRs among multiple active BMAs.
When the CSG2 uses multiple active BMAs, it sends all CDRs for a given user to a particular BMA. The CSG2 stores that BMA assignment in the CSG2 User Table entry for that user.
For example, if a configuration has four active BMAs, and one of those BMAs fails, the CSG2 looks for a suitable standby BMA. If the CSG2 finds a suitable standby BMA, it transfers all of the CDRs from the failed BMA to the new BMA, and updates all of the affected User Table entries to reflect the new BMA assignment.
However, if the CSG2 cannot find a suitable standby BMA, it redistributes all of the CDRs from the failed BMA among the remaining three active BMAs. It does so by finding the User Table entries for the affected users in the CDRs. The CSG2 then assigns one of the active BMAs to each affected user, and updates the User Table entries to reflect the new BMA assignments. The CSG2 reassigns all CDRs for a given user to the same BMA.
If the CSG2 cannot find a User Table entry for a user (for example, the user has logged off), it creates a temporary sticky object as a placeholder and assigns a new BMA to the sticky object. This ensures that the remaining CDRs for that user are sent to the same BMA.
Note
Examples
The following example shows how to enable support for multiple active BMAs for the CSG2 accounting service A1. In this example, up to two BMAs can be active at the same time, and the CSG2 deletes inactive sticky objects after 60 seconds:
ip csg bma activate 2 sticky 60Related Commands
Defines the Billing Mediation Agents (BMAs) to which the CSG2 is to send billing records
Activates one or more quota servers.
ip csg bma keepalive
To define the Billing Mediation Agent (BMA) keepalive time interval for the CSG2, use the ip csg bma keepalive command in global configuration mode. To reset the BMA keepalive timer to the default value, use the no form of this command.
ip csg bma keepalive number-of-seconds
no ip csg bma keepalive
Syntax Description
number-of-seconds
Time, in seconds, between BMA keepalives. The range is 1 to 65535. The default value is 60.
Defaults
The default value is 60 seconds.
Command Modes
Global configuration
Command History
12.4(11)MD
This command was migrated from CSG1.
Changes from CSG1:
•
•
Usage Guidelines
We recommend that you change the keepalive time interval only when directed to do so by Cisco Technical Assistance Center (TAC) engineers. In most environments, the default value is the most appropriate setting.
Examples
The following example shows how to specify a BMA keepalive time of 300 seconds:
ip csg bma keepalive 300Related Commands
ip csg bma local-port
To define the port on which the CSG2 communicates with the Billing Mediation Agent (BMA), use the ip csg bma local-port command in CSG2 global configuration mode. To remove the port, use the no form of this command.
ip csg bma local-port port-number
no ip csg bma local-port
Syntax Description
Defaults
No BMA local ports are configured.
Command Modes
Global configuration
Command History
12.4(11)MD
This command was migrated from CSG1.
Changes from CSG1: The name of this command changed from agent local-port to ip csg bma local-port.
Usage Guidelines
You must specify the BMA local port using the ip csg bma local-port command before you enter the ip csg bma command.
This command accommodates BMAs that configure a port number that is not the general packet radio service (GPRS) tunneling protocol (GTP) prime (GTP') default port (3386).
You must configure a local port to activate BMAs. The local port must be unique with respect to all other configured local ports, such as the quota server local port.
Note
Examples
The following example shows how to specify local port 5555 as the port on which the CSG2 listens for the CSG2 accounting service A1:
ip csg bma local-port 5555Related Commands
ip csg bma messages
To specify the maximum number of general packet radio service (GPRS) tunneling protocol prime (GTP') messages that the CSG2 can buffer for all Billing Mediation Agents (BMAs), use the ip csg bma messages command in global configuration mode. To restore the default setting, use the no form of this command.
ip csg bma messages number
no ip csg bma messages
Syntax Description
number
Maximum number of GTP' messages that can be buffered for all BMAs. The range is from 1 to 65535. The default is 10000.
Defaults
The CSG2 buffers up to 10000 GTP' messages.
Command Modes
Global configuration
Command History
12.4(11)MD
This command was migrated from CSG1.
Changes from CSG1:
•
•
Usage Guidelines
We recommend that you change the number of GTP' messages that can be buffered only when directed to do so by Cisco Technical Assistance Center (TAC) engineers. In most environments, the default value is the most appropriate setting.
The CSG2 can buffer GTP' messages in either the Cisco Persistent Storage Device (PSD) or in the Storage Area Network (SAN) connected to the Internet Small Computer Systems Interface (iSCSI), as configured. (For more information, see the "Configuring PSD Support" section on page 7-1 and the "Configuring iSCSI Support" section on page 8-1.)
If the BMA GTP' message buffer exceeds 75% of the number specified on this command, the CSG2 stops reading GTP' messages from the PSD or SAN. When the buffer drops below the 75% threshold, the CSG2 again begins reading from the PSD or SAN, placing the buffered GTP' messages in the BMA queue. For example, using the default setting for this command of 10,000 messages, the CSG2 can read from the PSD or SAN as long as the buffer contains less than 7,500 GTP' messages—75% of 10,000 messages.
By default, the CSG2 limits the rate at which GTP' messages are read from the PSD to 500 packets/second, and from the SAN to 167 packets/second. However, you can change those default rates. For more information, see the "Configuring the PSD Packet Drain Settings" section on page 7-2 and the "Configuring the iSCSI Packet Drain Settings" section on page 8-4.
Examples
The following example shows how to configure the CSG2 to buffer up to 12345 GTP' messages:
ip csg bma messages 12345Related Commands
ip csg bma retransmit
To define the Billing Mediation Agent (BMA) retransmit time interval for the CSG2, use the ip csg bma retransmit command in global configuration mode. To reset the BMA retransmit timer to the default value, use the no form of this command.
ip csg bma retransmit number-of-seconds
no ip csg bma retransmit
Syntax Description
number-of-seconds
Time, in seconds, between BMA retransmits. The range is 2 to 65535. The default value is 4.
Defaults
The default value is 4 seconds.
Command Modes
Global configuration
Command History
12.4(11)MD
This command was introduced.
12.4(15)MD
The range changed from 1 to 65535 to 2 to 65535.
Usage Guidelines
We recommend that you change the retransmit time interval only when directed to do so by Cisco Technical Assistance Center (TAC) engineers. In most environments, the default value is the most appropriate setting.
Examples
The following example shows how to specify a BMA retransmit time of 2 seconds:
ip csg bma retransmit 2Related Commands
ip csg bma retries
To define the maximum number of Billing Mediation Agent (BMA) retries allowed before the CSG2 determines that the link has failed, use the ip csg bma retries command in global configuration mode. To reset the number of BMA retries to the default value, use the no form of this command.
ip csg bma retries [packet] number-of-retries
no ip csg bma retries
Syntax Description
Defaults
The default value is 3 retries.
Command Modes
Global configuration
Command History
12.4(11)MD
This command was introduced.
12.4(15)MD
The packet keyword was added.
Usage Guidelines
We recommend that you change the number of retries allowed only when directed to do so by Cisco Technical Assistance Center (TAC) engineers. In most environments, the default value is the most appropriate setting.
By default, the CSG2 retries a packet forever; it never discards a packet. If you configure the ip csg bma retries packet command, the CSG2 tries to send a packet to the BMA the specified number of times, then discards the packet. (The first attempt to send a packet to the BMA is not counted as a retry.) For example, if you configure ip csg bma retries packet 4, the CSG2 tries to send a packet to the BMA five times before discarding it (the initial attempt plus four retries).
Examples
The following example shows how to allow two BMA retries:
ip csg bma retries 2The following example shows how to allow the CSG2 to try to send a packet to the BMA four times, in addition to the initial attempt:
ip csg bma retries packet 4Related Commands
ip csg bma window
To define the Billing Mediation Agent (BMA) transmit window size for the CSG2, use the ip csg bma window command in global configuration mode. To reset the BMA transmit window size to the default value, use the no form of this command.
ip csg bma window {max window-size | min window-size | min auto}
no ip csg bma window {max | min}
Syntax Description
Defaults
The default maximum window size is 128 packets.
The default minimum window size is automatically determined by the CSG2.Command Modes
Global configuration
Command History
Usage Guidelines
We recommend that you change the transmit window size only when directed to do so by Cisco Technical Assistance Center (TAC) engineers. In most environments, the default value is the most appropriate setting.
Examples
The following example shows how to set the maximum BMA transmit window to 64 packets:
ip csg bma window max 64Related Commands
ip csg case-sensitive
To specify whether to treat CSG2 header, method, and URL match patterns as case-sensitive, use the ip csg case-sensitive command in global configuration mode. To disable case-sensitivity for CSG2 match patterns, use the no form of this command.
ip csg case-sensitive
no ip csg case-sensitive
Syntax Description
This command has no arguments or keywords.
Defaults
CSG2 match patterns are case-sensitive.
Command Modes
Global configuration
Command History
Examples
The following example shows how to disable case-sensitivity for CSG2 match patterns:
no ip csg case-sensitiveRelated Commands
Specifies a header match pattern for a CSG2 billing map.
Specifies a method match pattern for a CSG2 billing map.
Specifies a URL match pattern for a CSG2 billing map.
ip csg content
To configure content for CSG2 services, and to enter CSG2 content configuration mode, use the ip csg content command in global configuration mode. To delete the content configuration, use the no form of this command.
ip csg content content-name
no ip csg content content-name
Syntax Description
Defaults
None
Command Modes
Global configuration
Command History
Usage Guidelines
You can define up to 2048 contents.
The characteristics of each content configuration are defined by the following commands:
•
•
You cannot change characteristics for a content while it is in service.
If the content configuration does not match any service listed under a subscriber's billing plan, the CSG2 considers the service to be either free or postpaid. The CSG2 does not try to authorize the subscriber with the quota server for the service.
Examples
The following example shows how to define the CSG2 content named MOVIES_COMEDY:
ip csg content MOVIES_COMEDYRelated Commands
ip csg database
To identify the database server that answers CSG2 user ID queries, use the ip csg database command in global configuration mode. To disable the database server, use the no form of this command.
ip csg database [vrf vrf-name] ip-address port-number local-port
no ip csg database
Syntax Description
Defaults
If no VRF table is specified, the CSG2 uses the global routing table to communicate with the database server.
Command Modes
Global configuration
Command History
Usage Guidelines
You can configure one and only one database server to answer CSG2 user ID queries.
The subscriber traffic must flow on an interface in the global routing table (not the VRF table).
Examples
The following example shows how to specify a user database server with IP address 10.1.2.3, port number 11111, and local port number 22222:
ip csg database 10.1.2.3 11111 22222ip csg entries fragment
To define the maximum number of entries in the CSG2 fragment database, or to define how long the CSG2 is to retain the entries, use the ip csg entries fragment command in global configuration mode. To restore the default settings, use the no form of this command.
ip csg entries fragment {idle duration | maximum entries-number}
no ip csg entries fragment {idle | max}
Syntax Description
Defaults
The default idle duration is 5 seconds.
The default maximum number of entries is 16384.Command Modes
Global configuration
Command History
Usage Guidelines
The CSG2 divides the configured maximum number of entries evenly among the traffic processors. For example, if you configure a maximum of 100 entries, the maximum buffer pool size on each traffic processor is 20.
Examples
The following example shows how to specify a maximum CSG2 fragment database size o0f 32,768 entries:
ip csg entries fragment maximum 32768Related Commands
ip csg entries session user max
To specify the maximum number of entries allowed in the CSG2 session table, use the ip csg entries session user max command in global configuration mode. To restore the default settings, use the no form of this command.
ip csg entries session user max entries
no ip csg entries session user max
Syntax Description
Defaults
The default maximum number of entries is 1000000.
Command Modes
Global configuration
Command History
Usage Guidelines
The maximum number of entries is not enforced on the buffer pool maximum size, it is enforced during allocation of individual subscriber sessions to the table.
Examples
The following example shows how to specify a maximum CSG2 session table size of 100,000 entries:
ip csg entries session user max 100000Related Commands
ip csg entries user idle
To specify how long the CSG2 is to retain entries in the CSG2 User Table, use the ip csg entries user idle command in global configuration mode. To restore the default settings, use the no form of this command.
ip csg entries user idle duration [pod]
no ip csg entries user idle
Syntax Description
Defaults
The default idle duration is 0 seconds (entries never idle out), and the CSG2 does not send the RADIUS Packet of Disconnect message when an entry idles out.
Command Modes
Global configuration
Command History
Usage Guidelines
The CSG2 User Table identifies all subscribers known to the CSG2. The table is populated on the basis of the contents of RADIUS Accounting Start messages, or from the user database, if either feature is enabled in your configuration.
When setting the entry idle timer, keep the following considerations in mind:
•
•
•
•
•
•
Examples
The following example shows how to specify a CSG2 User Table entry idle time of 86,400 seconds:
ip csg entries user idle 86400Related Commands
ip csg entries user max
To specify the maximum number of entries allowed in the CSG2 User Table, use the ip csg entries user max command in global configuration mode. To restore the default settings, use the no form of this command.
ip csg entries user max entries
no ip csg entries user max
Syntax Description
Defaults
The default maximum number of entries is 300000 for both the 1 GB-SAMI and the 2 GB-SAMI options.
Command Modes
Global configuration
Command History
Usage Guidelines
The maximum number of entries is not enforced on the buffer pool maximum size, it is enforced during allocation of individual entries to the CSG2 User Table.
Examples
The following example shows how to specify a maximum CSG2 User Table size of 500000 entries:
ip csg entries user max 500000Related Commands
ip csg entries user profile
To specify the location from which the CSG2 is to obtain the subscriber profile and billing plan when generating entries for the CSG2 User Table, use the ip csg entries user profile command in global configuration mode. To restore the default settings, use the no form of this command.
ip csg entries user profile {quota-server | radius {pass | remove | timeout timeout}}
no ip csg entries user profile
Syntax Description
Defaults
If you do not specify the ip csg entries user profile command, the CSG2 obtains the subscriber profile and billing plan from the quota server.
If you do not specify a timeout, the default timeout is 20 seconds.Command Modes
Global configuration
Command History
Usage Guidelines
Keep the following considerations in mind:
•
•
•
The CSG2 obtains billing plan data from authentication, authorization, and accounting (AAA) RADIUS Access response packets.
•
•
•
In most cases, the default timeout of 20 seconds is far greater than the delay between the receipt of the RADIUS Access response and the receipt of the RADIUS Accounting Start message. If the default timeout is not large enough, you can use the ip csg entries user profile timeout timeout command to increase the timeout.
Examples
The following example shows how to specify that the CSG2 is to obtain billing plan names from the RADIUS Access-Accept and RADIUS Accounting-Request messages, and that the CSG2 is not to remove the VSA containing the billing plan from the messages:
ip csg entries user profile radius passRelated Commands
ip csg ipc crashdump
To define the action to be taken by the CSG2 if an Interprocessor Communication (IPC) link fails, use the ip csg ipc crashdump command in global configuration mode. To restore the default setting, use the no form of this command.
ip csg ipc crashdump [never | tolerance [number-of-seconds]]
no ip csg ipc crashdump
Syntax Description
Defaults
The default setting is to never generate a crash dump.
If you specify the tolerance keyword without specifying a time, the CSG2 generates a crash dump 60 seconds after an IPC link fails.Command Modes
Global configuration
Command History
Usage Guidelines
We recommend that you change the crash dump setting only when directed to do so by Cisco Technical Assistance Center (TAC) engineers. In most environments, the default value is the most appropriate setting.
Examples
The following example shows how to specify that the CSG2 is to generate a crash dump 120 seconds after an IPC link fails:
ip csg ipc crashdump tolerance 120ip csg ipc keepalive
To define the Interprocessor Communication (IPC) module keepalive time interval for the CSG2, use the ip csg ipc keepalive command in global configuration mode. To reset the IPC keepalive timer to the default value, use the no form of this command.
ip csg ipc keepalive number-of-seconds
no ip csg ipc keepalive
Syntax Description
number-of-seconds
Time, in seconds, between IPC keepalives. The range is 1 to 65535. The default value is 8.
Defaults
The default value is 8 seconds.
Command Modes
Global configuration
Command History
Usage Guidelines
We recommend that you change the keepalive time interval only when directed to do so by Cisco Technical Assistance Center (TAC) engineers. In most environments, the default value is the most appropriate setting.
Examples
The following example shows how to specify an IPC keepalive time of 300 seconds:
ip csg ipc keepalive 300Related Commands
ip csg ipc retransmit
To define the Interprocessor Communication (IPC) retransmit time interval for the CSG2, use the ip csg ipc retransmit command in global configuration mode. To reset the IPC retransmit timer to the default value, use the no form of this command.
ip csg ipc retransmit number-of-seconds
no ip csg ipc retransmit
Syntax Description
number-of-seconds
Time, in seconds, between IPC retransmits. The range is 1 to 65535. The default value is 4.
Defaults
The default value is 4 second.
Command Modes
Global configuration
Command History
Usage Guidelines
We recommend that you change the retransmit time interval only when directed to do so by Cisco Technical Assistance Center (TAC) engineers. In most environments, the default value is the most appropriate setting.
Examples
The following example shows how to specify an IPC retransmit time of 2 seconds:
ip csg ipc retransmit 2Related Commands
ip csg ipc retries
To define the maximum number of Interprocessor Communication (IPC) retries allowed before the CSG2 determines that the link has failed, use the ip csg ipc retries command in global configuration mode. To reset the number of IPC retries to the default value, use the no form of this command.
ip csg ipc retries number-of-retries
no ip csg ipc retries
Syntax Description
number-of-retries
Maximum number of IPC retries allowed by the CSG2. The range is 1 to 65535. The default value is 20.
Defaults
The default value is 20 retries.
Command Modes
Global configuration
Command History
Usage Guidelines
We recommend that you change the number of retries allowed only when directed to do so by Cisco Technical Assistance Center (TAC) engineers. In most environments, the default value is the most appropriate setting.
Examples
The following example shows how to allow two IPC retries:
ip csg ipc retries 2Related Commands
ip csg iscsi drain delay
To define the delay interval, in seconds, before draining packets from the Storage Area Network (SAN) connected to the Internet Small Computer Systems Interface (iSCSI) when the Billing Mediation Agent (BMA) becomes active, use the ip csg iscsi drain delay command in global configuration mode. To delete the drain delay interval, use the no form of this command.
ip csg iscsi drain delay number-of-seconds
no ip csg iscsi drain delay
Syntax Description
number-of-seconds
Delay interval, in seconds, before draining packets from the SAN. The range is 0 to 3. The default value is 3. A value of 0 means no delay.
Defaults
The default value is 3 seconds.
Command Modes
Global configuration
Command History
Usage Guidelines
The CSG2 can buffer GTP' messages in the Storage Area Network (SAN) connected to the Internet Small Computer Systems Interface (iSCSI), if so configured. (For more information, see the "Configuring iSCSI Support" section on page 8-1.) By default, the CSG2 limits the rate at which GTP' messages are read from the SAN to 167 packets/second (500 packets/3 seconds). However, you can use the ip csg iscsi drain delay command to change that rate. For example, specifying an interval of 2 seconds yields a rate of 250 packets/second (500 packets/2 seconds).
Examples
The following example shows how to specify a SAN drain delay interval of 2 seconds:
ip csg iscsi drain delay 2Related Commands
ip csg iscsi drain packet
To define the number of packets to be drained from the Storage Area Network (SAN) connected to the Internet Small Computer Systems Interface (iSCSI) per drain delay interval when the Billing Mediation Agent (BMA) becomes active, use the ip csg iscsi drain packet command in global configuration mode. To delete the drain packet, use the no form of this command.
ip csg iscsi drain packet number-of-packets
no ip csg iscsi drain packet
Syntax Description
number-of-packets
Number of packets to be drained from the SAN per drain delay interval. The range is from 1 to 64000. The default is 500.
Defaults
The default value is 500 packets.
Command Modes
Global configuration
Command History
Usage Guidelines
The CSG2 can buffer GTP' messages in the Storage Area Network (SAN) connected to the Internet Small Computer Systems Interface (iSCSI), if so configured. (For more information, see the "Configuring iSCSI Support" section on page 8-1.) By default, the CSG2 limits the rate at which GTP' messages are read from the SAN to 167 packets/second (500 packets/3 seconds). However, you can use the ip csg iscsi drain packet command to change that rate. For example, specifying that 600 packets are to be drained per interval yields a rate of 200 packets/second (600 packets/3 seconds).
Examples
The following example shows how to specify that 1000 packets are to be drained from the SAN per drain delay interval:
ip csg iscsi drain packet 1000Related Commands
ip csg iscsi profile
To specify the Internet Small Computer Systems Interface (iSCSI) target to be used as backup storage for the CSG2, use the ip csg iscsi profile command in global configuration mode. To delete the iSCSI target, use the no form of this command.
ip csg iscsi profile target-profile-name
no ip csg iscsi profile
Syntax Description
Defaults
No iSCSI target is specified.
Command Modes
Global configuration
Command History
Usage Guidelines
You can associate one and only one iSCSI target profile with each CSG2.
Examples
The following example shows how to specify CSG_BACKUP as the iSCSI target:
ip csg iscsi profile CSG_BACKUPRelated Commands
ip csg map
To define the CSG2 billing content filters (header, method, and URL maps), and to enter CSG2 map configuration mode, use the ip csg map command in global configuration mode. To turn off the service, use the no form of this command.
ip csg map map-name
no ip csg map map-name
Syntax Description
Defaults
None
Command Modes
Global configuration
Command History
12.4(11)MD
This command was migrated from CSG1.
Changes from CSG1: The header and url keywords were removed.
Usage Guidelines
The CSG2 maps are used to match headers, methods, or URLs against a pattern to determine whether flows are to be processed by the CSG2 accounting services.
The headers, methods, or URLs that are to be matched against a pattern are defined by the following commands:
When configuring a map, keep the following considerations in mind:
•
•
•
ip csg map HOSTMAPmatch header host1 value *.2.*.44!ip csg map URLMAPmatch url */mobile/index.wml!ip csg policy MAP-POLICYmap HOSTMAPmap URLMAPIn this example, a flow must match both HOSTMAP and URLMAP in order to match policy MAP-POLICY.
Examples
The following example shows how to configure a CSG2 URL map named MOVIES:
ip csg map MOVIESmatch url *.movies_(comedy|action|drama).com/*.mpegRelated Commands
ip csg mode single-tp
To enable the CSG2 to use a single traffic processor (TP) instead of multiple TPs, use the ip csg mode single-tp command in global configuration mode. To restore the default setting, use the no form of this command.
ip csg mode single-tp
no ip csg mode single-tp
Syntax Description
This command has no arguments or keywords.
Defaults
The CSG2 operates in multiple-TP mode.
Command Modes
Global configuration
Command History
Usage Guidelines
In normal multiple-TP mode, the CSG2 distributes subscriber traffic among all of the TPs, based on each subscriber's IP address. In single-TP mode, the CSG2 dispatches traffic for all subscribers to the first TP to be processed.
Single-TP mode is required for HTTP X-Forwarded-For operation. Before configuring the CSG2 for X-Forwarded-For operation, configure the CSG2 for single-TP mode by entering the ip csg mode single-tp command, then performing a write memory, then restarting the CSG2.
To switch out of single-TP mode, enter the no ip csg mode single-tp command, then perform a write memory, then restart the CSG2.
If you intend to operate in single-TP mode, the ip csg mode single-tp command must be the first command in your CSG2 configuration.
Examples
The following example shows how to configure single-TP mode for the CSG2:
ip csg mode single-tpRelated Commands
Specifies that the CSG2 is to obtain the subscriber's IP address from the HTTP X-Forwarded-For header.
ip csg policy
To define a policy for qualifying flows for the CSG2 billing services, and to enter CSG2 policy configuration mode, use the ip csg policy command in global configuration mode. To turn off the service, use the no form of this command.
ip csg policy policy-name
no ip csg policy policy-name
Syntax Description
Defaults
None
Command Modes
Global configuration
Command History
Usage Guidelines
Because of limitations on the number of URL match patterns that the CSG2 can handle, do not define more than 16,000 policies. For more information on URL match patterns, see the description of the match url command.
The characteristics of each policy are defined by the following commands:
•
When configuring a map, keep the following considerations in mind:
•
•
ip csg map HOSTMAPmatch header host1 value *.2.*.44!ip csg map URLMAPmatch url */mobile/index.wml!ip csg policy MAP-POLICYmap HOSTMAPmap URLMAPIn this example, a flow must match both HOSTMAP and URLMAP in order to match policy MAP-POLICY.
Examples
The following example shows how to configure a CSG2 policy named MOVIES_COMEDY:
ip csg policy MOVIES_COMEDYRelated Commands
ip csg psd
To configure a Cisco Persistent Storage Device (PSD), use the ip csg psd command in global configuration mode. To remove the PSD, use the no form of this command.
ip csg psd [vrf vrf-name] ip-address port-number
no ip csg psd [vrf vrf-name] ip-address port-number
Syntax Description
Defaults
No PSDs are configured.
If no VRF table is specified, the CSG2 uses the global routing table to communicate with the PSD.Command Modes
Global configuration
Command History
Usage Guidelines
You must specify the PSD local port using the ip csg psd local-port command before you enter the ip csg psd command.
You can configure only one PSD.
Examples
The following example configures a PSD with IP address 1.2.3.4 and port number 7777, that uses VRF table PSDVRF to communicate with the CSG2:
ip csg psd vrf PSDVRF 1.2.3.4 7777Related Commands
ip csg psd drain delay
To define the delay interval, in seconds, before draining packets from the Cisco Persistent Storage Device (PSD) when the Billing Mediation Agent (BMA) becomes active, use the ip csg psd drain delay command in global configuration mode. To delete the drain delay interval, use the no form of this command.
ip csg psd drain delay number-of-seconds
no ip csg psd drain delay
Syntax Description
number-of-seconds
Delay interval, in seconds, before draining packets from the PSD. The range is 0 to 3. The default value is 1. A value of 0 means no delay.
Defaults
The default value is 1 second.
Command Modes
Global configuration
Command History
Usage Guidelines
The CSG2 can buffer GTP' messages in the Cisco Persistent Storage Device (PSD), if so configured. (For more information, see the "Configuring PSD Support" section on page 7-1.) By default, the CSG2 limits the rate at which GTP' messages are read from the PSD to 500 packets/second. However, you can use the ip csg psd drain delay command to change that rate. For example, specifying an interval of 2 seconds yields a rate of 250 packets/second (500 packets/2 seconds).
Examples
The following example shows how to specify a PSD drain delay interval of 2 seconds:
ip csg psd drain delay 2Related Commands
ip csg psd drain packet
To define the number of packets to be drained from the Cisco Persistent Storage Device (PSD) per drain delay interval when the Billing Mediation Agent (BMA) becomes active, use the ip csg psd drain packet command in global configuration mode. To delete the drain packet, use the no form of this command.
ip csg psd drain packet number-of-packets
no ip csg psd drain packet
Syntax Description
number-of-packets
Number of packets to be drained from the PSD per drain delay interval. The range is from 1 to 64000. The default is 500.
Defaults
The default value is 500 packets.
Command Modes
Global configuration
Command History
Usage Guidelines
The CSG2 can buffer GTP' messages in the Cisco Persistent Storage Device (PSD), if so configured. (For more information, see the "Configuring PSD Support" section on page 7-1.) By default, the CSG2 limits the rate at which GTP' messages are read from the PSD to 500 packets/second. However, you can use the ip csg psd drain packet command to change that rate. For example, specifying that 1000 packets are to be drained per interval yields a rate of 1000 packets/second (1000 packets/1 second).
Examples
The following example shows how to specify that 1000 packets are to be drained from the PSD per drain delay interval:
ip csg psd drain packet 1000Related Commands
ip csg psd keepalive
To define the Cisco Persistent Storage Device (PSD) keepalive time interval for the CSG2, use the ip csg psd keepalive command in global configuration mode. To reset the PSD keepalive timer to the default value, use the no form of this command.
ip csg psd keepalive number-of-seconds
no ip csg psd keepalive
Syntax Description
number-of-seconds
Time, in seconds, between PSD keepalives. The range is from 1 to 65535. The default value is 60.
Defaults
The default value is 60 seconds.
Command Modes
Global configuration
Command History
Usage Guidelines
We recommend that you change the keepalive time interval only when directed to do so by Cisco Technical Assistance Center (TAC) engineers. In most environments, the default value is the most appropriate setting.
Examples
The following example shows how to specify a PSD keepalive time of 300 seconds:
ip csg psd keepalive 300Related Commands
ip csg psd local-port
To configure the local port on which the CSG2 communicates with the Cisco Persistent Storage Device (PSD), use the ip csg psd local-port command in global configuration mode. To remove a quota server local port configuration, use the no form of this command.
ip csg psd local-port port-number
no ip csg psd local-port
Syntax Description
Defaults
No PSD local port is configured.
Command Modes
Global configuration
Command History
Usage Guidelines
You must specify the PSD local port using the ip csg psd local-port command before you enter the ip csg psd command.
You can configure only one PSD.
Examples
The following example configures a PSD with local port number 7777:
ip csg psd local-port 7777Related Commands
ip csg psd margin
To specify the maximum number of general packet radio service (GPRS) tunneling protocol prime (GTP') messages, beyond the size of the Billing Mediation Agent (BMA) message queue, that the CSG2 can buffer for the Cisco Persistent Storage Device (PSD), use the ip csg psd margin command in global configuration mode. To restore the default setting, use the no form of this command.
ip csg psd margin number
no ip csg psd margin
Syntax Description
number
Maximum number of GTP' messages, beyond the size of the BMA message queue, that can be buffered for the PSD. The range is from 100 to 65535. The default is 2000.
Defaults
The CSG2 buffers up to 2000 GTP' messages, beyond the size of the BMA message queue.
Command Modes
Global configuration
Command History
Usage Guidelines
We recommend that you change the number of GTP' messages that can be buffered only when directed to do so by Cisco Technical Assistance Center (TAC) engineers. In most environments, the default value is the most appropriate setting.
Examples
The following example shows how to configure the CSG2 to buffer up to 3000 GTP' messages, beyond the size of the BMA message queue:
ip csg psd margin 2000Related Commands
ip csg psd retransmit
To define the Cisco Persistent Storage Device (PSD) retransmit time interval for the CSG2, use the ip csg psd retransmit command in global configuration mode. To reset the PSD retransmit timer to the default value, use the no form of this command.
ip csg psd retransmit number-of-seconds
no ip csg psd retransmit
Syntax Description
number-of-seconds
Time, in seconds, between PSD retransmits. The range is 1 to 65535. The default value is 4.
Defaults
The default value is 4 seconds.
Command Modes
Global configuration
Command History
Usage Guidelines
We recommend that you change the retransmit time interval only when directed to do so by Cisco Technical Assistance Center (TAC) engineers. In most environments, the default value is the most appropriate setting.
Examples
The following example shows how to specify a PSD retransmit time of 2 seconds:
ip csg psd retransmit 2Related Commands
ip csg psd retries
To define the maximum number of Cisco Persistent Storage Device (PSD) retries allowed before the CSG2 determines that the link has failed, use the ip csg psd retries command in global configuration mode. To reset the number of PSD retries to the default value, use the no form of this command.
ip csg psd retries [packet] number-of-retries
no ip csg psd retries
Syntax Description
Defaults
The default value is 3 retries.
Command Modes
Global configuration
Command History
12.4(11)MD
This command was introduced.
12.4(15)MD
The packet keyword was added.
Usage Guidelines
We recommend that you change the number of retries allowed only when directed to do so by Cisco Technical Assistance Center (TAC) engineers. In most environments, the default value is the most appropriate setting.
By default, the CSG2 retries a packet forever; it never discards a packet. If you configure the ip csg psd retries packet command, the CSG2 tries to send a packet to the PSD the specified number of times, then discards the packet. (The first attempt to send a packet to the PSD is not counted as a retry.) For example, if you configure ip csg psd retries packet 4, the CSG2 tries to send a packet to the PSD five times before discarding it (the initial attempt plus four retries).
Examples
The following example shows how to allow two PSD retries:
ip csg psd retries 2The following example shows how to allow the CSG2 to try to send a packet to the PSD four times, in addition to the initial attempt:
ip csg psd retries packet 4Related Commands
ip csg psd window
To define the Cisco Persistent Storage Device (PSD) transmit window size for the CSG2, use the ip csg psd window command in global configuration mode. To reset the PSD transmit window size to the default value, use the no form of this command.
ip csg psd window {max window-size | min window-size | min auto}
no ip csg psd window {max | min}
Syntax Description
Defaults
The default maximum window size is 128 packets.
The default minimum window size is automatically determined by the CSG2.Command Modes
Global configuration
Command History
Usage Guidelines
We recommend that you change the transmit window size only when directed to do so by Cisco Technical Assistance Center (TAC) engineers. In most environments, the default value is the most appropriate setting.
Examples
The following example shows how to set the maximum PSD transmit window to 64 packets:
ip csg psd window max 64Related Commands
ip csg quota-server
To configure the CSG2 quota servers that return billing quota values for subscribers, use the ip csg quota-server command in global configuration mode. To remove a quota server configuration, use the no form of this command.
ip csg quota-server [vrf vrf-name] ip-address port-number priority
no ip csg quota-server [vrf vrf-name] ip-address port-number
Syntax Description
Defaults
No quota servers are configured.
If no VRF table is specified, the CSG2 uses the global routing table to communicate with the quota server.Command Modes
Global configuration
Command History
Usage Guidelines
For prepaid billing, you must configure at least one quota server.
You can configure up to 10 quota servers. Each quota server must have a unique priority and a unique IP address (or a unique IP address-VRF name combination, if VRF is configured).
Note
A quota server can recognize a duplicate quota-download request, as when general packet radio service (GPRS) tunneling protocol (GTP) retransmits a packet. When the quota server detects a duplicate quota-download request, it resends the same quota that it sent for the original request.
To disable quota server reassignment (that is, to prevent the CSG2 from assigning a new quota server to a subscriber if the original quota server fails), use the no form of the ip csg quota-server reassign command.
Examples
The following example configures a quota server with IP address 1.2.3.4, port number 6666, and priority 10, that uses VRF table QSVRF to communicate with the CSG2:
ip csg quota-server vrf QSVRF 1.2.3.4 6666 10Related Commands
ip csg quota-server activate
To activate one or more quota servers, use the ip csg quota-server activate command in global configuration mode. To deactivate quota servers, use the no form of this command.
ip csg quota-server activate number
no ip csg quota-server activate
Syntax Description
Defaults
The default value is 1.
Command Modes
Global configuration
Command History
Examples
The following example shows how to activate two quota servers:
ip csg quota-server activate 2Related Commands
Enables support for multiple active Billing Mediation Agents (BMAs)
Configures the CSG2 quota servers that return billing quota values for subscribers.
ip csg quota-server keepalive
To define the quota server keepalive time interval for the CSG2, use the ip csg quota-server keepalive command in global configuration mode. To reset the quota server keepalive timer to the default value, use the no form of this command.
ip csg quota-server keepalive number-of-seconds
no ip csg quota-server keepalive
Syntax Description
number-of-seconds
Time, in seconds, between quota server keepalives. The range is 1 to 65535. The default value is 60.
Defaults
The default value is 60 seconds.
Command Modes
Global configuration
Command History
Usage Guidelines
We recommend that you change the keepalive time interval only when directed to do so by Cisco Technical Assistance Center (TAC) engineers. In most environments, the default value is the most appropriate setting.
Examples
The following example shows how to specify a quota server keepalive time of 300 seconds:
ip csg quota-server keepalive 300Related Commands
ip csg quota-server local-port
To configure the local port on which the CSG2 communicates with quota servers, use the ip csg quota-server local-port command in global configuration mode. To remove a quota server local port configuration, use the no form of this command.
ip csg quota-server local-port port-number
no ip csg quota-server local-port
Syntax Description
Defaults
No quota server local ports are configured.
Command Modes
Global configuration
Command History
Usage Guidelines
For prepaid billing, you must configure a quota server local port.
Note
Examples
The following example configures quota server local port 6666:
ip csg quota-server local-port 6666Related Commands
ip csg quota-server messages
To specify the maximum number of general packet radio service (GPRS) tunneling protocol prime (GTP') messages that the CSG2 can buffer for all quota servers, use the ip csg quota-server messages command in global configuration mode. To restore the default settings, use the no form of this command.
ip csg quota-server messages number
no ip csg quota-server messages
Syntax Description
number
Maximum number of GTP' messages that can be buffered for all quota servers. The range is from 1 to 65535. The default is 10000.
Defaults
The CSG2 buffers up to 10000 GTP' messages.
Command Modes
Global configuration
Command History
Usage Guidelines
We recommend that you change the number of GTP' messages that can be buffered only when directed to do so by Cisco Technical Assistance Center (TAC) engineers. In most environments, the default value is the most appropriate setting.
Examples
The following example shows how to configure the CSG2 to buffer up to 12345 GTP' messages:
ip csg quota-server messages 12345Related Commands
ip csg quota-server reassign
To reassign subscribers to a different CSG2 quota server after a failure, use the ip csg quota-server reassign command in global configuration mode. To disable quota server reassignment for subscribers, use the no form of this command.
ip csg quota-server reassign
no ip csg quota-server reassign
Syntax Description
This command has no arguments or keywords.
Defaults
Subscribers are reassigned to a different quota server after a failure.
Command Modes
Global configuration
Command History
Examples
The following example reassigns subscribers after a quota server failure:
ip csg quota-server reassignRelated Commands
Configures the CSG2 quota servers that return billing quota values for subscribers.
ip csg quota-server retransmit
To define the quota server retransmit time interval for the CSG2, use the ip csg quota-server retransmit command in global configuration mode. To reset the quota server retransmit timer to the default value, use the no form of this command.
ip csg quota-server retransmit number-of-seconds
no ip csg quota-server retransmit
Syntax Description
number-of-seconds
Time, in seconds, between quota server retransmits. The range is 1 to 65535. The default value is 4.
Defaults
The default value is 4 seconds.
Command Modes
Global configuration
Command History
Usage Guidelines
We recommend that you change the retransmit time interval only when directed to do so by Cisco Technical Assistance Center (TAC) engineers. In most environments, the default value is the most appropriate setting.
Examples
The following example shows how to specify a quota server retransmit time of 2 seconds:
ip csg quota-server retransmit 2Related Commands
ip csg quota-server retries
To define the maximum number of quota server retries allowed before the CSG2 determines that the link has failed, use the ip csg quota-server retries command in global configuration mode. To reset the number of quota server retries to the default value, use the no form of this command.
ip csg quota-server retries [packet] number-of-retries
no ip csg quota-server retries
Syntax Description
Defaults
The default value is 3 retries.
Command Modes
Global configuration
Command History
12.4(11)MD
This command was introduced.
12.4(15)MD
The packet keyword was added.
Usage Guidelines
We recommend that you change the number of retries allowed only when directed to do so by Cisco Technical Assistance Center (TAC) engineers. In most environments, the default value is the most appropriate setting.
By default, the CSG2 retries a packet forever; it never discards a packet. If you configure the ip csg quota-server retries packet command, the CSG2 tries to send a packet to the quota server the specified number of times, then discards the packet. (The first attempt to send a packet to the quota server is not counted as a retry.) For example, if you configure ip csg quota-server retries packet 4, the CSG2 tries to send a packet to the quota server five times before discarding it (the initial attempt plus four retries).
Examples
The following example shows how to allow two quota server retries:
ip csg quota-server retries 2The following example shows how to allow the CSG2 to try to send a packet to the quota server four times, in addition to the initial attempt:
ip csg quota-server retries packet 4Related Commands
ip csg quota-server window
To define the quota server transmit window size for the CSG2, use the ip csg quota-server window command in global configuration mode. To reset the quota server transmit window size to the default value, use the no form of this command.
ip csg quota-server window {max window-size | min window-size | min auto}
no ip csg quota-server window {max | min}
Syntax Description
Defaults
The default maximum window size is 128 packets.
The default minimum window size is automatically determined by the CSG2.Command Modes
Global configuration
Command History
Usage Guidelines
We recommend that you change the transmit window size only when directed to do so by Cisco Technical Assistance Center (TAC) engineers. In most environments, the default value is the most appropriate setting.
Examples
The following example shows how to set the maximum quota server transmit window to 64 packets:
ip csg quota-server window max 64Related Commands
ip csg radius ack error parse
To enable the CSG2 to generate a RADIUS response to a RADIUS Accounting Start Request or a RADIUS Accounting Interim Request when it encounters a RADIUS parse error condition, use the ip csg radius ack error parse command in global configuration mode. To prevent RADIUS responses to errors, use the no form of this command.
ip csg radius ack error parse
no ip csg radius ack error parse
Syntax Description
This command has no arguments or keywords.
Defaults
The CSG2 generates a RADIUS response to a RADIUS Accounting Start Request or a RADIUS Accounting Interim Request when it encounters a RADIUS parse error condition.
Command Modes
Global configuration
Command History
Usage Guidelines
Use the no form of this command, no ip csg radius ack error parse, to prevent the CSG2 from acknowledging the following RADIUS parse errors:
•
•
•
•
