This is an old revision of the document!


mod_feature_capping.pm

Implements traffic or session time based capping defined using certain attributes that can be set at a group or user level.

Defines a maximum traffic usage allowed by the user/group. This value is in Mbyte.

If unset, this value is taken as undefined which translates to 0, this means prepaid.

If this value is set to 0 it is taken as unlimited, or uncapped.

SMRadius-Capping-Traffic-Limit  :=  500

Defines a maximum session time allowed by the user/group. This value is in minutes.

If unset, this value is taken as undefined which translates to 0, this means prepaid.

If this value is set to 0 it is taken as unlimited, or uncapped.

SMRadius-Capping-Uptime-Limit  :=  500

This attribute is a modifier for traffic limit. The limit for traffic will be multiplied by this value so that the effective traffic limit can be set to a portion of the total limit. Note - this attribute is commonly added to the clients as a client attribute. The advantage is being able to select a portion of users in a larger pool of users who are allowed additional traffic usage, or less traffic usage as needed.

SMRadius-Config-Capping-Traffic-Multiplier  :=  0.5

This attribute is a modifier for uptime limit. The limit for uptime will be multiplied by this value so that the effective uptime limit can be set to a portion of the total limit. Note - this attribute is commonly added to the clients as a client attribute. The advantage is being able to select a portion of users in a larger pool of users who are allowed additional uptime, or less uptime as needed.

SMRadius-Config-Capping-Uptime-Multiplier  :=  0.5

The amount of additional traffic in megabytes which the user can consume outside of the normal traffic limit before being disconnected and denied login. This attribute is set by the server using mod_config_sql_topups.pm.

The amount of additional uptime in minutes which the user can remain online for before being disconnected and denied login. This attribute is set by the server using mod_config_sql_topups.pm.

post_auth_hook

Runs the checks based on attribute configuration to determine whether or not traffic or uptime limits have been reached. Runs at the post authentication stage.

post_acct_hook

Runs the checks based on attribute configuration to determine whether or not traffic or uptime limit have been reached. Runs at the post authentication stage.