Configuring the Quota Manager
This module describes how to configure the quota manager
•Information About Configuring the Quota Manager
•How to Configure the SCA BB Application
Information About Configuring the Quota Manager
This section describes how to configure the quota manager. Both the service control engine (SCE) platform and the subscriber manager (SM) must be properly configured.
•Configuring the Quota Manager in the SM
•Configuring the Subscriber Manager
When configuring the quota manager, make sure that the following conditions are met:
•Anonymous subscribers should be assigned a package that is not managed by an external quota server.
•For different packages, it is possible to configure different quota management modes (external or internal). However, packages with internal quota management should not have a quota profile configured in the quota manager. Quota indications are issued for internal quota management packages (for billing purposes), and the quota manager ignores them if no quota profile is assigned for them.
•Buckets of type "Number of Sessions" should have a dosage value that is equal to the maximum bucket size. Quota Below Threshold indications are not generated for this type of bucket, so quota provisioning cannot be split into dosages (otherwise the subscriber would get breached between subsequent dosage provisions).
•The threshold value of the Quota Below Threshold indication must be configured to a lower value than the minimal quota dosage of all volume buckets.
Configuring the Quota Manager in the SM
The quota manager is configured with the p3qm.cfg configuration file, which resides in the sm-inst-dir /sm/server/root/config directory (sm-inst-dir refers to the SM installation directory).
The configuration file consists of sections headed by a bracketed section title, for example [Quota Profile.<QUOTA-PROFILE-NAME>]. Each section contains the definition for a single quota profile given by QUOTA-PROFILE-NAME and consists of several parameters having the format parameter=value. The number sign ("#") at the beginning of a line signifies that it is a remark.
•Configuring the Quota Profile Settings
•Configuring the Quota Profile Example
Configuring the Quota Profile Settings
The [Quota Profile.QUOTA-PROFILE-NAME] section in the quota manager configuration file contains the following parameters:
A comma separated list that defines, for each bucket, the quota limits within an aggregation period. You must order the list such that the first number is for bucket 1, the second number is for bucket 2, and so on. The units must also be of the correct corresponding type; "Volume (L3 KBytes)" or "Number of Sessions". The minimal bucket size is 0.
There is no default value for this parameter.
A comma separated list that defines how much quota should be in each bucket after each quota provisioning operation. You must order the list in the same way as the bucket_sizes parameter and the list must be of the same length. The minimal dosage size is 0 and the maximum is 1048576 (1 GB L3 KBytes or 1 million sessions).
There is no default value for this parameter.
Defines the aggregation period; i.e., the period of time for which an amount of quota or number of sessions will be granted to the subscriber.
The value none means that the period of time is not bounded to an aggregation period, and that the quota will not be replenished automatically. Quota can be replenished manually using the command-line utility (CLU).
Possible values are hourly, daily, weekly, monthly, or none.
The default value is daily.
Defines on which day of the month the aggregation period will start.
Possible values for this parameter are 1 to 31. The default value is 1.
Note This parameter is valid only if aggregation_period is set to monthly.
Defines on which day of the week the aggregation period will start.
Possible values are sunday, monday, tuesday, wednesday, thursday, friday, or saturday. The default value is sunday.
Note This parameter is valid only if aggregation_period is set to weekly.
Defines the time of day at which the aggregation period will start. This parameter is applicable for all values of aggregation_period.
The format of this parameter is HH:mm where the hours portion is based on a 24-hour clock.
Possible values are: hours 0 to 23, minutes 0 to 59. The default value is 00:00.
Note If aggregation_period is set to hourly, only the minute value is relevant.
Defines the distribution of the aggregation period start time between different subscribers. Distributing the aggregation period start times helps to avoid bursts of network activity when a new aggregation period begins.
Possible values are 0 to 100, where a gap of 0 means the aggregation period starts at the same time for all subscribers (no distribution) and a gap of 100 means the aggregation period start time is uniformly distributed over the entire aggregation period.
The default value is 0.
For example, if the aggregation period is daily and starts at midnight (00:00) a gap of 50 means that the update messages will be sent between midnight and midday (12:00). If the gap is 25, the update messages will be sent between midnight and 06:00.
Defines the packages that will be associated with this profile. The package values are listed as a comma-separated list of package Id values.
There is no default value for this parameter.
Configuring the Quota Profile Example
The following is an example of a configuration file:
Configuring the Subscriber Manager
In order to use the quota manager within the SM, you must configure the SM configuration file p3sm.cfg. This configuration file resides in the sm-inst-dir/sm/server/root/config directory (sm-inst-dir refers to the SM installation directory). The configuration file consists of sections headed by a bracketed section title, for example [Quota Manager].
Configuring the Quota Manager Section
The [Quota Manager] section in the SM configuration file contains the following parameters:
Defines whether to start the quota manager or not.
Possible values are yes and no. The default value is no.
Defines whether the quota manager should add messages about failures to the user log.
Possible values are true and false. The default value is true.
Defines whether the quota manager should add all messages to the user log.
Possible values are true and false. The default value is false.
Configuring the Quota Manager Section Example
The following is an example of a [Quota Manager] section from the SM configuration file:
How to Configure the SCA BB Application
In order for the SCA BB application to use the quota manager in the SM properly, it must be configured correctly, specifically the following are required:
–Quota management should be set to "external"
–When configuring buckets, the appropriate bucket type should be set. Available types are "Volume (L3 KBytes)" or "Number of Sessions"
–In the usage limit definitions for the appropriate service rules, the appropriate buckets should be selected. Service traffic consumes quota from the selected buckets
–The rule's breach handling action can be used to configure the level of service to assign to this traffic while the bucket is depleted
•Raw Data Records
–Set which quota raw data records (RDRs) should be generated and the rate for the remaining quota RDRs
Note To enable the application to issue quota-related indications, it should be enabled in the Cisco Service Control Application for Broadband GUI. See the Cisco Service Control Application for Broadband User Guide for configuration description.
Setting Quota Management and Buckets
This section describes how to set the quota management mode and quota buckets.
Step 1 From the Package Settings dialog box, set the quota management mode to External - replenished on external request.
Step 2 From the Package Settings dialog box set each quota bucket type accordingly.
Each bucket can be of type Volume or Session.
Figure 3-1 shows the Package Settings dialog.
Figure 3-1 Package Settings Dialog
Setting Breach Handling Rules
This section describes how to set the breach handling rules.
Step 1 From the Edit Rule for Service dialog box, set the rules to apply upon quota breach.
Figure 3-2 shows the Edit Rule for Service dialog.
Figure 3-2 Edit Rule for Service - Breach Handling
Setting Quota Bucket Service Consumption
This section describes how to set the quota buckets from which service is consumed.
Step 1 From the Edit Rule for Service dialog box, select the bucket to use for upstream and downstream traffic and select a quota bucket for session-based packages.
Figure 3-3 shows the Edit Rule for Service dialog.
Figure 3-3 Edit Rule for Service - Usage Limits
Setting the Quota RDRs
This section describes how to set the quota RDRs.
Step 1 From the RDR Settings dialog box, select the Quota RDRs tab.
Figure 3-4 shows the RDR Settings dialog.
Figure 3-4 RDR Settings
Step 2 Select the quota RDRs to be generated.
a. Quota Breach RDRs should be generated if you wish to generate an RDR when the quota is breached. It is recommended to set this.
b. Remaining Quota RDRs should be generated if you wish to keep the Quota Manager updated with the remaining quota.
It is possible to set how often these RDRs are generated and how many should be generated per second.
Note A high generation rate for these RDRs results in increased accuracy of the remaining subscriber quota; however, there is a performance penalty for having a high generation rate.
c. Quota Threshold RDRs should be generated if you wish to generate an RDR when subscriber quota drops below the defined threshold.
d. Quota State Restore RDRs must be generated. These RDRs are generated by the SCE in response to a subscriber login event.
Enabling the RDR Formatter to Issue Quota-Related Indications
This section describes how to enable the RDR formatter to issue quota-related indications by configuring the RDR formatter on the SCE.
Step 1 Configure the RDR formatter destination
#>RDR-formatter destination 127.0.0.1 port 33001 category number 4 priority 100
By default, Quota RDRs tags are mapped to category 4. If another category is required, use the following CLI command:
#>RDR-formatter rdr-mapping add tag-ID tag number category-number number
Note For Quota RDR tag IDs, see the Cisco Service Control Application for Broadband User Guide.