Home Products Store Blog Users Contact

Service option examples

Service options examples

One time 1 month of service with download limit of 50GB, service is terminated after a month or when GB limit is reached. Email and SMS notifications are sent when 50%, 80% and 100% of download limit is used:

Permanent = no
Duration months = 1
Download limit = 50
Disconnect limited = yes
Notifications = 50% Download Limit, 80% Download Limit, 100% Download Limit
Notification methods = email, SMS

One time 1 month of service, with default rate limit of 10Mbit/1Mbit of download/upload, Idle-Timeout of 24 hours and download limit of 50GB. Service is terminated after a month. If download limit is exhausted rate is reduced to 256Kbit/64Kbit. MikroTik router is used. Session has IP address assigned by NAS from local pool with name residential:

Permanent = no
Duration months = 1
Download limit = 50
Disconnect limited = no
Session attributes = Idle-Timeout = 86400 \n Framed-Pool=residential
Normal attributes = Mikrotik-Rate-Limit = 1M/10M
Limited attributes = Mikrotik-Rate-Limit = 64k/256k

Permanent monthly recurring service (will never expire) that has default rate limit of 10Mbit/1Mbit and monthly limit of 100 GB for upload+download of transfer from first day in month. When limit is exhausted speed is reduced to 512k/128k for the rest of the month. Full speed can be unlocked again for current month with top-up that extends monthly GB limit. MikroTik router is used:

Permanent = yes
Monthly GB limit = 100
Disconnect limited = no
Normal attributes = Mikrotik-Rate-Limit = 1M/10M
Limited attributes = Mikrotik-Rate-Limit = 128k/512k

Permanent prepaid service (will never expire) that has default rate limit of 10Mbit/1Mbit and double the speed from 20:00 in the evening to 06:00 in morning over workdays, and whole day over Saturdays and Sundays (SPECIAL mode). GB used during SPECIAL mode is counted only 25% towards default quota of 100 GB. Service will end only when GB limit is exhausted. Service will be available again only with top-up that extends GB limit. MikroTik router is used:

Permanent = yes
GB limit = 100
Disconnect limited = yes
Normal attributes = Mikrotik-Rate-Limit = 1M/10M
Special attributes = Mikrotik-Rate-Limit = 2M/20M
Special hours = 20-23, 0-5
Special days of week = 0, 6
Special GB percent = 25

RADIUS attribute assignment rules

There are 4 options that control how RADIUS attributes are assigned to session:

• Session attributes (attributes used with every session, regardless of mode)
• Normal attributes (active only during NORMAL mode, will override existing attributes with same name)
• Special attributes (active only during SPECIAL mode)
• Limited attributes (active only during LIMITED mode)

Important: Session attributes option define immutable properties of session, like framed address. Because these properties can't be changed, client must disconnect and reconnect again.

Important: Not all RADIUS attributes can be used as Normal, Special and Limited attributes. Only attributes that define mutable properties of session can be used (explained below). You must set attribute value for every mode you use (as Mikrotik-Rate-Limit shown in example below) so mode change can override old value. In practice, they should be used only to change rate limits and similar properties.

If service has set up like this (options that are not of interest are not shown):

...
Session attributes = Idle-Timeout=86400 \n Framed-Pool=residential
Normal attributes = Mikrotik-Rate-Limit = 1M/10M
Special attributes = Mikrotik-Rate-Limit = 2M/20M
Limited attributes = Mikrotik-Rate-Limit = 128k/512k
...

In moment of service start if mode is NORMAL, session will have this RADIUS attributes combined from Session attributes and Normal attributes options:

Idle-Timeout=86400
Framed-Pool=residential
Mikrotik-Rate-Limit = 1M/10M

If by any chance session is starting eg. over night while SPECIAL mode is active, these RADIUS attributes will be set:

Idle-Timeout=86400
Framed-Pool=residential
Mikrotik-Rate-Limit = 2M/20M

And if service has eg. monthly GB limit reached, when LIMITED mode is active, service will start with these attributes:

Idle-Timeout=86400
Framed-Pool=residential
Mikrotik-Rate-Limit = 128k/512k

Once service is running and mode changes, eg. from NORMAL to SPECIAL then service will be updated with CoA request that holds only attributes from Special attributes option:

Mikrotik-Rate-Limit = 2M/20M

Similarly, if limit is reached and mode is changed to LIMITED, these are sent using CoA request:

Mikrotik-Rate-Limit = 128k/512k

RADIUS attributes used with mode changes

Important: Attributes not listed below can only be used in Session attributes.

Which RADIUS attributes are permitted in Normal, Special and Limited attributes depends on type and version of NAS receiving CoA request. Consult NAS documentation for more details. RFC 3576 listed attributes should be supported by all devices.

Additional MikroTik supported attributes:

Mikrotik-Group
Mikrotik-Recv-Limit
Mikrotik-Xmit-Limit
Mikrotik-Rate-Limit
Ascend-Data-Rate (only if Mikrotik-Rate-Limit is not present)
Ascend-XMit-Rate (only if Mikrotik-Rate-Limit is not present)
Mikrotik-Mark-Id
Filter-Id
Mikrotik-Advertise-Url
Mikrotik-Advertise-Interval
Session-Timeout
Idle-Timeout
Port-Limit

Additional Cisco supported attributes:

Cisco-AVPair (with vendor specific commands)

Common errors

Using wrong options in notification

Common mistake is to list wrong options under Notifications. This will prevent notifications from working as expected.

Wrong:

...
Monthly GB limit = 120
Notifications = 50% Download Limit, 80% Download Limit
...

Right:

...
Monthly GB limit = 120
Notifications = 50% Monthly GB Limit, 80% Monthly GB Limit
...

Using RADIUS attributes that can't work with mode changes

Framed-Pool is immutable session property and it must be placed in Session attributes. It should never be set using Normal, Special or Limited attributes.

In wrong example below, session will get correct framed pool and timeout only if it starts during NORMAL mode. If it starts during LIMITED or SPECIAL mode no pool or timeout will be set. When mode changes from LIMITED or SPECIAL to NORMAL, timeout will be set (Idle-Timeout can be used with modes) but framed pool will not (Framed-Pool can't be used with modes). NAS will either silently ignore this change or reject request completely (depending on NAS type) which will log CoA-Error event.

Wrong:

...
Normal attributes = Idle-Timeout=86400 \n Framed-Pool=residential
...

Right:

...
Session attributes = Idle-Timeout=86400 \n Framed-Pool=residential
...

Using mode attribute in Session attributes

Mikrotik-Rate-Limit (or any other mode attribute) should not be placed in Session attributes unless you don't want same rate limit (property value) regardless of mode. Set them using Normal, Special and Limited attributes if you wish to change them trough modes.

In wrong example below, when session changes mode from LIMITED to NORMAL rate limit will stay 256k/512k instead of 1M/10M.

Wrong:

...
Session attributes = Framed-Pool=residential \n Mikrotik-Rate-Limit = 1M/10M
Limited attributes = Mikrotik-Rate-Limit = 256k/512k
...

Right:

...
Session attributes = Framed-Pool=residential 
Normal attributes = Mikrotik-Rate-Limit = 1M/10M
Limited attributes = Mikrotik-Rate-Limit = 256k/512k
...

Forgetting to set mutable attribute for every mode used

Mikrotik-Rate-Limit is not set using Normal attributes.

In wrong example below, when session changes mode from LIMITED to NORMAL rate limit will stay 256k/512k instead of 1M/10M.

Wrong:

...
Limited attributes = Mikrotik-Rate-Limit = 256k/512k
...

Right:

...
Normal attributes = Mikrotik-Rate-Limit = 1M/10M
Limited attributes = Mikrotik-Rate-Limit = 256k/512k
...