> 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-equipment/manage-onyx-edge.md).
# Manage Onyx Edge
The Onyx Edge is the core network function of the 5G Onyx system. It provides connectivity between the Onyx Portal and the FHMs and APs. The Onyx Edge terminates Control Plane signaling from the APs, handles management plane communications from the Onyx Portal, and enforces traffic policies on subscriber data (User Plane) traffic.
## View Onyx Edge Details
This section describes how to view Onyx Edge details.
* [*View Onyx Edge (NR+Core) Details*](#view-onyx-edge-nrcore-details)
* [*View Onyx Edge (Core) Details*](#view-onyx-edge-core-details)
### View Onyx Edge (NR+Core) Details
This section describes how to view details of Onyx Edge (NR+Core).
* [*View Summary Details of All Onyx Edge (NR+Core)*](#view-summary-details-of-all-onyx-edge-nrcore-in-a-5g-network)
* [*View Details of an Onyx Edge (NR+Core)*](#view-details-of-an-onyx-edge-nrcore-in-a-5g-network)
#### View Summary Details of All Onyx Edge (NR+Core)
**To view the summary details of all Onyx Edge (NR+Core) in a 5G network:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **Onyx Edge (NR+Core)** tab or **Onyx Edge** tab.
The **Equipment** page > **Onyx Edge (NR+Core)** tab or the **Onyx Edge** tab displays the summary details of all Onyx Edge (NR+Core) configured in the network.
{% hint style="info" %}
**NOTE:** If the 5G network includes only Onyx Edge (NR+Core), the **Equipment** page > **Onyx Edge** tab displays summary details of all Onyx Edge (NR+Core) configured in the network.
If the 5G network includes both Onyx Edge (NR+Core) and Onyx Edge (Core), the **Equipment** page displays separate tabs—**Onyx Edge (NR+Core)** and **Onyx Edge (Core)**—for each Onyx Edge type.
{% endhint %}
* **Onyx Edge (n)** – (n) Indicates the number of Onyx Edge (NR+Core) in the network.
* Status of services running on the Onyx Edge.
* Green – Indicates all critical services are up and running, none of the critical services were restarted in the last five minutes, and the Onyx Edge's Interface Status is green.
* Amber – Indicates all critical services are up and running, but critical services have restarted up to three times in the last five minutes, and the Onyx Edge's Interface Status is green or amber.
* Red – Indicates some critical service has gone down in the last five minutes, or critical services have restarted up to three times in the last five minutes, or the Onyx Edge's Interface Status is red.
* Grey – Indicates the Onyx Edge is offline, or data is not available.
Hover your cursor over the Service Status icon to view the list of services that are up/down/restarted.
* **Name** – The Onyx Edge's name.
* **Venue / VM** – The name of the venue or the VM hosting the Onyx Edge.
* **AP/FHM** – The number of APs/FHMs that are connected to the Onyx Edge is displayed in green, and those that are disconnected in red. To view the AP/FHM names, hover your cursor over the counts.
* **Subs** – The number of subscribers connected to the Onyx Edge.
* **Online** – The Onyx Edge's online status indicating its reachability from the Onyx Portal.
* Green – Indicates the Onyx Edge has checked-in with Onyx Portal in the last five minutes.
* Red – Indicates the Onyx Edge has not checked-in with the Onyx Portal in the last five minutes.
Hover your cursor over the Online Status icon to view the following details.
* **Interface Status** – Indicates connection status of N6 and RAN (Fronthaul) interfaces.
* Green – Indicates all APs are AMF-connected to the Onyx Edge, the N6 interface is up and has IP, and N6 link is active (periodic ICMP checks every five minutes).
* Amber – Indicates at least one AP is AMF-connected, but some are not, the N6 interface is UP and has IP (N6 link is active).
* Red – Indicates none of the APs are AMF-connected (that is all APs are AMF-disconnected or management-disconnected (AMF status is unknown)), or the N6 interface is not up or is not active (N6 link activity check through ICMP).
* Grey – Indicates the Onyx Edge is offline.
Hover your cursor over the "Interface Status" icon to view the following details.
* **Sync Status** — Indicates the Onyx Edge's synchronization status with the timing source.
*  Green – The Onyx Edge is in sync with the timing source.
*  Red – The Onyx Edge is out of sync with the timing source.
*  Grey – The Onyx Edge is offline, or sync status is not available.
Hover your cursor over the Sync Status icon to view the following details:
* **Compute Resource** – Indicates utilization of the Onyx Edge's computing resources – CPU, memory, and disk utilization percentage.
* Green – Indicates all parameters are below 50%.
* Amber – Indicates at least one parameter is above 50% and below 70%.
* Red – Indicates at least one parameter is above 70%.
* Grey – Indicates the Onyx Edge is offline.
Hover your cursor over the Compute Resource icon to view the following details:
* **Disk Utilization** – Percentage of disk space used for the volume mounted at root.
* **CPU Utilization** – System-wide CPU utilization as percentage over one second.
* **Memory Utilization** – Percentage of memory used.
* **Actions** – Options to view details, edit, and delete the Onyx Edge.
* **Upgrade Onyx Edge** – (GXC Administrators only.) To upgrade the Onyx Edge software on the Onyx Edge AGWs in the network. For information on managing Onyx Edge upgrades, see [*Manage Onyx Edge Software Upgrades*](#manage-onyx-edge-software-upgrades).
* **Show Graphs / Hide Graphs** — Collapsible panel of Onyx Edge performance charts. Default: Collapsed to improve page performance.
* **UE Throughput** – Trend chart of the throughput of all UE for the selected Onyx Edge, direction, and duration. The chart represents downlink throughput in blue and uplink throughput in green color.
* **Onyx Edge Connected with Onyx Portal** – Trend chart of the number of Onyx Edge connected with the Onyx Portal in the selected duration.
* **UE Attach Status** – Chart of control plane transaction success/failure status for the selected Onyx Edge, transaction type, and duration. Success count is displayed in green, and failure count in red color.
You can select the event type from the following:
* **Registration (Initial)** – First network registration attempt after UE power-on or SIM activation.
* **Registration (MobUpd)** – Registration updates triggered by UE mobility (changing tracking areas).
* **Registration (Periodic)** – Scheduled periodic re-registration to maintain network presence.
* **Auth Request** – Authentication procedure events.
* **PDN Establishment Request** – Session setup for data connectivity.
* **Service Request** – Resume of idle-mode UE sessions.
{% endstep %}
{% endstepper %}
#### View Details of an Onyx Edge (NR+Core)
**To view the details of an Onyx Edge (NR+Core) in a 5G network:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **Onyx Edge (NR+Core)** tab or **Onyx Edge** tab.
The **Equipment** page > **Onyx Edge (NR+Core)** tab or **Onyx Edge** tab displays the summary details of all Onyx Edge (NR+Core) configured in the network.
{% hint style="info" %}
**NOTE:** If the 5G network includes only Onyx Edge (NR+Core), the **Equipment** page > **Onyx Edge** tab displays summary details of all Onyx Edge (NR+Core) configured in the network.
If the 5G network includes both Onyx Edge (NR+Core) and Onyx Edge (Core), the **Equipment** page displays separate tabs—**Onyx Edge (NR+Core)** and **Onyx Edge (Core)**—for each Onyx Edge type.
{% endhint %}
{% endstep %}
{% step %}
To view the details of a particular Onyx Edge (NR+Core), in the **Onyx Edge (n)** panel, click its name.
The ***\*** page displays the following details:
* **Overview** tab:
* **Onyx Edge Details**:
* **Name** – The Onyx Edge's name.
* **Host Name** – The Onyx Edge's hostname.
* **Description** – The Onyx Edge's description.
* **NR Version** – The Onyx Edge's NR software version.
* **Core Version** – The Onyx Edge's Core software version.
* **Up Time** – The duration for which the Onyx Edge has been operational without any downtime or interruptions.
* **Management IP** – The management IP address for the Onyx Edge.
* **N6 IP** – The IP address and subnet of the N6 interface.
* **Hardware Address** – The Onyx Edge's eth0 hardware address.
* **NR Upgrade Status** – Status of the last NR software upgrade.
NOTE: The Upgrade Status parameter is displayed only during and for one hour after an upgrade.
* **Core Upgrade Status** – Status of the last Onyx Edge software upgrade.
NOTE: The Upgrade Status parameter is displayed only during and for one hour after an upgrade.
To view the Core or NR upgrade details, click the corresponding status. The **Upgrade Status** dialog box displays the following details:
* **Description** – Description of the last upgrade's status.
* **Old Version** – The Onyx Edge software version before the upgrade.
* **New Version** – The new Onyx Edge software version.
* **Updated At** – The timestamp at which the last upgrade completed.
* **Start Time** – The timestamp at which the last upgrade started.
* **Venue** – The name of the venue hosting the Onyx Edge. To view the venue's details, click its name.
* **More Info >>** – Click to view the following additional details. The **More Details** dialog box is displayed.
* **Hardware UUID** – The Onyx Edge's Hardware Universally Unique Identifier (UUID) used for device authentication to ensure secure communication. To copy the hardware UUID to the clipboard, click the copy icon.
* **Challenge Key** – The Onyx Edge's Challenge Key used in challenge-response authentication mechanism. To copy the challenge key to the clipboard, click the copy icon.
* The Onyx Edge's health status.
* **Online** – The Onyx Edge's online status indicating its reachability from the Onyx Portal.
* Green – Indicates the Onyx Edge has checked-in with Onyx Portal in the last five minutes.
* Red – Indicates the Onyx Edge has not checked-in with the Onyx Portal in the last five minutes.
Hover your cursor over the Online Status icon to view the following details.
* **Interface Status** – The Onyx Edge's interface status indicating the connection status of SGi and RAN (S1) interfaces.
* Green – Indicates all APs are MME-connected to the Onyx Edge, the SGi interface is up and has IP, and SGi link is active (periodic ICMP checks every five minutes).
* Amber – Indicates at least one AP is MME-connected, but some are not, the SGi interface is UP and has IP (SGi link is active).
* Red – Indicates none of the APs are MME-connected (that is all APs are MME-disconnected or management-disconnected (MME status is unknown)), or the SGi interface is not up or is not active (SGi link activity check through ICMP).
* Grey – Indicates the Onyx Edge is offline, or data is not available.
Hover your cursor over the Interface Status icon to view the following details.
* **Compute Resource** – Status of the Onyx Edge's computing resources.
* Green – Indicates all parameters are below 50%.
* Amber – Indicates at least one parameter is above 50% and below 70%.
* Red – Indicates at least one parameter is above 70%.
* Grey – Indicates the Onyx Edge is offline.
Hover your cursor over the Compute Resource Status icon to view the following details:
* **Disk Utilization** – Percentage of disk space used for the volume mounted at root.
* **CPU Utilization** – System-wide CPU utilization as percentage over one second.
* **Memory Utilization** – Percentage of memory used.
* **Service Status** – Status of the Onyx Edge's services. Hover your cursor over the "Service Status" icon to view details.
* Green – Indicates all critical services are up and running, none of the critical services were restarted in the last five minutes, and the Onyx Edge's Interface Status is green.
* Amber – Indicates all critical services are up and running, but critical services have restarted up to three times in the last five minutes, and the Onyx Edge's Interface Status is green or amber.
* Red – Indicates some critical service has gone down in the last five minutes, or critical services have restarted up to three times in the last five minutes, or the Onyx Edge's Interface Status is red.
* Grey – Indicates the Onyx Edge is offline, or data is not available.
Hover your cursor over the Service Status icon to view the following details.
* **Sync Status** – Indicates the Onyx Edge's synchronization status with the timing source.
*  Green – The Onyx Edge is in sync with the timing source.
*  Red – The Onyx Edge is out of sync with the timing source.
*  Grey – The Onyx Edge is offline, or sync status is not available.
Hover your cursor over the Sync Status icon to view the following details:
* **PHC State** — Status of the Precision Hardware Clock (PHC) used for accurate packet timestamping.
* **SyncE State** — Status of Synchronous Ethernet (SyncE) frequency synchronization over the physical layer.
* **GPS State** — Status of the GPS receiver used as the primary time reference source.
* **Data Usage** – The Onyx Edge's data usage for the selected duration.
* **Download** – The download data usage for the selected duration.
* **Upload** – The upload data usage for the selected duration.
* **Dynamic Services** – Status of the Onyx Edge's dynamic services.
* **CPE Monitoring** – The status of the CPE Monitoring service—Enabled or Disabled. When enabled, the Onyx Edge sends ICMP pings every minute to each connected UE. The measured round-trip time (RTT) latency is reported in the per-subscriber details. See **Subscribers** > Subscriber details > **UE Latency** parameter.
* **Spectrum Analyzer** – The Spectrum Analyzer service's status—Enabled or Disabled. When enabled, it provides real-time, per-cell analysis and visualization of uplink and downlink power characteristics across the RF spectrum, allowing administrators to monitor signal quality, detect interference, and optimize network performance. For more information, see [*Spectrum Analyzer*](#spectrum-analyzer).
* **APN-VLAN Details** – (Displayed only in VLAN mode.) For each APN, the following details are displayed. Note that APNs are common to all Onyx Edge in the network.
* **APN Name** – The APN's name. To view the APN's details, click its name.
* **VLAN** – The VLAN ID.
* **Local IP** – The local IP address / subnet of the Onyx Edge on the VLAN.
* **Default GW IP** – The Onyx Edge's IP address.
* **Default GW MAC** – The Onyx Edge's MAC address.
* **UE-IP-Block: IP Block** – Indicates whether the UE IP block feature is enabled or disabled.
* **UE-IP-Block: Start IP** – The start IP address of the UE IP block range.
* **UE-IP-Block: End IP** – The end IP address of the UE IP block range.
* **Core**: The Onyx Edge's Core settings.
* **UE IP Configuration**:
* **IP Range** – (Displayed only in NAT Mode.) The IP address range from which the Onyx Edge allocates IP addresses to UE.
* **IP Retention Time (Sec)** – The duration (in seconds) for which a UE's IP address is retained/leased after it disconnects.
* **DNS Server for UE**:
* **Onyx Edge-as-DNS-Server** – Indicates if the Onyx Edge functions as the DNS server—Enabled or Disabled.
* **DNS Second Server** – (Displayed only when **Onyx Edge-as-DNS-Server** is enabled.) Enabled or Disabled. When enabled, if the "ONYX-Edge-as-DNS-Server" is unavailable, or if it fails to resolve domain name, the UE will contact the secondary DNS server for domain name resolution.
* **DNS Primary** – The primary DNS server's IP address.
* **DNS Secondary** – The secondary DNS server's IP address.
* **Management Interface** – (VLAN Mode only) The UE IP address allocation mode—Static or DHCP.
* **Management IP Subnet** – (Displayed only if UE IP allocation mode is Static.) The management IP address for Onyx Edge to reach corporate network/internet.
* **N6 IP** – (Displayed only if UE IP allocation mode is Static.) The IP address of the N6 interface.
* **Gateway** – (Displayed only if UE IP allocation mode is Static.) The corporate gateway router IP address.
* **DNS Primary** – (Displayed only if UE IP allocation mode is Static.) The primary DNS server's IP address.
* **DNS Secondary** – (Displayed only if UE IP allocation mode is Static.) The secondary DNS server's IP address.
* **SGI Management VLAN** – (Displayed only for VLAN mode if UE IP allocation mode is Static.) The SGi Management VLAN ID.
* **NAS Security Algorithms**
* **Integrity Algorithm** – The NAS integrity protection algorithm in use.
* **Encryption Algorithm** – The NAS encryption algorithm in use.
* **DHCP Server Monitoring** — (Displayed only in VLAN mode) Indicates whether DHCP Server Monitoring is active for this Onyx Edge — Enabled, Disabled.
* **Frequency** — (Displayed only in VLAN mode if **DHCP Server Monitoring** is enabled) How often the system checks DHCP server availability, in minutes.
* **MAC** — (Displayed only in VLAN mode if **DHCP Server Monitoring** is enabled) The MAC address used by the monitoring probe when sending DHCP requests.
* **VLAN** — (Displayed only in VLAN mode if **DHCP Server Monitoring** is enabled) The VLAN on which the monitoring probe sends DHCP requests, ensuring the check targets the correct network segment.
* **RAN**: The Onyx Edge's (NR+Core) RAN settings.
* **Band** – The frequency band in use.
* **Slot Pattern** – The slot pattern configuration indicating the DL/UL frame structure.
* **DDDDDDDSUU (DL 77%, UL** **21%)** – Allocates approximately 77% subframes for downlink and 21% for uplink.
* **DDDSU (DL 74%, UL 23%)** – Allocates approximately 74% subframes for downlink and 23% for uplink.
* **DDSUU (DL 54%, UL 43%)** – Allocates approximately 54% subframes for downlink and 43% for uplink.
* **DSUUU (DL 34%, UL 63%)** – Allocates approximately 34% subframes for downlink and 63% for uplink.
* **DSUUUUDSUU** (**DL 25%, UL 72%)** – Allocates approximately 25% subframes for downlink and 72% for uplink.
* **DDSUUUUUUU** (**DL 20%, UL 77%)** – Allocates approximately 20% subframes for downlink and 77% for uplink.
* **Multi-Port Attach** – Indicates whether the Multi Port Attach feature is enabled or disabled. For more information, see *Multi-Port Attach Support*.
* **Timing Source** – The timing synchronization source in use (e.g., GPS).
* **Integrity Algorithm** – The RAN integrity protection algorithm in use.
* **Encryption Algorithm** – The RAN encryption algorithm in use.
* The table displays the following cell-specific details:
* **Name** – The cell's name.
* **Cell Local ID** – The local ID assigned to the cell within the gNB.
* **gNB ID** – The unique ID assigned to the gNB serving this cell.
* **BW** – The channel bandwidth allocated for the cell.
* **Freq** – The frequency at which the cell operates.
* **AP/FHM** – The associated AP or FHM linked to this cell.
* **PCI** – The Physical Cell Identifier (PCI) assigned to the cell.
* **PSS** – The Primary Synchronization Signal (PSS) index assigned to the cell.
* **SAS** – The status of the cell's SAS registration.
* **Actions** – Option to start the Spectrum Analyzer for a cell. For more information, see [*Spectrum Analyzer*](#spectrum-analyzer).
* **Connected Access Point / FHM** – Details of APs/FHMs connected to the Onyx Edge:
* The AP's/FHM's RF Tx status.
* **Name** – The AP's/FHM's name.
* **Serial No.** – The AP/FHM equipment's vendor-assigned serial number.
* **IP Address** – The AP's/FHM's IP address.
* **Online** – The AP's/FHM's online status.
* **Interface Status** – The AP's/FHM's interface status.
* **Sync Status** – The AP's sync status.
* **Connected APs** – (Displayed only for FHM entries.) Click to view the list of APs connected to through the FHM.
* **Subscribers** – Details of subscribers connected to the Onyx Edge.
NOTE: For non-GXC Administrator users this list excludes MeshBackhaul subscriber data.
* **Status** – The subscriber account's status.
* **Name** – The subscriber account's name.
* **IMSI** – The subscriber's IMSI. To view the subscriber account's details, click the IMSI.
* **Subscriber Group ID** – The subscriber group that the subscriber account is associated with. To view the subscriber group's details, click its name. For information on subscriber groups, see *Manage Subscriber Groups*.
* **gNB ID/Cell ID** – The gNB ID (Onyx Edge ID) and Cell ID to which the subscriber is connected.
* **View All Subscribers** – Click to view details of all subscriber accounts in the network. The **Subscribers** page > **Subscriber** tab is displayed.
* **Backhaul Speedtest** – Prioritized list of iPerf-compatible speedtest servers used to measure backhaul link performance, with an edit control to manage the list. The following details are shown for each entry:
* **Priority** – The priority order in which speedtest servers are tried.
* **URL** – The hostname/URL of the speedtest server.
* **Port Range** – The port range used for the speedtest.
{% endstep %}
{% step %}
Click the **Events & Alerts** tab.
* **Alerts** – Details of Onyx Edge related alerts for the selected severity level:
You can select the alert severity level from **All**, **Major**, **Minor**, **Critical**, or **Others**.
* **Date** – The alert’s creation timestamp.
* **Status** – The alert’s status.
* **Alert Name** – The alert’s name.
* **Severity** – The alert’s severity.
To view an alert’s details, click the corresponding row.
* **Events** – Details of Onyx Edge related events for the selected events and time duration:
* **NR / Core** – Switch between NR and Core network events.
* To change the date and time range, select the required timestamps in the  fields. The events list automatically updates to display the corresponding logs.
NOTE: Your selections must fall within a seven-day range.
* **Timestamp** – The event’s creation timestamp.
* **Module** – The specific module or source from which the event originated. To filter the events based on module, click the **Module** column header and select one or more modules.
* **Event Type** – The event’s type. To filter the events based on the event type, click the **Event Type** header and select one or more event types.
* **Entity** – The entity’s name.
* **Event Description** – The event’s description.
* To view more details for a particular event, click the corresponding (view details) icon.
{% endstep %}
{% step %}
Click the **Logs** tab.
* **Logs (n)** – The number of logs for the Onyx Edge in the selected type and date and time range.
* **NR / Core** – Allows switching between NR and Core network logs.
* Download Logs – To download the logs in .csv format, in the field, enter the number of logs to be included in the .csv file, then click . Default value: 1000. The downloaded .csv file includes details such as the timestamp, service, tag, type, and log text.
NOTE: You can download a maximum 5000 logs.
* Date and Time Range – To view logs in a specific date and time range, select the required timestamps in the fields. The logs list automatically updates to display the corresponding logs.
NOTE: Your selections must fall within a seven-day range.
* Search Logs – To search for a log, in the field, enter your search term. The logs list updates automatically to display matching logs.
* **Timestamp** – The date and time at which the log was created.
* **Service** – The specific service associated with the log.
* **Tag** – The event’s tag—a label associated with the log entry.
* **Type** – The log’s type.
* **Output** – The log’s message.
{% endstep %}
{% step %}
Click the **Handover** tab.
The **Handover Configuration** table displays the following details for each cell:
* **Name** – The cell's name.
* **PCI** – The Physical Cell Identifier assigned to the cell.
* **Frequency** – The cell's operating frequency.
* **Neighbors** – The cell's configured neighbor relations, with **Explicit,** **Desired,** and **Configured** neighbor-list values.
* **Hysteresis (dB)** – The hysteresis margin applied before triggering a handover measurement report.
* **Time To Trigger (ms)** – The duration a triggering condition must persist before the handover event fires.
* **RSRP** – Threshold values (dBm) for each configured handover event: **A1**, **A2**, **A3 Offset**, **A5-Serving Cell**, and **A5-Neighbor Cell**.
{% endstep %}
{% step %}
**Actions** – (Enabled only when the Onyx Edge is online.) In the upper-right corner of the page, click the **Actions** button to access the following options:
* **Upgrade** – (GXC Administrators, Super Administrators, and Administrators only.) Upgrade the Onyx Edge’s software version, move the Onyx Edge to the required target upgrade group. For more information, see *Move an Onyx Edge from one Upgrade Group to Another*.
* **Reboot Onyx Edge** – (GXC Administrators, Super Administrators, and Administrators only.) Reboot the Onyx Edge. Services will be down while the equipment reboots.
* **Restart Services on Onyx Edge** – (GXC Administrators, Super Administrators, and Administrators only.) Restart the Onyx Edge’s core services. Connectivity will be down until the services resume.
* **Ping** – (GXC Administrators, Super Administrators, and Administrators only.) Ping the Onyx Edge’s host.
Enter the following details, then click **Ping**.
* **Host** – (Required) The host’s IP address.
* **Packets (default 4)** – (Optional) The number of packets to send. Default: 4.
* **Detach Subscriber** – (GXC Administrators, Super Administrators, and Administrators only.) Forcibly detach an active subscriber/UE.
Enter the following details, then click **Execute**.
* **Subscriber IMSI** – The subscriber’s IMSI.
* **Force Config Sync** – (GXC Administrators, Super Administrators, and Administrators only.) Trigger a full configuration synchronization.
* **Force Status Sync from Onyx Edge** – (GXC Administrators, Super Administrators, and Administrators only.) Trigger Onyx Edge state synchronization. This action control is useful when investigating stale status displays or validating a change without waiting for the next periodic sync.
* **Force Subscriber Config Sync** – (GXC Administrators and Super Administrators only.) Trigger a configuration synchronization for a specific subscriber.
* **Trigger Debug Information Collection** – (GXC Administrators, Super Administrators, and Administrators only.) Collect logs and telemetry from Onyx Edge.
* **List Debug Information Files in OE** – (GXC Administrators, Super Administrators, and Administrators only.) View downloadable debug files available on the Onyx Edge.
* **Generic Command** – (GXC Administrators only.) Run generic commands on the Onyx Edge.
The **Run Onyx Edge Command** dialog box is displayed.
Enter the following details, then click **Execute**:
* **Command** – (Required) The command to run.
* **Parameters** – (Optional) Parameters for the command.
{% endstep %}
{% endstepper %}
### View Onyx Edge (Core) Details
{% hint style="info" %}
**NOTE:** An Onyx Edge is designated as Onyx Edge (Core) if added as type Onyx Edge (Core).
{% endhint %}
This section describes how to view Onyx Edge (Core) details in a 5G network.
* [*View Summary Details of All Onyx Edge (Core)*](#view-summary-details-of-all-onyx-edge-core-in-a-5g-network)
* [*View Details of an Onyx Edge (Core)*](#view-details-of-an-onyx-edge-core-in-a-5g-network)
#### View Summary Details of All Onyx Edge (Core)
**To view the summary details of all Onyx Edge (Core) in a 5G network:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **Onyx Edge (Core)** tab or **Onyx Edge** tab.
The **Equipment** page > **Onyx Edge (Core)** tab or **Onyx Edge** tab displays the summary details of all Onyx Edge (Core) configured in the network.
{% hint style="info" %}
**NOTE:** If the 5G network includes only Onyx Edge (Core), the **Equipment** page > **Onyx Edge** tab displays summary details of all Onyx Edge (Core) configured in the network.
If the 5G network includes both Onyx Edge (NR+Core) and Onyx Edge (Core), the **Equipment** page displays separate tabs—**Onyx Edge (NR+Core)** and **Onyx Edge (Core)**—for each Onyx Edge type.
{% endhint %}
* **Onyx Edge (n)** – (n) indicates the number of Onyx Edge (Core) in the network.
* Status of services running on the Onyx Edge (Core).
* Green – Indicates all critical services are up and running, none of the critical services were restarted in the last five minutes, and the Onyx Edge's Interface Status is green.
* Amber – Indicates all critical services are up and running, but critical services have restarted up to three times in the last five minutes, and the Onyx Edge's Interface Status is green or amber.
* Red – Indicates some critical service has gone down in the last five minutes, or critical services have restarted up to three times in the last five minutes, or the Onyx Edge's Interface Status is red.
* Grey – Indicates the Onyx Edge is offline, or data is not available.
Hovering your cursor over the "Service Status" icon displays view the list of services that are up/down/restarted.
* **Name** – The Onyx Edge's name.
* **Venue / VM** – The name of the venue or the VM hosting the Onyx Edge.
* **Subs** – The number of subscribers connected to the Onyx Edge.
* **Online** – The Onyx Edge's online status indicating its reachability from the Onyx Portal.
* Green – Indicates the Onyx Edge has checked-in with Onyx Portal in the last five minutes.
* Red – Indicates the Onyx Edge has not checked-in with the Onyx Portal in the last five minutes.
Hovering your cursor over the "Online Status" icon displays the last synced at (last check-in) timestamp.
* **Interface Status** – Indicates connection status of N6 and RAN (Fronthaul) interfaces.
* Green – Indicates all APs are MME-connected to the Onyx Edge, the SGi interface is up and has IP, and SGi link is active (periodic ICMP checks every five minutes).
* Amber – Indicates at least one AP is MME-connected, but some are not, the SGi interface is UP and has IP (SGi link is active).
* Red – Indicates none of the APs are MME-connected (that is all APs are MME-disconnected or management-disconnected (MME status is unknown)), or the SGi interface is not up or is not active (SGi link activity check through ICMP).
* Grey – Indicates the Onyx Edge is offline.
Hovering your cursor over the "Interface Status" icon displays additional details.
* **Compute Resource** – Indicates utilization of the Onyx Edge's computing resources – CPU percentage, Memory percentage, and Disk Utilization percentage.
* Green – Indicates all parameters are below 50%.
* Amber – Indicates at least one parameter is above 50% and below 70%.
* Red – Indicates at least one parameter is above 70%.
* Grey – Indicates the Onyx Edge is offline.
Hovering your cursor over the "Compute Resource Status" icon displays the following details:
* **Disk Utilization** – Percentage of disk space used for the volume mounted at root.
* **CPU Utilization** – System-wide CPU utilization as percentage over one second.
* **Memory Utilization** – Percentage of memory used.
* **Actions** – Options to view details, edit, and delete the Onyx Edge.
* **Upgrade Core Onyx Edge** – (GXC Administrators only.) To upgrade the Onyx Edge software on the Onyx Edge AGWs in the network. For information on managing Onyx Edge upgrades, see *Manage Onyx Edge Software Upgrades*.
* **Onyx Edge Pool (n)** — (n) indicates the count of Onyx Edge pools in the network.\
For information on adding and managing Onyx Edge pools, see [*Manage Onyx Edge Core-Only HA Pools*](#manage-onyx-edge-core-only-ha-pools).
* The Onyx Edge pool's HA connectivity status.
* Green – One Onyx Edge is functioning as the Primary ACS, and the others as Standby ACS.
* Amber – One Onyx Edge is functioning as the Primary ACS, but one or more of the other Onyx Edge are non-functional.
* Red – All Onyx Edge are non-functional, or their status is not available.
* Grey – All Onyx Edge are offline.
Hovering your cursor over the "HA Connectivity Status" icon displays which Onyx Edge are designated as the Primary and Standby ACS.
* **Name** — The Onyx Edge pool's name.
* **HA IP Address** — Currently only for GXC use.
* **Associated Onyx Edges** — The count of Onyx Edge nodes currently associated with this pool.
* **Actions** — Options to view details, edit, or delete the pool.
* **Show Graphs / Hide Graphs** — Collapsible panel of Onyx Edge performance charts, each filterable by Onyx Edge instance and time range.
\
Defaults to collapsed to improve page performance.
* **UE Throughput** – Trend chart of the throughput of all UE for the selected Onyx Edge, direction, and duration. The chart represents downlink throughput in blue and uplink throughput in green color.
* **Onyx Edge Connected with Onyx Portal** – Trend chart of the number of Onyx Edge connected with the Onyx Portal in the selected duration.
* **UE Attach Status** – Chart of control plane transaction success/failure status for the selected Onyx Edge, transaction type, and duration.
Success count is displayed in green, and failure count in red color. You can select the event type from the following:
* **Registration (Initial)**
* **Registration (MobUpd)**
* **Registration (Periodic)**
* **Auth Request**
* **PDN Establishment Request**
* **Service Request**
{% endstep %}
{% endstepper %}
#### View Details of an Onyx Edge (Core)
**To view the details of an Onyx Edge (Core) in a 5G network:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **Onyx Edge (Core)** tab or **Onyx Edge** tab.
The **Equipment** page > **Onyx Edge (Core)** tab or **Onyx Edge** tab displays the summary details of all Onyx Edge (Core) configured in the network.
{% hint style="info" %}
**NOTE:** If the 5G network includes only Onyx Edge (Core), the **Equipment** page > **Onyx Edge** tab displays summary details of all Onyx Edge (Core) configured in the network.
If the 5G network includes both Onyx Edge (NR+Core) and Onyx Edge (Core), the **Equipment** page displays separate tabs—**Onyx Edge (NR+Core)** and **Onyx Edge (Core)**—for each Onyx Edge type.
{% endhint %}
{% endstep %}
{% step %}
To view the details of a particular Onyx Edge (Core), in the **Onyx Edge (n)** panel, click its name.
The ***\*** page displays the following details:
* **Overview** tab:
* **Onyx Edge Details**:
* **Type** – The Onyx Edge's deployment type.
* **Name** – The Onyx Edge's name.
* **Pool Name** — The AMF/Onyx Edge pool that the Onyx Edge is associated with. To view the pool's details, click the pool's name. The ***\*** page is displayed.
* **Host Name** – The Onyx Edge's hostname.
* **Description** – The Onyx Edge's description.
* **N6 Interface (Eth0)** – (Displayed only in NAT mode) The N6 interface's IP address.
* **N6 Interface (Uplink br0)** – (Displayed only in VLAN mode) The N6 interface's IP address.
* **NG Interface (Eth1)** – The NG interface's eth1 IP address.
* **Version** – The Onyx Edge's software version.
* **Upgrade Status** – Status of the last Onyx Edge software upgrade.
NOTE: The Upgrade Status parameter is displayed only during and for one hour after an upgrade.
To view the upgrade details, click the status. The **Upgrade Status** dialog box displays the following details:
* **Description** – Description of the last upgrade's status.
* **Old Version** – The Onyx Edge software version before the upgrade.
* **New Version** – The new Onyx Edge software version.
* **Updated At** – The timestamp at which the last upgrade completed.
* **Start Time** – The timestamp at which the last upgrade started.
* **Venue** – The name of the venue hosting the Onyx Edge. To view the venue's details, click its name.
* **Up Time** – The duration for which the Onyx Edge has been operational without any downtime or interruptions.
* **Hardware Address** – (Displayed only for Onyx Edge On-Premises) The Onyx Edge's eth0 hardware address.
* **More Info >>** – Click to view the following additional details. The **More Details** dialog box is displayed.
* **Hardware UUID** – The Onyx Edge's Hardware Universally Unique Identifier (UUID) used for device authentication to ensure secure communication. To copy the hardware UUID to the clipboard, click the copy icon.
* **Challenge Key** – The Onyx Edge's Challenge Key used in challenge-response authentication mechanism. To copy the challenge key to the clipboard, click the copy icon.
* **AGW User Configuration** – The AGW User account's password, displayed only if it has been set.
* **SSH Keys** – The AGW User account's SSH key used for secure, password-less access to the system using public-private key authentication, displayed only if it has been added.
* The Onyx Edge's health status.
* **Online** – The Onyx Edge's online status indicating its reachability from the Onyx Portal.
* Green – Indicates the Onyx Edge has checked-in with Onyx Portal in the last five minutes.
* Red – Indicates the Onyx Edge has not checked-in with the Onyx Portal in the last five minutes.
Hovering your cursor over the "Online Status" icon displays the last check-in timestamp.
* **Interface Status** – The Onyx Edge's interface status indicating the connection status of SGi and RAN (S1) interfaces.
* Green – Indicates all APs are AMF-connected to the Onyx Edge, the SGi interface is up and has IP, and SGi link is active (periodic ICMP checks every five minutes).
* Amber – Indicates at least one AP is MME-connected, but some are not, the SGi interface is UP and has IP (SGi link is active).
* Red – Indicates none of the APs are MME-connected (that is all APs are MME-disconnected or management-disconnected (MME status is unknown)), or the SGi interface is not up or is not active (SGi link activity check through ICMP).
* Grey – Indicates the Onyx Edge is offline, or data is not available.
Hovering your cursor over the "Interface Status" icon displays additional details.
* **Compute Resource** – Status of the Onyx Edge's computing resources.
* Green – Indicates all parameters are below 50%.
* Amber – Indicates at least one parameter is above 50% and below 70%.
* Red – Indicates at least one parameter is above 70%.
* Grey – Indicates the Onyx Edge is offline.
Hovering your cursor over the "Compute Resource Status" icon displays the following details:
* **Disk Utilization** – Percentage of disk space used for the volume mounted at root.
* **CPU Utilization** – System-wide CPU utilization as percentage over one second.
* **Memory Utilization** – Percentage of memory used.
* **Service Status** – Status of the Onyx Edge's services. Hover your cursor over the "Service Status" icon to view details.
* Green – Indicates all critical services are up and running, none of the critical services were restarted in the last five minutes, and the Onyx Edge's Interface Status is green.
* Amber – Indicates all critical services are up and running, but critical services have restarted up to three times in the last five minutes, and the Onyx Edge's Interface Status is green or amber.
* Red – Indicates some critical service has gone down in the last five minutes, or critical services have restarted up to three times in the last five minutes, or the Onyx Edge's Interface Status is red.
* Grey – Indicates the Onyx Edge is offline, or data is not available.
Hovering your cursor over the "Service Status" icon displays the list of services that are up/down/restarted.
* **Data Usage** – The Onyx Edge's data usage for the selected duration.
* **Download** – The download data usage for the selected duration.
* **Upload** – The upload data usage for the selected duration.
* **Dynamic Services** – Status of the Onyx Edge's dynamic services.
* **Event Aggregation** – Indicates the status of event aggregation for Onyx Edge services. Aggregated events are displayed in event lists and charts in the Onyx Portal interface. This feature is always enabled and cannot be disabled.
* **Log Aggregation** – Indicates the status of log aggregation from gateway services. Aggregated logs are displayed in log lists and charts in the Onyx Portal interface. This feature is always enabled and cannot be disabled.
* **CPE Monitoring** – The status of the CPE Monitoring service—Enabled or Disabled. When enabled, the Onyx Edge sends ICMP pings every minute to each connected UE. The measured round-trip time (RTT) latency is reported in the per-subscriber details. See the **Subscribers** > Subscriber details > **UE Latency** parameter.
* **Core**: The Onyx Edge's Core settings.
* **UE-IP-Configuration**:
* **IP Range** – (Displayed only in NAT mode.) The IP range from which the Onyx Edge allocates IP addresses to UE.
* **IP Retention Time (sec)** – The duration (in seconds) for which a UE's IP address is retained/leased after it disconnects.
* **DNS Server for UE**:
* **Onyx Edge-as-DNS-Server** – Indicates if the Onyx Edge functions as the DNS server—Enabled or Disabled.
* **DNS Second Server** – (Displayed only when **Onyx Edge-as-DNS-Server** is enabled.) Enabled or Disabled. When enabled, if the "ONYX-Edge-as-DNS-Server" is unavailable, or if it fails to resolve domain name, the UE will contact the secondary DNS server for domain name resolution.
* **DNS Primary** – The primary DNS server's IP address.
* **DNS Secondary** – The secondary DNS server's IP address.
* **N6 Interface**:
* **N6 Interface** – The UE IP address allocation mode—Static or DHCP.
* **IP Subnet** – (Displayed only if UE IP allocation mode is Static.) The management IP address for Onyx Edge to reach corporate network/internet.
* **Gateway** – (Displayed only if UE IP allocation mode is Static.) The corporate gateway router IP address.
* **DNS Primary** – (Displayed only if UE IP allocation mode is Static.) The primary DNS server's IP address.
* **DNS Secondary** – (Displayed only if UE IP allocation mode is Static.) The secondary DNS server's IP address.
* **N6 Management VLAN** – (Displayed only in VLAN mode if UE IP allocation mode is Static.) The N6 Management VLAN ID.
* **NAS Security Algorithms**
* **Integrity Algorithm** – The NAS integrity protection algorithm in use.
* **Encryption Algorithm** – The NAS encryption algorithm in use.
* **DHCP Server Monitoring** — (Displayed only in VLAN mode) Indicates whether DHCP Server Monitoring is active for this Onyx Edge — **Enabled**, **Disabled**.
* **Frequency** — (Displayed only in VLAN mode if **DHCP Server Monitoring** is enabled) How often the system checks DHCP server availability, in minutes.
* **MAC** — (Displayed only in VLAN mode if **DHCP Server Monitoring** is enabled) The MAC address used by the monitoring probe when sending DHCP requests.
* **VLAN** — (Displayed only in VLAN mode if **DHCP Server Monitoring** is enabled) The VLAN on which the monitoring probe sends DHCP requests, ensuring the check targets the correct network segment.
* **Backhaul Speedtest** – Prioritized list of iPerf-compatible speedtest servers used to measure backhaul link performance. The following details are shown for each entry:
* **Priority** – The priority order in which speedtest servers are tried.
* **URL** – The hostname/URL of the speedtest server.
* **Port Range** – The port range used for the speedtest.
* **APN-VLAN Details** – (Displayed only in VLAN mode.) For each APN, the following details are displayed. Note that APNs are common to all Onyx Edge in the network.
* **APN Name** – The APN's name. To view the APN's details, click its name.
* **VLAN ID** – The VLAN ID.
* **Local IP** – The local IP address / subnet of the Onyx Edge on the VLAN.
* **Default GW IP** – The Onyx Edge's IP address.
* **Default GW MAC** – The Onyx Edge's MAC address.
* **UE-IP-Block: IP Block** – Indicates whether the UE IP block feature is enabled or disabled.
* **UE-IP-Block: Start IP** – The start IP address of the UE IP block range.
* **UE-IP-Block: End IP** – The end IP address of the UE IP block range.
* **RAN**: The Onyx Edge's (Core) RAN settings.
* **Subscribers** – Details of subscribers connected to the Onyx Edge.
NOTE: For non-GXC Administrator users this list excludes MeshBackhaul subscriber data.
* **Status** – The subscriber account's status.
* **Name** – The subscriber account's name.
* **IMSI** – The subscriber's IMSI. To view the subscriber account's details, click the IMSI.
* **Subscriber Group ID** – The subscriber group that the subscriber account is associated with. To view the subscriber group's details, click its name. For information on subscriber groups, see *Manage Subscriber Groups*.
* **View All Subscribers** – Click to view details of all subscriber accounts in the network. The **Subscribers** page > **Subscriber** tab is displayed.
{% endstep %}
{% step %}
Click the **Events & Alerts** tab.
* **Alerts** – Details of Onyx Edge related alerts for the selected severity level.
You can select the alert severity level from **All**, **Major**, **Minor**, **Critical**, or **Others**.
To view an alert's details, click the corresponding row.
* **Date** – The alert's creation timestamp.
* **Status** – The alert's status.
* **Alert Name** – The alert's name.
* **Severity** – The alert's severity.
* **Events** – Details of Onyx Edge related events for the selected events and time duration:
* **NR / Core** – Allows switching between NR and Core network events.
* To change the date and time range, select the required timestamps in the date/time fields. The events list automatically updates to display the corresponding logs.
NOTE: Your selections must fall within a seven-day range.
* **Timestamp** – The event's creation timestamp.
* **Module** – The specific module or source from which the event originated. To filter events based on module, click the **Module** column header and select one or more modules.
* **Event Type** – The event's type. To filter the events based on the event type, click the **Event Type** header and select one or more event types.
* **Entity** – The entity's name.
* **Event Description** – The event's description.
* To view more details for a particular event, click the corresponding (view details) icon.
{% endstep %}
{% step %}
Click the **Logs** tab.
* **Logs (n)** – The number of logs for the Onyx Edge in the selected type and date and time range.
* **NR / Core** – Allows switching between NR and Core network logs.
* Download Logs – To download the logs in .csv format, in the field enter the number of logs to be included in the .csv file, then click the icon. Default value: 5000. The downloaded .csv file includes details such as the timestamp, service, tag, type, and log text.
NOTE: You can download a maximum 5000 logs.
* Date and Time Range – To view logs in a specific date and time range, select the required timestamps in the date/time fields. The logs list automatically updates to display the corresponding logs.
NOTE: Your selections must fall within a seven-day range.
* Search Logs – To search for a log, enter your search term in the search field. The logs list updates automatically to display matching logs.
* **Timestamp** – The date and time at which the log was created.
* **Service** – The specific service associated with the log.
* **Tag** – The event's tag—a label associated with the log entry.
* **Type** – The log's type.
* **Output** – The log's message.
{% endstep %}
{% step %}
**Actions** – (Enabled only when the Onyx Edge is online.) In the upper-right corner of the page, click the **Actions** button to access the following options.
* **Upgrade** – (GXC Administrators, Super Administrators, and Administrators only.) Upgrade the Onyx Edge's software version, move the Onyx Edge to the required target upgrade group. For more information, see *Move an Onyx Edge from One Upgrade Group to Another*.
* **Reboot Onyx Edge** – (GXC Administrators, Super Administrators, and Administrators only.) Reboot the Onyx Edge. Services will be down while the equipment reboots.
* **Restart Services on Onyx Edge** – (GXC Administrators, Super Administrators, and Administrators only.) Restart the Onyx Edge's core services. Connectivity will be down until the services resume.
* **Ping** – (GXC Administrators, Super Administrators, and Administrators only.) Ping the Onyx Edge's host.
Enter the following details, then click **Ping**.
* **Host** – (Required) The host's IP address.
* **Packets (default 4)** – (Optional) The number of packets to send. Default: 4.
* **Reboot AP** – (GXC Administrators, Super Administrators, and Administrators only.) Reboot all or a specific AP.
Enter the following details, then click **Execute**.
* **Reboot AP** – Select to reboot a specific AP in the network. In the **Select an AP** dropdown, select the AP's serial number.
* **Reboot All APs** – Select to reboot all APs in the network.
* **Detach Subscriber** – (GXC Administrators, Super Administrators, and Administrators only.) Forcibly detach an active subscriber/UE.
Enter the following details, then click **Execute**.
* **Subscriber IMSI** – The subscriber's IMSI.
* **Force Config Sync** – (GXC Administrators, Super Administrators, and Administrators only.) Trigger a full configuration synchronization.
* **Force Status Sync from Onyx Edge** – (GXC Administrators, Super Administrators, and Administrators only.) Trigger Onyx Edge state synchronization. This action control is useful when investigating stale status displays or validating a change without waiting for the next periodic sync.
* **Force Subscriber Config Sync** – (GXC Administrators and Super Administrators only.) Trigger a configuration synchronization for a specific subscriber.
* **Trigger Debug Information Collection** – (GXC Administrators, Super Administrators, and Administrators only.) Collect logs and telemetry from Onyx Edge.
* **List Debug Information Files in OE** – (GXC Administrators, Super Administrators, and Administrators only.) View downloadable debug files available on the Onyx Edge.
* **Generic Command** – (GXC Administrators only.) Run generic commands on the Onyx Edge.
The **Run Onyx Edge Command** dialog box is displayed. Enter the following details, then click **Execute**:
* **Command** – (Required) The command to run.
* **Parameters** – (Optional) Parameters for the command.
{% endstep %}
{% endstepper %}
## Add Onyx Edge
This section describes how to add an Onyx Edge in the following modes:
* [*Add Onyx Edge (NR+Core)*](#add-onyx-edge-nrcore)
* [*Add Onyx Edge (Core-Only)*](#add-onyx-edge-core-only)
### Add Onyx Edge (NR+Core)
This section describes how to add an Onyx Edge (NR+Core) in the following modes:
* [*Add Onyx Edge (NR+Core) in NAT Mode*](#add-onyx-edge-nrcore-in-nat-mode)
* [*Add Onyx Edge (NR+Core) in VLAN Mode*](#add-onyx-edge-nrcore-in-vlan-mode)
#### Add Onyx Edge (NR+Core) in NAT Mode
{% hint style="info" %}
**NOTE:** You can add an Onyx Edge only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}
{% hint style="info" %}
**NOTE:** Before adding an Onyx Edge On-Premises, make sure that the customer account, required network, and venue are already set up.
{% endhint %}
{% hint style="info" %}
**NOTE:** To add Onyx Edge in NAT mode, VLAN mode must be disabled at the network level.
{% endhint %}
{% hint style="info" %}
**NOTE**: For detailed information on the networking modes supported by the GXC 5G Onyx Platform, refer to the *4G & 5G Networking Modes Application Note*. The document covers NAT and Bridge (APN-on-VLAN) modes detailing their architectures, traffic flows, isolation characteristics, and trade-offs. It also provides step-by-step configuration guidance for each mode via the Onyx Portal.
{% endhint %}
**To add an Onyx Edge (NR+Core) in NAT mode:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page > **Onyx Edge** tab displays the summary details of all Onyx Edge configured in the network.
{% endstep %}
{% step %}
In the upper-right corner of the page, click **Add Node** > **Add Onyx Edge**.
The **Create Onyx Edge** page > **Onyx Edge** tab is displayed.
{% endstep %}
{% step %}
Enter the following details:
* **Type** – (Required) Select the Onyx Edge type **NR+Core**. Default value: **NR+Core**.
NOTE: After you add an Onyx Edge, its type cannot be changed.
* **Venue** – (Required) Select the venue hosting the Onyx Edge.
* **Onyx Edge Name** – (Required) The Onyx Edge's name.
* **Host Name** – (Optional) The Onyx Edge's host name to be displayed in the Onyx Edge equipment's interface. The host name must be an alphanumeric string of 5–64 characters, and can contain uppercase, lowercase, and numeric characters. It cannot contain white spaces or special characters.
* **Description** – (Required) The Onyx Edge's description.
* **Provisioning** – The Provisioning Server uses the Onyx Edge's eth0 hardware address to generate and provision the keys required for it to operate with the Onyx Portal.
* **Onyx Edge HW Address** – (Required) The Onyx Edge's eth0 hardware address.
To obtain the eth0 hardware address:
* Towards the end of the Onyx Edge ISO software installation, the screen displays the Onyx Edge's eth0 hardware address.
* If you have management access to the Onyx Edge, run the `show_gateway_info.py` command. From the command's output get the eth0 hardware address displayed against the OnyxEdge ID parameter.
* If you do not have management access to the Onyx Edge, contact GXC Technical Support.
{% endstep %}
{% step %}
In the lower-right corner of the page, click **Configure Core**.
The **Create Onyx Edge** page > **Core** tab is displayed.
{% endstep %}
{% step %}
Enter the following details.
* **UE IP Configuration**
* **IP Range** – (Required) The IP address range from which the Onyx Edge will allocate IP addresses to UE. For example, 192.168.128.0/24.
* **IP Retention Time** – (Required) The duration (in seconds) for which a UE's IP address is retained/leased after it disconnects. Default: 604800 (7 days).
* **DNS Server for UE**
* **Onyx Edge-as-DNS-Server** – Enable or disable the Onyx Edge functioning as the DNS server for UE. Default setting: enabled.
* **DNS Primary** – (Displayed only when **Onyx Edge-as-DNS-Server** is disabled. Required.) The primary DNS server IP address. Default value: 8.8.8.8.
* **DNS Secondary** – (Displayed only when **Onyx Edge-as-DNS-Server** is disabled. Required.) The secondary DNS server IP address. Default value: 8.8.4.4.
* **Second Server** – (Displayed only when **Onyx Edge-as-DNS-Server** is enabled.) If the ONYX-Edge-as-DNS-Server is unavailable, or if it fails to resolve the domain name, the UE will contact this Second DNS Server for domain name resolution.
* **DNS Server IP** – (Displayed only when **Second Server** is enabled. Or, if **Onyx Edge-as-DNS-Server** is disabled. Required.) IP address of the second DNS server.
* **Management Interface**
* **Static** – Select to configure the management network parameters. Default setting: disabled.
* **Management IP/Subnet** – (Required) The management IP address for Onyx Edge to reach corporate network/Internet. Example: 1.1.1.1/24.
* **N6 IP** – (Required) The N6 interface's IP address. Example: 1.1.1.1.
* **Gateway** – (Required) The corporate gateway router IP address. Example: 1.1.1.1.
* **DNS Primary** – (Required) The primary DNS server IP address. Example: 8.8.8.8.
* **DNS Secondary** – The secondary DNS server IP address. Example: 8.8.4.4.
* **DHCP** – Select to enable DHCP for management interface, to get IP address for the management interface. Default setting: enabled.
* **NAS Security Algorithms** – Configure the security algorithms used for Non-Access Stratum (NAS) signaling — the control plane protocol between UE and the 5G Core.
* **Integrity Algorithm** – Algorithm used to ensure NAS message integrity.
* **NIA1** – 128-SNOW 3G integrity protection
* **NIA2** – (Default) 128-bit AES-based integrity protection (standard 5G/LTE algorithm)
* **Encryption Algorithm** – Algorithm used to encrypt NAS messages.
* **NEA2** – (Default) 128-bit AES-based ciphering
* **NEA0** – Null encryption
{% endstep %}
{% step %}
In the lower-right corner of the page, click **Configure RAN**.
The **Create Onyx Edge** page > **RAN** tab is displayed.
{% endstep %}
{% step %}
Enter the following details.
* **Slot Pattern** – (Required) Select the DL/UL Subframe Assignment (SA). The DL/UL Distribution SA configuration refers to allocating specific subframes within the radio frame for downlink and uplink data transmissions, facilitating efficient data exchange between the AP and UE.
* **Same as Network** – Inherits the network-level DL/UL Distribution configuration. To view the network-level slot pattern, hover your cursor over the **Same as Network** option.
* **DDDDDDDSUU (DL 77%, UL** **21%)** – Allocates approximately 77% subframes for downlink and 21% for uplink.
* **DDDSU (DL 74%, UL 23%)** – Allocates approximately 74% subframes for downlink and 23% for uplink.
* **DDSUU (DL 54%, UL 43%)** – Allocates approximately 54% subframes for downlink and 43% for uplink.
* **DSUUU (DL 34%, UL 63%)** – Allocates approximately 34% subframes for downlink and 63% for uplink.
* **DSUUUUDSUU** (**DL 25%, UL 72%)** – Allocates approximately 25% subframes for downlink and 72% for uplink.
* **DDSUUUUUUU** (**DL 20%, UL 77%)** – Allocates approximately 20% subframes for downlink and 77% for uplink.
* **Band** – Click to select the frequency band used for communication between UE and the network.
* **N48** – A 5G frequency band (3550–3700 MHz) that offers a balance of coverage and capacity with shared spectrum access.
* **N78** – A widely adopted 5G frequency band (3300–3800 MHz) ideal for enhanced mobile broadband in urban and suburban areas, offering high data rates and capacity for various commercial 5G applications.
* **N77** – A broader mid-band frequency that ranges from 3300–4200 MHz, often utilized in global 5G networks to provide high-capacity and low-latency connectivity.
* **RAN Security Algorithms** – RAN security protects traffic between UE and the RAN.
* **Encryption / Integrity Algorithms** (Required)
* **NEA2/NIA2** – (Default) 128-AES encryption and integrity
* **NEA1/NIA1** – 128-SNOW 3G encryption and integrity
* **NEA0/NIA1** – Null encryption with 128-SNOW 3G integrity
* **Timing Source** – Select the timing synchronization source for the Onyx Edge RAN.
* **Free Running** – The Onyx Edge uses its internal oscillator as the timing reference, with no external synchronization. Suitable for isolated single-cell deployments where inter-cell time alignment is not required.
* **GPS** – The Onyx Edge synchronizes to a GPS receiver for accurate, UTC-traceable time/phase synchronization. Required for multi-cell TDD deployments to ensure correct DL/UL slot coordination and prevent inter-cell interference. Requires a GPS antenna with clear sky visibility at the deployment site.
* **Multi-Port Attach** – Enable or disable the Multi-Port Attach feature, which allows UE to attach through any active AP's transmission port, improving coverage and connection success rates by removing restrictions to specific ports. For more information, see [*Multi-Port Attach Support*](#multi-port-attach-support).
* **Add Cell** – Click to add a cell. The **Add Cell** dialog box is displayed.
1. In the **General** tab, enter the following details.
Applicable to N48 with SAS disabled, N77, and N78 bands:
* **SAS Enabled** – (Applicable only to N48 band.) Keep disabled. Default setting: disabled.
* **Name** – (Required) The cell's name.
* **BW (MHz)** – (Required) Select the bandwidth.
* **Freq (MHz)** – (Required) Click to select the frequency.
* **Associated AP/FHM \[Band N\*\*]** – Click to select the associated AP/FHM.
* **PSS (for PCI)** – (Required) Click to select the Primary Synchronization Signal (PSS) index used for cell identification during UE synchronization. Contact GXC Technical Support for the correct PSS value for your deployment.
Applicable to N48 band with SAS enabled:
* **SAS Enabled** – Enable. Default setting: disabled.
* **Name** – (Required) The cell's name.
* **User ID** – (Required) The SAS account's user ID.
NOTE: To obtain the SAS user ID, contact GXC Technical Support.
* **Preferred BW (MHz)** – (Required) The preferred bandwidth in MHz for the cell. Default value: 40 MHz.
* **Preferred Freq (MHz) in Priority Order** – (Required) Click to select the preferred frequencies in MHz for the cell in order of priority. That is, select the highest priority first, followed by the second priority, and so on.
* **Strict Freq Preference** – (Required) Click to specify whether the selected preferred frequencies must be strictly adhered to. Default value: True.
When enabled (True), grant requests are limited to the preferred frequency range. If the preferred bandwidth is unavailable, the system may attempt the same frequency with a lower bandwidth.
When disabled (False), the next best frequency will be requested for the grant.
* **PSS (for PCI)** – (Required) Click to select the Primary Synchronization Signal index used for cell identification during UE synchronization. Contact GXC Technical Support for the correct PSS value for your deployment.
* **Access Point Association** – Cell–AP/FHM association configuration:
* **Associated AP/FHM** – (Required) Click to select the AP or FHM to associate with this cell.
FHM selection enables managing SAS configuration for cells associated with FHMs, enabling unified control of SAS settings for all APs associated with an FHM.
* **CBSD Category** – (Required) Click to select the CBSD category. Category A for devices that operate at maximum 30 dBm EIRP, and Category B for devices that operate at maximum 47 dBm EIRP. Default value: A.
* **Antenna Gain (dBi)** – (Required) The antenna gain in decibels relative to an isotropic radiator (dBi). Default value: 0.
* **No. of Antenna Ports** – (Required) The number of antennas associated with the cell. Number of CBSD based on the deployment type—Single Carrier: 1.
* G505 – Must be 1 or 2.
Number of Antenna Ports refers to radio deployments where a single radio has multiple antennas facing geographically distinct areas. This would be the case of a DC deployment where each carrier is connected to separate physical antennas each facing dissimilar coverage areas. The same is true for CA. In this case, each antenna is defined as a separate CBSD with a unique serial number. The CPI chooses the sector ID number for each installation and appends it to the original serial number of the radio serving the antennas. For example, if the serial number of the radio is 1234, one sector serial number can be 1234:1, and the other could be registered with serial number 1234:2.
NOTE: SAS-Enabled FHM Cell Behavior: When SAS is enabled for a cell associated with an FHM, the following restrictions apply to the Preferred Frequencies (MHz) in Priority Order parameter: 1. Only one center frequency can be selected. 2. Strict Preference is automatically set to True, and it cannot be modified. 3. If multiple frequencies were selected before associating the cell with an FHM, the first frequency in the original selection will be retained as the active choice.
2. In the **Handover** tab, enter the following details:
* **Explicit Neighbors** – Toggle to enable or disable an explicit neighbor configuration for this cell. When disabled, all cells associated with the Onyx Edge are automatically configured as the cell’s neighbors. Default setting: disabled.
* **Select Neighbor Cell (Priority Order)** – (Displayed when **Explicit Neighbors** is enabled.) Click to select one or more neighbor cells, in priority order, for explicit handover targeting.
* **Show Advanced Configuration** / **Hide Advanced Configuration** – Click to expand or collapse the advanced handover parameters.
* **Handover Thresholds**
* **A5 RSRP** – (Required)
* **Serving Cell** – The serving cell RSRP threshold (dBm) for triggering an A5 handover event. The serving cell’s signal strength must fall below this threshold to qualify for handover evaluation. Ensures handovers only occur when serving cell signal is genuinely weak. Default value: 56.
* **Neighbor Cell** – The neighbor cell RSRP threshold (dBm) for triggering an A5 handover event. The neighboring cell’s signal strength must exceed this threshold to be considered a valid handover target. This prevents handovers to cells with insufficient signal quality. Default value: 59.
* **A1 RSRP** – (Required) The RSRP threshold (dBm) for the A1 handover event. The RSRP threshold above which the serving cell’s signal is considered acceptable. When this threshold is met, the UE is instructed to stop measuring neighbor cells. This optimizes battery life by stopping unnecessary measurements when signal is strong. Default value: 71.
* **A2 RSRP** – (Required) The RSRP threshold (dBm) for the A2 handover event. The RSRP threshold below which the serving cell’s signal quality is considered poor. When this threshold is met, the UE is instructed to start measuring neighbor cells in preparation for a potential handover. Default value: 66.
* **A3 Offset RSRP** – (Required) The RSRP offset (dB) for the A3 handover event. The signal strength margin (in dB) by which the neighbor cell's RSRP must exceed the serving cell's RSRP to trigger a handover. This offset helps prevent unnecessary handovers due to minor signal fluctuations. Default value: 10.
* **Timing Parameters**
* **Hysteresis (dB)** – (Required) The hysteresis margin applied before triggering a handover measurement report. A buffer value that prevents handover flapping due to small signal fluctuations. The neighbor cell's signal must exceed the serving cell’s signal by this margin (in dB) for the handover to be triggered. Default value: 1.
* **Time To Trigger (ms)** – (Required) The time duration (in milliseconds) that a qualifying signal condition must persist before a handover is initiated. This prevents unnecessary handovers due to temporary signal variations. Default value: 480.
3. Click **Submit** to save the cell.
{% endstep %}
{% step %}
In the lower-right corner of the page, click **Configure Others**.
The **Create Onyx Edge** page > **Others** tab is displayed.
{% endstep %}
{% step %}
Enter the following details.
* **CPE Monitoring** – (Optional) Enable or disable data-path latency monitoring for UE connected to the Onyx Edge.
When enabled, the Onyx Edge sends ICMP pings every one minute to each connected UE. The ping RTT latency is measured and reported in the per subscriber details. See **Subscribers** > Subscriber details > **UE Latency** parameter.
NOTE: It is recommended to enable CPE Monitoring only when required as the Onyx Edge keeps sending ICMP pings every one minute to each connected UE and keeps the radio interface busy.
NOTE: Some commercially available UE have ICMP ping responses disabled. In such cases, CPE monitoring for the UE fails. In this case, in the subscriber details, the Last Reported Time parameter is blank, displayed as --.
* **Spectrum Analyzer** – (Optional) Enable or disable the Spectrum Analyzer feature for the Onyx Edger to analyze RF/wireless signal quality on the 5G network. For more information, see 5G *Spectrum Analyzer Application Note*.
* **Backhaul Speedtest** – Configure servers used to measure backhaul link performance.
* **Add Server** – Add a new speedtest server.
*  (Drag Handle) icon – Drag-and-drop to reorder speedtest server position.
* **Priority** – Order in which speedtest servers are tried (1 = highest priority).
* **URL** – (Required) Hostname of the speedtest server.
* **Start Port** – Beginning of the port range used for the speedtest connection. Default: 5200.
* **End Port** – End of the port range used for the speedtest connection. Default: 5209.
* **Actions** – Delete icon to remove a speedtest server entry.
{% endstep %}
{% step %}
To save the Onyx Edge, in the upper-right corner of the page, click **Save Onyx Edge**.
{% endstep %}
{% endstepper %}
#### Add Onyx Edge (NR+Core) in VLAN Mode
{% hint style="info" %}
**NOTE:** You can add an Onyx Edge only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}
{% hint style="info" %}
**NOTE:** Before you add an Onyx Edge On-Premises, make sure the customer account and the required network and venue exist.
{% endhint %}
{% hint style="info" %}
**NOTE:** To add Onyx Edge in VLAN mode, VLAN mode must be enabled at the network level.
{% endhint %}
{% hint style="info" %}
**NOTE**: For detailed information on the networking modes supported by the GXC 5G Onyx Platform, refer to the *4G & 5G Networking Modes Application Note*. The document covers NAT and Bridge (APN-on-VLAN) modes detailing their architectures, traffic flows, isolation characteristics, and trade-offs. It also provides step-by-step configuration guidance for each mode via the Onyx Portal.
{% endhint %}
**To add an Onyx Edge (NR+Core) to a 5G network in VLAN Mode:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page > **Onyx Edge** tab displays the summary details of all Onyx Edge configured in the network.
{% endstep %}
{% step %}
In the upper-right corner of the page, click **Add Node** > **Add Onyx Edge**.
The **Create Onyx Edge** page > **Onyx Edge** tab is displayed.
{% endstep %}
{% step %}
Enter the following details:
* **Type** – (Required) Select the Onyx Edge type **NR+Core**. Default value: **NR+Core**.
NOTE: After you add an Onyx Edge, its type cannot be changed.
* **Venue** – (Required) Select the venue hosting the Onyx Edge.
* **Onyx Edge Name** – (Required) The Onyx Edge's name.
* **Host Name** – (Optional) The Onyx Edge's host name to be displayed in the Onyx Edge equipment's interface. The host name must be an alphanumeric string of 5–64 characters, and can contain uppercase, lowercase, and numeric characters. It cannot contain white spaces or special characters.
* **Description** – (Required) The Onyx Edge's description.
* **Provisioning** – The Provisioning Server uses the Onyx Edge's eth0 hardware address to generate and provision the keys required for each Onyx Edge to operate with the Onyx Portal.
* **Onyx Edge HW Address** – (Required) The Onyx Edge's eth0 hardware address.
To obtain the eth0 hardware address:
* Towards the end of the Onyx Edge ISO software installation, the screen displays the Onyx Edge's eth0 hardware address.
* If you have management access to the Onyx Edge, run the `show_gateway_info.py` command. From the command's output get the eth0 hardware address displayed against the OnyxEdge ID parameter.
* If you do not have management access to the Onyx Edge, contact GXC Technical Support.
{% endstep %}
{% step %}
In the lower-right corner of the page, click **Configure Core**.
The **Create Onyx Edge** page > **Core** tab is displayed.
{% endstep %}
{% step %}
Enter the following details.
* **UE IP Configuration**
* **IP Retention Time** – (Required) The duration (in seconds) for which a UE's IP address is retained/leased after it disconnects. Default value: 604800 sec (7 days).
* **Onyx Edge-as-DNS-Server** – (Always disabled.) Indicates the Onyx Edge does not function as the primary DNS server for UE. DNS resolution is handled by external servers configured below.
* **DNS Primary** – (Required) The primary DNS server's IP address. Default value: 8.8.8.8.
* **DNS Secondary** – (Required) The secondary DNS server's IP address. Default value: 8.8.4.4.
* **Management Interface**:
* **Static** – Selected by default.
* **Management IP/Subnet** – (Required) The management IP address for Onyx Edge to reach corporate network/Internet. Example: 1.1.1.1/24.
* **N6 IP** – (Required) The N6 interface's IP address. Example: 1.1.1.1.
* **Gateway** – (Required) The corporate gateway router IP address. Example: 1.1.1.1.
* **Management VLAN** – The Management VLAN ID. Default value: 0.
* **DNS Primary** – (Required) The primary DNS server IP address. Example: 8.8.8.8.
* **DNS Secondary** – The secondary DNS server IP address. Example: 8.8.4.4.
* **NAS Security Algorithms** – Configure the security algorithms used for Non-Access Stratum (NAS) signaling — the control plane protocol between UE and the 5G Core.
* **Integrity Algorithm** – Algorithm used to ensure NAS message integrity.
* **NIA1** – 128-SNOW 3G integrity protection
* **NIA2** – (Default) 128-bit AES-based integrity protection (standard 5G/LTE algorithm)
* **Encryption Algorithm** – Algorithm used to encrypt NAS messages.
* **NEA2** – (Default) 128-bit AES-based ciphering
* **NEA0** – Null encryption
* **DHCP Server Monitoring** – Toggle to enable or disable DHCP Server Monitoring for this Onyx Edge. To enable DHCP Server Monitoring, at least one APN with a VLAN must be configured.
* **MAC** — (Displayed only when **DHCP Server Monitoring** is **Enabled**.) The MAC address used by the monitoring probe when sending DHCP requests — **Random**, **Explicit**. Random, which generates a random MAC address for each probe request. Explicit, which allows a specific MAC address to be entered. Default: Random.
* **MAC Address** — (Displayed only when **MAC** is set to **Explicit**) The specific MAC address for the monitoring probe.
* **Frequency (Minutes)** — (Displayed only when **DHCP Server Monitoring** is **Enabled**. Required.) How often the system sends a DHCP probe to check server availability, in minutes. Default: 30.
* **VLAN** — (Displayed only when **DHCP Server Monitoring** is **Enabled**. Required.) The VLAN on which the monitoring probe sends DHCP requests.
{% endstep %}
{% step %}
In the lower-right corner of the page, click **Configure RAN**.
The **Create Onyx Edge** page > **RAN** tab is displayed.
{% endstep %}
{% step %}
Enter the following details.
* **Slot Pattern** – (Required) Select the DL/UL Subframe Assignment (SA). The DL/UL Distribution SA configuration refers to allocating specific subframes within the radio frame for downlink and uplink data transmissions, facilitating efficient data exchange between the AP and UE.
* **Same as Network** – Inherits the network-level DL/UL Distribution configuration. To view the network-level slot pattern, hover your cursor over the **Same as Network** option.
* **DDDDDDDSUU (DL 77%, UL** **21%)** – Allocates approximately 77% subframes for downlink and 21% for uplink.
* **DDDSU (DL 74%, UL 23%)** – Allocates approximately 74% subframes for downlink and 23% for uplink.
* **DDSUU (DL 54%, UL 43%)** – Allocates approximately 54% subframes for downlink and 43% for uplink.
* **DSUUU (DL 34%, UL 63%)** – Allocates approximately 34% subframes for downlink and 63% for uplink.
* **DSUUUUDSUU** (**DL 25%, UL 72%)** – Allocates approximately 25% subframes for downlink and 72% for uplink.
* **DDSUUUUUUU** (**DL 20%, UL 77%)** – Allocates approximately 20% subframes for downlink and 77% for uplink.
* **Band** – (Required) Click to select the frequency band used for communication between UE and the network.
* **N48** – A 5G frequency band (3550–3700 MHz) that offers a balance of coverage and capacity with shared spectrum access.
* **N78** – A widely adopted 5G frequency band (3300–3800 MHz) ideal for enhanced mobile broadband in urban and suburban areas, offering high data rates and capacity for various commercial 5G applications.
* **N77** – A broader mid-band frequency that ranges from 3300–4200 MHz, often utilized in global 5G networks to provide high-capacity and low-latency connectivity.
* **RAN Security Algorithms** – RAN security protects traffic between UE and the RAN.
* **Encryption / Integrity Algorithms**
* **NEA2/NIA2** – (Default) 128-AES encryption and integrity
* **NEA1/NIA1** – 128-SNOW 3G encryption and integrity
* **NEA0/NIA1** – Null encryption with 128-SNOW 3G integrity
* **Timing Source** – Select the timing synchronization source for the Onyx Edge RAN.
* **Free Running** – The Onyx Edge uses its internal oscillator as the timing reference, with no external synchronization. Suitable for isolated single-cell deployments where inter-cell time alignment is not required.
* **GPS** – The Onyx Edge synchronizes to a GPS receiver for accurate, UTC-traceable time/phase synchronization. Required for multi-cell TDD deployments to ensure correct DL/UL slot coordination and prevent inter-cell interference. Requires a GPS antenna with clear sky visibility at the deployment site.
* **Multi-Port Attach** – Enable or disable the Multi-Port Attach feature, which allows UE to attach through any active AP's transmission port, improving coverage and connection success rates by removing restrictions to specific ports. For more information, see [*Multi-Port Attach Support*](#multi-port-attach-support).
* **Add Cell** – Click to add a cell. The **Add Cell** dialog box is displayed.
1. In the **General** tab, enter the following details.
Applicable to N48 with SAS disabled, N77, and N78 bands:
* **SAS Enabled** – (Applicable only to N48 band.) Keep disabled. Default setting: disabled.
* **Name** – (Required) The cell's name.
* **BW (MHz)** – (Required) Select the bandwidth.
* **Freq (MHz)** – (Required) Click to select the frequency.
* **Associated AP/FHM \[Band N\*\*]** – Click to select the associated AP/FHM.
* **PSS (for PCI)** – (Required) Primary Synchronization Signal index used for cell identification during UE synchronization. Contact GXC Technical Support for the correct PSS value for your deployment.
Applicable to N48 band with SAS enabled:
* **SAS Enabled** – (Applicable only to N48 band.) Enable. Default setting: disabled.
* **Name** – (Required) The cell's name.
* **User ID** – (Required) The SAS account's user ID.
NOTE: For more information, contact GXC Technical Support.
* **Preferred BW (MHz)** – (Required) The preferred bandwidth in MHz for the cell. Default value: 40 MHz.
* **Preferred Freq (MHz) in Priority Order** – (Required) Click to select the preferred frequencies in MHz for the cell in order of priority. That is, select the highest priority first, followed by the second priority, and so on.
* **Strict Freq Preference** – (Required) Click to specify whether the selected preferred frequencies must be strictly adhered to. Default value: True.
When enabled (True), grant requests are limited to the preferred frequency range. If the preferred bandwidth is unavailable, the system may attempt the same frequency with a lower bandwidth.
When disabled (False), the next best frequency will be requested for the grant.
* **PSS (for PCI)** – (Required) Click to select the Primary Synchronization Signal index used for cell identification during UE synchronization. Contact GXC Technical Support for the correct PSS value for your deployment.
* **Access Point Association** – Cell–AP/FHM association configuration:
* **Associated AP/FHM** – (Required) Click to select the AP or FHM to associate with this cell.
FHM selection enables managing SAS configuration for cells associated with FHMs, enabling unified control of SAS settings for all APs associated with an FHM.
* **CBSD Category** – (Required) Click to select the CBSD category. Category A for devices that operate at maximum 30 dBm EIRP, and Category B for devices that operate at maximum 47 dBm EIRP. Default value: A.
* **Antenna Gain (dBi)** – (Required) The antenna gain in decibels relative to an isotropic radiator (dBi). Default value: 0.
* **No. of Antenna Ports** – (Required) The number of antennas associated with the cell. Number of CBSD based on the deployment type—Single Carrier: 1.
* G505 AP – Must be 1 or 2.
Number of Antenna Ports refers to radio deployments where a single radio has multiple antennas facing geographically distinct areas. This would be the case of a DC deployment where each carrier is connected to separate physical antennas each facing dissimilar coverage areas. The same is true for CA. In this case, each antenna is defined as a separate CBSD with a unique serial number. The CPI chooses the sector ID number for each installation and appends it to the original serial number of the radio serving the antennas. For example, if the serial number of the radio is 1234, one sector serial number can be 1234:1, and the other could be registered with serial number 1234:2.
NOTE: SAS-Enabled FHM Cell Behavior: When SAS is enabled for a cell associated with an FHM, the following restrictions apply to the Preferred Frequencies (MHz) in Priority Order parameter: 1. Only one center frequency can be selected. 2. Strict Preference is automatically set to True, and it cannot be modified. 3. If multiple frequencies were selected before associating the cell with an FHM, the first frequency in the original selection will be retained as the active choice.
2. In the **Handover** tab, enter the following details:
* **Explicit Neighbors** – Toggle to enable or disable explicit neighbor configuration for this cell. When disabled, all cells associated with the Onyx Edge are automatically configured as the cell’s neighbors. Default setting: disabled.
* **Select Neighbor Cell (Priority Order)** – (Displayed when **Explicit Neighbors** is enabled.) Click to select one or more neighbor cells, in priority order, for explicit handover targeting.
* **Show Advanced Configuration** / **Hide Advanced Configuration** – Click to expand or collapse the advanced handover parameters.
* **Handover Thresholds**
* **A5 RSRP** – (Required)
* **Serving Cell** – The serving cell RSRP threshold (dBm) for triggering an A5 handover event. The serving cell’s signal strength must fall below this threshold to qualify for handover evaluation. Ensures handovers only occur when serving cell signal is genuinely weak. Default value: 56.
* **Neighbor Cell** – The neighbor cell RSRP threshold (dBm) for triggering an A5 handover event. The neighboring cell’s signal strength must exceed this threshold to be considered a valid handover target. This prevents handovers to cells with insufficient signal quality. Default value: 59.
* **A1 RSRP** – (Required) The RSRP threshold (dBm) for the A1 handover event. The RSRP threshold above which the serving cell’s signal is considered acceptable. When this threshold is met, the UE is instructed to stop measuring neighbor cells. This optimizes battery life by stopping unnecessary measurements when signal is strong. Default value: 71.
* **A2 RSRP** – (Required) The RSRP threshold (dBm) for the A2 handover event. The RSRP threshold below which the serving cell’s signal quality is considered poor. When this threshold is met, the UE is instructed to start measuring neighbor cells in preparation for a potential handover. Default value: 66.
* **A3 Offset RSRP** – (Required) The RSRP offset (dB) for the A3 handover event. The signal strength margin (in dB) by which the neighbor cell's RSRP must exceed the serving cell's RSRP to trigger a handover. This offset helps prevent unnecessary handovers due to minor signal fluctuations. Default value: 10.
* **Timing Parameters**
* **Hysteresis (dB)** – (Required) The hysteresis margin applied before triggering a handover measurement report. A buffer value that prevents handover flapping due to small signal fluctuations. The neighbor cell's signal must exceed the serving cell’s signal by this margin (in dB) for the handover to be triggered. Default value: 1.
* **Time To Trigger (ms)** – (Required) The time duration (in milliseconds) that a qualifying signal condition must persist before a handover is initiated. This prevents unnecessary handovers due to temporary signal variations. Default value: 480.
3. Click **Submit** to save the cell.
{% endstep %}
{% step %}
In the lower-right corner of the page, click **Configure APN-VLAN**.
The **Create Onyx Edge** page > **APN-VLAN** tab is displayed.
{% endstep %}
{% step %}
Enter the following details.
Map APN profiles to specific VLAN and gateway configurations for user plane traffic routing. The **APN-VLAN** tab displays the following parameters for the "Internet" APN and any other APNs configured in the network. Verify/update these details for each APN.
* **APN ID** – (Read only) The APN's ID.
* **Local IP / Subnet** – (Required) The local IP address / subnet of the Onyx Edge on the VLAN. It must be unique across all APNs. It must be configured if the VLAN is different from the Management-VLAN.
* **Default GW IP** – (Required) The Onyx Edge's IP address.
* **VLAN** – (Required) The VLAN ID. Each APN must be on a different VLAN. Only one APN can share the Management VLAN at a time. The VLAN ID must be unique across all APNs and can be 0 or 2–4095.
* **Default GW MAC** – (Optional) The Onyx Edge's MAC address.
* **UE-IP-Block**
* **Enable** – Enable/disable static UE IP block allocation for this APN instead of dynamic assignment.
* **Start** – (Active only when **Enable** is on.) First IP address in the static block assigned to UE on this APN.
* **End** – (Active only when **Enable** is on.) Last IP address in the static block assigned to UE on this APN (active only when Enable is on).
{% endstep %}
{% step %}
In the lower-right corner of the page, click **Configure Others**.
The **Create Onyx Edge** page > **Others** tab is displayed.
{% endstep %}
{% step %}
Enter the following details.
* **CPE Monitoring** – (Optional) Enable or disable data-path latency monitoring for UE connected to the Onyx Edge.
When enabled, the Onyx Edge sends ICMP pings every one minute to each connected UE. The ping RTT latency is measured and reported in the per subscriber details. See **Subscribers** > Subscriber details > **UE Latency** parameter.
NOTE: It is recommended to enable CPE Monitoring only when required as the Onyx Edge keeps sending ICMP pings every one minute to each connected UE and keeps the radio interface busy.
NOTE: Some commercially available UE have ICMP ping responses disabled. In such cases, CPE monitoring for the UE fails. In the subscriber details, the Last Reported Time parameter is displayed as blank --.
* **Spectrum Analyzer** – (Optional) Enable or disable Spectrum Analyzer for the Onyx Edge to analyze RF/wireless signal quality on the 5G network. For more information, see *5G Spectrum Analyzer Application Note*.
* **Backhaul Speedtest** – Configures servers used to measure backhaul link performance.
* **Add Server** – Add a new speedtest server.
*  (Drag Handle) icon – Drag-and-drop to reorder the speedtest server's priority.
* **Priority** – Order in which speedtest servers are tried (1 = highest priority). Rows can be reordered by drag-and-drop.
* **URL** – (Required) The speedtest server's hostname/URL.
* **Start Port** – Beginning of the port range used for the speedtest connection. Default: 5200.
* **End Port** – End of the port range used for the speedtest connection. Default: 5209.
* **Actions** – Delete icon to remove a speedtest server entry.
{% endstep %}
{% step %}
To save the Onyx Edge, in the upper-right corner of the page, click **Save Onyx Edge**.
{% endstep %}
{% endstepper %}
### Add Onyx Edge (Core-Only)
This section describes how to add an Onyx Edge in the following modes:
* [*Add Onyx Edge (Core-Only) in NAT Mode*](#add-onyx-edge-core-only-in-nat-mode)
* [*Add Onyx Edge (Core-Only) in VLAN Mode*](#add-onyx-edge-core-only-in-vlan-mode)
#### Add Onyx Edge (Core-Only) in NAT Mode
{% hint style="info" %}
**NOTE:** You can add an Onyx Edge only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}
{% hint style="info" %}
**NOTE:** Before adding an Onyx Edge On-Premises, make sure that the customer account, required network, and venue are already set up.
{% endhint %}
{% hint style="info" %}
**NOTE:** To add Onyx Edge in NAT mode, VLAN mode must be disabled at the network level.
{% endhint %}
{% hint style="info" %}
**NOTE**: For detailed information on the networking modes supported by the GXC 5G Onyx Platform, refer to the *4G & 5G Networking Modes Application Note*. The document covers NAT and Bridge (APN-on-VLAN) modes detailing their architectures, traffic flows, isolation characteristics, and trade-offs. It also provides step-by-step configuration guidance for each mode via the Onyx Portal.
{% endhint %}
**To add an Onyx Edge (Core-Only) to a 5G network in NAT mode:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page > **Onyx Edge** tab displays the summary details of all Onyx Edge configured in the network.
{% endstep %}
{% step %}
In the upper-right corner of the page, click **Add Node** > **Add Onyx Edge**.
The **Create Onyx Edge** page > **Onyx Edge** tab is displayed.
{% endstep %}
{% step %}
Enter the following details:
* **Type** – (Required) Select Onyx Edge type **Core-Only**. Default value: **NR+Core**.
NOTE: After you add an Onyx Edge, its type cannot be changed.
* **Venue** – (Required) Select the venue hosting the Onyx Edge.
* **Onyx Edge Name** – (Required) The Onyx Edge's name.
* **Host Name** – (Optional) The Onyx Edge's host name to be displayed in the Onyx Edge equipment's interface. The host name must be an alphanumeric string of 5–64 characters, and can contain uppercase, lowercase, and numeric characters. It cannot contain white spaces or special characters.
* **Description** – (Required) The Onyx Edge's description.
* **Provisioning** – The Provisioning Server uses the Onyx Edge's eth0 hardware address to generate and provision the keys required for it to operate with the Onyx Portal.
* **Onyx Edge HW Address** – (Required) The Onyx Edge's eth0 hardware address.
To obtain the eth0 hardware address:
* Towards the end of the Onyx Edge ISO software installation, the screen displays the Onyx Edge's eth0 hardware address.
* If you have management access to the Onyx Edge, run the `show_gateway_info.py` command. From the command's output get the eth0 hardware address displayed against the OnyxEdge ID parameter.
* If you do not have management access to the Onyx Edge, contact GXC Technical Support.
* **Enable Onyx Edge Pool** – (Enabled only if at least one Onyx Edge pool exists in the network.) To associate the Onyx Edge with an Onyx Edge pool, turn on the toggle button.
* **AMF Pool** – (Required) Click to select the Onyx Edge pool. Onyx Edge can be deployed as a pool for AMF/Onyx Edge High Availability. For information on High Availability and managing Onyx Edge pools, see [*Manage Onyx Edge High Availability*](https://docs.gxc.io/installation-and-operations-guides/4g-onyx-portal-4.x-operations/manage-equipment/manage-onyx-edge#manage-onyx-edge-high-availability).
{% endstep %}
{% step %}
In the lower-right corner of the page, click **Configure Core**.
The **Create Onyx Edge** page > **Core** tab is displayed.
{% endstep %}
{% step %}
Enter the following details.
* **UE-IP-Configuration**
* **IP Block** – (Required) The IP address pool from which the Onyx Edge will allocate IP addresses to UE. For example, 192.168.128.0/24.
* **IP Retention Time** – (Required) The duration (in seconds) for which a UE's IP address is retained/leased after it disconnects. Default value: 604800 (7 days).
* **DNS Server for UE**
* **Onyx Edge-as-DNS-Server** – Enable or disable the Onyx Edge functioning as the DNS server for UE. Default setting: enabled.
* **DNS Primary** – (Displayed only when **Onyx Edge-as-DNS-Server** is disabled. Required.) The primary DNS server IP address. Default value: 8.8.8.8.
* **DNS Secondary** – (Displayed only when **Onyx Edge-as-DNS-Server** is disabled. Required.) The secondary DNS server IP address. Default value: 8.8.4.4.
* **Second Server** – (Displayed only when **Onyx Edge-as-DNS-Server** is enabled.) If the ONYX-Edge-as-DNS-Server is unavailable, or if it fails to resolve the domain name, the UE will contact this Second DNS Server for domain name resolution.
* **DNS Server IP** – (Displayed only when **Second Server** is enabled. Or, if **Onyx Edge-as-DNS-Server** is disabled. Required.) IP address of the second DNS server.
* **Management Interface**
* **Static** – Select to configure the management network parameters. Default setting: disabled.
* **N6 IP/Subnet** – (Required) The management IP address for Onyx Edge to reach corporate network/Internet. Example: 1.1.1.1/24.
* **Gateway** – (Required) The corporate gateway router IP address. Example: 1.1.1.1.
* **DNS Primary** – (Required) The primary DNS server IP address. Example: 8.8.8.8.
* **DNS Secondary** – The secondary DNS server IP address. Example: 8.8.4.4.
* **DHCP** – Select to enable DHCP for management interface, to get IP address for the management interface. Default setting: enabled.
* **NAS Security Algorithms** – Configure the security algorithms used for Non-Access Stratum (NAS) signaling — the control plane protocol between UE and the 5G Core.
* **Integrity Algorithm** – Algorithm used to ensure NAS message integrity.
* **NIA1** – 128-SNOW 3G integrity protection
* **NIA2** – (Default) 128-bit AES-based integrity protection (standard 5G/LTE algorithm)
* **Encryption Algorithm** – Algorithm used to encrypt NAS messages.
* **NEA2** – (Default) 128-bit AES-based ciphering
* **NEA0** – Null encryption
{% endstep %}
{% step %}
In the lower-right corner of the page, click **Configure RAN**.
The **Create Onyx Edge** page > **RAN** tab is displayed.
{% endstep %}
{% step %}
Enter the following details.
* **NG Interface** – (Required) Select how the Onyx Edge gets its IP address.
* **Static** – Select for deployments where the APs are directly connected to the Onyx Edge and are in an L2 network of their own. When the AP DHCP Service option is also enabled, the Onyx Edge serves as a DHCP server for IP address allocation to directly connected APs. Default setting: enabled.
* **IP/Subnet** – (Applicable only when Static mode is enabled. Required.) The subnet from which the first IP address is used for the NG interface. In the case of AP DHCP Service, the rest are for allocating IP addresses to APs to connect to the Onyx Edge. Default value: 10.0.2.1/24.
* **DHCP** – Select to enable DHCP for IP address allocation for S1 interface of the Onyx Edge. Default setting: disabled.
* **Same as N6** – Select for deployments where the Onyx Edge and AP are not on the same L2 network (private network). Or, where there is no separate L2 network, and the Onyx Edge and AP are directly in the customer's corporate network. The APs get their IP addresses from the customer's network DHCP service.
* **Access Point DHCP Service** – (Applicable only when Static mode is selected. Required.) Enable or disable the AP DHCP service. When enabled, the Onyx Edge serves as a DHCP server for IP address allocation to directly connected APs.
* **Start IP** – (Applicable only when AP DHCP service is enabled. Required.) The start IP address for the DHCP pool. This IP address must be in the same subnet as the static IP address. Default value: 10.0.2.240.
* **No. of IPs** – (Applicable only when AP DHCP service is enabled. Required.) The number of IP addresses. This value must not exceed the maximum number of IP addresses of the subnet from Start IP. Default value: 15.
{% endstep %}
{% step %}
In the lower-right corner of the page, click **Configure Others**.
The **Create Onyx Edge** page > **Others** tab is displayed.
{% endstep %}
{% step %}
Enter the following details.
* **CPE Monitoring** – (Optional) Enable or disable data-path latency monitoring for UE connected to the Onyx Edge.
When enabled, the Onyx Edge sends ICMP pings every one minute to each connected UE. The ping RTT latency is measured and reported in the per subscriber details. See **Subscribers** > Subscriber details > **UE Latency** parameter.
NOTE: It is recommended to enable CPE Monitoring only when required as the Onyx Edge keeps sending ICMP pings every one minute to each connected UE and keeps the radio interface busy.
NOTE: Some commercially available UE have ICMP ping responses disabled. In such cases, CPE monitoring for the UE fails. In this case, in the subscriber details, the Last Reported Time parameter is blank, displayed as --.
* **Backhaul Speedtest** – Configures servers used to measure backhaul link performance.
* **Add Server** – Add a new speedtest server.
*  (Drag Handle) icon – Drag-and-drop to reorder speedtest server priority**.**
* **Priority** – Order in which speedtest servers are tried (1 = highest priority).
* **URL** – (Required) The speedtest server's hostname/URL.
* **Start Port** – Beginning of the port range used for the speedtest connection. Default: 5200.
* **End Port** – End of the port range used for the speedtest connection. Default: 5209.
* **Actions** – Delete icon to remove a speedtest server entry.
* **AGW User Configuration** – (Onyx Edge Core-Only. Optional.) Onyx Edge *agw\_user* configuration. Allows partners and customers to log on to the Onyx Edge to collect basic debug information, reset Onyx Edge parameters to factory settings, etc. For more information, see *Onyx Edge On-Premises Installation and Operations Guide*.
* **Add Keys** – Click to add SSH keys for *agw\_user*.
The **Add SSH Key** dialog box is displayed.
Enter the SSH key, then click **Save**.
You can add a maximum of 10 SSH keys.
* **View All Keys** – Click to view existing SSH keys.
The list of SSH keys is displayed.
You have the option to view details, edit, and delete SSH keys.
* **Change Password** – Click to change the *agw\_user* password.\
The **Change Password** dialog box is displayed.
* **Password** – (Required) Password for *agw\_user*.
* **Confirm Password** – (Required) Reenter the password to confirm.
{% endstep %}
{% step %}
To save the Onyx Edge, in the upper-right corner of the page, click **Save Onyx Edge**.
{% endstep %}
{% endstepper %}
#### Add Onyx Edge (Core-Only) in VLAN Mode
{% hint style="info" %}
**NOTE:** You can add an Onyx Edge only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}
{% hint style="info" %}
**NOTE:** Before you add an Onyx Edge On-Premises, make sure the customer account and the required network and venue exist.
{% endhint %}
{% hint style="info" %}
**NOTE:** To add Onyx Edge in VLAN mode, VLAN mode must be enabled at the network level.
{% endhint %}
{% hint style="info" %}
**NOTE**: For detailed information on the networking modes supported by the GXC 5G Onyx Platform, refer to the *4G & 5G Networking Modes Application Note*. The document covers NAT and Bridge (APN-on-VLAN) modes detailing their architectures, traffic flows, isolation characteristics, and trade-offs. It also provides step-by-step configuration guidance for each mode via the Onyx Portal.
{% endhint %}
**To add an Onyx Edge (Core-Only) to a 5G network in VLAN Mode:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page > **Onyx Edge** tab displays the summary details of all Onyx Edge configured in the network.
{% endstep %}
{% step %}
In the upper-right corner of the page, click **Add Node** > **Add Onyx Edge**.
The **Create Onyx Edge** page > **Onyx Edge** tab is displayed.
{% endstep %}
{% step %}
Enter the following details:
* **Type** – (Required) Click to select the Onyx Edge type, **Core-Only**. Default value: **NR+Core**.
NOTE: After you add an Onyx Edge, its type cannot be changed.
* **Venue** – (Required) Select the venue hosting the Onyx Edge.
* **Onyx Edge Name** – (Required) The Onyx Edge's name.
* **Host Name** – (Optional) The Onyx Edge's host name to be displayed in the Onyx Edge equipment's interface. The host name must be an alphanumeric string of 5–64 characters, and can contain uppercase, lowercase, and numeric characters. It cannot contain white spaces or special characters.
* **Description** – (Required) The Onyx Edge's description.
* **Provisioning** – The Provisioning Server uses the Onyx Edge's eth0 hardware address to generate and provision the keys required for each Onyx Edge to operate with the Onyx Portal.
* **Onyx Edge HW Address** – (Required) The Onyx Edge's eth0 hardware address.
To obtain the eth0 hardware address:
* Towards the end of the Onyx Edge ISO software installation, the screen displays the Onyx Edge's eth0 hardware address.
* If you have management access to the Onyx Edge, run the `show_gateway_info.py` command. From the command's output get the eth0 hardware address displayed against the OnyxEdge ID parameter.
* If you do not have management access to the Onyx Edge, contact GXC Technical Support.
{% endstep %}
{% step %}
In the lower-right corner of the page, click **Configure Core**.
The **Create Onyx Edge** page > **Core** tab is displayed.
{% endstep %}
{% step %}
Enter the following details.
* **UE IP Configuration** -
* **IP Retention Time** – (Required) The duration (in seconds) for which a UE's IP address is retained/leased after it disconnects. Default value: 604800 sec (7 days).
* **Onyx Edge-as-DNS-Server** – (Always disabled.) Indicates the Onyx Edge does not function as the primary DNS server for UE in VLAN mode. DNS resolution is handled by external servers configured below.
* **DNS Primary** – (Required) The primary DNS server's IP address. Default value: 8.8.8.8.
* **DNS Secondary** – (Required) The secondary DNS server's IP address. Default value: 8.8.4.4.
* **Management Interface**:
* **Static** – Selected by default.
* **N6 IP/Subnet** – (Required) The management IP address for Onyx Edge to reach corporate network/Internet. Example: 1.1.1.1/24.
* **Gateway** – (Required) The corporate gateway router IP address. Example: 1.1.1.1.
* **DNS Primary** – (Required) The primary DNS server IP address. Example: 8.8.8.8.
* **DNS Secondary** – The secondary DNS server IP address. Example: 8.8.4.4.
* **N6 Management VLAN** – (Required) The Management VLAN ID. Default value: 0.
* **NAS Security Algorithms** – Configure the security algorithms used for Non-Access Stratum (NAS) signaling — the control plane protocol between UE and the 5G Core.
* **Integrity Algorithm** – Algorithm used to ensure NAS message integrity.
* **NIA1** – 128-SNOW 3G integrity protection
* **NIA2** – (Default) 128-bit AES-based integrity protection (standard 5G/LTE algorithm)
* **Encryption Algorithm** – Algorithm used to encrypt NAS messages.
* **NEA2** – (Default) 128-bit AES-based ciphering
* **NEA0** – Null encryption
* **DHCP Server Monitoring** – Toggle to enable or disable DHCP Server Monitoring for this Onyx Edge. To enable DHCP Server Monitoring, at least one APN with a VLAN must be configured.
* **MAC** — (Displayed only when **DHCP Server Monitoring** is **Enabled**.) The MAC address used by the monitoring probe when sending DHCP requests — **Random**, **Explicit**. Random, which generates a random MAC address for each probe request. Explicit, which allows a specific MAC address to be entered. Default: Random.
* **MAC Address** — (Displayed only when **MAC** is set to **Explicit**) The specific MAC address for the monitoring probe.
* **Frequency (Minutes)** — (Displayed only when **DHCP Server Monitoring** is **Enabled**. Required.) How often the system sends a DHCP probe to check server availability, in minutes. Default: 30.
* **VLAN** — (Displayed only when **DHCP Server Monitoring** is **Enabled**. Required.) The VLAN on which the monitoring probe sends DHCP requests.
{% endstep %}
{% step %}
In the lower-right corner of the page, click **Configure RAN**.
The **Create Onyx Edge** page > **RAN** tab is displayed.
{% endstep %}
{% step %}
Enter the following details.
* **NG Interface** – (Required) Select how the Onyx Edge gets its IP address.
* **Static** – Select for deployments where the APs are directly connected to the Onyx Edge and are in an L2 network of their own. When the AP DHCP Service option is also enabled, the Onyx Edge serves as a DHCP server for IP address allocation to directly connected APs. Default setting: enabled.
* **IP/Subnet** – (Applicable only when Static mode is enabled. Required.) The subnet from which the first IP address is used for the NG interface. In the case of AP DHCP Service, the rest are for allocating IP addresses to APs to connect to the Onyx Edge. Default value: 10.0.2.1/24.
* **DHCP** – Select to enable DHCP for IP address allocation for S1 interface of the Onyx Edge. Default setting: disabled.
* **Same as N6** – Select for deployments where the Onyx Edge and AP are not on the same L2 network (private network). Or, where there is no separate L2 network, and the Onyx Edge and AP are directly in the customer’s corporate network. The APs get their IP addresses from the customer’s network DHCP service.
* **Access Point DHCP Service** – (Applicable only when Static mode is selected. Required.)
* **Start IP** – (Applicable only when AP DHCP service is enabled. Required.) The start IP address for the DHCP pool. This IP address must be in the same subnet as the static IP address. Default value: 10.0.2.240.
* **No. of IPs** – (Applicable only when AP DHCP service is enabled. Required.) The number of IP addresses. This value must not exceed the maximum number of IP addresses of the subnet from Start IP. Default value: 15.
{% endstep %}
{% step %}
In the lower-right corner of the page, click **Configure APN-VLAN**.
The **Create Onyx Edge** page > **APN-VLAN** tab is displayed.
{% endstep %}
{% step %}
Enter the following details:
Map APN profiles to specific VLAN and gateway configurations for user plane traffic routing. The **APN-VLAN** tab displays the following parameters for the "Internet" APN and any other APNs configured in the network. Verify/update these details for each APN.
* **APN ID** – (Read only) The APN's ID.
* **Local IP / Subnet** – (Required) The local IP address / subnet of the Onyx Edge on the VLAN. It must be unique across all APNs. It must be configured if the VLAN is different from the Management-VLAN.
* **Default GW IP** – (Required) The Onyx Edge's IP address.
* **VLAN ID** – (Required) The VLAN ID. Each APN must be on a different VLAN. Only one APN can share the Management VLAN at a time. The VLAN ID must be unique across all APNs and can be 0 or 2–4095.
* **Default GW MAC** – (Optional) The Onyx Edge's MAC address.
* **UE-IP-Block**
* **Enable** – Enable/disable static UE IP block allocation for this APN instead of dynamic assignment.
* **Start** – (Active only when **Enable** is on.) First IP address in the static block assigned to UE on this APN.
* **End** – (Active only when **Enable** is on.) Last IP address in the static block assigned to UE on this APN.
{% endstep %}
{% step %}
In the lower-right corner of the page, click **Configure Others**.
The **Create Onyx Edge** page > **Others** tab is displayed.
{% endstep %}
{% step %}
Enter the following details.
* **CPE Monitoring** – (Optional) Enable or disable data-path latency monitoring for UE connected to the Onyx Edge.
When enabled, the Onyx Edge sends ICMP pings every one minute to each connected UE. The ping RTT latency is measured and reported in the per subscriber details. See **Subscribers** > Subscriber details > **UE Latency** parameter.
NOTE: It is recommended to enable CPE Monitoring only when required as the Onyx Edge keeps sending ICMP pings every one minute to each connected UE and keeps the radio interface busy.
NOTE: Some commercially available UE have ICMP ping responses disabled. In such cases, CPE monitoring for the UE fails. In the subscriber details, the Last Reported Time parameter is displayed as blank --.
* **Backhaul Speedtest** – Configures servers used to measure backhaul link performance.
* **Add Server** – Add a new speedtest server.
*  (Drag Handle) icon – Drag-and-drop to reorder speedtest server priority.
* **Priority** – Order in which speedtest servers are tried (1 = highest priority).
* **URL** – (Required) Hostname of the speedtest server.
* **Start Port** – Beginning of the port range used for the speedtest connection. Default: 5200.
* **End Port** – End of the port range used for the speedtest connection. Default: 5209.
* **Actions** – Delete icon to remove a speedtest server entry.
* **AGW User Configuration** – (Onyx Edge Core-Only. Optional.) Onyx Edge *agw\_user* configuration. Allows partners and customers to log on to the Onyx Edge to collect basic debug information, reset Onyx Edge parameters to factory settings, etc. For more information, see the *Onyx Edge On-Premises Installation and Operations Guide*.
* **Add Keys** – Click to add SSH keys for *agw\_user*.\
The **Add SSH Key** dialog box is displayed.
Enter the SSH key, then click **Save**.\
You can add a maximum of 10 SSH keys.
* **View All Keys** – Click to view existing SSH keys.\
The list of SSH keys is displayed.\
You have the option to view details, edit, and delete SSH keys.
* **Change Password** – Click to change the *agw\_user* password.
The **Change Password** dialog box is displayed.
* **Password** – (Required) Password for *agw\_user*.
* **Confirm Password** – (Required) Reenter the password to confirm.
{% endstep %}
{% step %}
To save the Onyx Edge, in the upper-right corner of the page, click **Save Onyx Edge**.
{% endstep %}
{% endstepper %}
## Edit Onyx Edge
{% hint style="info" %}
**NOTE:** You can edit Onyx Edge details only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}
**To edit the details of an Onyx Edge in a 5G network:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page > **Onyx Edge** tab displays the summary details of all Onyx Edge configured in the network.
{% endstep %}
{% step %}
For the Onyx Edge that you want to edit, in the **Onyx Edge (n)** panel > **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.
The **Edit Onyx Edge** page displays the equipment's details.
{% endstep %}
{% step %}
Edit the Onyx Edge's details as required.
For parameter descriptions, see [*Add Onyx Edge*](#add-onyx-edge).
{% endstep %}
{% step %}
To save your edits, in the upper-right corner of the page, click **Save Onyx Edge**.
{% endstep %}
{% endstepper %}
## Configure Onyx Edge agw\_user Account
The Onyx Edge *agw\_user* account allows GXC partners and customers to log on to their Onyx Edge AGW to gather basic debug information, restart Onyx Edge services, and reset their Onyx Edge back to factory settings.
SSH- and password-based access are both supported for the *agw\_user*.
For password-based access, the Onyx Edge is provisioned with a factory-default password, which partners and customers can change in the Onyx Portal. Note that password access is restricted to the console and can be used only if the networking is hosed, or if the user has physical access to the ONYX-ES.
For SSH access, in the Onyx Portal, partners and customers can add authentication keys for other devices on the same network.
For more information, see the *Onyx Edge On-Premises Installation and Operations Guide*.
{% hint style="info" %}
**NOTE:** You can configure the Onyx Edge agw\_user account only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}
**To configure the Onyx Edge *****agw\_user***** account on an operational Onyx Edge:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page > **Onyx Edge** tab displays the summary details of all Onyx Edge configured in the network.
{% endstep %}
{% step %}
For the Onyx Edge on which you want to configure the *agw\_user* account, in the **Onyx Edge (n)** panel > **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.
The **Edit Onyx Edge (*****\*****)** page is displayed.
{% endstep %}
{% step %}
Click the **Others** tab and move to the **AGW User Configuration** section.
{% endstep %}
{% step %}
To add an SSH key:
1. Click **Add Keys**.
The **Add SSH Key** dialog box is displayed.
2. Enter the SSH key, then click **Save**.
The SSH key is added.
You can add a maximum of 10 SSH keys.
{% endstep %}
{% step %}
To view existing SSH keys, click **View All Keys**.
The list of SSH keys is displayed. You can view details, edit, and delete SSH keys here.
{% endstep %}
{% step %}
To change the password for *agw\_user*, click **Change Password**.
The **Change Password** dialog box is displayed.
* **Password** – (Required) Password for *agw\_user*.
* **Confirm Password** – (Required) Reenter the password to confirm.
The password must be at least eight characters in length.
{% endstep %}
{% endstepper %}
## Delete Onyx Edge
{% hint style="info" %}
**NOTE:** You can delete an Onyx Edge only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}
{% hint style="info" %}
**NOTE:** You cannot delete an Onyx Edge if there are any APs associated with it. If there are APs associated with the Onyx Edge that you want to delete, you must first remove the APs.
{% endhint %}
**To delete an Onyx Edge:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page > **Onyx Edge** tab displays the summary details of all Onyx Edge configured in the network.
{% endstep %}
{% step %}
For the Onyx Edge that you want to delete, in the **Onyx Edge (n)** panel > **Actions** column, click the corresponding ⋮ (options) icon, then click **Delete**.
A confirmation dialog box is displayed.
{% endstep %}
{% step %}
To confirm the deletion, click **Yes**.
{% endstep %}
{% endstepper %}
## Manage Onyx Edge Core-Only HA Pools
In 5G standalone core-only networks, Onyx Edge pooling provides High Availability (HA) by grouping multiple Onyx Edge nodes into a pool. All Onyx Edge nodes operate in active-active mode with equal capacity. If an Onyx Edge node fails, UE registered on that node are automatically transferred to other Onyx Edge in the pool with minimal service disruption.
{% hint style="info" %}
**NOTE**: The ACS status functionality currently displayed in the Onyx Portal is not applicable to 5G Core-only HA deployments and must be ignored.
{% endhint %}
### View Onyx Edge Pool Details
* [*View Dashboard View of all Onyx Edge Pools in the Network*](#view-dashboard-view-of-all-onyx-edge-pools-in-the-network)
* [*View Summary Details of all Onyx Edge Pools in the Network*](#view-summary-details-of-all-onyx-edge-pools-in-the-network)
* [*View an Onyx Edge Pool's Details*](#view-details-of-an-onyx-edge-pool)
#### **View Dashboard View of all Onyx Edge Pools in the Network**
{% hint style="info" %}
**NOTE:** The Dashboard view of Onyx Edge pools is displayed only if at least one Onyx Edge Pool exists in the network.
{% endhint %}
**To view the Dashboard view of all Onyx Edge pools in the network:**
{% stepper %}
{% step %}
In the navigation pane, click **Dashboard**.
The Dashboard page is displayed.
The **Onyx Edge Pool** panel displays the number of Onyx Edge pools in the network, the pool names, and their HA connectivity status.
Onyx Edge pool HA connectivity status:
* Green — One Onyx Edge is functioning as the Primary ACS, and the others as Standby ACS.
* Amber — One Onyx Edge is functioning as the Primary ACS, but one or more of the other Onyx Edge are non-functional.
* Red — All Onyx Edge are non-functional, or their status is not available.
* Grey — All Onyx Edge are offline.
{% endstep %}
{% step %}
To view a pool's details, click its name.
The ***\*** page displays the Onyx Edge pool's details.
For more information, see *View Details of an Onyx Edge Pool*.
{% endstep %}
{% endstepper %}
#### **View Summary Details of all Onyx Edge Pools in the Network**
{% hint style="info" %}
**NOTE**: The ACS status functionality currently displayed in the Onyx Portal is not applicable to 5G Core-only HA deployments and must be ignored. The status indicated by the High Availability status icon's tooltip is also not applicable and must be ignored.
{% endhint %}
**To view the summary details of all Onyx Edge pools in the network:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page opens to the **Onyx Edge** tab displaying the summary details of all the Onyx Edge connected to the network. At the bottom of the page, the **Onyx Edge Pool** section lists the existing pools.
The **Onyx Edge Pool** section displays the following columns:
* **Status** — The Onyx Edge pool's HA connectivity status:
* Green — One Onyx Edge is functioning as the Primary ACS, and the others as Standby ACS.
* Amber — One Onyx Edge is functioning as the Primary ACS, but one or more of the other Onyx Edge are non-functional.
* Red — All Onyx Edge are non-functional, or their status is not available.
* Grey — All Onyx Edge are offline.
* **Name** — The pool's name.
* **HA IP Address** — Currently only for GXC use.
* **Associated Onyx Edges** — The number of Onyx Edge associated with the pool.
* **Actions** — Options to view details, edit, and delete the Onyx Edge pool.
{% endstep %}
{% endstepper %}
#### **View an Onyx Edge Pool's Details**
{% hint style="info" %}
**NOTE**: The ACS status functionality currently displayed in the Onyx Portal is not applicable to 5G Core-only HA deployments and must be ignored. The status indicated by the High Availability status icon's tooltip is also not applicable and must be ignored.
{% endhint %}
**To view a particular Onyx Edge pool's details:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page opens to the **Onyx Edge** tab displaying the summary details of all the Onyx Edge connected to the network. The **Onyx Edge Pool** section lists the existing pools.
{% endstep %}
{% step %}
To view the details of a particular pool, click its name.
The ***\*** page displays the pool's details, including the following sections:
**Pool Details**
* **Name** — The pool's name.
* **ID** — The pool's ID. This ID is system-generated.
* **HA IP Address** — Currently only for GXC use.
* **HA Connectivity Status** — The Onyx Edge pool's HA connectivity status:
* Green — One Onyx Edge is functioning as the Primary ACS, and the others as Standby ACS.
* Amber — One Onyx Edge is functioning as the Primary ACS, but one or more of the other Onyx Edge are non-functional.
* Red — All Onyx Edge are non-functional, or their status is not available.
* Grey — All Onyx Edge are offline.
To view which Onyx Edge are designated as the Primary and Standby ACS, hover your cursor over the HA Connectivity Status icon.
* **Associated Onyx Edge** — The list of Onyx Edge associated with this pool, with the following columns:
* **Priority** — Not applicable.
* **Name** — The Onyx Edge's name.
* **Access Point** — Not applicable.
* **Subscribers** — The number of subscribers associated with the Onyx Edge.
* **Online** — Indicates the Onyx Edge's online status, determined by its reachability from the Onyx Portal:
* Green — The Onyx Edge has checked in with the Onyx Portal in the last five minutes.
* Red — The Onyx Edge has not checked in with the Onyx Portal in the last five minutes.
* **ACS** — Not applicable.
* **Interface Status** — Indicates the N6 interface connection status:
* Green — The N6 interface is up and has IP, and the N6 link is active (periodic ICMP checks every five minutes).
* Amber — The N6 interface is up and has IP (N6 link is active).
* Red — The N6 interface is not up or is not active (N6 link activity check through ICMP).
* Grey — The Onyx Edge is offline, or data is not available.
{% endstep %}
{% endstepper %}
### Create Onyx Edge Pools
This section describes how to create Onyx Edge pools.
{% hint style="info" %}
**NOTE:** You can create Onyx Edge pools only if you are a GXC Administrator, Customer Administrator, or an Administrator.
{% endhint %}
{% hint style="info" %}
**NOTE:** Each pool can have a maximum of three Onyx Edge associated with it.
{% endhint %}
{% hint style="info" %}
**NOTE**: The ACS functionality currently displayed in the Onyx Portal is not applicable to 5G Core-only HA deployments and must be ignored.
{% endhint %}
**To create an Onyx Edge pool:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page opens to the **Onyx Edge** tab displaying the summary details of all the Onyx Edge connected to the network. The **Onyx Edge Pool** section lists the existing pools.
{% endstep %}
{% step %}
Click **Add Pool**.
The **Create Onyx Edge Pool** page is displayed.
Enter the following details:
* **Name** — (Required) The pool's name. The pool name must be unique within the network and must be an alphanumeric string of 1–64 characters.
* **HA IP Address** — (Required) Currently only for GXC use. Enter a unique IP address from Ng network subnet.
{% endstep %}
{% step %}
Click **Save Onyx Edge Pool**.
The pool is created and is listed in the **Equipment** > **Onyx Edge** tab > **Onyx Edge Pool** list.
{% endstep %}
{% step %}
Associate the Onyx Edge with this pool.
For more information, see [*Associate or Disassociate Onyx Edge with Pools*](https://docs.gxc.io/application-notes/4g-onyx-edge-ha#associate-or-disassociate-onyx-edge-with-pools) and [*Edit Onyx Edge Pools*](https://docs.gxc.io/application-notes/4g-onyx-edge-ha#edit-onyx-edge-pools).
{% endstep %}
{% endstepper %}
### Edit Onyx Edge Pools
This section describes how to edit Onyx Edge pools.
{% hint style="info" %}
**NOTE:** You can edit Onyx Edge pools only if you are a GXC Administrator, Customer Administrator, or an Administrator.
{% endhint %}
{% hint style="info" %}
**NOTE**: The ACS functionality currently displayed in the Onyx Portal is not applicable to 5G Core-only HA deployments and must be ignored.
{% endhint %}
**To edit an Onyx Edge pool:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page opens to the **Onyx Edge** tab displaying the summary details of all the Onyx Edge connected to the network. At the bottom of the page, the **Onyx Edge Pool** section lists the existing pools.
{% endstep %}
{% step %}
For the pool that you want to edit, in the **Actions** column, click the corresponding ⋮ Options icon, then click **Edit**.
The **Edit Onyx Edge Pool** page is displayed.
{% endstep %}
{% step %}
Edit the following details as required:
* **Name** — (Required) The pool's name. The pool name must be unique within the network and must be an alphanumeric string of 1–64 characters.
* **HA IP Address** — (Required) Currently only for GXC use. Enter a unique IP address from Ng network subnet.
{% endstep %}
{% step %}
To save your edits, click **Save Onyx Edge Pool**.
{% endstep %}
{% step %}
Associate or disassociate Onyx Edge with the pool. For more information, see *Associate or Disassociate Onyx Edge with Pools*.
{% endstep %}
{% step %}
**Onyx Edge Priority** — Not applicable.
{% endstep %}
{% step %}
To save your edits, clcik **Save Onyx Edge Pool**.
{% endstep %}
{% endstepper %}
### Delete Onyx Edge Pools
This section describes how to delete Onyx Edge pools.
{% hint style="info" %}
**NOTE:** You can delete Onyx Edge pools only if you are a GXC Administrator, Customer Administrator, or an Administrator.
{% endhint %}
{% hint style="info" %}
**NOTE:** Before you delete a pool, you must disassociate any Onyx Edge and APs associated with it. For information on disassociating Onyx Edge from pools, see *Associate or Disassociate Onyx Edge with Pools*. For information on disassociating APs from a pool, see *Edit Onyx Edge Pools*.
{% endhint %}
**To delete an Onyx Edge pool:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page opens to the **Onyx Edge** tab displaying the summary details of all the Onyx Edge connected to the network. The **Onyx Edge Pool** section lists the existing Onyx Edge pools.
{% endstep %}
{% step %}
For the pool 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 pool, click **Delete**.
{% endstep %}
{% endstepper %}
### Associate or Disassociate Onyx Edge with Pools
You can associate an Onyx Edge with a pool either when you add the Onyx Edge, or later by editing the Onyx Edge's details.
{% hint style="info" %}
**NOTE:** You can associate and disassociate Onyx Edge with a pool only if you are a GXC Administrator, Customer Administrator, or Administrator.
{% endhint %}
{% hint style="info" %}
**NOTE:** Each pool can have a maximum of three Onyx Edge associated with it.
{% endhint %}
{% hint style="info" %}
**NOTE:** An Onyx Edge can be associated only with one pool at any time.
{% endhint %}
**To associate or disassociate an existing Onyx Edge with a pool:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page opens to the **Onyx Edge** tab displaying the summary details of all the Onyx Edge connected to the network.
{% endstep %}
{% step %}
For the Onyx Edge that you want to edit, in the **Actions** column, click the corresponding ⋮ Options icon, then click **Edit**.
The "**Edit Onyx Edge (*****\*****)**" page displays the Onyx Edge's details.
{% endstep %}
{% step %}
In the **Onyx Edge** tab:
* To associate the Onyx Edge with a pool, turn on the **Enable Onyx Edge Pool** toggle button, then in the dropdown, select the pool's name.
The dropdown is displayed only when the **Enable Onyx Edge Pool** toggle button is turned on. If there are no Onyx Edge pools available, the **Enable Onyx Edge Pool** toggle button is disabled.
* To disassociate the Onyx Edge from a pool, turn off the **Enable Onyx Edge Pool** toggle button. A confirmation dialog box is displayed. To confirm, click **Yes**.
{% endstep %}
{% step %}
To save your edits, in the upper-right corner of the page, click **Save Onyx Edge**.
{% endstep %}
{% endstepper %}
## Multi-Port Attach Support
{% hint style="info" %}
**NOTE:** The Multi-Port Attach feature is available only for 5G Onyx Edge (NR+Core) deployments.
{% endhint %}
The Onyx solution supports enhanced Distributed Unit (DU) configuration and scheduling logic that enables UE to dynamically select and attach through any active AP transmission port, rather than being restricted to specific ports. This capability significantly improves network coverage and connection success rates by eliminating limitations that can cause coverage gaps in multi-antenna deployments, while also reducing OPEX by delivering the same coverage and reliability with fewer APs.
Multi-Port Attach capability extends across key 5G channels, including System Information Block Type 1 (SIB1), Downlink Control Information Format 1\_0 (DCI\_1\_0), Physical Random Access Channel (PRACH), Physical Uplink Shared Channel (PUSCH), and Message 3 (Msg3).
When Multi-Port Attach is enabled, each AP can be configured with multiple antenna ports (1–4 per sector) with each antenna gain configuration generating a unique Citizens Broadband Radio Service Device (CBSD) record. The system automatically manages CBSD generation, registration, and lifecycle operations. During configuration, the backend extracts antenna gain details and converts each antenna gain entry into a corresponding CBSD record, maintaining CBSD serial numbers as a list under each AP's metadata. This granular approach enables precise power and antenna management per AP while maintaining full compliance with SAS requirements.
For more information, see *5G Multi-Port Attach Application Note*.
### Enable/Disable Multi-Port Attach Support
The Multi-Port Attach feature is enabled/disabled per Onyx Edge.
{% hint style="info" %}
**NOTE:** You can enable/disable the Multi-Port Attach feature for an Onyx Edge only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}
**To enable/disable the Multi-Port Attach feature for an Onyx Edge:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **Onyx Edge (NR+Core)** tab or the **Onyx Edge** tab.
The **Equipment** page > **Onyx Edge (NR+Core)** tab or the **Onyx Edge** tab displays the summary details of all Onyx Edge (NR+Core) configured in the network.
{% endstep %}
{% step %}
For the Onyx Edge that you want to enable/disable the Multi-Port Attach feature, in the **Onyx Edge (n)** panel > **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.
The **Edit Onyx Edge (\)** page is displayed.
{% endstep %}
{% step %}
Click the **RAN** tab.
{% endstep %}
{% step %}
Click the **Multi-Port Attach** toggle switch to enable/disable the feature for the Onyx Edge.
{% endstep %}
{% step %}
To save your edits, in the top right corner of the page, click **Save Onyx Edge**.
{% endstep %}
{% endstepper %}
## Provisioning Support
The Provisioning Server generates and provisions the keys required for each Onyx Edge and Mesh Node to operate with the Onyx Portal. The Provisioning Server generates a permanent UUID and Challenge Key, for each Onyx Edge based on its eth0 hardware address, and for each Mesh Node based on its serial number, which the equipment use to connect with the Onyx Portal. Software reimages do not affect the permanent UUID and Challenge Key.
## Spectrum Analyzer
{% hint style="info" %}
**NOTE:** The Spectrum Analyzer feature is available only for 5G Onyx Edge (NR+Core) deployments.
{% endhint %}
{% hint style="info" %}
**NOTE:** You can use the Spectrum Analyzer only if you are a GXC Administrator, Partner Administrator, Super Administrator, or Administrator.
{% endhint %}
{% hint style="info" %}
**NOTE:** For detailed information, including use case scenarios, usage instructions, comprehensive plot interpretation guidance, advanced analysis techniques, and technical specifications, refer to the *5G Spectrum Analyzer Application Note*.
{% endhint %}
The Spectrum Analyzer provides real-time, per-cell analysis and visualization of uplink and downlink power characteristics across the RF spectrum. Built into the Onyx Portal, this tool enables monitoring of signal quality, detecting interference, and optimizing network performance without requiring external test equipment.
The Spectrum Analyzer offers the following analysis plots:
* Average Power – Frequency-domain view of power distribution
* Maximum Power – Peak power analysis for interference detection
### Listen-Only Mode
The Listen-Only Mode configuration determines whether the gNB transmits during spectrum analysis.
When enabled, the gNB disables all transmissions and passively listens to the RF spectrum. This mode causes complete service interruption and is suitable only for pre-deployment site surveys, scheduled maintenance windows, or inactive test sites. Use this mode to assess the RF environment before site activation, identify interference sources, and measure background noise floor. Downlink traces are not displayed as the gNB does not transmit. Uplink traces may show attempted UE transmissions from devices searching for connectivity.
When disabled (default), the gNB continues normal transmission while capturing RF data. The network serves users normally with no service interruption, making this the recommended mode for analyzing live network performance and troubleshooting active traffic in production networks.
{% hint style="warning" %}
**CAUTION:** In multi-RU deployments with Fronthaul Multiplexer (FHM), selecting a specific RU for analysis will cause temporary service interruption to other RUs regardless of the Listen-Only Mode setting. For production networks, schedule analysis during maintenance windows.
{% endhint %}
---
# 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-equipment/manage-onyx-edge.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.
Green – Indicates all critical services are up and running, none of the critical services were restarted in the last five minutes, and the Onyx Edge's Interface Status is green.
* 
Amber – Indicates all critical services are up and running, but critical services have restarted up to three times in the last five minutes, and the Onyx Edge's Interface Status is green or amber.
* 
Red – Indicates some critical service has gone down in the last five minutes, or critical services have restarted up to three times in the last five minutes, or the Onyx Edge's Interface Status is red.
* 
Grey – Indicates the Onyx Edge is offline, or data is not available.
Hover your cursor over the Service Status icon to view the list of services that are up/down/restarted.
Green – Indicates the Onyx Edge has checked-in with Onyx Portal in the last five minutes.
* 
Red – Indicates the Onyx Edge has not checked-in with the Onyx Portal in the last five minutes.
Hover your cursor over the Online Status icon to view the following details.
Green – Indicates all APs are AMF-connected to the Onyx Edge, the N6 interface is up and has IP, and N6 link is active (periodic ICMP checks every five minutes).
* 
Amber – Indicates at least one AP is AMF-connected, but some are not, the N6 interface is UP and has IP (N6 link is active).
* 
Red – Indicates none of the APs are AMF-connected (that is all APs are AMF-disconnected or management-disconnected (AMF status is unknown)), or the N6 interface is not up or is not active (N6 link activity check through ICMP).
* 
Grey – Indicates the Onyx Edge is offline.
Hover your cursor over the "Interface Status" icon to view the following details.
Green – Indicates all parameters are below 50%.
* 
Amber – Indicates at least one parameter is above 50% and below 70%.
* 
Red – Indicates at least one parameter is above 70%.
* 
Grey – Indicates the Onyx Edge is offline.
Hover your cursor over the Compute Resource icon to view the following details:
copy icon.
* **Challenge Key** – The Onyx Edge's Challenge Key used in challenge-response authentication mechanism. To copy the challenge key to the clipboard, click the 
copy icon.
* The Onyx Edge's health status.
* **Online** – The Onyx Edge's online status indicating its reachability from the Onyx Portal.
* 
Green – Indicates the Onyx Edge has checked-in with Onyx Portal in the last five minutes.
* 
Red – Indicates the Onyx Edge has not checked-in with the Onyx Portal in the last five minutes.
Hover your cursor over the Online Status icon to view the following details.
Green – Indicates all APs are MME-connected to the Onyx Edge, the SGi interface is up and has IP, and SGi link is active (periodic ICMP checks every five minutes).
* 
Amber – Indicates at least one AP is MME-connected, but some are not, the SGi interface is UP and has IP (SGi link is active).
* 
Red – Indicates none of the APs are MME-connected (that is all APs are MME-disconnected or management-disconnected (MME status is unknown)), or the SGi interface is not up or is not active (SGi link activity check through ICMP).
* 
Grey – Indicates the Onyx Edge is offline, or data is not available.
Hover your cursor over the Interface Status icon to view the following details.
Green – Indicates all parameters are below 50%.
* 
Amber – Indicates at least one parameter is above 50% and below 70%.
* 
Red – Indicates at least one parameter is above 70%.
* 
Grey – Indicates the Onyx Edge is offline.
Hover your cursor over the Compute Resource Status icon to view the following details:
Green – Indicates all critical services are up and running, none of the critical services were restarted in the last five minutes, and the Onyx Edge's Interface Status is green.
* 
Amber – Indicates all critical services are up and running, but critical services have restarted up to three times in the last five minutes, and the Onyx Edge's Interface Status is green or amber.
* 
Red – Indicates some critical service has gone down in the last five minutes, or critical services have restarted up to three times in the last five minutes, or the Onyx Edge's Interface Status is red.
* 
Grey – Indicates the Onyx Edge is offline, or data is not available.
Hover your cursor over the Service Status icon to view the following details.
(view details) icon.
{% endstep %}
{% step %}
Click the **Logs** tab.
field, enter the number of logs to be included in the .csv file, then click 
. Default value: 1000. The downloaded .csv file includes details such as the timestamp, service, tag, type, and log text.
fields. The logs list automatically updates to display the corresponding logs.
field, enter your search term. The logs list updates automatically to display matching logs.
* **Timestamp** – The date and time at which the log was created.
* **Service** – The specific service associated with the log.
* **Tag** – The event’s tag—a label associated with the log entry.
* **Type** – The log’s type.
* **Output** – The log’s message.
{% endstep %}
{% step %}
Click the **Handover** tab.
The **Handover Configuration** table displays the following details for each cell:
* **Name** – The cell's name.
* **PCI** – The Physical Cell Identifier assigned to the cell.
* **Frequency** – The cell's operating frequency.
* **Neighbors** – The cell's configured neighbor relations, with **Explicit,** **Desired,** and **Configured** neighbor-list values.
* **Hysteresis (dB)** – The hysteresis margin applied before triggering a handover measurement report.
* **Time To Trigger (ms)** – The duration a triggering condition must persist before the handover event fires.
* **RSRP** – Threshold values (dBm) for each configured handover event: **A1**, **A2**, **A3 Offset**, **A5-Serving Cell**, and **A5-Neighbor Cell**.
{% endstep %}
{% step %}
**Actions** – (Enabled only when the Onyx Edge is online.) In the upper-right corner of the page, click the **Actions** button to access the following options:
* **Upgrade** – (GXC Administrators, Super Administrators, and Administrators only.) Upgrade the Onyx Edge’s software version, move the Onyx Edge to the required target upgrade group. For more information, see *Move an Onyx Edge from one Upgrade Group to Another*.
* **Reboot Onyx Edge** – (GXC Administrators, Super Administrators, and Administrators only.) Reboot the Onyx Edge. Services will be down while the equipment reboots.
* **Restart Services on Onyx Edge** – (GXC Administrators, Super Administrators, and Administrators only.) Restart the Onyx Edge’s core services. Connectivity will be down until the services resume.
* **Ping** – (GXC Administrators, Super Administrators, and Administrators only.) Ping the Onyx Edge’s host.
Enter the following details, then click **Ping**.
* **Host** – (Required) The host’s IP address.
* **Packets (default 4)** – (Optional) The number of packets to send. Default: 4.
* **Detach Subscriber** – (GXC Administrators, Super Administrators, and Administrators only.) Forcibly detach an active subscriber/UE.
Enter the following details, then click **Execute**.
* **Subscriber IMSI** – The subscriber’s IMSI.
* **Force Config Sync** – (GXC Administrators, Super Administrators, and Administrators only.) Trigger a full configuration synchronization.
* **Force Status Sync from Onyx Edge** – (GXC Administrators, Super Administrators, and Administrators only.) Trigger Onyx Edge state synchronization. This action control is useful when investigating stale status displays or validating a change without waiting for the next periodic sync.
* **Force Subscriber Config Sync** – (GXC Administrators and Super Administrators only.) Trigger a configuration synchronization for a specific subscriber.
* **Trigger Debug Information Collection** – (GXC Administrators, Super Administrators, and Administrators only.) Collect logs and telemetry from Onyx Edge.
* **List Debug Information Files in OE** – (GXC Administrators, Super Administrators, and Administrators only.) View downloadable debug files available on the Onyx Edge.
* **Generic Command** – (GXC Administrators only.) Run generic commands on the Onyx Edge.
The **Run Onyx Edge Command** dialog box is displayed.
Enter the following details, then click **Execute**:
* **Command** – (Required) The command to run.
* **Parameters** – (Optional) Parameters for the command.
{% endstep %}
{% endstepper %}
### View Onyx Edge (Core) Details
{% hint style="info" %}
**NOTE:** An Onyx Edge is designated as Onyx Edge (Core) if added as type Onyx Edge (Core).
{% endhint %}
This section describes how to view Onyx Edge (Core) details in a 5G network.
* [*View Summary Details of All Onyx Edge (Core)*](#view-summary-details-of-all-onyx-edge-core-in-a-5g-network)
* [*View Details of an Onyx Edge (Core)*](#view-details-of-an-onyx-edge-core-in-a-5g-network)
#### View Summary Details of All Onyx Edge (Core)
**To view the summary details of all Onyx Edge (Core) in a 5G network:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **Onyx Edge (Core)** tab or **Onyx Edge** tab.
The **Equipment** page > **Onyx Edge (Core)** tab or **Onyx Edge** tab displays the summary details of all Onyx Edge (Core) configured in the network.
{% hint style="info" %}
**NOTE:** If the 5G network includes only Onyx Edge (Core), the **Equipment** page > **Onyx Edge** tab displays summary details of all Onyx Edge (Core) configured in the network.
If the 5G network includes both Onyx Edge (NR+Core) and Onyx Edge (Core), the **Equipment** page displays separate tabs—**Onyx Edge (NR+Core)** and **Onyx Edge (Core)**—for each Onyx Edge type.
{% endhint %}
* **Onyx Edge (n)** – (n) indicates the number of Onyx Edge (Core) in the network.
* Status of services running on the Onyx Edge (Core).
* 
Green – Indicates all critical services are up and running, none of the critical services were restarted in the last five minutes, and the Onyx Edge's Interface Status is green.
* 
Amber – Indicates all critical services are up and running, but critical services have restarted up to three times in the last five minutes, and the Onyx Edge's Interface Status is green or amber.
* 
Red – Indicates some critical service has gone down in the last five minutes, or critical services have restarted up to three times in the last five minutes, or the Onyx Edge's Interface Status is red.
* 
Grey – Indicates the Onyx Edge is offline, or data is not available.
Hovering your cursor over the "Service Status" icon displays view the list of services that are up/down/restarted.
* **Name** – The Onyx Edge's name.
* **Venue / VM** – The name of the venue or the VM hosting the Onyx Edge.
* **Subs** – The number of subscribers connected to the Onyx Edge.
* **Online** – The Onyx Edge's online status indicating its reachability from the Onyx Portal.
* 
Green – Indicates the Onyx Edge has checked-in with Onyx Portal in the last five minutes.
* 
Red – Indicates the Onyx Edge has not checked-in with the Onyx Portal in the last five minutes.
Hovering your cursor over the "Online Status" icon displays the last synced at (last check-in) timestamp.
* **Interface Status** – Indicates connection status of N6 and RAN (Fronthaul) interfaces.
* 
Green – Indicates all APs are MME-connected to the Onyx Edge, the SGi interface is up and has IP, and SGi link is active (periodic ICMP checks every five minutes).
* 
Amber – Indicates at least one AP is MME-connected, but some are not, the SGi interface is UP and has IP (SGi link is active).
* 
Red – Indicates none of the APs are MME-connected (that is all APs are MME-disconnected or management-disconnected (MME status is unknown)), or the SGi interface is not up or is not active (SGi link activity check through ICMP).
* 
Grey – Indicates the Onyx Edge is offline.
Hovering your cursor over the "Interface Status" icon displays additional details.
* **Compute Resource** – Indicates utilization of the Onyx Edge's computing resources – CPU percentage, Memory percentage, and Disk Utilization percentage.
* 
Green – Indicates all parameters are below 50%.
* 
Amber – Indicates at least one parameter is above 50% and below 70%.
* 
Red – Indicates at least one parameter is above 70%.
* 
Grey – Indicates the Onyx Edge is offline.
Hovering your cursor over the "Compute Resource Status" icon displays the following details:
* **Disk Utilization** – Percentage of disk space used for the volume mounted at root.
* **CPU Utilization** – System-wide CPU utilization as percentage over one second.
* **Memory Utilization** – Percentage of memory used.
* **Actions** – Options to view details, edit, and delete the Onyx Edge.
* **Upgrade Core Onyx Edge** – (GXC Administrators only.) To upgrade the Onyx Edge software on the Onyx Edge AGWs in the network. For information on managing Onyx Edge upgrades, see *Manage Onyx Edge Software Upgrades*.
* **Onyx Edge Pool (n)** — (n) indicates the count of Onyx Edge pools in the network.\
For information on adding and managing Onyx Edge pools, see [*Manage Onyx Edge Core-Only HA Pools*](#manage-onyx-edge-core-only-ha-pools).
* The Onyx Edge pool's HA connectivity status.
* 
Green – One Onyx Edge is functioning as the Primary ACS, and the others as Standby ACS.
* 
Amber – One Onyx Edge is functioning as the Primary ACS, but one or more of the other Onyx Edge are non-functional.
* 
Red – All Onyx Edge are non-functional, or their status is not available.
* 
Grey – All Onyx Edge are offline.
Hovering your cursor over the "HA Connectivity Status" icon displays which Onyx Edge are designated as the Primary and Standby ACS.
* **Name** — The Onyx Edge pool's name.
* **HA IP Address** — Currently only for GXC use.
* **Associated Onyx Edges** — The count of Onyx Edge nodes currently associated with this pool.
* **Actions** — Options to view details, edit, or delete the pool.
* **Show Graphs / Hide Graphs** — Collapsible panel of Onyx Edge performance charts, each filterable by Onyx Edge instance and time range. 
Green – Indicates the Onyx Edge has checked-in with Onyx Portal in the last five minutes.
* 
Red – Indicates the Onyx Edge has not checked-in with the Onyx Portal in the last five minutes.
Hovering your cursor over the "Online Status" icon displays the last check-in timestamp.
* **Interface Status** – The Onyx Edge's interface status indicating the connection status of SGi and RAN (S1) interfaces.
* 
Green – Indicates all APs are AMF-connected to the Onyx Edge, the SGi interface is up and has IP, and SGi link is active (periodic ICMP checks every five minutes).
* 
Amber – Indicates at least one AP is MME-connected, but some are not, the SGi interface is UP and has IP (SGi link is active).
* 
Red – Indicates none of the APs are MME-connected (that is all APs are MME-disconnected or management-disconnected (MME status is unknown)), or the SGi interface is not up or is not active (SGi link activity check through ICMP).
* 
Grey – Indicates the Onyx Edge is offline, or data is not available.
Hovering your cursor over the "Interface Status" icon displays additional details.
* **Compute Resource** – Status of the Onyx Edge's computing resources.
* 
Green – Indicates all parameters are below 50%.
* 
Amber – Indicates at least one parameter is above 50% and below 70%.
* 
Red – Indicates at least one parameter is above 70%.
* 
Grey – Indicates the Onyx Edge is offline.
Hovering your cursor over the "Compute Resource Status" icon displays the following details:
* **Disk Utilization** – Percentage of disk space used for the volume mounted at root.
* **CPU Utilization** – System-wide CPU utilization as percentage over one second.
* **Memory Utilization** – Percentage of memory used.
* **Service Status** – Status of the Onyx Edge's services. Hover your cursor over the "Service Status" icon to view details.
* 
Green – Indicates all critical services are up and running, none of the critical services were restarted in the last five minutes, and the Onyx Edge's Interface Status is green.
* 
Amber – Indicates all critical services are up and running, but critical services have restarted up to three times in the last five minutes, and the Onyx Edge's Interface Status is green or amber.
* 
Red – Indicates some critical service has gone down in the last five minutes, or critical services have restarted up to three times in the last five minutes, or the Onyx Edge's Interface Status is red.
* 
Grey – Indicates the Onyx Edge is offline, or data is not available.
Hovering your cursor over the "Service Status" icon displays the list of services that are up/down/restarted.
* **Data Usage** – The Onyx Edge's data usage for the selected duration.
* **Download** – The download data usage for the selected duration.
* **Upload** – The upload data usage for the selected duration.
* **Dynamic Services** – Status of the Onyx Edge's dynamic services.
* **Event Aggregation** – Indicates the status of event aggregation for Onyx Edge services. Aggregated events are displayed in event lists and charts in the Onyx Portal interface. This feature is always enabled and cannot be disabled.
* **Log Aggregation** – Indicates the status of log aggregation from gateway services. Aggregated logs are displayed in log lists and charts in the Onyx Portal interface. This feature is always enabled and cannot be disabled.
* **CPE Monitoring** – The status of the CPE Monitoring service—Enabled or Disabled. When enabled, the Onyx Edge sends ICMP pings every minute to each connected UE. The measured round-trip time (RTT) latency is reported in the per-subscriber details. See the **Subscribers** > Subscriber details > **UE Latency** parameter.
* **Core**: The Onyx Edge's Core settings.
* **UE-IP-Configuration**:
* **IP Range** – (Displayed only in NAT mode.) The IP range from which the Onyx Edge allocates IP addresses to UE.
* **IP Retention Time (sec)** – The duration (in seconds) for which a UE's IP address is retained/leased after it disconnects.
* **DNS Server for UE**:
* **Onyx Edge-as-DNS-Server** – Indicates if the Onyx Edge functions as the DNS server—Enabled or Disabled.
* **DNS Second Server** – (Displayed only when **Onyx Edge-as-DNS-Server** is enabled.) Enabled or Disabled. When enabled, if the "ONYX-Edge-as-DNS-Server" is unavailable, or if it fails to resolve domain name, the UE will contact the secondary DNS server for domain name resolution.
* **DNS Primary** – The primary DNS server's IP address.
* **DNS Secondary** – The secondary DNS server's IP address.
* **N6 Interface**:
* **N6 Interface** – The UE IP address allocation mode—Static or DHCP.
* **IP Subnet** – (Displayed only if UE IP allocation mode is Static.) The management IP address for Onyx Edge to reach corporate network/internet.
* **Gateway** – (Displayed only if UE IP allocation mode is Static.) The corporate gateway router IP address.
* **DNS Primary** – (Displayed only if UE IP allocation mode is Static.) The primary DNS server's IP address.
* **DNS Secondary** – (Displayed only if UE IP allocation mode is Static.) The secondary DNS server's IP address.
* **N6 Management VLAN** – (Displayed only in VLAN mode if UE IP allocation mode is Static.) The N6 Management VLAN ID.
* **NAS Security Algorithms**
* **Integrity Algorithm** – The NAS integrity protection algorithm in use.
* **Encryption Algorithm** – The NAS encryption algorithm in use.
* **DHCP Server Monitoring** — (Displayed only in VLAN mode) Indicates whether DHCP Server Monitoring is active for this Onyx Edge — **Enabled**, **Disabled**.
* **Frequency** — (Displayed only in VLAN mode if **DHCP Server Monitoring** is enabled) How often the system checks DHCP server availability, in minutes.
* **MAC** — (Displayed only in VLAN mode if **DHCP Server Monitoring** is enabled) The MAC address used by the monitoring probe when sending DHCP requests.
* **VLAN** — (Displayed only in VLAN mode if **DHCP Server Monitoring** is enabled) The VLAN on which the monitoring probe sends DHCP requests, ensuring the check targets the correct network segment.
* **Backhaul Speedtest** – Prioritized list of iPerf-compatible speedtest servers used to measure backhaul link performance. The following details are shown for each entry:
* **Priority** – The priority order in which speedtest servers are tried.
* **URL** – The hostname/URL of the speedtest server.
* **Port Range** – The port range used for the speedtest.
* **APN-VLAN Details** – (Displayed only in VLAN mode.) For each APN, the following details are displayed. Note that APNs are common to all Onyx Edge in the network.
* **APN Name** – The APN's name. To view the APN's details, click its name.
* **VLAN ID** – The VLAN ID.
* **Local IP** – The local IP address / subnet of the Onyx Edge on the VLAN.
* **Default GW IP** – The Onyx Edge's IP address.
* **Default GW MAC** – The Onyx Edge's MAC address.
* **UE-IP-Block: IP Block** – Indicates whether the UE IP block feature is enabled or disabled.
* **UE-IP-Block: Start IP** – The start IP address of the UE IP block range.
* **UE-IP-Block: End IP** – The end IP address of the UE IP block range.
* **RAN**: The Onyx Edge's (Core) RAN settings.
* **Subscribers** – Details of subscribers connected to the Onyx Edge.
date/time fields. The events list automatically updates to display the corresponding logs.
(view details) icon.
{% endstep %}
{% step %}
Click the **Logs** tab.
* **Logs (n)** – The number of logs for the Onyx Edge in the selected type and date and time range.
* **NR / Core** – Allows switching between NR and Core network logs.
* Download Logs – To download the logs in .csv format, in the 
field enter the number of logs to be included in the .csv file, then click the 
icon. Default value: 5000. The downloaded .csv file includes details such as the timestamp, service, tag, type, and log text.
date/time fields. The logs list automatically updates to display the corresponding logs.
search field. The logs list updates automatically to display matching logs.
* **Timestamp** – The date and time at which the log was created.
* **Service** – The specific service associated with the log.
* **Tag** – The event's tag—a label associated with the log entry.
* **Type** – The log's type.
* **Output** – The log's message.
{% endstep %}
{% step %}
**Actions** – (Enabled only when the Onyx Edge is online.) In the upper-right corner of the page, click the **Actions** button to access the following options.
* **Upgrade** – (GXC Administrators, Super Administrators, and Administrators only.) Upgrade the Onyx Edge's software version, move the Onyx Edge to the required target upgrade group. For more information, see *Move an Onyx Edge from One Upgrade Group to Another*.
* **Reboot Onyx Edge** – (GXC Administrators, Super Administrators, and Administrators only.) Reboot the Onyx Edge. Services will be down while the equipment reboots.
* **Restart Services on Onyx Edge** – (GXC Administrators, Super Administrators, and Administrators only.) Restart the Onyx Edge's core services. Connectivity will be down until the services resume.
* **Ping** – (GXC Administrators, Super Administrators, and Administrators only.) Ping the Onyx Edge's host.
Enter the following details, then click **Ping**.
* **Host** – (Required) The host's IP address.
* **Packets (default 4)** – (Optional) The number of packets to send. Default: 4.
* **Reboot AP** – (GXC Administrators, Super Administrators, and Administrators only.) Reboot all or a specific AP.
Enter the following details, then click **Execute**.
* **Reboot AP** – Select to reboot a specific AP in the network. In the **Select an AP** dropdown, select the AP's serial number.
* **Reboot All APs** – Select to reboot all APs in the network.
* **Detach Subscriber** – (GXC Administrators, Super Administrators, and Administrators only.) Forcibly detach an active subscriber/UE.
Enter the following details, then click **Execute**.
* **Subscriber IMSI** – The subscriber's IMSI.
* **Force Config Sync** – (GXC Administrators, Super Administrators, and Administrators only.) Trigger a full configuration synchronization.
* **Force Status Sync from Onyx Edge** – (GXC Administrators, Super Administrators, and Administrators only.) Trigger Onyx Edge state synchronization. This action control is useful when investigating stale status displays or validating a change without waiting for the next periodic sync.
* **Force Subscriber Config Sync** – (GXC Administrators and Super Administrators only.) Trigger a configuration synchronization for a specific subscriber.
* **Trigger Debug Information Collection** – (GXC Administrators, Super Administrators, and Administrators only.) Collect logs and telemetry from Onyx Edge.
* **List Debug Information Files in OE** – (GXC Administrators, Super Administrators, and Administrators only.) View downloadable debug files available on the Onyx Edge.
* **Generic Command** – (GXC Administrators only.) Run generic commands on the Onyx Edge.
The **Run Onyx Edge Command** dialog box is displayed. Enter the following details, then click **Execute**:
* **Command** – (Required) The command to run.
* **Parameters** – (Optional) Parameters for the command.
{% endstep %}
{% endstepper %}
## Add Onyx Edge
This section describes how to add an Onyx Edge in the following modes:
* [*Add Onyx Edge (NR+Core)*](#add-onyx-edge-nrcore)
* [*Add Onyx Edge (Core-Only)*](#add-onyx-edge-core-only)
### Add Onyx Edge (NR+Core)
This section describes how to add an Onyx Edge (NR+Core) in the following modes:
* [*Add Onyx Edge (NR+Core) in NAT Mode*](#add-onyx-edge-nrcore-in-nat-mode)
* [*Add Onyx Edge (NR+Core) in VLAN Mode*](#add-onyx-edge-nrcore-in-vlan-mode)
#### Add Onyx Edge (NR+Core) in NAT Mode
{% hint style="info" %}
**NOTE:** You can add an Onyx Edge only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}
{% hint style="info" %}
**NOTE:** Before adding an Onyx Edge On-Premises, make sure that the customer account, required network, and venue are already set up.
{% endhint %}
{% hint style="info" %}
**NOTE:** To add Onyx Edge in NAT mode, VLAN mode must be disabled at the network level.
{% endhint %}
{% hint style="info" %}
**NOTE**: For detailed information on the networking modes supported by the GXC 5G Onyx Platform, refer to the *4G & 5G Networking Modes Application Note*. The document covers NAT and Bridge (APN-on-VLAN) modes detailing their architectures, traffic flows, isolation characteristics, and trade-offs. It also provides step-by-step configuration guidance for each mode via the Onyx Portal.
{% endhint %}
**To add an Onyx Edge (NR+Core) in NAT mode:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page > **Onyx Edge** tab displays the summary details of all Onyx Edge configured in the network.
{% endstep %}
{% step %}
In the upper-right corner of the page, click **Add Node** > **Add Onyx Edge**.
The **Create Onyx Edge** page > **Onyx Edge** tab is displayed.
Green — One Onyx Edge is functioning as the Primary ACS, and the others as Standby ACS.
* 
Amber — One Onyx Edge is functioning as the Primary ACS, but one or more of the other Onyx Edge are non-functional.
* 
Red — All Onyx Edge are non-functional, or their status is not available.
* 
Grey — All Onyx Edge are offline.
{% endstep %}
{% step %}
To view a pool's details, click its name.
The ***\
Green — One Onyx Edge is functioning as the Primary ACS, and the others as Standby ACS.
* 
Amber — One Onyx Edge is functioning as the Primary ACS, but one or more of the other Onyx Edge are non-functional.
* 
Red — All Onyx Edge are non-functional, or their status is not available.
* 
Grey — All Onyx Edge are offline.
* **Name** — The pool's name.
* **HA IP Address** — Currently only for GXC use.
* **Associated Onyx Edges** — The number of Onyx Edge associated with the pool.
* **Actions** — Options to view details, edit, and delete the Onyx Edge pool.
{% endstep %}
{% endstepper %}
#### **View an Onyx Edge Pool's Details**
{% hint style="info" %}
**NOTE**: The ACS status functionality currently displayed in the Onyx Portal is not applicable to 5G Core-only HA deployments and must be ignored. The status indicated by the High Availability status icon's tooltip is also not applicable and must be ignored.
{% endhint %}
**To view a particular Onyx Edge pool's details:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page opens to the **Onyx Edge** tab displaying the summary details of all the Onyx Edge connected to the network. The **Onyx Edge Pool** section lists the existing pools.
{% endstep %}
{% step %}
To view the details of a particular pool, click its name.
The ***\
Green — One Onyx Edge is functioning as the Primary ACS, and the others as Standby ACS.
* 
Amber — One Onyx Edge is functioning as the Primary ACS, but one or more of the other Onyx Edge are non-functional.
* 
Red — All Onyx Edge are non-functional, or their status is not available.
* 
Grey — All Onyx Edge are offline.
To view which Onyx Edge are designated as the Primary and Standby ACS, hover your cursor over the HA Connectivity Status icon.
* **Associated Onyx Edge** — The list of Onyx Edge associated with this pool, with the following columns:
* **Priority** — Not applicable.
* **Name** — The Onyx Edge's name.
* **Access Point** — Not applicable.
* **Subscribers** — The number of subscribers associated with the Onyx Edge.
* **Online** — Indicates the Onyx Edge's online status, determined by its reachability from the Onyx Portal:
* 
Green — The Onyx Edge has checked in with the Onyx Portal in the last five minutes.
* 
Red — The Onyx Edge has not checked in with the Onyx Portal in the last five minutes.
* **ACS** — Not applicable.
* **Interface Status** — Indicates the N6 interface connection status:
* 
Green — The N6 interface is up and has IP, and the N6 link is active (periodic ICMP checks every five minutes).
* 
Amber — The N6 interface is up and has IP (N6 link is active).
* 
Red — The N6 interface is not up or is not active (N6 link activity check through ICMP).
* 
Grey — The Onyx Edge is offline, or data is not available.
{% endstep %}
{% endstepper %}
### Create Onyx Edge Pools
This section describes how to create Onyx Edge pools.
{% hint style="info" %}
**NOTE:** You can create Onyx Edge pools only if you are a GXC Administrator, Customer Administrator, or an Administrator.
{% endhint %}
{% hint style="info" %}
**NOTE:** Each pool can have a maximum of three Onyx Edge associated with it.
{% endhint %}
{% hint style="info" %}
**NOTE**: The ACS functionality currently displayed in the Onyx Portal is not applicable to 5G Core-only HA deployments and must be ignored.
{% endhint %}
**To create an Onyx Edge pool:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page opens to the **Onyx Edge** tab displaying the summary details of all the Onyx Edge connected to the network. The **Onyx Edge Pool** section lists the existing pools.
{% endstep %}
{% step %}
Click **Add Pool**.
The **Create Onyx Edge Pool** page is displayed.
Enter the following details:
* **Name** — (Required) The pool's name. The pool name must be unique within the network and must be an alphanumeric string of 1–64 characters.
* **HA IP Address** — (Required) Currently only for GXC use. Enter a unique IP address from Ng network subnet.
{% endstep %}
{% step %}
Click **Save Onyx Edge Pool**.
The pool is created and is listed in the **Equipment** > **Onyx Edge** tab > **Onyx Edge Pool** list.
{% endstep %}
{% step %}
Associate the Onyx Edge with this pool.
For more information, see [*Associate or Disassociate Onyx Edge with Pools*](https://docs.gxc.io/application-notes/4g-onyx-edge-ha#associate-or-disassociate-onyx-edge-with-pools) and [*Edit Onyx Edge Pools*](https://docs.gxc.io/application-notes/4g-onyx-edge-ha#edit-onyx-edge-pools).
{% endstep %}
{% endstepper %}
### Edit Onyx Edge Pools
This section describes how to edit Onyx Edge pools.
{% hint style="info" %}
**NOTE:** You can edit Onyx Edge pools only if you are a GXC Administrator, Customer Administrator, or an Administrator.
{% endhint %}
{% hint style="info" %}
**NOTE**: The ACS functionality currently displayed in the Onyx Portal is not applicable to 5G Core-only HA deployments and must be ignored.
{% endhint %}
**To edit an Onyx Edge pool:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page opens to the **Onyx Edge** tab displaying the summary details of all the Onyx Edge connected to the network. At the bottom of the page, the **Onyx Edge Pool** section lists the existing pools.
{% endstep %}
{% step %}
For the pool that you want to edit, in the **Actions** column, click the corresponding ⋮ Options icon, then click **Edit**.
The **Edit Onyx Edge Pool** page is displayed.
{% endstep %}
{% step %}
Edit the following details as required:
* **Name** — (Required) The pool's name. The pool name must be unique within the network and must be an alphanumeric string of 1–64 characters.
* **HA IP Address** — (Required) Currently only for GXC use. Enter a unique IP address from Ng network subnet.
{% endstep %}
{% step %}
To save your edits, click **Save Onyx Edge Pool**.
{% endstep %}
{% step %}
Associate or disassociate Onyx Edge with the pool. For more information, see *Associate or Disassociate Onyx Edge with Pools*.
{% endstep %}
{% step %}
**Onyx Edge Priority** — Not applicable.
{% endstep %}
{% step %}
To save your edits, clcik **Save Onyx Edge Pool**.
{% endstep %}
{% endstepper %}
### Delete Onyx Edge Pools
This section describes how to delete Onyx Edge pools.
{% hint style="info" %}
**NOTE:** You can delete Onyx Edge pools only if you are a GXC Administrator, Customer Administrator, or an Administrator.
{% endhint %}
{% hint style="info" %}
**NOTE:** Before you delete a pool, you must disassociate any Onyx Edge and APs associated with it. For information on disassociating Onyx Edge from pools, see *Associate or Disassociate Onyx Edge with Pools*. For information on disassociating APs from a pool, see *Edit Onyx Edge Pools*.
{% endhint %}
**To delete an Onyx Edge pool:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page opens to the **Onyx Edge** tab displaying the summary details of all the Onyx Edge connected to the network. The **Onyx Edge Pool** section lists the existing Onyx Edge pools.
{% endstep %}
{% step %}
For the pool 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 pool, click **Delete**.
{% endstep %}
{% endstepper %}
### Associate or Disassociate Onyx Edge with Pools
You can associate an Onyx Edge with a pool either when you add the Onyx Edge, or later by editing the Onyx Edge's details.
{% hint style="info" %}
**NOTE:** You can associate and disassociate Onyx Edge with a pool only if you are a GXC Administrator, Customer Administrator, or Administrator.
{% endhint %}
{% hint style="info" %}
**NOTE:** Each pool can have a maximum of three Onyx Edge associated with it.
{% endhint %}
{% hint style="info" %}
**NOTE:** An Onyx Edge can be associated only with one pool at any time.
{% endhint %}
**To associate or disassociate an existing Onyx Edge with a pool:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page opens to the **Onyx Edge** tab displaying the summary details of all the Onyx Edge connected to the network.
{% endstep %}
{% step %}
For the Onyx Edge that you want to edit, in the **Actions** column, click the corresponding ⋮ Options icon, then click **Edit**.
The "**Edit Onyx Edge (*****\