QoE Appliance - Quick Start Guide - System Release 4.8
QoE Appliance - Quick Start Guide - System Release 4.8
QoE Appliance
Cambium reserves the right to make changes to any products described herein to improve reliability,
function, or design, and reserves the right to revise this document and to make changes from time to
time in content hereof with no obligation to notify any person of revisions or changes. Cambium
recommends reviewing the Cambium Networks website for the latest changes and updates to products.
Cambium does not assume any liability arising out of the application or use of any product, software, or
circuit described herein; neither does it convey license under its patent rights or the rights of others. It is
possible that this publication may contain references to, or information about Cambium products
(machines and programs), programming, or services that are not announced in your country. Such
references or information must not be construed to mean that Cambium intends to announce such
Cambium products, programming, or services in your country.
Copyrights
This document, Cambium products, and 3rd Party software products described in this document may
include or describe copyrighted Cambium and other 3rd Party supplied computer programs stored in
semiconductor memories or other media. Laws in the United States and other countries preserve for
Cambium, its licensors, and other 3rd Party supplied software certain exclusive rights for copyrighted
material, including the exclusive right to copy, reproduce in any form, distribute and make derivative
works of the copyrighted material. Accordingly, any copyrighted material of Cambium, its licensors, or
the 3rd Party software supplied material contained in the Cambium products described in this document
may not be copied, reproduced, reverse engineered, distributed, merged or modified in any manner
without the express written permission of Cambium. Furthermore, the purchase of Cambium products
shall not be deemed to grant either directly or by implication, estoppel, or otherwise, any license under
the copyrights, patents or patent applications of Cambium or other 3rd Party supplied software, except
for the normal non-exclusive, royalty free license to use that arises by operation of law in the sale of a
product.
Restrictions
Software and documentation are copyrighted materials. Making unauthorized copies is prohibited by law.
No part of the software or documentation may be reproduced, transmitted, transcribed, stored in a
retrieval system, or translated into any language or computer language, in any form or by any means,
without prior written permission of Cambium.
License Agreements
The software described in this document is the property of Cambium and its licensors. It is furnished by
express license agreement only and may be used only in accordance with the terms of such an
agreement.
Cambium and its supplier(s) specifically disclaim any express or implied warranty of fitness for any high-
risk activities or uses of its products including, but not limited to, the operation of nuclear facilities,
aircraft navigation or aircraft communication systems, air traffic control, life support, or weapons systems
(“High Risk Use”).
This product is not restricted in the EU. Any High Risk is unauthorized, is made at your own risk and you
shall be responsible for any and all losses, damage or claims arising out of any High-Risk Use.
Wire configuration 15
Profiles 17
Burst options 20
Rules 25
APIs 26
Radius API 27
REST API 27
Contents 3
Subscriber identification 28
Policy examples 32
Glossary 44
Cambium Networks 45
Contents 4
Chapter 1: About This Guide
This Quick Start Guide assists operators in acquiring a high-level understanding of the following QoE
platform:
l Hardware
l Installation method
l Configuration.
l TCP optimization: to optimize TCP flows by working as TCP a proxy that manages the TCP
sessions by:
l Controlling the TCP flow to increase or decrease the session rate based on the session
health.
l Denial of Service (DoS) attack detection: QoE can be configured to detect DoS and generate a
report for the potential attacks. It does not act on the attack. It does not mitigate and block the
attack.
l Application Insight: QoE provides an insight into the traffic consumed by applications.
The Advantech FWA-1112VC hardware, when running on QoE, can manage and accelerate traffic up to 1
Gbps.
The default QoE appliance configuration of the system are explained in Table 1.
1 and 2, The remaining port pairs are bridged to form a wire, as follows:
4 and 5
l Ports (en0o2 and en0o3) for Wire 1 which is GigE (1 G)
2 Port (en0o3): Internet interface of Wire 1. The Internet interface is connected to this
port.
5 Port (en0o6): Internet interface of Wire 2. The Internet interface shall be connected to
this port.
Attention
Ensure that the APs and the Internet links are connected to the correct port. This is very
important for proper TCP acceleration operation. If they are swapped, the TCP optimizer
shows a warning message and impacts the optimization performance.
It is recommended that a bypass path is established between the neighboring nodes of the QoE (Access
and Internet Gateways in the diagram above). If there is a failure in the active link or the QoE, the traffic is
automatically steered through the bypass path. Such bypass link can be set up at layer-2 (Example:
Mikrotik’s active-backup link bonding or an active-backup LACP setup) or layer-3 (Example: OSPF or
BGP dynamic routing).
Note
Since the links are established directly between the two neighboring nodes, transparently
with the QoE in the middle, the link monitoring mechanism should not be electrical
(Example: MII), but based on messages (Example: ARP or fast LACP).
Figure 4 shows the bypass device connection that is connected to the external links and the QoE.
Note
Chrome, Firefox, Safari, and Microsoft Edge are supported. Click the Help icon ( ) on the top-right of
the UI to access the corresponding contextual help page.
Note
To access the management UI, navigate to https://192.168.0.121 and type the below username and
password.
l Username: admin
l Password: cambium
The home page has a lateral menu, a dashboard, and a small summary of system information.
The dashboard displays all the icons in Green. The network interfaces icon will not be in green until all the
configured wires are connected (if there are interfaces that are not used in any of the configured wires, it
remains in orange) and the icon traffic will not be in green until traffic flows through the QoE. In some
icons, clicking on them navigates to a window with more information about the QoE status.
If Cambium Networks logo is not displayed at the top-left corner of the UI, then refer to QoE Appliance
Installation Guide and execute the Step 5 of Automatic setup procedure.
l Setting timezone
l Wire configuration
IP settings include the IP address and mask, the default gateway, and the VLAN identifier (if any).
Note
Note
Do not change the network interface used for management, unless indicated by the
Cambium Networks support personnel.
3. After completing the new settings, click Apply Configuration to apply the changes.
Connecting back to the node requires access from the new subnet and logging back into the UI.
The IP address ranges allowed to access the management interface is displayed. By default, no IP
address ranges are configured, and all are allowed.
2. To add an allowed IP address range, click icon and Add IP Address Range….
When one IP address range is allowed, the firewall is enabled and all IP addresses not covered by
the configured IP address ranges are blocked.
Note
It is important to include an IP address range that includes the IP address from which
the user is accessing the UI and the subnet of the management IP address.
1. Navigate to Administration > System Date > Set Date & Time from the home page.
3. Select the time zone from the drop-down and click Apply Zone.
Wire configuration
A wire is a network interface pair processing subscriber traffic.
Wires are directional, with the first network interface connected to the access towards the
subscribers and the second interface on the Internet side.
Warning
If any mistake happens while connecting the ports, then click icon to swap.
A form allows selecting the access and Internet interfaces (the form lists the available interfaces).
Note
Do not delete the wires unless indicated by the Cambium Networks support
personnel, as misconfiguration may lead to service loss.
l A subscriber refers to an IPv4 address on the access side, or any IPv6 address from the same or 64
subnet on the access side. Refer to the Subscriber Identification section for more details.
l A flow is a TCP connection, a UDP flow, or a flow with another protocol (Example: ICMP ping). A
subscriber can have many flows at the same time.
To decide which functionality, apply to which flows or subscribers, the QoE uses the following three
concepts:
l Policies define the actions to perform on the traffic, along with action parameters (Example: a
speed limit).
l Profiles classify the traffic according to certain criteria (Example: an access profile identifies all the
traffic from subscribers whose IP address is within the set of IP address ranges in that access
profile).
l Rules relate to policies and profiles (Example, a rule may specify that some specific access profiles
are limited by a rate policy. That is, subscribers whose IP addresses are in same subnet contain a
specific rate limit).
Profiles
Profiles classify the traffic and help to determine, along with rules, which policies are applied to each
subscriber and flow. There are different profile types, according to the properties being used for
classification. To configure the profile, navigate to Configuration > Profiles from the home page.
l Interface Profile identifies the flows or subscribers whose first data packet comes in through a
network interface within the list of network interfaces specified by the interface profile.
l VLAN Profile identifies the flows or subscribers whose first data packet uses a VLAN tag within the
set of VLAN tags (or the absence of any tag) specified by the VLAN profile.
l Internet Profile identifies the flows coming from or going to an IP address on the Internet side,
contained in the set of IP address ranges specified by the Internet profile. Optionally, Internet side
ports can also be specified (Example: port 80).
l Access Profile identifies the flows or subscribers coming from or going to an IP address on the
access side, contained in the list of IP address ranges specified by the access profile. Optionally,
access side ports can also be specified.
l Time Time-based profile activates the rule during a period of time. A time profile is a list of time
ranges, and it is true if any of the ranges is true. The ranges within the same profile cannot overlap.
A range can apply to all days of the week or just to a period of days.
l Throughput Profile identifies all the flows, which are created when the total downlink traffic going
through the QoE is above the threshold specified by the throughput profile.
l DPI (Deep Packet Inspection) Profile identifies the flows that use an HTTP/HTTPS/QUIC. This
domain is included in the list of HTTP/HTTPS/QUIC domains specified by the DPI profile. There are
a set of pre-defined DPI signatures, which include the domains for popular applications (like the
most important video streaming apps or the most common software updates).
l TCP Optimization: Improves TCP traffic performance. It specifies whether to apply optimization to
TCP traffic. It is recommended to set I to ON (the default value).
l Shaping per subscriber: It limits the speed to a given value. It is possible to limit the downlink
and/or uplink direction. The limit applies to all flows matching the policy belonging to the same
subscriber. For example, if a limit of 6 Mbps is specified for video streaming, and the subscriber
has three video streaming flows from different servers, the three flows will share the 6 Mbps limit
(getting around 2 Mbps each). It is possible to define bursts that allow flows to exceed temporally
the limit.
l Shaping per flow: It limits the speed of one flow to a given value. It is possible to limit in the
downlink and/or uplink direction. The limit applies to any flow matching the policy. For example, if
video streaming flows are assigned to a per flow 2 Mbps limit, a video flow cannot exceed those 2
Mbps. Shaping per flow can be combined with shaping per subscriber. For example, if there is a
per subscriber 6 Mbps limit, and a 2 Mbps per flow, a subscriber with four flows has them limited to
the 6 Mbps maximum (around 1.5 Mbps each). Per flow shaping has no burst option. Because per-
flow shaping is not applied per subscriber, it can be used even when there is a NAT between the
QoE and the end subscribers.
l Block: It blocks all flows falling in the blocking policy, in both the directions, and does not allow to
proceed. It should be used with care, to avoid affecting traffic different to the one intended.
To configure the policies, navigate to Configuration > Subscriber Flows, and select the POLICIES tab.
Burst options
Bursts are configured under Advanced parameters of the appropriate direction (Example: Downlink
shaping). Figure 10 displays the burst threshold, shaping rate and burst rate.
l Burst Rate: the maximum rate during the burst, typically bigger than the normal shaping max rate
(Example: allow a burst of 20 Mbps for flows normally limited to 10 Mbps).
l Burst Duration: the duration of the burst, for how long the burst rate can be sustained.
l Burst Threshold: an average speed that, if exceeded, prevents a new burst from happening. It is
the way to control when a new burst can be granted. For example, for a 10 Mbps limit with 20
Mbps bursts, a 5 Mbps burst threshold will require the subscriber flows to drop the speed to half its
normal limit before allowing a new burst.
l Burst Threshold Window: the period, in seconds, used to compute the average speed that is
checked versus the threshold. The longer the window, the bigger the weight of past subscriber
activity on the decision of grating a new burst.
l Maximum downlink speed: the maximum speed in the downlink direction for all traffic going
towards the subscriber’s IP address.
l Maximum uplink speed: the maximum speed in the uplink direction for all traffic coming from the
subscriber’s IP address.
l Under Advanced Parameters, you can find the same burst options as for Subscriber Flow Policies.
l There is an Automatic Congestion Management (ACM) option, that detects congestion and select
a rate limit automatically (off by default).
Note
Policy changes takes minimum one minute to make the changes for the existing subscriber
sessions.
To enable the ACM from QoE configured Rate Policies, enable the Automatic Congestion Management of
a Subscriber Rate Policy (typically the rate-default one). Figure 13 shows enabling ACM from QoE
configured Rate Policies tab.
To enable this feature in Dynamic Rate Policies from RADIUS, navigate to Configuration > External
Subscriber Data > RADIUS and enable Automatic Congestion Management. Figure 14 shows enabling
ACM from RADIUS tab.
Rules
Rules specify which policies are assigned to each subscriber and flow, as a function of how they match
the profiles in the rule.
There are independent sets of rules for each policy type: subscriber flow rules select the appropriate
subscriber flow policy for each flow, subscriber rate rules select the appropriate subscriber rate policy for
each subscriber.
A rule can use one profile of each type (or use the any option, if the profile type is indifferent), and it
defines only one policy to apply.
Every set of rules may have many rules, but only the one with the best match will be selected for each
flow or subscriber. To evaluate the rules in a way that maximizes performance, profiles are checked in
order. This pre-defined order determines which rule is finally selected. A tree-view of the rules helps in
identifying which rule is selected in each case. See the Decision Tree sections for more information on the
trees and the profile evaluation order.
Manually configured rule priorities are not used because of the performance penalties they entail and the
burden on the operator to keep priorities consistent.
To configure the subscriber rate rules, navigate to Configuration > Subscriber Rates.
APIs
The QoE has two APIs to select subscriber rate policies, instead of using QoE local rules, that act as a
default. There are two APIs:
l Radius
l Rest
The QoE receives Radius accounting, configuring the Radius source (e.g. a PPPoE server or a RADIUS
server) to send accounting information to the QoE management IP address.
In the QoE UI, navigate to Configuration > Radius and set Radius as ON. On the top-right corner click
and select Add Client… from the upper-right menu to configure the IP address of the radius accounting
source and the secret used.
Note
The supported Radius field specifies the rate policy that is Mikrotik Address List. The address list name
must match the name given to the Subscriber Rate policy in the QoE.
REST API
A REST API allows the QoE to be integrated into an external system (Example: a billing system) to
receive instructions of which rate policy applies to the corresponding subscriber. The Rest API is based
The REST API can be used to map policies configured in the QoE to subscriber IP addresses. It also
supports defining dynamic policies, that takes precedence over any local policy. To configure the Rest
API, navigate to Configuration > REST API in the UI.
Note
Add at least one user/password to authenticate rest requests and set the toggle ON.
Optionally, the user can define the IP addresses from which the request will be allowed.
Refer to the QoE REST API Guide for more information on the QoE REST API definition.
Subscriber identification
For QoE, traffic belongs to the same subscriber if it shares the same IP address on the access side (in
IPv4), or if it is from the same /64 subnet on the access side (in IPv6).
If there is a NAT between the QoE server and the real subscribers, subscribers whose IP address is
translated to the same IP address would be considered as the same subscriber.
A new subscriber is identified when the first packet from an IP address is received. This is when the
subscriber rate rules are evaluated, to choose which policies to apply.
To view the subscriber flows decision tree, navigate to Configuration > Subscriber Flows > Rules Tree
View.
1. Interface
2. VLAN
3. Policy Rate
5. Access
6. Throughput
7. DPI
The profile evaluation order defines a decision tree, whose nodes are the different profiles and with
policies as leaves. The tree determines which rule is finally selected because a rule can be excluded if it
belongs to a branch that the decision tree does not follow. It may be the case that a flow matches more
than one rule. In that case, the rule matching the Interface profile would have priority over the rule
matching the VLAN profile, and so on in the previously specified order.
If two rules have a match with the same type of profile, the more restrictive profile would have priority.
For an example, a flow from a subscriber with IP address 192.168.0.1 would match a rule with an access
profile with the 192.168.0.0/24 range and match another rule with an access profile with the
192.168.0.0/16 range, the one with the more restrictive range, would be selected.
To facilitate the understanding of this order, the UI includes a graphic representation of the decision tree,
where the top-most matching path would lead to the selected policy (except when there is more than
one match at the same profile level when the most restrictive wins). It is accessible in Configuration >
Subscriber Flows > Rules and click the Rules Tree-View tab.
If there are common elements in two profiles of the same type and therefore a rule conflict, the decision
tree flags it so the rules can be reviewed by the operator and the conflict corrected.
2. VLAN
3. Access
In subscriber rate rules, Internet profiles and DPI profiles cannot be used, because such profiles make no
sense in policies that apply to all traffic of the same subscriber, regardless of the application.
The decision tree is like the one for subscriber flow rules. From home page, navigate to Configuration >
Subscriber Rate select RULES TREE-VIEW tab.
l Last measurement of downlink retransmissions in TCP traffic (Latest downlink TCP RTX rate) and
its average value (Average downlink TCP RTX rate).
l Last measurement, in milliseconds of the minimum access RTT (Latest RTT-min) and historical
minimum (Absolute RTT-min).
Likewise, for a given a policy, it is possible to view the number of subscriber IP addresses are under each
policy going to Status > Policies.
Click policy name to list the subscribers using that policy (more volume consumption is listed).
Also, a throughput profile is created with the traffic load from which to start limiting (above-5 Gbps in
this example). Then, a subscriber flow policy (flow-8 Mbps in the example) is created with a downlink
limit (Downlink shaping) set at 8 Mbps. Finally, the DPI profile, the throughput profile, and the subscriber
flow policy are tied together in a subscriber flow rule.
The QoE applies these limits better than a conventional shaping element because, for TCP traffic (the
most common), it does not need to discard packets. Furthermore, it uses independent queues per flow
and that makes application latencies independent of each other, which greatly improves the experience
of interactive applications. The following picture shows the queue structure, with a queue per flow and
policy control at flow and subscriber levels.
Subscribers of each data plan must be identifiable by some of the profiles currently supported by the
QoE, for example by VLAN or by IP address ranges. In the following example, three subscriber rate
policies are defined, corresponding to three rate plans (rate-100 Mbps, rate-10 Mbps, and rate-50 Mbps in
the example), and they are linked to their corresponding access profiles with three rules. Each of the
access profiles consists of a list of IP address ranges belonging to each rate plan.
l If the color is not Green, then the connection is not established, and QoE does not register with the
license server to acquire the license.
l If there is a firewall, then open TCP port 13152 for the IP addresses 146.59.206.4 (primary) and
46.26.190.166 (backup). Refer to the QoE Users Guide for steps to debug license server
connectivity issues.
The evolution over time per network interface is available in Statistics > Throughput > Interfaces.
It is possible to check how much traffic is being processed according to each of the configured policies.
For Subscriber Flows policies, it can be checked in Statistics > Throughput > Subscriber Flows Policies
and similarly for Subscriber Rate Policies and Subscriber Monitoring Policies.
The chart in Statistics > System > Latencies shows the access RTT (RTT-Down) and Internet RTT (RTT-
Up). Average minimum values are provided.
To see the number of flows per policy and per protocol, navigate to Statistics > Flow > Per Policy and
Statistics > Flow > Per Protocol respectively
For every category, you can get the distribution of the latencies (percentage of RTT samples in each
latency bin) by clicking on the icon. You can also see how that distribution changes over time. That is
the percentage of samples in each bin at different times, by clicking on the icon. To see the latency
per service, navigate to Statistics > DPI Service Analysis > Latency per Service. Figure 30 shows the
Average Internet Latency per Service page.
The hourly evolution can be obtained in Statistics > DPI Analysis > Hourly Volume per Service.
When you navigate to Statistics > Subscribers > Top by Time and Statistics > Subscribers > Top Total, the
subscriber IP addresses appears. With the biggest traffic consumption over time or the total in the period
being considered, respectively.
l Downlink failed handshake rate — SYNs per second without an answer in the direction towards the
subscribers (initialized from the Internet). The default value is 0 SYN/sec (feature is disabled). A
typical value is 50 failed handshakes per second.
l Uplink failed handshake rate — SYNs per second without an answer initialized by a subscriber. The
default value is 0 SYN/sec (feature is disabled). A typical value is 50 failed handshakes per second.
l Minimum rate— Minimum speed rate that can be considered a volumetric attack. The exact value
depends on the network speed, but the default value is 50 Mbps.
l Multiplier of subscriber rate policy— If the subscriber has a known rate policy, a threshold is
defined as multiplier * downlink limit. A typical multiplier is 3. For an example, a subscriber with a
20 Mbps plan has a DoS threshold of 3 * 20 = 60 Mbps. Figure 33 shows the DoS settings.
The DoS events are shown in Statistics > DoS Attacks. In DoS Attacks Over Time, the DoS attack events
are displayed showing its type, its duration, and parameters such as the affected subscriber IP and the
main IP contributing o the attack.
In Details of DoS Attacks all DoS events are listed, with information about the time, event type, IP address
affected, the direction of the attack (Ingress or Egress), and its duration. In SYN Attacks can be found
attacks of SYN type, with the number of failed SYN and its rate per second. In Volume Attacks, there is a
list of volumetric attacks, with information on the traffic volume and its average rate.
1. Go to: https://support.cambiumnetworks.com/files/qoe_qoe/.
3. Access the UI from the management port using the configured management IP address.
l IP address: 192.168.0.121
l Username: admin
l Password: cambium
7. After the software update is complete, the Software Installed Successfully message appears.
To activate the new software, reboot the system, or click icon for the updated software.
Glossary 44
Cambium Networks
Cambium Networks delivers wireless communications that work for businesses, communities, and cities
worldwide. Millions of our radios are deployed to connect people, places and things with a unified
wireless fabric that spans multiple standards and frequencies of fixed wireless and Wi-Fi, all managed
centrally via the cloud. Our multi-gigabit wireless fabric offers a compelling value proposition over
traditional fiber and alternative wireless solutions. We work with our Cambium certified
ConnectedPartners to deliver purpose-built networks for service provider, enterprise, industrial, and
government connectivity solutions in urban, suburban, and rural environments, with wireless that just
works.
Warranty https://www.cambiumnetworks.com/support/standard-warranty/
www.cambiumnetworks.com
Cambium Networks and the stylized circular logo are trademarks of Cambium Networks, Ltd. All other
trademarks are the property of their respective owners.
Cambium Networks 45