UNMS v1 - Suspension and Traffic shaping


This article discusses the new advanced network features of Suspension and Traffic shaping, available for UNMS versions 0.14.0 and 1.0.0 These features strongly focus on helping ISPs manage their network. This article will cover how they work, configuration instructions and requirements needed for feature functionality.

NOTES & REQUIREMENTS: Please note that the features described in this article require the latest firmware and a correctly configured main gateway.

Table of Contents

  1. Introduction
  2. Traffic Shaping
  3. Suspension
  4. Related Articles


Back to Top

In UNMS version 0.14.0 and 1.0.0, it is recommended to perform both suspension and traffic shaping through the gateway. Alternatively, it is possible to do traffic shaping on airMAX devices as well.

There is a difference in how this is done between both versions. On version 0.14.0 traffic shaping is manually configured directly on Client Sites; while on version 1.0.0. it is possible to use the new integrated CRM module to manage suspension and traffic shaping according to ISP business plans and tariffs. The management is performed through a service created in CRM and paired with a client site. The administrator can identify whether a client site is connected to CRM by opening its dashboard in Network module:


In order to manage traffic shaping, UNMS gathers all IP addresses of all devices attached to a Client Site. Then it discards those IP addresses which are not in the defined internal network range (which can be configured in Settings > Network > Addresses). In a future update, soon to come, all management IP addresses are discarded as well at this point. For all remaining IP addresses, a rule is created on the gateway with a specified data transfer speed limit. In the case of Gateway + CPE traffic shaping, those rules are pushed to a specific CPE device, which connects a given Client Site to its parent Site.

NOTE: UNMS monitors any IP changes on shaped or suspended devices and alters the rules on the gateway or CPE accordingly.

Traffic Shaping

Back to Top

NOTE: In UNMS versions 0.14.0 / 1.0.0 traffic shaping is not supported on ONU devices. It will be added once OLT firmware 4.0.0 is released.

There are many ways to perform traffic shaping on a network. UNMS focuses on two of them:

Gateway Only: All traffic shaping rules are configured on the main gateway. It is important to make sure all internet connections are going through that device in order to make the traffic shaping work correctly. UNMS supports multiple gateways with the expectation that there won't be dozens of them. We recommend the EdgeRouter with FW 2.0.3 as a gateway device. It is possible to use FW 2.0.1 (it will not support all the functions though) but for EdgeRouters from the e50 platform, the FW 2.0.4 is required. MediaTek EdgeRouters, like ER-X, will be supported with FW 2.0.5+. Here is an article about gateway configuration options.

Gateway + CPE: It is not possible to configure the traffic shaping only on CPE devices as that may lead to conflicts with gateway settings. The gateway has to be aware that traffic shaping is enabled. It is important to mention that each traffic shaping method has its own pros and cons. Traffic shaping in UNMS is done on WLAN only (Ingress and Egress). This method lowers the load on the CPE's CPU and provides the best ratio between CPU load and traffic shaping accuracy. Please note that traffic shaping config can be inserted into a CPE only if there are no existing traffic shaping rules defined there. Supported CPE devices for this version are airMAX AC, airMAX M, and airFiber in both router and bridge modes. Be aware that at this moment ONU devices are not supported.

In addition to specific traffic shaping rules for individual Client Sites, in the sense of limitation of download/upload, UNMS allows setting global rules as well. It can be used to limit either the WAN interface of the main gateway or devices with no traffic shaping rule. It is called Default client limits and it can be set up while creating or editing the main gateway:


When 'Allow default client limits' is ON then the value from 'Default bandwidth' will be used for all devices that are not shaped by their own traffic shaping rules. The value is aggregated, so if it were set to 100 Mbps, and there are 10 connected devices, each will get a max of 10 Mbps. If it were set to zero then all traffic will stop for any device that is not shaped through their own rules.

What aggregation means? From the viewpoint of ISP when 100Mbps is provided with the aggregation of 10 then any Client Site can get 100Mbps at best (Only CPE devices from that Client Site are downloading) and 10Mbps at worst (CPE devices from all 10 Client Sites are downloading as much as they can). When aggregation is enabled, UNMS configures the gateway to provide 100Mbps to a Client Site (and all its CPE devices) at most. From that, you can also see that aggregation will not work without the gateway.


Back to Top

It is vital to have the main gateway defined in order to make the suspension feature work. The recommended device is the EdgeRouter with the appropriate firmware. The minimum is FW 2.0.1, though we would recommend using at least 2.0.3. Please note that for the e50 platform it is necessary to have 2.0.4 FW. MediaTek EdgeRouters, like ER-X, will be supported with FW 2.0.7+. 

Another requirement for functionality is customer internet connectivity through that specific gateway. Since there can be more than one gateway defined in UNMS it is vital to make sure this is correctly set up. The suspended Client Site and devices attached to it will not disconnect to UNMS and it will be still possible to manage them remotely.

Admins may set up other IP addresses which customers should be able to visit despite being in the suspended state. This is useful to allow customers to pay for the service or have access to some form of communication with the ISP. When a suspended customer tries to visit any page outside of the mentioned whitelist, the traffic is redirected to a suspension page with information about the suspension and an option to temporarily cancel it in order to allow payment.

NOTE: A suspended client's devices can still reach UNMS since the default exception is created for them. The client also has access to a suspension page where a temporary un-suspension can be performed to allow payment for the service

Related Articles

UNMS v1 - Global Features for Networks

We're sorry to hear that!