# 4G & 5G Onyx Portal 3.1.0 Release Notes
## Release Information
This release note provides information about the 4G and 5G Onyx Portal 3.1.0 release.
### Component Compatibility Information
This release has been verified to be compatible with the following component releases.
Component Compatibility Information for 4G Networks
| Component | Release |
|---|
| Onyx Portal | 3.1.0 |
| Onyx Edge | 3.1.0 |
| GM01 Mesh Node | 3.0.0 |
| G100 Indoor Access Point | BaiBLQ_3.1.14 |
| G101 Outdoor Access Point | BaiBLQ_3.1.14 |
| G501 Outdoor Access Point | BaiBLQ_3.1.14 |
Component Compatibility Information for 5G Networks
| Component | Release |
|---|
| Onyx Portal | 3.1.0 |
| Onyx Edge | 3.1.0 |
| Onyx FHM (Beta Release) | 1.5.3
For details, contact GXC Technical Support. |
G105-n48F Indoor Access Point
G105-n48P Indoor Access Point
G105-n78F Indoor Access Point
G105-n78P Indoor Access Point
G505-n48P Outdoor Access Point
G505-n78P Outdoor Access Point
G506-n77 Outdoor Access Point | For details, contact GXC Technical Support. |
## New Features, Enhancements, and Behavior Changes
This section describes new features, enhancements, and behavior changes introduced in the Onyx Portal in this release.
### Alerts, Rules, and Notifications
This section describes changes to alerts, alert rules, and alert notifications in this release.
#### 5G Predefined Alert Rules
{% hint style="info" %}
**NOTE:** This change is applicable only to 5G networks.
{% endhint %}
The following predefined alert rules are now supported in 5G networks.
| Type | Module | Predefined Alert Rule Name |
|---|
| Access Point | CU Plane | Cell Service Down |
| Access Point | Domain Proxy | CBSD Lesser BW Granted |
| Access Point | Domain Proxy | CBSD New Grant |
| Access Point | Domain Proxy | CBSD Preferred Frequency Unavailable |
| Access Point | Domain Proxy | CBSD Registration Failure |
| Access Point | Management Plane | Offline |
| Access Point | MCU Plane | Cell Unwarranted Transmission |
| Access Point | S Plane | Timing Out of Sync |
| Onyx Edge (Core) | Control Plane | NG Setup Failure |
| Onyx Edge (Core) | Management Plane | Offline |
| Onyx Edge (Core) | MCU Plane | Service Down |
| Onyx Edge (Core) | Platform | CPU Usage Alert |
| Onyx Edge (Core) | Platform | Disk Usage Alert |
| Onyx Edge (Core) | Platform | Memory Usage Alert |
| Onyx Edge (Core) | Provisioning Server | Provisioning Server Connection Failure |
| Onyx Edge (NR) | Control Plane | F1 Setup Failure |
| Onyx Edge (NR) | Control Plane | RRC Security Mode Failure |
| Onyx Edge (NR) | Control Plane | RRC Setup Failure |
| Onyx Edge (NR) | Management Plane | Offline |
| Onyx Edge (NR) | MCU Plane | Service Down |
| Onyx Edge (NR) | Platform | CPU Usage Alert |
| Onyx Edge (NR) | Platform | Disk Usage Alert |
| Onyx Edge (NR) | Platform | Memory Usage Alert |
| Onyx Edge (NR) | Provisioning Server | Provisioning Server Connection Failure |
| Orchestrator | Domain Proxy | SAS Connection Failure |
For detailed information on these alert rules, refer to the *5G Onyx Portal Alerts Reference*.
#### Modified Pre-defined Alert Type
{% hint style="info" %}
**NOTE:** This change is applicable to both 4G and 5G networks.
{% endhint %}
The predefined alert type "Onyx Edge" has been modified to "Onyx Edge (Core)" to differentiate between 5G Core and NR alerts. In 4G networks, the alert type is now reciprocally "Onyx Edge (Core)".
{% hint style="info" %}
**NOTE:** After migration to Onyx 3.1.0 release, any previously firing alerts will be cleared and re-triggered if the trigger condition persists.
{% endhint %}
### Onyx Portal Updates for Enhanced Functionality and Usability
The following Onyx Portal updates enhance user experience and improve functionality.
#### Additional Onyx Edge Details
{% hint style="info" %}
**NOTE:** This change is applicable to both 4G and 5G networks.
{% endhint %}
The Onyx Edge Details page now includes the following additional details. (**Equipment** > **Onyx Edge** tab > Onyx Edge details page > **Overview** tab > **Onyx Edge Details** section > **More Info >>**.)
* **Hardware UUID** (Previously existing, now displayed in the **More Details** dialog box.)
* **Challenge Key** (Previously existing, now displayed in the **More Details** dialog box.)
* **AGW User Configuration** (New in this release.)
* **AGW User SSH Key** (New in this release.)
#### Onyx Edge Software Version Display Format
{% hint style="info" %}
**NOTE:** This change is applicable to both 4G and 5G networks.
{% endhint %}
The Onyx Edge details page now displays the current Onyx Edge software version in a shortened, more readable format instead of the full-length format. (**Equipment** > **Onyx Edge** tab > Onyx Edge details page > **Overview** tab > **ONYX Edge Details** section > **Version** (in 4G networks) / **NR Version**, **Core Version** (in 5G networks).)
#### Onyx Edge "Control Plane Transaction Status" Label Renamed to "UE Attach Status"
{% hint style="info" %}
**NOTE:** This change is applicable to both 4G and 5G networks.
{% endhint %}
In the Onyx Edge summary page, the **Control Plane Transaction Status** label has been renamed to **UE Attach Status**. (**Equipment** > **Onyx Edge** tab.)
#### Additional AP Details
{% hint style="info" %}
**NOTE:** This change is applicable to both 4G and 5G networks.
{% endhint %}
The AP details page now includes the following additional details. (**Equipment** > **Access Points** tab > AP Details page > **Overview** tab > **RAN** section > **SAS Status** section.)
* **Heartbeat Interval** – The time interval (in seconds) at which the CBSD sends heartbeat messages to the SAS to confirm continued operation on the assigned frequency.
* **Grant Expiry Time** – The SAS grant's expiration time, after which the CBSD must renew its authorization to continue operating.
* **Transmit Expiry Time** – The transmit expiry time, at which the device's current grant will expire if not renewed or extended via heartbeat messages.
#### Additional Subscriber Details
{% hint style="info" %}
**NOTE:** This change is applicable only to 4G networks.
{% endhint %}
The Subscriber details page now includes the following additional details. (**Subscribers** > Subscriber details page > **Overview** tab > **Subscriber Details** section > **IMEISV** parameter.)
* **IMEISV** – The subscriber's/UE's International Mobile Equipment Identity – Software Version (IMEISV), a unique identifier for the UE, including its software version.
#### GPS Coordinates as Alternate Location Input
{% hint style="info" %}
**NOTE:** This change is applicable to both 4G and 5G networks.
{% endhint %}
When adding venues, in addition to address-based input, the Onyx Portal now supports GPS coordinates (latitude and longitude) as an alternative. This enhancement enables precise location input, even when an address is unavailable, such as in remote or unlisted areas. The option to enter either an address or GPS coordinates is now available in the Add Venue and Edit Venue pages.
#### International Addresses in Onyx Portal
{% hint style="info" %}
**NOTE:** This change is applicable to both 4G and 5G networks.
{% endhint %}
In previous releases, the Onyx Portal only allowed U.S.-based addresses (zip codes). With this release, the Onyx Portal supports adding partners, customers, venues, etc. with international addresses.
### Equipment Software Upgrade Permissions for Super Users
{% hint style="info" %}
**NOTE:** This change is applicable to both 4G and 5G networks.
{% endhint %}
In previous releases, only GXC Administrators could manage software upgrades for the Onyx Edge, Access Point, and Mesh Node equipment. With this release, Super Admin users in GXC Partner accounts can also perform these software upgrades.
### ONYX Edge in Core-Only Configuration
{% hint style="info" %}
**NOTE:** This change is applicable only to 5G networks.
{% endhint %}
This release supports the following Onyx Edge deployment configurations:
* **Onyx Edge Core** – New in this release. This deployment configures the Onyx Edge to function as 5G Core-only, with the gNB external to the Onyx Edge. It is used when integrating third-party gNB and is offered with limited support. For more information on Onyx Edge Core configuration, please contact GXC Technical Support.
* **Onyx Edge NR+Core** – Previously supported in 5G Onyx 3.0.0 Release. This is the standard 5G deployment model, where an Onyx Edge runs both New Radio (NR) and 5G Core on the same server.
Onyx Portal > **Equipment** page tabbing behavior:
* If a 5G network includes only Onyx Edge (Core) or only Onyx Edge (NR+Core), the **Equipment** page > **Onyx Edge** tab displays the summary details of all Onyx Edge configured in the network based on the deployment type.
* If a 5G network includes both Onyx Edge (Core) and Onyx Edge (NR+Core):
* The **Equipment** page > **Onyx Edge (NR+Core)** tab displays the summary details of all Onyx Edge (NR+Core) configured in the network.
* The **Equipment** page > **Onyx Edge (Core)** tab displays the summary details of all Onyx Edge (Core) configured in the network.
Administrator users can add, edit, delete Onyx Edge (Core), and manage software upgrades for Onyx Edge (Core) equipment in their 5G networks. For more information, refer to the *5G Onyx Portal Operations Guide*.
### Onyx Edge 5G in VLAN Mode
{% hint style="info" %}
**NOTE:** This change is applicable only to 5G networks.
{% endhint %}
In addition to the NAT networking mode available in 5G Onyx 3.0.0 Release, Onyx Edge 5G now supports the VLAN mode, providing greater flexibility for Onyx Edge deployments. For more information, refer to the *5G Onyx Portal Operations Guide*.
### "S1 Same as SGi" Configuration Support in VLAN Mode
{% hint style="info" %}
**NOTE:** This change is applicable only to 4G networks.
{% endhint %}
In previous releases, the Onyx Edge in VLAN mode configuration required separate configurations for S1 and SGi interfaces. With this release, a "S1 same as SGi" configuration is now supported, which can be configured provided SGi uses the same VLAN as the management interface. This enhancement enables a completely flat network that expects only a single interface on the Onyx Edge. For more information, refer to the *4G Onyx Portal Operations Guide*.
### APN - Default Aggregate Bandwidth Configuration
{% hint style="info" %}
**NOTE:** This change is applicable to both 4G and 5G networks.
{% endhint %}
The following default aggregate bandwidth values have been updated in this release, improving network capacity—particularly improving downlink performance for 4G networks and both uplink and downlink performance for 5G networks.
* 4G Networks:
* Aggregate Bandwidth (Uplink): 100 Mbps (No change)
* Aggregate Bandwidth (Downlink): 250 Mbps (Increased from 100 Mbps)
* 5G Networks:
* Aggregate Bandwidth (Uplink): 2000 Mbps (Increased from 1000 Mbps)
* Aggregate Bandwidth (Downlink): 2000 Mbps (Increased from 1000 Mbps)
### Expanded Support for AP Device Class, 5G NR Band, Carrier, 10-Slot TDD Pattern
{% hint style="info" %}
**NOTE:** This change is applicable only to 5G networks.
{% endhint %}
In 5G networks, the Onyx system now supports:
* G506-n77 AP device class
* 5G NR band N77
* 50 MHz carrier for N77 band
* 10-Slot TDD Patterns – In addition to existing TDD configurations, Onyx Edge 5G now supports the "DL 77%, UL 21% (DDDDDDDSUU)" 10-slot TDD pattern.
### Fronthaul Multiplexer Equipment Support
{% hint style="info" %}
**NOTE:** This change is applicable only to 5G networks.
{% endhint %}
The Onyx 5G Network architecture now supports the Fronthaul Multiplexer (FHM) equipment, which manages the fronthaul connections between the Onyx Edge and multiple Radio Units (RUs). The FHM helps expand coverage by allowing multiple RUs to operate as part of the same cell.
Administrator users can add, edit, and delete FHM equipment in their 5G networks. For more information, refer to the *5G Onyx Portal Operations Guide*.
## Resolved Issues
The following issues were resolved in this release.
### **Missing Data Points on Analytics Plots Don't Break Line Graphs**
The issue with missing data points in Analytics plots due to the reporting node not having checked in with the Orchestrator at specific times is now resolved. (Onyx Portal > **Analytics** > generate report > **Plots** tab).
## Open Issues
{% hint style="info" %}
**NOTE:** Open issues reported in previous releases, unless subsequently reported as resolved, may exist in this release.
{% endhint %}
### Access Point "Cell Service Down" Alert Not Triggered for Secondary Cell
The Access Point "Cell Service Down" alert is not generated for Dual Carrier APs when the RF status of the secondary cell is OFF.
**Workaround**: None. This issue will be addressed in an upcoming release.
### "Provisioning Server Connection Failure" Alert Not Triggered for NR Box
The "Provisioning Server Connection Failure" alert is not generated from the NR box, even after 15 minutes of connection failure.
**Workaround**: None. This issue will be addressed in an upcoming release.
### Incorrect WLS Status Reported by Orchestrator
The Orchestrator incorrectly reports the Wireless Link Status (WLS) as Disconnected although the NR is functioning properly with the WLS being up, and UE data working as expected.
**Workaround**: Restart gNodeB services to temporarily restore the correct status. Restarting gNodeB services restores the correct status, but the issue recurs after a few hours. As long as the UE maintains signal, the NR remains operational despite the false indication. This issue will be addressed in an upcoming release.
### Failure When Moving Onyx Edge from NAT Mode to VLAN Mode
Switching Onyx Edge from NAT mode to VLAN mode may fail if the UE-IP-Block in NAT mode is configured with a subnet that conflicts with any other VLAN subnet configuration.
**Reproduction Steps:**
1. Configure Onyx Edge in NAT mode with ue\_ip\_block: 192.168.129.0/24.
2. Change the IP allocation mode from NAT to VLAN.
3. Configure the VLAN parameters.
4. Attempt to save changes — validation fails due to conflicting subnet error.
**Workaround:**
* Before switching to VLAN mode, set the UE-IP-Block in NAT mode to a different, non-conflicting subnet.
* If 192.168.128.0/24 is needed in VLAN mode, move the UE-IP-Block to an unused subnet while in NAT mode.
* If switching temporarily to NAT mode is not possible, contact GXC Technical Support for assistance.
## Revision History
Revision History
| Date | Updates |
|---|
| 2025-03-20 | Pre-release version. |
---
# Agent Instructions: 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:
```
GET https://docs.gxc.io/release-notes/release-notes-archive/onyx-portal-release-notes/4g-and-5g-onyx-portal-3.1.0-release-notes.md?ask=
```
The question should be specific, self-contained, and written in natural language.
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.