Add a product and under the Module Tab, please configure it as show here:
Service option names are case insensitive and spaces are ignored, eg. GBLimit, gblimit, GB limit are all the same.
If same option is listed more than once then last line takes precedence.
Here is an example of a 30mbps down and 3mbps up, with 30sec burst 32mbps/4mbps with a queue priority 5:
Permanent = yes
Port limit = 1
Session attributes = Idle-Timeout=86400 \n Mikrotik-Rate-Limit = 3M/30M 4M/32M 3M/30M 30/30 5
Calling ID login = yes
Normal attributes = Idle-Timeout=86400 \n Mikrotik-Rate-Limit = 3M/30M 4M/32M 3M/30M 30/30 5
This is a list of options available:
- Permanent - (yes/no) - should service be permanent (have no expiration date), default is no
- Duration months - (integer) - number of months non permanent service lasts before it is terminated, default is 0
- Duration days - (integer) - number of days non permanent service lasts before it is terminated, default is 0 (duration months and days are added together)
- Port limit - (integer) - number of simultaneous online sessions per service, default is 1
- Framed IP - (text) - list of single IPv4/IPv6 addresses or IPv4 ranges to assign, eg. 10.4.4.117, 2001:ffaa::, 10.0.0.10-255, 192.168.0.1-32, default is empty meaning RADIUS leaves to NAS to assign address from local pool. IPv6 ranges are not supported for now.
- Session attributes - (text) - list of RADIUS attributes set for all modes, multiple values are separated with \n, eg. Idle-Timeout=86400 \n Mikrotik-Rate-Limit=512k/5M. These attributes are set only on session start and may be overridden by NORMAL, SPECIAL or LIMITED attributes.
- Calling ID login - (yes/no) - should service be authenticated by CallingID/MAC that will serve as service username, default is no (login requires correct username and password)
- Notifications - (text) - list of usage thresholds that will trigger email notifications, in format PERCENT% OPTION, eg. 50% Hourly limit, 90% GB limit, default is empty (no notifications)
- Notification methods - (text) - list of notification methods to use, default is SMS, email (send using all methods available)
- NAS access - (text) - comma separated list of NAS IDs or NAS names matched by * wild card that are permitted to be used by this service for authentication, eg. 1, 3, *public*. Default is blank value, meaning service can connect from any NAS.
NORMAL mode
- Normal attributes - (text) - list of RADIUS attributes for NORMAL mode, syntax is same as in Session attributes. These attributes are set on NORMAL session start and on NORMAL mode change.
SPECIAL mode
- Special attributes - (text) - list of RADIUS attributes for SPECIAL mode, syntax is same as in Session attributes. These attributes are set on SPECIAL session start and on SPECIAL mode change.
- Disconnect special - (yes/no) - should services in SPECIAL mode be disconnected, default is no
- Special hours - (text) - list of hours (0-23) during which service switch to SPECIAL mode, eg. 0-8, 13, 14, 20-23
- Special days of month - (text) - list of days of month (1-31) during which service switch to SPECIAL mode, eg. 1, 2, 3, 25-31
- Special days of week - (text) - list of days of week (0-6 where 0=Sunday, 1=Monday, ..., 6=Saturday) during which service switch to SPECIAL mode, eg. 0, 6
- Special GB percent - (integer) - percent (0-100) that control how to count GB used in SPECIAL mode towards quota, default is 100
LIMITED mode
- Limited attributes - (text) - list of RADIUS attributes for LIMITED mode, syntax is same as in Session attributes. These attributes are set on LIMITED session start and on LIMITED mode change.
- Disconnect limited - (yes/no) - should services in LIMITED mode be disconnected, default is no
- Calendar monthly limit - (yes/no) - if yes then monthly limits are calculated from first day of month, otherwise limits are calculated from day service was created, default is yes
- Monthly data rollover - (yes/no) - if yes then left over from previous month is added to monthly limits, default is no
- Hourly limit - (decimal) - amount of hours online service has before it switch to LIMITED mode
- Download limit - (decimal) - amount of GB of download service has before it switch to LIMITED mode
- Upload limit - (decimal) - amount of GB of upload service has before it switch to LIMITED mode
- GB limit - (decimal) - amount of GB of download + upload service has before it switch to LIMITED mode
- Daily hourly limit - (decimal) - amount of hours per day, counter is reset at midnight
- Daily download limit - (decimal) - daily download limit in GB
- Daily upload limit - (decimal) - daily upload limit in GB
- Daily GB limit - (decimal) - daily download + upload limit in GB
- Monthly hourly limit - (decimal) - amount of hours per month, counter is reset at midnight of first day of month or day when service was created (see Calendar monthly limit option)
- Monthly download limit - (decimal) - monthly download limit in GB
- Monthly upload limit - (decimal) - monthly upload limit in GB
- Monthly GB limit - (decimal) - monthly download + upload limit in GB
If you have any questions or run into trouble, please open up a ticket and we will help you configure the first ones.