UISP - Global Features for Networks
This article introduces new network features for UISP. Prominently: Traffic shaping, Suspend, and NetFlow.
Table of Contents
UISP features the option to configure network management features. Instead of specific devices, those features are focused on the whole network and allow UISP to understand its complexity. In order to make those features work it is critical to have a well-defined topology view.
In order to start using advanced network features navigate to Settings > Network. The network section has several subsections:
Addresses - In this section, all network subnets can be defined. Those subnets will be then monitored by UISP and NetFlow, as well as used for Traffic shaping and Suspend features. When left empty all private subnets will be used. Basically, this section allows admins to separate their internal network from customer areas.
Netflow - This section displays the general status of the NetFlow traffic measurement; as well as a list of any router IP addresses defined in the Addresses subsection that have presented recent data flow. NetFlow can be monitored from any NetFlow compatible router, but it works best when enabled on a Ubiquiti device that has been added to the Gateways subsection. Netflow versions 5 and 9 are supported.
Traffic Shaping - Here it is possible to define if the traffic shaping should occur only on the gateway or on CPE devices as well.
Gateways - Gateways are critical for the correct behavior of advanced UISP Network features. In the Gateways subsection, admins can define and edit gateways that serve as the entry point from the Internet into the network. Only UISP-branded gateway devices (ex. UISP Console, UISP Router) or EdgeRouter devices can be set up as UISP Gateways. For larger networks, we recommend UISP-R-Pro or EdgeRouter Infinity; for mid-to-small sized networks, the UISP-Console or EdgeRouter ER-12P. Ideally with firmware v2.0.6+ as it offers all available functions while the older FW can only offer NetFlow. Detailed info about the Gateway setup can be found below in the next section.
You can either use the button 'Add new gateway' if the list is empty or click on the 'Edit' link for an already created gateway. Each gateway has its own configuration with these settings:
Device - Provide information about which EdgeRouter in the network serves as the gateway to the Internet. It is possible to have several gateways, each with a separate configuration.
WAN interface - When selected, it will automatically create a link in the Topology view from that router to the Internet. Please be aware that this doesn't work the other way (creating a data link will not create a gateway record in Network settings).
Allow NetFlow - Enable the NetFlow protocol on this router.
NetFlow Alerts - When there is no NetFlow data on the gateway for some time, an email alert will be sent out to the admins.
Allow Suspend - Enable the suspend feature on this gateway. When a suspend rule is created it will be automatically distributed to all gateways which have this option enabled.
Allow IP addresses - This is a whitelist of IP addresses that are always reachable even when a suspension is active for a customer device. The UISP Hostname IP is automatically treated as being on the whitelist, even when not explicitly stated in this list.
Allow Traffic shaping - Enable the Quality of Service feature.
WAN download speed - Can limit the amount of data flowing from the Internet to the network. This is useful when there is a limit in place from the ISP you are taking bandwidth from.
WAN upload speed - Here you can set a limit of upstream data traffic from your network to the Internet.
Allow default client limits - This setting allows to globally limit traffic for users who do not have Traffic shaping configured.
Default bandwidth - This value represents a free capacity that should be used for those clients/devices which are not limited by Traffic shaping. The number aggregates both download and upload so if the value is 1Mbps and there are 8 clients with no Traffic shaping, they will all share 1Mbps of upload and download. In the case of ideally distributed data, each client will have 64Kbps for upload and 64Kbps for download. Values of zero will block all traffic in the entire network.