> For the complete documentation index, see [llms.txt](https://docs.gxc.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.gxc.io/docs/network-configuration-and-operations-guides/5g-onyx-portal-4.x-operations/manage-traffic.md).
# Manage Traffic
Traffic management enables effective prioritization and control of network traffic, ensuring efficient utilization of network resources and enhanced user experience.
## Application-based Policies and Resource Management
This section describes the QoS Management architecture in the Onyx solution.
* **Default Bearer** – A default bearer is the initial logical connection established when a UE initiates a data session. It provides basic connectivity between the UE and the PDN and handles best-effort data traffic with moderate QoS requirements. One default bearer is established per APN.
* **Dedicated Bearer** – A dedicated bearer is a secondary logical connection established for specific types of traffic, such as video streaming or IoT telemetry, with a tailored QoS policy. It ensures optimized performance for these specialized services, running alongside the default bearer. One dedicated bearer is established per application group.
* **APNs** – Access Point Name (APN) specify the PDNs that subscribers/UE should connect to. They are essential for routing data traffic from UE to the appropriate networks, which could be public internet or a private corporate network. One default bearer is established per APN. Each APN is associated with a QoS category, which specifies the QoS policy for the default bearer. For more information on APNs, see [*Manage APNs*](#manage-apns).
* **Applications** – Application definitions specify the traffic classification rules that distinguish between different types of data flows based on their flow characteristics (direction, protocol, peer IP address, and source and destination ports). Multiple flow classification rules can be used to define what constitutes an application. For more information on applications, see [*Manage Applications*](#manage-applications).
* **Application Groups** – Application groups categorize application definitions into different groups based on their similarities such as data rate, latency sensitivity, and reliability requirements. For example, all real-time streaming applications can be grouped into one application group, while all monitoring applications can be in another group. One dedicated bearer is established per application group. The QoS category associated with an application group specifies the QoS policy for the dedicated bearer used for data flows associated with all applications in that group. For more information on application groups, see [*Manage Application Groups*](#manage-application-groups).
* **QoS Categories** – QoS categories are predefined QoS policies that can be applied to APNs and application groups. The predefined QoS categories help simplify the QoS configuration procedure. If required, operators have the option to create their own custom QoS categories.
For APNs, the system supports the following QoS categories:
QoS Category
QCI
Priority
PDB
PELR
Use Cases
NA
5
1
100ms
10^-6
IMS signaling
High Priority Data
6
6
300ms
10^-6
Buffered video/TCP based
NA
7
7
100ms
10^-3
Live streaming
Medium Priority Data
8
8
300ms
10^-6
Buffered video/TCP based
Low Priority Data
9
9
300ms
10^-6
Buffered video/TCP based
For application groups, the system supports the following QoS categories.
* GBR type
QoS Category
QCI
Priority
PDB
PELR
Use Cases
Live Audio
1
2
100ms
10^-2
Conversational voice
Live Video
2
4
150ms
10^-3
Video/live streaming
Real-time Applications
3
3
50ms
10^-3
Real-time gaming
High Priority Data
4
5
300ms
10^-6
Non-conversation video/buffering streaming
* Non-GBR type
QoS Category
QCI
Priority
PDB
PELR
Use Cases
NA
5
1
100ms
10^-6
IMS signaling
High Priority Data
6
6
300ms
10^-6
Buffered video/TCP based
NA
7
7
100ms
10^-3
Live streaming
Medium Priority Data
8
8
300ms
10^-6
Buffered video/TCP based
Low Priority Data
9
9
300ms
10^-6
Buffered video/TCP based
* **Subscriber Groups** – Subscriber groups categorize subscribers/UE into different groups based on their usage patterns and other criteria. Subscribers within the same subscriber group share a common set of application groups. This grouping helps avoid repeating the same configuration for each subscriber/UE that must be treated on par. For example, all camera devices can be grouped into a "Cameras" group, all IoT scanners can be put into an "IoT Scanners" group, and so on. By default, the system creates the "Default" and "Mesh Nodes" subscriber groups in the network.
{% hint style="info" %}
**NOTE:** Each subscriber group is associated with a single APN. All the subscribers/UE associated with a subscriber group connect to the same APN.
{% endhint %}
{% hint style="info" %}
**NOTE:** Each subscriber/UE can be associated only with a single subscriber group.
{% endhint %}
{% hint style="info" %}
**NOTE:** All the subscribers/UE associated with a subscriber group use the same set of application groups.
{% endhint %}
{% hint style="info" %}
**NOTE:** Each subscriber group can contain multiple application groups. Within a subscriber group, the order in which application groups are prioritized determines which application group (QoS policy) is applied when there are overlapping traffic selection rules.
{% endhint %}
{% hint style="info" %}
**NOTE:** The "Mesh Nodes" subscriber group is visible only to GXC Administrators.
{% endhint %}
{% hint style="info" %}
**NOTE:** The QoS Management 2.0.0 feature works only in conjunction with Onyx Edge running software release 2.0.0 or later.
{% endhint %}
For more detailed information, refer to the *QoS Management Application Note*.
### How it Works
{% stepper %}
{% step %}
A subscriber group is associated with an APN and a set of application groups.
{% endstep %}
{% step %}
A subscriber/UE associated with the subscriber group uses the APN and application groups associated with that specific subscriber group.
{% endstep %}
{% step %}
An application group is associated with applications that classify different types of traffic based on their flow characteristics.
{% endstep %}
{% step %}
The QoS category associated with the application group decides the QoS treatment for those applications.
{% endstep %}
{% step %}
While registering with the network, the UE sends an Attach Request to the AP, which contains the APN identifying the PDN that the UE wants to connect to. The network verifies the UE's identity and checks if the UE is authorized to access the requested APN. The network establishes the default bearer and applies the QoS policy defined in the APN to the default bearer.
{% endstep %}
{% step %}
After the default bearer is established, for each application group associated with the subscriber group that the subscriber/UE is associated with, the network establishes a dedicated bearer and applies the QoS policy defined in the application group to it.
{% endstep %}
{% step %}
After the default and dedicated bearers are established, data packets are transmitted over these bearers facilitating communication between the UE and the network. While the default bearer handles general data traffic, the dedicated bearers cater to their respective application groups with defined QoS requirements.
{% endstep %}
{% step %}
At the UE and the Onyx Edge, the downlink and uplink packets are routed to the respective bearers based on the application definitions associated with the corresponding application group.
* Uplink data packets (originating from the UE) are processed and routed to the appropriate bearer based on the application definitions associated with the applications running on the UE.
* At the Onyx Edge, downlink data packets are inspected and routed to the appropriate bearers based on the application definitions associated with the corresponding application group.
{% endstep %}
{% step %}
The default and dedicated bearers are released when:
* The UE detaches from the network.
* The user session is terminated.
* Network/operator policies trigger bearer release under specific conditions.
{% endstep %}
{% endstepper %}
### Limitations
This section outlines the limitations of the QoS Management feature in this release.
1. The QoS functionality works end-to-end only with UE connected to APs that are directly connected with an Onyx Edge.
2. When application definitions are modified, changes will not affect current sessions. The modifications will only come into effect when the UE establishes a new session.
3. Downlink-only application groups are not supported. To ensure the creation of a dedicated bearer, at least one uplink rule (even if it is a dummy rule) must be included in any of its member applications.
4. A maximum of four simultaneous dedicated bearers are supported per UE.
5. It is possible that not all dedicated bearers (one per application group) will always be established. For example, due to radio resource constraints.
6. The Onyx Edge can only create up to 15 TFTs in a bearer. This is further restricted by how many TFTs can be encoded within 255 octets in the "Create Bearer Request" message. Consequently, this restricts the number of flows across all applications within an application group.
7. The Preemption Vulnerability and Preemption Capability functionality are available only for trials in this release.
### QoS Configuration
This section describes the QoS configuration workflow and the procedure.
#### QoS Configuration Workflow
QoS Configuration Workflow
QoS Configuration Workflow:
{% stepper %}
{% step %}
Create APNs.
* Specify the default bearer characteristics (associate with a predefined QoS category or define custom a QoS category).
See [*Manage APNs*](#manage-apns) *>* [*Create APNs*](#create-apns).
{% endstep %}
{% step %}
Create application definitions.
* Specify the flow classification rules.
See [*Manage Applications*](#manage-applications) *>* [*Create Applications*](#create-applications).
{% hint style="info" %}
**NOTE:** Avoid creating application definitions unless there is a specific requirement to prioritize certain types of traffic over others.
{% endhint %}
{% endstep %}
{% step %}
Create application groups.
* Specify the application group's QoS characteristics (associate with a predefined QoS category or define a custom QoS category).
* Associate the application group with application definitions.
See [*Manage Application Groups*](#manage-application-groups) *>* [*Create Application Groups*](#create-application-groups).
{% endstep %}
{% step %}
Create subscriber groups.
* Associate the subscriber group with an APN.
* Associate the subscriber group with application groups.
See *Manage Subscriber Groups > Create Subscriber Groups*.
{% hint style="info" %}
**NOTE:** By default, the system creates the "Default" and "Mesh Nodes" subscriber groups in the network. Note that the "Mesh Nodes" subscriber group is visible only to GXC Administrators.
{% endhint %}
{% hint style="info" %}
**NOTE:** Avoid creating subscriber groups unless there is a specific requirement.
{% endhint %}
{% endstep %}
{% step %}
Create subscriber accounts.
* Associate subscriber accounts with subscriber groups.
See *Manage Subscriber Accounts > Create Subscriber Accounts*.
QoS Configuration Associations
{% endstep %}
{% endstepper %}
## Manage APNs
{% hint style="info" %}
**NOTE:** You can create and manage APNs only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}
APNs serve as network identifiers to route UE traffic to a specific PDN. When a UE establishes a data connection, it must specify the APN it wants to use. The APN also specifies the QoS policy for the default bearer established between the UE and the PDN.
By default, Onyx Portal supports the following APNs:
* "internet": Used for various data services, including web browsing, email, and other Internet-related activities.
* QCI – 9
* ARP Priority Level – 15
* Aggregate Bandwidth Downlink – 100 Mbps
* Aggregate Bandwidth Uplink – 100 Mbps
* "MeshBackhaul": For use by Mesh devices in the network.
* QCI – 6
* ARP Priority Level – 15
* Aggregate Bandwidth Downlink – 200 Mbps
* Aggregate Bandwidth Uplink – 50 Mbps
{% hint style="info" %}
**NOTE:** The "MeshBackhaul" APN is visible only to GXC Administrators.
{% endhint %}
{% hint style="info" %}
**NOTE:** The default APNs cannot be deleted.
{% endhint %}
{% hint style="info" %}
**NOTE:** The default APNs cannot be renamed. APN names are case-insensitive, that is "internet" and "Internet" are treated as identical by the system.
{% endhint %}
### View APNs
**To view APNs configured in the network:**
{% stepper %}
{% step %}
In the navigation pane, click **Traffic**.
The **Traffic** page > **APNs** tab displays the list of configured APNs.
* **APN ID** – The APN's ID.
* **Aggregate BW**
* **Download** – The maximum bandwidth allowed for all non-GBR bearers per UE in the downlink direction.
* **Upload** – The maximum bandwidth allowed for all non-GBR bearers per UE in the uplink direction.
* **QoS Category** – The QoS category associated with the APN, which specifies the QoS policy for the default bearer associated with the APN—High Priority Data, Medium Priority Data, Low Priority Data, Custom.
* **QCI** – (Displayed only for custom QoS categories.) The QoS Class ID.
* **Pre-emption**
* **Priority (ARP)** – (Displayed only for custom QoS categories.) The priority level of the bearer associated with this APN relative to other bearers in the network. On a congested cell, it determines the priority of a new bearer setup request—whether to release an established bearer with a lower priority to make way for the new bearer, or to reject the new bearer setup request. Higher priority bearers, indicated by higher ARP values, are less likely to be released in favor of lower priority bearers. Preemption priority ensures that critical services, such as real-time applications, receive preferential treatment, maintaining QoS during periods of network congestion.
* **Vulnerability** – (Displayed only for custom QoS categories.) Indicates whether, during periods of network congestion, the bearer associated with this APN can be released to make way for a new bearer with a higher priority.
* **Capability** – (Displayed only for custom QoS categories.) Indicates whether, during periods of network congestion, establishment of the bearer associated with this APN could lead to the release of an established bearer with a lower priority.
* **Actions** – (GXC Administrators, GXC Partner Administrators, Super Administrators, and Administrators only.) Options to edit and delete APNs.
{% endstep %}
{% step %}
To search for a particular APN, in the Search field, enter your search term.
{% endstep %}
{% endstepper %}
### Create APNs
This section describes how to create APNs.
{% hint style="info" %}
**NOTE:** You can create APNs only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}
**To create an APN in a 5G network:**
{% stepper %}
{% step %}
In the navigation pane, click **Traffic**.
The **Traffic** page > **APNs** tab displays the list of APNs configured in the network.
{% endstep %}
{% step %}
In the upper-right corner of the page, click **Add APN**.
The **Add APN** page > **Add APN** tab is displayed.
{% endstep %}
{% step %}
In the **Add APN** tab, enter the following details:
* **ID** – (Required) The APN's ID.
{% hint style="info" %}
**NOTE:** APN names are case-insensitive, that is "internet" and "Internet" are identical in the system.
{% endhint %}
* **Aggregate BW (Upload)** – (Required) The maximum bandwidth allowed for all non-GBR bearers per UE in uplink direction in Mbps. The value must be in the range of range: 1 Mbps to 1000 Mbps. Default value: 100 Mbps.
* **Aggregate BW (Download)** – (Required) The maximum bandwidth allowed for all non-GBR bearers per UE in downlink direction in Mbps. The value must be in the range of range: 1 Mbps to 1000 Mbps. Default value: 250 Mbps.
* **QoS Category** – (Required) Click to select the APN's QoS category, which specifies the QoS policy for the default bearer associated with the APN. Default value: Low Priority Data. For more information including the QoS parameters per each category, see *QoS Categories*.
NOTE: In this release, "Low Priority Data" is the only supported QoS category.
* **Low Priority Data** – This category is suitable for non-urgent or background traffic that can tolerate delays or occasional packet loss. Examples include software updates, non-critical file transfers, and bulk data backups.
{% endstep %}
{% step %}
To save the APN, in the upper-right corner of the page, click **Save APN**.
{% endstep %}
{% endstepper %}
### Edit APNs
{% hint style="info" %}
**NOTE:** You can edit APNs only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}
**To edit an APN in a 5G network:**
{% stepper %}
{% step %}
In the navigation pane, click **Traffic**.
The **Traffic** page > **APNs** tab displays the list of APNs configured in the network.
{% endstep %}
{% step %}
For the APN that you want to edit, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.
The **Edit APN** page is displayed.
{% endstep %}
{% step %}
Edit the APN's details as required:
* **APN ID** – (Required) The APN's ID.
* **Aggregate BW (Upload)** – (Required) The maximum bandwidth allowed for all non-GBR bearers per UE in the uplink direction in Mbps.
* **Aggregate BW (Download)** – (Required) The maximum bandwidth allowed for all non-GBR bearers per UE in downlink direction in Mbps.
* **QoS Category** – (Required) Click to select the APN's QoS category. The QoS category specifies the QoS policy for the bearer associated with this APN. For more information including the QoS parameters per each category, see *QoS Categories*.
* **High Priority Data** – This category is suitable for critical data traffic that requires high-priority treatment and reliable transmission with low latency and minimal packet loss. Examples include control signals for industrial automation systems, emergency communications, and real-time transactions.
* **Medium Priority Data** – This category is suitable for important but less time-sensitive data traffic that requires reliable transmission with moderate priority and latency. Examples include email services and non-real-time communications that can tolerate some latency while still requiring reliable delivery.
* **Low Priority Data** – This category is suitable for non-urgent or background traffic that can tolerate delays or occasional packet loss. Examples include software updates, non-critical file transfers, and bulk data backups.
* **Custom** – The custom category allows for the creation of a tailored QoS policy that will be applied to all traffic associated with the APN.
* **QCI** – (Displayed only if the **QoS Category** is **Custom**. Required.) The QoS Class ID from QCI 5 to QCI 9. Default value: QCI=9.
* QCI=5 (PDB=100, PER=10^-6)
* QCI=6 (PDB=300, PER=10^-6)
* QCI=7 (PDB=100, PER=10^-3)
* QCI=8 (PDB=300, PER=10^-6)
* QCI=9 (PDB=300, PER=10^-6)
* **Pre-emption Priority** – (Displayed only if the **QoS Category** is **Custom**. Required.) The priority level of the bearer associated with this APN relative to other bearers in the network. On a congested cell, it determines the priority of a new bearer setup request—whether to release an established bearer with a lower priority to make way for the new bearer, or to reject the new bearer setup request. Higher priority bearers, indicated by higher ARP values, are less likely to be released in favor of lower priority bearers. Preemption priority ensures that critical services, such as real-time applications, receive preferential treatment, maintaining QoS during periods of network congestion.
* **Pre-emption Vulnerability** – (Displayed only if the **QoS Category** is **Custom**.) Enable or disable ARP preemption vulnerability. Specifies whether, during periods of network congestion, the bearer associated with this APN can be released to make way for a new bearer with a higher priority. To enable preemption vulnerability, turn on the toggle button. Default setting: disabled.
NOTE: The Pre-emption Vulnerability configuration is available only for trials in this release. Keep it disabled. For more information, contact GXC Technical Support.
* **Pre-emption Capability** – (Displayed only if the **QoS Category** is **Custom**.) Enable or disable ARP preemption capability. Specifies whether, during periods of network congestion, establishment of the bearer associated with this APN can lead to the release of an established bearer with a lower priority. To enable preemption capability, turn on the toggle button. Default setting: disabled.
NOTE: The Pre-emption Capability configuration is available only for trials in this release. Keep it disabled. For more information, contact GXC Technical Support.
{% endstep %}
{% step %}
To save your edits, in the upper-right corner of the page, click **Save APN**.
{% endstep %}
{% endstepper %}
### Delete APNs
{% hint style="info" %}
**NOTE:** You can delete APNs only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}
{% hint style="info" %}
**NOTE:** You can only delete APNs that are not associated with any subscriber groups.
{% endhint %}
{% hint style="info" %}
**NOTE:** You cannot delete the two default APNs available out of the box—Internet and MeshBackhaul.
{% endhint %}
**To delete an APN:**
{% stepper %}
{% step %}
In the navigation pane, click **Traffic**.
The **Traffic** page > **APNs** tab displays the list of APNs configured in the network.
{% endstep %}
{% step %}
For the APN that you want to delete, in the **Actions** column click the corresponding ⋮ (options) icon, then click **Delete**.
A confirmation dialog box is displayed.
{% endstep %}
{% step %}
To delete the APN, click **Yes**.
{% endstep %}
{% endstepper %}
## Manage Applications
{% hint style="info" %}
**NOTE:** You can create and manage applications only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}
Application definitions specify the traffic classification rules that distinguish between different types of data flows based on their flow characteristics (direction, protocol, peer IP address, and source and destination ports).
{% hint style="info" %}
**NOTE:** You can create a maximum of 15 flow classification rules per application.
{% endhint %}
The application group's order in the list of associations within a subscriber group determines which application/rule will be matched against a given flow. A flow will only ever be assigned to one application.
For example, a video streaming application deployed in cameras can have a rule like:
```
TCP traffic from local port 45000 to {Streaming server IP} port 50000 and vice versa
```
A resource-constrained monitoring application that sends status reports periodically may have rules like:
```
TCP traffic any local port to {Monitoring Server IP} port 80 and vice versa
```
```
UDP traffic from local port 46000 to {Monitoring Server IP} port 50100
```
### View Applications
**To view applications configured in the network:**
{% stepper %}
{% step %}
In the navigation pane, click **Traffic** > **Applications** tab.
The **Traffic** page > **Applications** tab displays the list of configured applications.
{% endstep %}
{% step %}
To view an application's details, click the corresponding row.
Any flow classification rules associated with the application are listed.
* **Description** – The application's description.
* **Direction** – The flow's direction—Downlink, Uplink.
* **Protocol** – The flow's communication protocol—ICMP, IP, TCP, UDP.
* **Peer IP/Subnet** – The peer IP address.
* **Peer Port** – The flow's source port number.
* **Destination Port** – The flow's destination port number.
* **Bidirectional** – Indicates if an additional rule has been created internally to match all packets (not just responses) in the reverse direction (based on the selected **Direction**)—No, Yes.
* **Actions** – (GXC Administrators, GXC Partner Administrators, Super Administrators, and Administrators only.) Click the ⋮ (options) icon to view the options to edit and delete applications.
{% endstep %}
{% endstepper %}
### Create Applications
{% hint style="info" %}
**NOTE:** You can create applications only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}
{% hint style="info" %}
**NOTE:** Avoid creating applications unless there is a specific need to prioritize certain types of traffic over others. Otherwise, unnecessary applications may increase complexity and overhead in managing the network.
{% endhint %}
**To create an application:**
{% stepper %}
{% step %}
In the navigation pane, click **Traffic** > **Applications** tab.
The **Traffic** page > **Applications** tab displays the list of configured applications.
{% endstep %}
{% step %}
In the upper-right area of the page, click **Add Application**.
The **Add Application** page is displayed.
{% endstep %}
{% step %}
Enter the following details:
* **Application**
* **Name** – (Required) The application's name. The application name can be an alphabetic, numeric, or alphanumeric string of up to 32 characters.
{% endstep %}
{% step %}
Add the flow classification rules to route traffic based on the flow characteristics. For example, to block IP traffic in the uplink direction.
{% hint style="info" %}
**NOTE:** You can create a maximum of 15 flow classification rules per application.
{% endhint %}
1. To add a flow classification rule, click **Add Flows**, and enter the following details:
* **Description** – (Optional) The rule's description.
* **Direction** – (Required) Select the flow's direction between **Uplink** (outgoing), **Downlink** (incoming), and **Bidirectional** (outgoing and incoming, the Onyx system internally creates an additional rule to match all packets (not just responses)). Default value: Bidirectional.
* **Protocol** – (Required) Select the flow's communication protocol between **ICMP**, **IP**, **TCP**, and **UDP**. Default value: IP.
* **Peer IP/Subnet** – (Optional) Enter the flow's peer IP address.
* **Peer Port** – (Optional) Enter the flow's destination port number.
* **UE Port** – (Optional) Enter the flow's source port number.
2. To save the flow classification rule, under **Actions**, click (save).
3. To discard the flow classification rule without saving it, under **Actions**, click (delete).
{% endstep %}
{% step %}
To save the application, click **Save Application**.
{% hint style="info" %}
**NOTE:** You will not be able save an application until you create and save at least one flow classification rule under it.
{% endhint %}
{% endstep %}
{% endstepper %}
### Edit Applications
{% hint style="info" %}
**NOTE:** You can edit applications only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}
{% hint style="info" %}
**NOTE:** In case application definitions are modified, the changes will not affect the current sessions. The changes will only take effect when the UE establishes a new session.
{% endhint %}
**To edit an application definition:**
{% stepper %}
{% step %}
In the navigation pane, click **Traffic** > **Applications** tab.
The **Traffic** page > **Applications** tab displays the list of configured applications.
{% endstep %}
{% step %}
For the application that you want to edit, click the corresponding ⋮ (options) icon, then click **Edit**.
The **Edit Application** page is displayed.
{% endstep %}
{% step %}
Edit the following details as required:
* **Application**
* **Application Name** – (Required) The application's name.
* **Flows**
* Add Flows:
NOTE: You can create a maximum of 15 flow classification rules per application.
1. To add a flow classification rule, click **Add Flows**, and enter the following details:
* **Description** – (Optional) The rule's description.
* **Direction** – (Required) Select the flow's direction between **Uplink** (outgoing), **Downlink** (incoming), and **Bidirectional** (outgoing and incoming, the Onyx system internally creates an additional rule to match all packets (not just responses)). Default value: Bidirectional.
* **Protocol** – (Required) Select the flow's communication protocol between **ICMP**, **IP**, **TCP**, and **UDP**. Default value: IP.
* **Peer IP/Subnet** – (Optional) Enter the flow's peer IP address.
* **Peer Port** – (Optional) Enter the flow's destination port number.
* **UE Port** – (Optional) Enter the flow's source port number.
2. To save the rule, under **Actions**, click (save).
3. To discard the rule without saving it, under **Actions**, click (delete).
* Edit Flows:
NOTE: You can create a maximum of 15 flow classification rules per application.
1. To edit a flow classification rule, click the corresponding  (edit) and edit the following details as required.
* **Description** – (Optional) The rule's description.
* **Direction** – (Required) Select the flow's direction between **Uplink** and **Downlink**. Default value: Uplink.
* **Protocol** – (Required) Select the flow's communication protocol between **ICMP**, **IP**, **TCP**, and **UDP**. Default value: IP.
* **Peer IP** – (Optional) Enter the flow's peer IP address.
* **Source Port** – (Optional) Enter the flow's source port number.
* **Destination Port** – (Optional) Enter the flow's destination port number.
* **Bidirectional** – (Required) If the Onyx system should internally create an additional rule to match all packets (not just responses) in the reverse direction (based on the selected **Direction**), select the / check box.
2. To save your edits, under **Actions**, click (save).
* Delete Flows:
To delete a flow classification rule, click the corresponding (delete) icon.
{% endstep %}
{% step %}
To save your edits, in the lower-right area of the page, click **Save Application**.
{% endstep %}
{% endstepper %}
### Delete Applications
{% hint style="info" %}
**NOTE:** You can delete applications only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}
{% hint style="info" %}
**NOTE:** You cannot delete applications that are associated with application groups.
{% endhint %}
**To delete an application definition:**
{% stepper %}
{% step %}
In the navigation pane, click **Traffic** > **Applications** tab.
The **Traffic** page > **Applications** tab displays the list of configured applications.
{% endstep %}
{% step %}
For the application that you want to delete, click the corresponding ⋮ (options) icon, then click **Delete**.
A confirmation dialog box is displayed.
{% endstep %}
{% step %}
To confirm deleting the application, click **Yes**.
{% endstep %}
{% endstepper %}
## Manage Application Groups
{% hint style="info" %}
**NOTE:** In this release, Application Groups are supported only in 4G networks.
{% endhint %}
{% hint style="info" %}
**NOTE:** You can create and manage application groups only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}
Application groups allow you to group applications together based on their common characteristics, such as similar resource usage patterns. These groups can be used as match criteria to optimize the allocation of network resources to different application groups. For instance, you could create a "Monitoring Application Group" that contains multiple monitoring applications.
### View Application Groups
**To view application groups configured in the network:**
{% stepper %}
{% step %}
In the navigation pane, click **Traffic** > **Application Groups** tab.
The **Traffic** page > **Application Groups** tab displays the list of configured application groups.
* **Name** – The application group's name.
* **Application** – The applications associated with the application group.
* **Downlink BW (Mbps)**
* **Max** – The maximum bandwidth allocated to traffic flows originating from the network or internet and traveling towards a UE. Any packets arriving at the bearer after this limit is exceeded will be discarded.
* **Guaranteed** – The minimum bandwidth allocated to traffic flows originating from the network or internet and traveling towards a UE.
* **Uplink BW (Mbps)**
* **Max** – The maximum bandwidth allocated to traffic flows originating from a UE and traveling towards the network or internet. Any packets arriving at the bearer after this limit is exceeded will be discarded.
* **Guaranteed** – The guaranteed/minimum bandwidth that will be allocated to traffic flows originating from a UE and traveling towards the network or internet.
* **QoS Category** – The application group's QoS category, which specifies the QoS policy for the bearer associated with this application group—Live Audio, Live Video, Real-time Applications, High Priority Data, or Custom. For more information see *QoS Categories*.
* **QCI** – (Displayed only for custom QoS categories.) The QoS Class Identifier assigned to the application group.
* **Pre-emption**
* **Priority (ARP)** – (Displayed only for custom QoS categories.) The priority level of the bearer associated with this application group relative to other bearers in the network. On a congested cell, it determines the priority of a new bearer setup request—whether to release an established bearer with a lower priority to make way for the new bearer, or to reject the new bearer setup request. Higher priority bearers, indicated by higher ARP values, are less likely to be released in favor of lower priority bearers. Preemption priority ensures that critical services, such as real-time applications, receive preferential treatment, maintaining QoS during periods of network congestion.
* **Vulnerability** – (Displayed only for custom QoS categories.) Indicates whether, during periods of network congestion, the bearer associated with this application group can be released to make way for a new bearer with a higher priority.
* **Capability** – (Displayed only for custom QoS categories.) Indicates whether, during periods of network congestion, establishment of the bearer associated with this application group could lead to the release of an established bearer with a lower priority.
* **Actions** – (GXC Administrators, GXC Partner Administrators, Super Administrators, and Administrators only.) Options to edit and delete application groups.
{% endstep %}
{% endstepper %}
### Create Application Groups
{% hint style="info" %}
**NOTE:** You can create application groups only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}
**To create an application group:**
{% stepper %}
{% step %}
In the navigation pane, click **Traffic** > **Application Groups** tab.
The **Traffic** page > **Application Groups** tab displays the list of configured application groups.
{% endstep %}
{% step %}
In the upper-right area of the page, click **Add Application Group**.
The **Add Application Group** page is displayed.
{% endstep %}
{% step %}
Enter the following details:
* **Application Group Name** – (Required) The application group's ID. It can be an alphabetic, numeric, or alphanumeric string of up to 32 characters.
* **Applications** – (Required) Click to select the applications to add to the group.
{% hint style="info" %}
**NOTE:** You can associate a maximum of 15 applications with an application group.
{% endhint %}
* **Downlink Max BW (Mbps)** – (Required) The maximum bandwidth that will be allocated to traffic flows originating from the network or internet and traveling towards a UE. Any packets arriving at the bearer after this limit is exceeded will be discarded. Default value: 100 Mbps.
* **Uplink Max BW (Mbps)** – (Required) The maximum bandwidth that will be allocated to traffic flows originating from a UE and traveling towards the network or internet. Any packets arriving at the bearer after this limit is exceeded will be discarded. Default value: 100 Mbps.
* **Guaranteed BW** – To reserve bandwidth for the bearer associated with this application group, select the **Guaranteed BW** check box. This parameter decides if the bearer is a GBR bearer or a non-GBR bearer. Default setting: Selected (GBR bearer).
* **Downlink Guaranteed BW (Mbps)** – (Displayed only if the **Guaranteed BW** check box is selected.) The guaranteed/minimum bandwidth that will be allocated to traffic flows originating from the network or internet and traveling towards a UE. Default value: 10 Mbps.
NOTE:Downlink Guaranteed BW must always be less than or equal to Downlink Max BW.
* **Uplink Guaranteed BW (Mbps)** – (Displayed only if the **Guaranteed BW** check box is selected.) The guaranteed/minimum bandwidth that will be allocated to traffic flows originating from a UE and traveling towards the network or internet. Default value: 10 Mbps.
NOTE:Uplink Guaranteed BW must always be less than or equal to Uplink Max BW.
Note the maximum possible GBR values for downlink and uplink based on the Subframe Assignment and Primary Cell Channel Bandwidth.
Bandwidth of the Primary Carrier
Subframe Assignment
GBR Downlink (Mbps)
GBR Uplink (Mbps)
20 MHz +
2
28
3
10 MHz
2
14
1.5
20 MHz +
6
16
8
10 MHz
6
8
4
* **QoS Category** – (Required) Click to select the application group's QoS category. The QoS category specifies the QoS policy for the application group. For more information including the QoS parameters configured per category, see *QoS Categories*.
* **Live Audio** – This category is suitable for applications and services that require real-time transmission of audio data. It ensures low latency and minimal jitter to maintain the real-time nature of the audio stream.
* **Live Video** – This category is suitable for applications and services that involve real-time transmission of video data, such as video conferencing, live streaming, or remote surveillance. It prioritizes low latency and stable throughput to support smooth video playback and minimize buffering.
* **Real-time Applications** – This category is suitable for applications and services (other than audio and video) that require real-time responsiveness and low latency, such as remote desktop applications. It provides a balance between low latency and efficient resource utilization.
* **High Priority Data** – This category is suitable for applications and services that require high-priority treatment with moderate latency, while still maintaining a high level of reliability to support time-sensitive operations. Examples include control signals for industrial automation systems and telemetry data in IoT deployments.
* **Custom** – The custom category allows for the creation of tailored QoS policies based on the needs of specific applications, services, or subscriber groups.
* **QCI** – (Displayed only if the **QoS Category** is **Custom**. Required.) Select the QoS Class Identifier.
(If the **Guaranteed BW** check box is selected.) For GBR bearer configuration, select from QCI 1 to QCI 4. Each QCI is assigned a standard Packet Delay Budget and Packet Error Rate. Default value: QCI=1.
* QCI=1 (PDB=100, PER=10^-2)
* QCI=2 (PDB=150, PER=10^-3)
* QCI=3 (PDB=50, PER=10^-3)
* QCI=4 (PDB=300, PER=10^-6)
(If the **Guaranteed BW** check box is cleared.) For non-GBR bearer configuration, select from QCI 5 to QCI 9. Default value: QCI=5.
* QCI=5 (PDB=100, PER=10^-6)
* QCI=6 (PDB=300, PER=10^-6)
* QCI=7 (PDB=100, PER=10^-3)
* QCI=8 (PDB=300, PER=10^-6)
* QCI=9 (PDB=300, PER=10^-6)
* **Pre-emption Priority (ARP)** – (Displayed only if the **QoS Category** is **Custom**. Required.) The priority level of the bearer associated with this application group relative to other bearers in the network. On a congested cell, it determines the priority of a new bearer setup request—whether to release an established bearer with a lower priority to make way for the new bearer, or to reject the new bearer setup request. Higher priority bearers, indicated by higher ARP values, are less likely to be released in favor of lower priority bearers. Preemption priority ensures that critical services, such as real-time applications, receive preferential treatment, maintaining QoS during periods of network congestion. Default value: 2.
* **Pre-emption Vulnerability** – (Displayed only if the **QoS Category** is **Custom**.) Enable or disable ARP preemption vulnerability. Specifies whether, during periods of network congestion, the bearer associated with this application group can be released to make way for a new bearer with a higher priority. To enable preemption vulnerability, turn on the toggle button. Default setting: disabled.
{% hint style="info" %}
**NOTE:** The Pre-emption Vulnerability configuration is available only for trials in this release. Keep it disabled. For more information, contact GXC Technical Support.
{% endhint %}
* **Pre-emption Capability** – (Displayed only if the **QoS Category** is **Custom**.) Enable or disable ARP preemption capability. Specifies whether, during periods of network congestion, establishment of the bearer associated with this application group can lead to the release of an established bearer with a lower priority. To enable preemption capability, turn on the toggle button. Default setting: disabled.
{% hint style="info" %}
**NOTE:** The Pre-emption Capability configuration is available only for trials in this release. Keep it disabled. For more information, contact GXC Technical Support.
{% endhint %}
{% endstep %}
{% step %}
To save the application group, in the lower-right corner of the page, click **Save Application Group**.
{% endstep %}
{% endstepper %}
### Edit Application Groups
{% hint style="info" %}
**NOTE:** You can edit application groups only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}
**To edit an application group:**
{% stepper %}
{% step %}
In the navigation pane, click **Traffic** > **Application Groups** tab.
The **Traffic** page > **Application Groups** tab displays the list of configured application groups.
{% endstep %}
{% step %}
For the application group that you want to edit, in the **Actions** column click the corresponding ⋮ (options) icon, then click **Edit**.
The **Edit Application Group** page displays the application group's details.
{% endstep %}
{% step %}
Edit the following details as required:
* **Name** – (Required) The application group's name.
* **Applications** – (Required) Click to add or remove applications from the group— select or clear the corresponding check boxes.
{% hint style="info" %}
**NOTE:** You can associate a maximum of 15 applications with an application group.
{% endhint %}
* **Downlink Max BW (Mbps)** – (Required) The maximum bandwidth that will be allocated to traffic flows originating from the network or internet and traveling towards a UE. Any packets arriving at the bearer after this limit is exceeded will be discarded. Default value: 100 Mbps.
* **Uplink Max BW (Mbps)** – (Required) The maximum bandwidth that will be allocated to traffic flows originating from a UE and traveling towards the network or internet. Any packets arriving at the bearer after this limit is exceeded will be discarded. Default value: 100 Mbps.
* **Guaranteed BW** – To reserve bandwidth for the application group, select the **Guaranteed BW** check box. This parameter decides if the bearer is a GBR bearer or a non-GBR bearer. Default setting: selected (GBR bearer).
* **Downlink Guaranteed BW (Mbps)** – (Displayed only if the **Guaranteed BW** check box is selected.) The guaranteed/minimum bandwidth that will be allocated to traffic flows originating from the network or internet and traveling towards a UE. Default value: 10 Mbps.
NOTE:Downlink Guaranteed BW must always be less than or equal to Downlink Max BW.
* **Uplink Guaranteed BW (Mbps)** – (Displayed only if the **Guaranteed BW** check box is selected.) The guaranteed/minimum bandwidth that will be allocated to traffic flows originating from a UE and traveling towards the network or internet. Default value: 10 Mbps.
NOTE:Uplink Guaranteed BW must always be less than or equal to Uplink Max BW.
Note the maximum possible GBR values for downlink and uplink based on the Subframe Assignment and Primary Cell Channel Bandwidth.
Bandwidth of the Primary Carrier
Subframe Assignment
GBR Downlink (Mbps)
GBR Uplink (Mbps)
20 MHz +
2
28
3
10 MHz
2
14
1.5
20 MHz +
6
16
8
10 MHz
6
8
4
* **QoS Category** – (Required) Click to select the application group's QoS category. The QoS category specifies the QoS policy for the application group. For more information including the QoS parameters configured per category, see *QoS Categories*.
* **Live Audio** – This category is suitable for applications and services that require real-time transmission of audio data. It ensures low latency and minimal jitter to maintain the real-time nature of the audio stream.
* **Live Video** – This category is suitable for applications and services that involve real-time transmission of video data, such as video conferencing, live streaming, or remote surveillance. It prioritizes low latency and stable throughput to support smooth video playback and minimize buffering.
* **Real-time Applications** – This category is suitable for applications and services (other than audio and video) that require real-time responsiveness and low latency, such as remote desktop applications. It provides a balance between low latency and efficient resource utilization.
* **High Priority Data** – This category is suitable for applications and services that require high-priority treatment with moderate latency, while still maintaining a high level of reliability to support time-sensitive operations. Examples include control signals for industrial automation systems and telemetry data in IoT deployments.
* **Custom** – The custom category allows for the creation of tailored QoS policies based on the needs of specific applications, services, or subscriber groups.
* **QCI** – (Displayed only when the **Custom** QoS category is selected. Required.) Select the QoS Class Identifier.
(If the **Guaranteed BW** check box is selected.) For GBR bearer configuration, select from QCI 1 to QCI 4. Each QCI is assigned a standard Packet Delay Budget and Packet Error Rate. Default value: QCI=1.
* QCI=1 (PDB=100, PER=10^-2)
* QCI=2 (PDB=150, PER=10^-3)
* QCI=3 (PDB=50, PER=10^-3)
* QCI=4 (PDB=300, PER=10^-6)
(If the **Guaranteed BW** check box is cleared.) For non-GBR bearer configuration, select from QCI 5 to QCI 9. Default value: QCI=5.
* QCI=5 (PDB=100, PER=10^-6)
* QCI=6 (PDB=300, PER=10^-6)
* QCI=7 (PDB=100, PER=10^-3)
* QCI=8 (PDB=300, PER=10^-6)
* QCI=9 (PDB=300, PER=10^-6)
* **Pre-emption Priority (ARP)** – (Displayed only if the **QoS Category** is **Custom**. Required.) The priority level of the bearer associated with this application group relative to the other bearers in the network. On a congested cell, it determines the priority of a new bearer setup request—whether to release an established bearer with a lower priority to make way for the new bearer, or to reject the new bearer setup request. Higher priority bearers, indicated by higher ARP values, are less likely to be released in favor of lower priority bearers. Preemption priority ensures that critical services, such as real-time applications, receive preferential treatment, maintaining QoS during periods of network congestion. Default value: 2.
* **Pre-emption Vulnerability** – (Displayed only if the **QoS Category** is **Custom**.) Enable or disable ARP preemption vulnerability. Specifies whether, during periods of network congestion, the bearer associated with this application group can be released to make way for a new bearer with a higher priority. To enable preemption vulnerability, turn on the toggle button. Default setting: disabled.
{% hint style="info" %}
**NOTE:** The Pre-emption Vulnerability configuration is available only for trials in this release. Keep it disabled. For more information, contact GXC Technical Support.
{% endhint %}
* **Pre-emption Capability** – (Displayed only if the **QoS Category** is **Custom**.) Enable or disable ARP preemption capability. Specifies whether, during periods of network congestion, establishment of the bearer associated with this application group can lead to the release of an established bearer with a lower priority. To enable preemption capability, turn on the toggle button. Default setting: disabled.
{% hint style="info" %}
**NOTE:** The Pre-emption Capability configuration is available only for trials in this release. Keep it disabled. For more information, contact GXC Technical Support.
{% endhint %}
{% endstep %}
{% step %}
To save your edits, click **Save Application Group**.
{% endstep %}
{% endstepper %}
### Delete Application Groups
{% hint style="info" %}
**NOTE:** You can delete application groups only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}
**To delete an application group:**
{% stepper %}
{% step %}
In the navigation pane, click **Traffic** > **Application Groups** tab.
The **Traffic** page > **Application Groups** tab displays the list of configured application groups.
{% endstep %}
{% step %}
For the application group that you want to delete, in the **Actions** column click the corresponding ⋮ (options) icon, then click **Delete**.
A confirmation dialog box is displayed.
{% endstep %}
{% step %}
To confirm deleting the application group, click **Yes**.
{% endstep %}
{% endstepper %}
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.gxc.io/docs/network-configuration-and-operations-guides/5g-onyx-portal-4.x-operations/manage-traffic.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
(save).
3. To discard the flow classification rule without saving it, under **Actions**, click 
(delete).
{% endstep %}
{% step %}
To save the application, click **Save Application**.
{% hint style="info" %}
**NOTE:** You will not be able save an application until you create and save at least one flow classification rule under it.
{% endhint %}
{% endstep %}
{% endstepper %}
### Edit Applications
{% hint style="info" %}
**NOTE:** You can edit applications only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}
{% hint style="info" %}
**NOTE:** In case application definitions are modified, the changes will not affect the current sessions. The changes will only take effect when the UE establishes a new session.
{% endhint %}
**To edit an application definition:**
{% stepper %}
{% step %}
In the navigation pane, click **Traffic** > **Applications** tab.
The **Traffic** page > **Applications** tab displays the list of configured applications.
{% endstep %}
{% step %}
For the application that you want to edit, click the corresponding ⋮ (options) icon, then click **Edit**.
(save).
3. To discard the rule without saving it, under **Actions**, click 
(delete).
* Edit Flows:
/
check box.
2. To save your edits, under **Actions**, click 
(save).
* Delete Flows:
To delete a flow classification rule, click the corresponding 
(delete) icon.
{% endstep %}
{% step %}
To save your edits, in the lower-right area of the page, click **Save Application**.
{% endstep %}
{% endstepper %}
### Delete Applications
{% hint style="info" %}
**NOTE:** You can delete applications only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}
{% hint style="info" %}
**NOTE:** You cannot delete applications that are associated with application groups.
{% endhint %}
**To delete an application definition:**
{% stepper %}
{% step %}
In the navigation pane, click **Traffic** > **Applications** tab.
The **Traffic** page > **Applications** tab displays the list of configured applications.
{% endstep %}
{% step %}
For the application that you want to delete, click the corresponding ⋮ (options) icon, then click **Delete**.
