> This is part 1 of 4 of the full documentation (pages 1–100 of 309).
> The content is paginated: fetch every part to see all of it.
> Next part: https://docs.gxc.io/llms-full.txt/1
> Page index: https://docs.gxc.io/llms.txt

# 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
This site has an agentic ask interface you may use to query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.gxc.io/index.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

---

# Introduction to GXC Onyx

## GXC Private 5G: A Smarter Way to Power Your Network

Private 5G should be powerful — but it shouldn’t be complicated. With Private 5G, companies can connect devices, machines, sensors, and people on a network that’s:

* **Fast** – Handles large amounts of data with low delay
* **Reliable** – Designed to keep critical operations running smoothly
* **Secure** – Keeps sensitive information on a controlled, private system
* **Scalable** – Grows as your needs expand

GXC’s platform is designed to give organizations full control over their wireless network without the heavy lift of traditional telecom infrastructure. It brings together edge computing, secure connectivity, and flexible radio technology into a solution that’s built to run where your business runs.

Here’s what that looks like in practice.

***

## Precision Where It Matters

Private 5G depends on precise timing and synchronization. Behind the scenes, high-speed transport links keep everything aligned and coordinated.

This level of precision helps ensure stable connections, minimal signal variation, and reliable communications — especially important in environments where timing matters.

<div data-with-frame="true"><figure><img src="https://2839344875-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcsOm7izkwc75UBmow1N0%2Fuploads%2FCZmGf1B09RqnpPJUTaCC%2Fimage.png?alt=media&amp;token=0182a9e5-34a5-4960-a5e6-fa80120e3160" alt=""><figcaption></figcaption></figure></div>

***

## Onyx Architecture

<figure><img src="https://2839344875-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcsOm7izkwc75UBmow1N0%2Fuploads%2FDQSlvOX9wb8wcJiEucMx%2Fimage.png?alt=media&amp;token=467d023c-658e-489e-8051-82f9f538d66a" alt=""><figcaption></figcaption></figure>

***

### Onyx Portal: Visibility Without Complexity

Managing a private network shouldn’t require a telecom engineering degree.

The **Onyx Portal** gives you a clean, centralized interface to configure, monitor, and manage your network. From one dashboard, you can see device activity, network performance, and subscriber data in real time.

It also integrates with external systems through open APIs, making it easier to connect your wireless network with existing IT and operational platforms.

***

### Onyx Edge and the 5G Core: The Foundation of the Network

At the center of the system is **Onyx Edge**, a compact on-site appliance that serves as the foundation of your private network. Rather than spreading key components across multiple systems or relying heavily on external cloud infrastructure, Onyx Edge brings everything together into a single platform. This makes the network easier to deploy, simpler to operate, and less dependent on outside services.

Built into Onyx Edge is the **5G Core** and **RAN Stack**, which manages how devices connect and communicate across the network. It handles essential functions such as authenticating devices, managing data sessions, and maintaining connectivity as people, machines, or sensors move around your facility.

Because these capabilities run locally, data can stay on-site and applications can respond quickly without needing to travel to a distant data center. This approach helps support the low latency, reliability, and control that many enterprise environments require.

To further simplify deployments, GXC also includes a **Fronthaul Multiplexer** that coordinates traffic between the core system and the radio units providing wireless coverage. Instead of managing each radio independently, the system treats them as part of a unified radio layer. This reduces operational complexity and helps deliver consistent, seamless coverage across the entire facility.

***

### Onyx APs: Connecting Devices Across Your Facility

The **AP Network** is what allows devices to connect to the private 5G system. This includes everything from handheld scanners and tablets to cameras, sensors, and autonomous machines.

GXC’s radio architecture is designed to provide reliable coverage while keeping performance consistent across the environment. Processing that needs to happen quickly takes place close to the edge of the network, while centralized control helps coordinate how the system operates overall.

This approach helps maintain stable connections and low latency, which is important for applications like automation, real-time monitoring, and video analytics. The goal is simple: devices stay connected, and the network performs reliably wherever it’s needed.

***

### Mesh Nodes: Expanding Coverage Without Wires

Not every environment is easy to wire — especially warehouses, outdoor sites, or temporary installations.

Mesh Nodes allow wireless backhaul between gateway nodes and access points, extending coverage quickly without running new cables. It’s a practical way to expand your network where traditional infrastructure isn’t available.

## Built for Real-World Enterprise Needs

Beyond the architecture, GXC’s Private 5G platform is designed to support how modern businesses operate.

#### 5G Standalone Architecture

The system runs on a full 5G Standalone core, delivering low latency, high throughput, and the flexibility to evolve as new applications emerge.

#### Open RAN Flexibility

Built on open standards, the platform allows organizations to use commercial hardware and select components from multiple vendors. This approach reduces costs, supports a wide range of global spectrum bands, and enables software-driven upgrades — without replacing hardware.

It also allows phased integration with existing infrastructure, avoiding costly “rip-and-replace” scenarios.

#### Smarter Spectrum Use

Multiple radio units can operate as a single logical cell, improving spectrum efficiency and mobility while reducing interference. This is especially valuable in dense environments like factories and distribution centers.

#### DAS Support

The solution integrates with both passive and active Distributed Antenna Systems (DAS), enabling shared infrastructure between public and private networks and delivering consistent coverage in large or complex venues.

#### Flexible Spectrum Options

Support for multiple carrier frequencies and synchronized operation allows businesses to optimize coverage and balance network performance based on their specific needs.

#### CBRS and Open Standards

Full compatibility with CBRS and adherence to O-RAN and 3GPP standards ensure interoperability and long-term investment protection.

#### End-to-End Security

Security is built into every layer — from SIM-based authentication and role-based access controls to encrypted traffic and secure management protocols — helping organizations meet regulatory and operational requirements.

## The Bottom Line

GXC’s Private 5G solution is designed to give enterprises something public networks can’t: control.

Control over performance.\
Control over data.\
Control over how and where the network evolves.

With edge-based intelligence, open standards, and a deployment model built for simplicity, it delivers the speed and reliability of 5G — on your terms — and positions your organization for whatever comes next.


# Is Onyx Right For You?

Private Cellular is not a better Wi-Fi. It is a different tool, with a different cost profile and a different set of obligations, and it wins decisively on a specific class of problem while being poor value on others.

Settle whether that class describes your situation before spending time sizing a network in [*Plan Your Network*](/plan-your-network).

## The short version

Private cellular earns its place when **one or more of these is true**:

* Coverage has to be **uniform** across a large or awkward space: a warehouse with moving racking, a campus with outdoor gaps, a facility whose RF environment changes as inventory moves.
* Devices **move continuously** and cannot tolerate a connection gap while roaming.
* The **uplink** is the demanding direction: cameras, sensors, inspection capture, video contribution.
* Latency has a **hard ceiling** that must hold under load, not on average.
* Access must be controlled by **credentials you issue and revoke**, with traffic that never leaves your site.
* The environment is **hostile to Wi-Fi**: metal, dense racking, concrete, RF congestion, long distances.

If none of these apply, well-designed enterprise Wi-Fi is usually cheaper and entirely adequate. That is a legitimate answer.

## Against Wi-Fi

The honest comparison is not "which is better" but "where does each stop working".

<table><thead><tr><th width="200"></th><th>Wi-Fi</th><th>Private cellular</th></tr></thead><tbody><tr><td><strong>Mobility</strong></td><td>Roaming between APs interrupts the connection. Usually invisible for browsing; fatal for an AGV control loop or a live video feed.</td><td>Handover is managed by the network. With Onyx Shared Cell, devices moving inside the coverage area see one cell and perform no handover at all.</td></tr><tr><td><strong>Coverage per radio</strong></td><td>Shorter range, more APs, more co-channel interference to plan around.</td><td>Longer range at comparable power; substantially longer on sub-GHz bands.</td></tr><tr><td><strong>Determinism</strong></td><td>Contention-based. Throughput and latency degrade as the medium gets busy, no reservation mechanism.</td><td>Scheduled. QoS is enforced per flow via 3GPP 5QI, so a control loop and a bulk download coexist without competing.</td></tr><tr><td><strong>Uplink</strong></td><td>Optimized for downlink-heavy consumer traffic.</td><td>TDD split is configurable: Onyx supports up to 63% uplink (<code>DSUUU</code>) for camera- and sensor-heavy sites.</td></tr><tr><td><strong>Access control</strong></td><td>Shared credentials, certificates, or a captive portal.</td><td>SIM/eSIM credentials you provision and revoke centrally. No password to leak.</td></tr><tr><td><strong>Spectrum</strong></td><td>Unlicensed and shared with everyone nearby.</td><td>Licensed, coordinated, or shared-with-priority. Far less contention you cannot control.</td></tr><tr><td><strong>Cost and effort</strong></td><td>Lower. Familiar to any IT team.</td><td>Higher. Requires spectrum access, SIM management, and RF planning.</td></tr></tbody></table>

{% hint style="info" %}
**NOTE**: These are not mutually exclusive. A common pattern is Wi-Fi for general office and guest traffic, private cellular for the operational workloads that Wi-Fi cannot hold, with both running in the same building.
{% endhint %}

## LTE or 5G

Onyx runs both, on **distinct hardware platforms**. This makes technology selection an early decision rather than a late one: it changes the bill of materials, not just a configuration.

|                        | **Onyx LTE**                                                              | **Onyx 5G**                                                    |
| ---------------------- | ------------------------------------------------------------------------- | -------------------------------------------------------------- |
| **Latency**            | Suitable above \~50 ms                                                    | Supports real-time workloads below 30 ms                       |
| **Typical workloads**  | General enterprise connectivity, telemetry, IoT                           | Real-time analytics, robotics, machine vision, broadcast video |
| **Peak AP throughput** | \~40 Mbps @ 20 MHz baseline; \~105 Mbps/cell at 20 MHz in default Config1 | 300+ Mbps with 4×4 MIMO @ 40 MHz, deployment dependent         |
| **Channel bandwidth**  | Up to 40 MHz with Carrier Aggregation; 20 MHz per cell in Dual Carrier    | 20, 40, 50, 100 MHz (band and RU dependent)                    |
| **Devices per AP**     | Up to 96 (SC); 96 + 96 (DC)                                               | Up to 128 (SC)                                                 |
| **Bands**              | B48 (CBRS), B1, B3                                                        | n48, n77, n78, n41, n79, n28, n26                              |
| **Shared Cell**        | DAS-based coverage extension                                              | FHM-based: up to 8 RUs per FHM, up to 64 RUs as one cell       |

**Choose LTE** when the workload is telemetry, IoT, voice, or general connectivity; latency above 50 ms is acceptable; and CBRS is your spectrum. It is the lower-cost path and entirely sufficient for a large share of enterprise deployments.

**Choose 5G** when you need sub-30 ms latency, uplink-heavy capacity, more than 40 MHz of channel, handover-free mobility across a large floor, or a band other than CBRS.

{% hint style="warning" %}
**NOTE**: Latency requirements are the most common reason a design has to be revisited. If any workload has a hard latency ceiling below 50 ms, that decides the technology, no amount of capacity headroom on LTE will meet it.
{% endhint %}

## What a deployment actually requires

Worth knowing before you commit, not after.

**Spectrum access.** You need a band you are permitted to transmit on. In the US that usually means CBRS, which brings SAS registration, Certified Professional Installer sign-off on every radio, and grants that the SAS can modify or revoke during normal operation. Elsewhere it usually means a local license in n77/n78. See [*Private 5G Spectrum and Regulations*](/private-5g-spectrum).

**Devices that support your band.** Not every phone, tablet, or module supports CBRS or your regional band. Check the [*End Devices*](https://docs.gxc.io/devices) compatibility matrix against the actual device population: this is a frequent late surprise, particularly with existing handheld fleets.

**SIM provisioning.** Every device needs a credential, issued and managed through the Onyx Portal. For a fleet of a few hundred handhelds this is a real operational process, not an afterthought.

**Site infrastructure.** Onyx Edge needs rack space, power, and cooling. Radios need cabling (fronthaul over fiber or Ethernet) plus PoE or local power, mounting, and in outdoor deployments enclosures, grounding, and surge protection. Where cabling is genuinely impractical, Mesh Nodes provide wireless backhaul, but they are an exception rather than the default.

**RF planning.** The [*Onyx ROM AP Calculator*](https://www.gxc.io/rom-ap-calculator/) gives a reliable starting estimate. Sites with significant clutter, height variation, difficult propagation, or strict coverage SLAs need a survey. GXC offers RF design as a service.

**Ongoing operation.** Someone owns the Portal: monitoring, alerts, subscriber lifecycle, firmware updates, and (on CBRS) the SAS relationship.

## When it is probably not the right fit

Said plainly, so you do not spend weeks discovering it:

* **A single small office with static users.** Wi-Fi 6/6E does this well for far less.
* **Downlink-dominant general internet access.** You are paying for capability you will not use.
* **No route to spectrum.** Without a band you can transmit on, there is no deployment. Settle this first.
* **A device fleet that cannot support the band**, with no budget to replace it.
* **No one to operate it.** A private network is infrastructure. It needs an owner.

## If it does fit

{% stepper %}
{% step %}

## Introduction

{% content-ref url="/pages/UmOPXP3eSkJOt9LBhZON" %}
[Introduction to GXC Onyx](/)
{% endcontent-ref %}
{% endstep %}

{% step %}

## Spectrum and regulations

{% content-ref url="/pages/f1bf111d86c09d920bb9d1837dc0f2404370b929" %}
[Private 5G Spectrum](/private-5g-spectrum)
{% endcontent-ref %}
{% endstep %}

{% step %}

## Plan your network

{% content-ref url="/pages/d17dc6876a5d6309a6cbe730c19e8a65af773626" %}
[Plan Your Network](/plan-your-network)
{% endcontent-ref %}
{% endstep %}
{% endstepper %}

To see the requirements real workloads produce (throughput, latency, jitter, 5QI mapping, TDD pattern) see [*Use Cases/Workflows*](https://docs.gxc.io/usecases-workflows/). If one of them resembles your situation, it will tell you more about your design than any general guidance here.

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# Private 5G Spectrum

A private cellular network needs spectrum, and unlike Wi-Fi, you do not simply switch it on. Every band Onyx supports carries its own licensing model, its own regulator, and its own set of obligations that continue for as long as the network operates.

What follows is the spectrum Onyx can use, how to get access to it in each region, and what the regulator expects of you afterwards. Read it before [*Step 1: Capacity*](/plan-your-network/capacity): the band you can actually obtain constrains channel bandwidth, which constrains throughput, which sets the radio count.

## The three ways to get spectrum

Private cellular spectrum comes from one of three models. Which one applies to you depends entirely on where the site is.

<table><thead><tr><th width="200">Model</th><th>How access works</th><th>Where it applies</th></tr></thead><tbody><tr><td><strong>Shared / coordinated</strong></td><td>A central database authorises each radio dynamically and can modify or revoke that authorisation at any time. No auction, no license fee.</td><td>CBRS in the United States (n48/B48)</td></tr><tr><td><strong>Local licensed</strong></td><td>The regulator issues a site- or area-specific license directly to the enterprise, typically for a fixed term and a fixed fee.</td><td>n77/n78 in much of Europe and Asia-Pacific</td></tr><tr><td><strong>Operator-provided</strong></td><td>A mobile network operator leases capacity from its own licensed holdings for use on your private network.</td><td>Widely available; the usual route for FDD bands such as n26 and n28</td></tr></tbody></table>

{% hint style="warning" %}
**NOTE**: Spectrum availability is the single most common reason a design has to change late. Confirm which band you can actually obtain, and at what channel bandwidth: before committing to a capacity plan. A design sized for 100 MHz on n78 does not survive being moved to 20 MHz on CBRS.
{% endhint %}

## Spectrum by country

The table below records where GXC has deployed and what is available elsewhere. Regulatory terms change often, so treat it as a starting point and confirm with the national regulator before committing to a design.

{% hint style="info" %}
**How to read n77 and n78 here.** In 3GPP, n77 spans 3.3 to 4.2 GHz and n78 spans 3.3 to 3.8 GHz, so n78 sits entirely inside n77. That overlap causes a lot of confusion. In practice the industry treats them as adjacent, and this table follows that convention: **n78 for 3.3 to 3.8 GHz, n77 for 3.8 to 4.2 GHz**.
{% endhint %}

{% hint style="info" %}
**Why several European rows say "3.8 to 4.2 pending".** EU Decision 2025/2425 harmonises 3800 to 4200 MHz for local-area networks and requires member states to make it available by **30 September 2026**. Italy, Czechia and Hungary are all working through that, so those entries are likely to change.
{% endhint %}

| Country        | Band | Frequency                         | Status                                                                                                                                                                                                                               |
| -------------- | ---- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| United States  | n48  | 3.55 to 3.70 GHz                  | GXC deployment                                                                                                                                                                                                                       |
| Brazil         | n78  | 3.70 to 3.80 GHz                  | GXC deployment                                                                                                                                                                                                                       |
| Germany        | n78  | 3.70 to 3.80 GHz                  | GXC deployment                                                                                                                                                                                                                       |
| Argentina      | n40  | 2.30 to 2.40 GHz                  | GXC deployment                                                                                                                                                                                                                       |
| France         | n77  | 3.80 to 4.20 GHz                  | GXC deployment                                                                                                                                                                                                                       |
| United Kingdom | n77  | 3.80 to 4.20 GHz                  | GXC deployment                                                                                                                                                                                                                       |
| Austria        | n77  | 3.80 to 4.20 GHz                  | GXC deployment                                                                                                                                                                                                                       |
| Australia      | n77  | 3.80 to 4.00 GHz                  | GXC deployment                                                                                                                                                                                                                       |
| Malaysia       | n79  | 4.70 to 4.80 GHz                  | GXC deployment                                                                                                                                                                                                                       |
| Portugal       | n77  | 3.80 to 4.20 GHz                  | Confirmed with a GXC customer                                                                                                                                                                                                        |
| Netherlands    | n78  | 3400 to 3450 and 3750 to 3800 MHz | Licensed since December 2023. Two 50 MHz blocks, your own site only, no third-party service. Licences run to 2040 and must be in use within 9 months. [RDI](https://www.rdi.nl/onderwerpen/private-netwerken/perceelgebonden-netten) |
| Spain          | n77  | 3.80 to 4.12 GHz                  | Revised by the July 2026 CNAF update. See the note below. [Ministry announcement](https://digital.gob.es/content/dam/portal-mtdfp/comunicacion/comunicacion_setid/2026/07/2026-07-17/20260717_NdP_CNAF_.pdf)                         |
| Japan          | n79  | 4.60 to 4.90 GHz                  | Local 5G license from MIC, open to enterprises since December 2020                                                                                                                                                                   |
| Thailand       | n79  | 4.80 to 4.90 GHz                  | Available on request                                                                                                                                                                                                                 |
| Qatar          | n78  | 3.50 to 3.80 GHz                  | No dedicated private band. Each operator holds 100 MHz and can provide capacity from it                                                                                                                                              |
| Czechia        | n78  | 3.40 to 3.80 GHz                  | Not a direct assignment: requires an operator agreement alongside regulator authorisation. 26 GHz opened for campus networks in 2026. 3.8 to 4.2 GHz pending                                                                         |
| Hungary        |      |                                   | No enterprise access today. The regulator has signalled the framework may change, and 3.8 to 4.2 GHz is pending                                                                                                                      |
| Italy          |      |                                   | No dedicated band yet. A consultation on 3.8 to 4.2 GHz opened in May 2026. [AGCOM 109/26/CONS](https://www.agcom.it/provvedimenti/delibera-109-26-cons)                                                                             |
| Indonesia      |      |                                   | No local allocation. 3.5 GHz has not yet been released                                                                                                                                                                               |

**Spain.** The July 2026 CNAF revision splits the band several ways, and the segments overlap in places, so read the Orden itself before planning: 3800 to 3920 MHz is available as a local license, 3920 to 4020 MHz is reserved for defense, 3920 to 4120 MHz covers self-provision for broadcast use, and 4020 to 4120 MHz is available for self-provision more generally. 3.4 to 3.8 GHz is operator spectrum, not private.

## Bands supported by Onyx

### 5G NR

<table><thead><tr><th width="110">Band</th><th width="90">Duplex</th><th width="230">Frequency</th><th>Access Points</th></tr></thead><tbody><tr><td><strong>n48</strong> (CBRS)</td><td>TDD</td><td>3550–3700 MHz</td><td>G105 (indoor), G505 (outdoor)</td></tr><tr><td><strong>n78</strong></td><td>TDD</td><td>3300–3800 MHz</td><td>G105 (indoor), G505 · G506 (outdoor)</td></tr><tr><td><strong>n77</strong></td><td>TDD</td><td>3800–4200 MHz (G506)<br>3700–4200 MHz (G105, future release)</td><td>G506 (outdoor), G105 (indoor, future release)</td></tr><tr><td><strong>n41</strong></td><td>TDD</td><td>2496–2690 MHz</td><td>G509-n41 (outdoor)</td></tr><tr><td><strong>n79</strong></td><td>TDD</td><td>4700–5000 MHz</td><td>G509-n79 (outdoor)</td></tr><tr><td><strong>n28</strong></td><td>FDD</td><td>UL 703–748 MHz · DL 758–803 MHz</td><td>G509-n28 (outdoor)</td></tr><tr><td><strong>n26</strong></td><td>FDD</td><td>UL 814–849 MHz · DL 859–894 MHz</td><td>G509-n26 (outdoor)</td></tr></tbody></table>

### LTE

<table><thead><tr><th width="110">Band</th><th width="90">Duplex</th><th width="230">Frequency</th><th>Access Points</th></tr></thead><tbody><tr><td><strong>B48</strong> (CBRS)</td><td>TDD</td><td>3550–3700 MHz</td><td>G100 (indoor), G101 · G501 (outdoor)</td></tr><tr><td><strong>B3</strong></td><td>FDD</td><td>UL 1710–1785 MHz · DL 1805–1880 MHz</td><td>G229 (indoor)</td></tr><tr><td><strong>B1</strong></td><td>FDD</td><td>UL 1920–1980 MHz · DL 2110–2170 MHz</td><td>G249 (outdoor)</td></tr></tbody></table>

For transmit power, MIMO configuration, channel bandwidth options, and link budget per model, see the individual specification sheets under [*Onyx Hardware*](https://docs.gxc.io/hw/onyx-hardware/gxc-5g-and-lte-hardware).

## What the band choice determines

Band selection is not only a licensing question. It propagates through the whole design.

**Duplex mode sets the uplink ceiling.** The TDD bands: n48, n77, n78, n41, n79: share one channel between uplink and downlink on a configurable slot pattern, so uplink capacity is a design decision. Onyx supports patterns from 77% DL / 21% UL (`DDDDDDDSUU`) through to 34% DL / 63% UL (`DSUUU`). The FDD bands: n26, n28, B1, B3: give uplink and downlink permanently separate channels, so the split is fixed but guaranteed.

**Frequency sets the coverage radius.** The sub-GHz FDD bands (n28 at 703–803 MHz, n26 at 814–894 MHz) propagate substantially further and penetrate structure better than the mid-band TDD options at 3.3–5.0 GHz. Their channel bandwidths are correspondingly narrow: 40 MHz on n28, 20 MHz on n26, against up to 100 MHz on n78. Coverage and capacity pull in opposite directions here.

**Channel bandwidth sets the throughput.** This is the number that carries into [*Step 1 - Capacity*](/plan-your-network/capacity). CBRS grants in particular are frequently narrower than the maximum the hardware supports, because the SAS issues what is available rather than what you request.

{% hint style="warning" %}
**NOTE**: Every cell sharing a band at a site, and any neighbouring operator in the same band: must use the same TDD pattern and frame timing. The slot pattern is a site-wide decision, not a per-application one. Where two applications need incompatible splits, separate them onto different carriers rather than compromising both.
{% endhint %}

## CBRS in the United States

CBRS is the most common route to private cellular spectrum in the US, and the one with the most operational obligation attached. It operates in 3550–3700 MHz under *47 CFR Part 96*, regulated by the FCC.

### The three-tier model

Access is prioritized across three tiers, and the Spectrum Access System (SAS) enforces that priority continuously.

| Tier                                        | Users                                                                                   | Protection                                                                    |
| ------------------------------------------- | --------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| **Tier 1: Incumbents**                      | US Navy radar, Fixed Satellite Service earth stations, other federally authorised users | Full protection. When incumbent activity is detected, all lower tiers vacate. |
| **Tier 2: Priority Access License (PAL)**   | Licensees holding exclusive rights won at FCC auction                                   | Protected within the licensed geographic area; yields to incumbents.          |
| **Tier 3: General Authorized Access (GAA)** | License-by-rule, open to anyone                                                         | Shared, non-exclusive, no interference protection.                            |

Most private deployments, including most GXC Onyx deployments, run on **GAA**. There is no license to buy and no auction to enter, but there is also no protection, and a grant can be modified or withdrawn.

### What this obligates you to

CBRS is not permission granted once. It is authorisation maintained continuously.

* **Every radio must register with an FCC-approved SAS before it transmits.** Onyx handles this through an integrated Domain Proxy, so registration and grant management happen from the Onyx Portal rather than radio by radio. GXC's primary SAS provider is Federated Wireless, though the platform is designed to work with any FCC-approved SAS.
* **A Certified Professional Installer must certify each installation.** The FCC requires a credentialed CPI to verify and digitally sign the installation parameters: location, antenna height AGL, azimuth, downtilt, gain, and deployment category: before those records go to the SAS. CPI certification is issued to an individual, not a company, and that individual is accountable for the accuracy of every record they sign.
* **Grants must be maintained by heartbeat.** Each radio sends periodic heartbeats through the Domain Proxy. Miss the interval, or have spectrum availability change, and the SAS may suspend, modify, or terminate the grant.
* **The SAS can reconfigure your network without warning.** Environmental Sensing Capability sensors watch for federal incumbent activity. When a Dynamic Protection Area activates, the SAS automatically reassigns frequencies, reduces transmit power, or suspends transmission until the incumbent clears. Onyx handles this automatically, but plan for a network whose operating frequency and bandwidth can change during normal operation.

{% hint style="info" %}
**NOTE**: Plan your capacity against the bandwidth you are likely to be *granted*, not the maximum the band allows. A GAA deployment that only works at its peak grant is a deployment that stops working when a higher tier needs the spectrum.
{% endhint %}

For the complete registration workflow: CPI account setup, deployment creation, CBSD records, signing, Onyx Portal configuration, grant verification, and troubleshooting: see [*4G & 5G Onyx CBRS SAS Registration*](https://docs.gxc.io/docs/application-notes/4g-and-5g-onyx-cbrs-sas-registration).

## Outside the United States

Local licensing for private networks is now established in many markets, most commonly in n77 and n78. Terms vary widely: some regulators issue per-site licences on application, others allocate regional blocks, and some route private allocations through incumbent operators.

Two things are consistent enough to plan around:

* **Mid-band TDD (n77/n78) is the mainstream private allocation.** If a market has a dedicated private-network band, it is usually here.
* **Equipment authorisation is separate from spectrum authorisation.** Holding a license does not by itself permit you to deploy a given radio. Each Onyx AP ships with regulatory compliance information for its supported markets; see the *Appendix: Regulatory Compliance* in that model's hardware installation guide.

{% hint style="info" %}
**NOTE**: Regulatory frameworks for private spectrum change faster than most documentation. Confirm current terms with the national regulator, and contact GXC before finalising a design that depends on a specific allocation.
{% endhint %}

## Compliance and certification

* **FCC Part 96**: Onyx is FCC-certified for Part 96 compliance, supporting shared CBRS spectrum use in the United States.
* **Integrated CBRS Domain Proxy**: enables compliant, interference-free shared-spectrum operation through encrypted communication with the SAS.
* **Per-model regulatory compliance**: each AP, mesh node, and FHM hardware installation guide includes a regulatory compliance appendix covering the markets that model is approved for.

For the platform's wider security posture and certifications, see [*Security and Compliance*](/security-and-compliance).

## Related reading

* [*4G & 5G Onyx CBRS SAS Registration*](https://docs.gxc.io/docs/application-notes/4g-and-5g-onyx-cbrs-sas-registration): the full CBSD registration workflow, end to end
* [*Step 1: Capacity*](/plan-your-network/capacity): how channel bandwidth and TDD pattern turn into a radio count
* [*Onyx Hardware*](https://docs.gxc.io/hw/onyx-hardware/gxc-5g-and-lte-hardware): per-model frequency, power, and regulatory detail
  * [*Glossary*](/glossary): CBRS, SAS, CBSD, CPI, GAA, PAL, DPA, and related terms

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# Plan Your Network

## Introduction

As connectivity becomes core infrastructure, enterprises are increasingly adopting private Long-Term Evolution (LTE) and Fifth Generation (5G) networks resilient and secure enough to meet their operational requirements for coverage, capacity, mobility, reliability, and access control, capabilities that enterprise Wi-Fi was not designed to deliver at industrial scale.

GXC's Onyx™ platform provides a flexible, scalable, and secure foundation for private LTE and 5G deployments across a wide range of indoor and outdoor enterprise environments. It brings coverage, capacity, mobility, reliability, and access control together in a single, integrated system, providing the connectivity infrastructure that modern enterprises need.

## What this Guide Covers

This guide provides a practical framework for designing Onyx-powered private cellular networks, guiding you from *“I have a site and a use case”* to a preliminary network design suitable for developing a quote and Bill of Materials (BoM).

## Who This Guide Is For

This guide is intended for customer technical teams designing their own deployments and for GXC partners developing customer proposals.

## What You'll Get

By the end of this guide, you'll have:

* **A radio plan**: The number of radios required, the appropriate radio type, and their recommended placement.
* **A network design**: The required infrastructure, Onyx Edge servers, fronthaul, backhaul, switches, and the overall deployment architecture.
* **A Bill of Materials (BoM)**: The BoM that you can use to request a quote or build a customer proposal.

## Onyx ROM AP Calculator

At each step, the guide walks you through the [*Onyx Rough Order of Magnitude (ROM) AP Calculator*](https://www.gxc.io/rom-ap-calculator/), a live tool that turns your deployment requirements into design recommendations. This guide also explains the manual methods and reference data behind those results, enabling you to validate the recommendations and develop them into a complete preliminary design and BoM.

<p align="center"><strong>Figure: Onyx ROM AP Calculator Interface</strong></p>

<div data-with-frame="true"><figure><img src="https://2839344875-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcsOm7izkwc75UBmow1N0%2Fuploads%2FKLHYKD5BZHlqmNQNpCfm%2Fimage.png?alt=media&#x26;token=faa65ed4-6b46-4cd3-aa88-bd047e2d7191" alt=""><figcaption></figcaption></figure></div>

{% hint style="info" %}
**NOTE**: The calculator's estimates (like the rules of thumb they're built on) are a reliable starting point, not a substitute for an RF survey at sites with significant clutter, height variation, challenging propagation conditions, or strict coverage SLAs. For projects requiring a detailed RF design, GXC offers RF design as a service.
{% endhint %}

## What to Bring

Before you begin, gather the following information.

Each item maps directly to one of the [*ROM Calculator's*](https://www.gxc.io/rom-ap-calculator/) three input panels.

| Bring this                                                                                                                                                                                                    | ROM Calculator Panel / Fields                                                                                                                                                                                                          |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <p><strong>Your Site</strong><br><br>- Size<br>- Indoor/outdoor split<br>- Terrain<br>- Obstructions<br>- Ceiling heights<br>- Zones with different coverage needs</p>                                        | <p><strong>Site & Coverage</strong><br><br>- Deployment Type<br>- Environment<br>- Clutter Level<br>- Total Site Area</p>                                                                                                              |
| <p><strong>Your Use Cases</strong><br><br>- Voice<br>- Video<br>- Industrial automation<br>- Internet of Things (IoT)<br>- Surveillance<br>- Telemetry<br>- Broadcast<br>- Other operational applications</p> | <p><strong>Capacity & Application</strong><br><br>- Primary Use Case<br>- Latency Requirement</p>                                                                                                                                      |
| <p><strong>Your Devices</strong><br><br>- Types<br>- Capabilities<br>- Expected concurrency<br>- Bandwidth needs</p>                                                                                          | <p><strong>Capacity & Application</strong><br><br>- Downlink / User<br>- Uplink / User<br><br><strong>Site & Coverage</strong><br><br>- UL Device Class</p>                                                                            |
| <p><strong>Your Scale</strong><br><br>- Expected users/devices<br>- Peak concurrency</p>                                                                                                                      | <p><strong>Capacity & Application</strong><br><br>- Concurrent Devices<br>- Device Mobility</p>                                                                                                                                        |
| <p><strong>Your Spectrum and Backhaul</strong><br><br>- CBRS<br>- n77/n78 or other regional bands<br>- Existing wired connectivity</p>                                                                        | <p><strong>Capacity & Application</strong><br><br>- Technology<br>- Channel BW<br><br><strong>Site & Coverage</strong><br><br>- Region<br>- AP Power Class<br><br><strong>Planning Parameters</strong><br><br>- Backhaul / Cabling</p> |
| <p><strong>Your Design Preferences</strong><br><br>- How conservative your estimate should be<br>- How much growth/overlap margin to plan for</p>                                                             | <p><strong>Planning Parameters</strong><br><br>- Planning Stance<br>- Overlap / Growth Buffer</p>                                                                                                                                      |

## Before you Begin

New to private cellular terminology or concepts?

* [*Introduction to GXC Onyx*](/): Review the overall Onyx platform architecture and components.
* [*Is Onyx Right for You?*](/is-onyx-right-for-you): Check that private cellular fits the problem before you size a network for it.
* [*GXC Glossary*](/glossary): Learn common private cellular and Onyx terminology.
* [*Private 5G Spectrum and Regulations*](/private-5g-spectrum): Understand supported spectrum bands and regulatory considerations.
* [*Security and Compliance*](/security-and-compliance): Review security features, compliance certifications, and applicable regulatory requirements.
* [*Onyx Hardware*](https://docs.gxc.io/hw/onyx-hardware/gxc-5g-and-lte-hardware): Learn about supported Onyx Edge gateways, Access Points (APs), antennas, and related hardware.
* [*Use Case Workflows*](https://docs.gxc.io/usecases-workflows): See the network requirements that real deployments produce, workflow by workflow.

## Where this Guide is Going

Network design follows four steps, in this order:

<p align="center"><strong>Capacity → Coverage → Architecture → Accessories</strong></p>

Capacity sets a floor, Coverage sets a ceiling, Architecture resolves where you land between them, and Accessories completes the system.

Work through the four steps in order. Each one carries a number into the next, so skipping ahead produces a design that does not hold together.

{% stepper %}
{% step %}

## Capacity

{% content-ref url="/pages/14089bc89bad4e9a4195b0712ba83fdcea56894e" %}
[Capacity](/plan-your-network/capacity)
{% endcontent-ref %}
{% endstep %}

{% step %}

## Coverage

{% content-ref url="/pages/0a57114e418b953a1c4a9a4e9ffd24baeeb62a42" %}
[Coverage](/plan-your-network/coverage)
{% endcontent-ref %}
{% endstep %}

{% step %}

## Architecture

{% content-ref url="/pages/bf5c2f6f7a9de308312c038193e06056a44b7b37" %}
[Architecture](/plan-your-network/architecture)
{% endcontent-ref %}
{% endstep %}

{% step %}

## Accessories

{% content-ref url="/pages/b01886e7a37e4a97868341e5760ac09f5a731d08" %}
[Accessories](/plan-your-network/accessories)
{% endcontent-ref %}
{% endstep %}
{% endstepper %}

## Getting a Full Estimate

The BoM components in *Step 4* [*Accessories*](/plan-your-network/accessories) cover the equipment required for a given architecture, but several accessory quantities: antenna and cable counts, FHM requirements, RU/gNodeB configuration, and outdoor-unit accessories: depend heavily on the specific deployment's physical layout and are not produced by the calculator. Adding these manually without confirming they apply to your design can significantly overstate the estimate.

For a validated BoM and a formal quote, contact GXC Sales with the outputs from your ROM Calculator session. GXC Sales will confirm the accessory and configuration details: such as tenant/antenna counts, FHM requirements, and RU or outdoor-unit accessories: that apply to your specific deployment.

## Contact GXC Sales

To convert the preliminary BoM into a priced, deployment-ready quote, contact [GXC Sales](https://www.gxc.io/contact-us). Sales involvement is especially useful when your design includes an outdoor unit, since outdoor accessories, tenant/antenna counts, and other site-dependent components are best confirmed before final pricing.


# Capacity

Capacity planning determines how much wireless throughput the deployment must support and how many cells are required to meet that demand.

<details>

<summary><strong>Why Capacity Comes First?</strong></summary>

Capacity is the foundation of the network design. Getting the capacity requirement wrong can lead to an inappropriate technology or architecture choice resulting in an under- or over-sized deployment.

Because Onyx LTE and 5G use distinct hardware platforms, technology selection should be considered early in the design. Coverage, Architecture, and Accessories then build on the capacity requirement established here.

This is why the ROM AP Calculator asks for the application-level inputs early in the workflow and why its Technology Assessment should be considered alongside the calculated capacity requirement.

</details>

### Do this in the Calculator

{% stepper %}
{% step %}

## Set Capacity & Application Inputs

In the **Capacity & Application** panel, set:

* **Technology**: 4G / LTE or 5G NR
* **Channel BW**: (Only for 5G NR) 20 / 40 / 100 MHz
* **Primary Use Case**: The category that best represents the dominant application (General Enterprise / Voice & Data, IoT/Telemetry & Sensors, Video Surveillance & Broadcast, Logistics/AGVs & Automated Vehicles, Machine Vision & Real-time Control, AR/VR & High-bandwidth Immersive)
* **Latency Requirement**: Not Sensitive / Moderate / <30 ms\
  (LTE delivers >50 ms; 5G NR delivers <30 ms)
* **Downlink / User**: <3 / 3–50 / >50 Mbps
* **Uplink / User**: <1 / 1–10 / >10 Mbps
* **Concurrent Devices**: <25 / 25–100 / 100+
* **Device Mobility**: Fixed / Mobile / Continuous

<p align="center"><strong>Figure: ROM Calculator - Capacity &#x26; Application Panel</strong></p>

<div data-with-frame="true"><figure><img src="https://2839344875-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcsOm7izkwc75UBmow1N0%2Fuploads%2FmISdycFffQM99hIzxChv%2Fimage.png?alt=media&#x26;token=8c2ed8b4-5283-493b-9914-160dd069e84b" alt=""><figcaption></figcaption></figure></div>

The calculator uses these inputs to estimate traffic demand and determine the capacity-driven AP count.
{% endstep %}

{% step %}

## Review Estimated APs

In the **Estimated APs** panel, review:

* **Capacity estimate:&#x20;*****n*****&#x20;APs (DL needs&#x20;*****X*****&#x20;· UL needs&#x20;*****Y*****)**: The estimated AP count and the calculated downlink and uplink requirements. The larger of *X* and *Y* is your capacity-driven cell count, and the calculator identifies the binding direction, such as "UL-limited".

<p align="center"><strong>Figure: ROM Calculator - Estimated APs Panel</strong></p>

<div data-with-frame="true"><figure><img src="https://2839344875-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcsOm7izkwc75UBmow1N0%2Fuploads%2F8dylM1Aoyn7D5F28ZSIX%2Fimage.png?alt=media&#x26;token=a5bc17cb-f60a-4955-9ed3-d71620d85156" alt=""><figcaption></figcaption></figure></div>

* **Technology Assessment**: Indicates whether the selected technology is a good fit, with the reasoning behind the recommendation.

<p align="center"><strong>Figure: ROM Calculator - Technology Assessment Panel</strong></p>

<div data-with-frame="true"><figure><img src="https://2839344875-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcsOm7izkwc75UBmow1N0%2Fuploads%2FlNBAXHBlrvIw10jaDT1z%2Fimage.png?alt=media&#x26;token=51831358-2b02-4084-8388-5e33d1313659" alt=""><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}

#### Understanding the Methodology

The Calculator performs the capacity calculation automatically. This section explains the methodology so that you can validate the recommendation and adapt it when the deployment does not fit the Calculator's generic application categories.

The Calculator's built-in capacity estimate applies a 0.65 concurrency factor to the device count in your selected Concurrent Devices bucket before computing throughput demand: it never evaluates 100% of devices as simultaneously active.

The manual method below (Application Profile → Total Throughput Demand) does not apply this factor, because it uses your own per-application peak-concurrency figures directly: a number you've already defined as "simultaneously active during peak operating conditions." This is intentional as the manual method is more precise when you know your actual peak concurrency, while the Calculator's 0.65 factor is a generic estimate for when you don't.

{% hint style="info" %}
**NOTE:** The Calculator provides a planning estimate. It does not replace a detailed capacity or RF design when application requirements, device behavior, spectrum availability, or site conditions require more detailed analysis.
{% endhint %}

{% stepper %}
{% step %}

## Determine the Application Profile

The application profile is an inventory of the devices and applications that will use the network.

For each device category, capture:

* **Application**: What does the device or application do? Examples include Automated Guided Vehicle (AGV) navigation, video surveillance, handheld scanning, voice, and Supervisory Control and Data Acquisition (SCADA).
* **Peak concurrent devices**: How many devices of that type are expected to be simultaneously active during peak operating conditions?

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> Size the network for the expected peak operating workload, not simply the total number of deployed devices or the average traffic level. Identify how many devices are expected to be active simultaneously and what traffic each application generates during the peak operating condition.</p></div>
* **Downlink requirement**: How much data does the application receive?
* **Uplink requirement**: How much data does the application transmit?
* **Latency requirement**: How sensitive is the application to network delay?
* **Mobility**: Is the device stationary, pedestrian, or vehicle-mounted?

<details>

<summary><strong>Why Application Profiling Comes First?</strong></summary>

Not all devices place the same demands on the network.

A handheld barcode scanner may use only a small amount of bandwidth, while a 4K surveillance camera can generate a continuous high-volume uplink stream. Similarly, an AGV performing real-time navigation may have more demanding latency requirements than a sensor that periodically reports a measurement.

Understanding the complete application profile provides the baseline for calculating network capacity and determining the required AP density.

</details>

**Application Traffic Classes**

{% hint style="info" %}
**NOTE:** The following ranges provide general planning guidance for classifying application traffic. They are illustrative ranges, not guaranteed application requirements.
{% endhint %}

| Class    | Examples                                             | Typical Range      |
| -------- | ---------------------------------------------------- | ------------------ |
| Light    | Voice, messaging, telemetry                          | 100–300 kbps       |
| Moderate | IoT, monitoring systems, standard video applications | 500 kbps – 3 Mbps  |
| Heavy    | AR/VR, machine vision, real-time video analytics     | 10 Mbps or greater |

{% hint style="info" %}
**NOTE:** Actual bandwidth depends on application design, concurrency, video resolution, frame rate, compression, operational workload, and device behavior. Use application-specific requirements whenever they are available.
{% endhint %}

**ROM Calculator Bandwidth Tiers**

The Calculator uses broader planning buckets than the application traffic ranges above. These DL and UL values are what the calculator maps to your Downlink/User and Uplink/User selections.

| Class        | Examples                                   | DL      | UL       |
| ------------ | ------------------------------------------ | ------- | -------- |
| Light / Low  | Voice, messaging, telemetry                | 2 Mbps  | 0.5 Mbps |
| Moderate     | IoT, monitoring, standard video            | 20 Mbps | 5 Mbps   |
| Heavy / High | AR/VR, machine vision, real-time analytics | 75 Mbps | 25 Mbps  |

{% hint style="info" %}
**NOTE**: The Calculator applies a 0.65 concurrency factor to the device count used in its capacity calculation. Do not independently apply an additional concurrency reduction when interpreting the Calculator's estimate. For deployments where the expected traffic profile does not map well to the Calculator's generic tiers, validate the result using the application-specific calculation described below.
{% endhint %}
{% endstep %}

{% step %}

## Calculate the Total Throughput Demand

Calculate the aggregate throughput requirement for the defined peak operating condition.

For each device category:

```
Total DL demand = active devices × DL bandwidth per device

Total UL demand = active devices × UL bandwidth per device
```

Sum the results across all device categories.

Calculate downlink and uplink independently because enterprise applications rarely generate equal traffic in both directions.

The result is the peak throughput requirement that the network must support during the defined peak operating condition.

{% hint style="info" %}
**NOTE:** Capacity planning should use the expected peak concurrent workload rather than average utilization. Designing only for average traffic can result in insufficient capacity during normal operational peaks.
{% endhint %}
{% endstep %}

{% step %}

## Select the Technology and Architecture

With the peak throughput requirement established, compare it against the capabilities of the Onyx LTE and 5G platforms.

Technology selection should consider: Peak downlink throughput, peak uplink throughput, application latency requirements, device capabilities, spectrum availability, MIMO capability, expected device concurrency, mobility requirements, capacity-driven cell count, deployment architecture, and future operational requirements.

Cell capacity is determined from the LTE or 5G SA TDD tables below (frame format × bandwidth × MIMO):

```
APs_cap = max(⌈TotalDL ÷ CellDL⌉, ⌈TotalUL ÷ CellUL⌉)
```

**LTE or 5G?**

In many deployments, technology selection needs to be made early because GXC Onyx LTE and 5G use distinct hardware platforms.

**LTE vs 5G At a Glance**

|                                  | LTE                                                                                                                                                                                  | 5G                                                                         |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- |
| Latency Characteristics          | Suitable for moderate-latency enterprise applications (>50 ms)                                                                                                                       | Supports lower-latency and real-time workloads (<30 ms)                    |
| Typical Use Cases                | General enterprise connectivity, telemetry, IoT                                                                                                                                      | Real-time analytics, robotics, machine vision, broadcast video             |
| Estimated Peak AP Throughput     | \~40 Mbps @ 20 MHz (general baseline); \~105 Mbps/cell at 20 MHz for the default Config1 configuration (up to 96 RRC users), see the table below for the full range by configuration | Up to 300+ Mbps with 4×4 MIMO @ 40 MHz, depending on deployment conditions |
| Channel BW options in calculator | Fixed (2×20 MHz CA reference)                                                                                                                                                        | 20 / 40 / 100 MHz, selectable                                              |

{% hint style="info" %}
**NOTE:** Actual throughput and latency depend on spectrum allocation, RF conditions, antenna configuration, device capability, mobility, interference, and overall deployment design. Use the measured throughput tables in this guide as planning references rather than guaranteed production performance.
{% endhint %}

**LTE and 5G Hardware Considerations**

GXC Onyx LTE and 5G use distinct hardware platforms. Selecting the appropriate technology is therefore an important early design decision.

If an existing LTE deployment later requires 5G capability, a supported 5G architecture may be available for specific configurations. This is not a standard LTE-to-5G migration model.
{% endstep %}
{% endstepper %}

### LTE Capacity

This section provides guidance for understanding LTE capacity on the Onyx platform.

<details>

<summary><strong>LTE Capacity Overview</strong></summary>

LTE capacity planning determines how much traffic the network can support and how many cells are required to meet the expected peak demand.

LTE Time Division Duplex (TDD) shares the available radio spectrum between downlink and uplink transmission. Capacity therefore depends not only on channel bandwidth and MIMO configuration, but also on how radio resources are divided between the two directions.

For LTE deployments, capacity planning should consider:

* Peak downlink throughput
* Peak uplink throughput
* Traffic direction and application behavior
* TDD Subframe Assignment (SA)
* Channel bandwidth
* MIMO configuration
* Modulation
* Carrier Aggregation (CA), where supported
* Device capability
* RF conditions
* Expected peak device concurrency

The goal is to select an LTE configuration that provides sufficient capacity in both directions while avoiding unnecessary cell deployment.

</details>

<details>

<summary><strong>Select the LTE TDD Subframe Assignment</strong></summary>

LTE Time Division Duplex (TDD) uses the same frequency channel for downlink and uplink traffic. The network alternates between the two directions, allocating a defined portion of radio resources to each.

The Subframe Assignment (SA) determines this DL/UL allocation.

Think of the radio channel as a road shared by traffic moving in two directions. Allocating more time to one direction increases capacity in that direction, but leaves less capacity available for the other.

**Why Does it Matter?**

Choosing the appropriate SA profile is an important part of LTE capacity planning.

For example, a surveillance deployment may continuously transmit video from cameras to a recording system. Selecting a heavily downlink-oriented SA profile for such a deployment would allocate insufficient airtime to uplink traffic.

**Available SA Profiles**

| SA  | DL  | UL  | Traffic Profile        |
| --- | --- | --- | ---------------------- |
| SA1 | 70% | 30% | Balanced traffic       |
| SA2 | 85% | 15% | Downlink-heavy traffic |
| SA6 | 60% | 40% | Uplink-heavy traffic   |

**Choosing an SA Profile Rule of Thumb**

* **Balanced traffic** · General enterprise connectivity, tablets, laptops, and mixed IoT → Consider **SA1** as the starting point.
* **Primarily downlink traffic** · Streaming video, software updates, command delivery, and content distribution → Consider **SA2**.
* **Primarily uplink traffic** · Cameras, sensors, AGVs, telemetry, and industrial monitoring → Consider **SA6**.

For example, a surveillance deployment may continuously transmit video from cameras to a recording or monitoring system. A heavily downlink-oriented SA would allocate insufficient airtime to this uplink traffic.

These recommendations are starting points: the final selection should be based on the calculated application traffic profile.

| Application                                   | Recommended SA      |
| --------------------------------------------- | ------------------- |
| CPE routers serving broadband traffic         | SA2: DL-heavy       |
| Video streaming to displays or signage        | SA2: DL-heavy       |
| Handheld scanners downloading work orders     | SA2: primarily DL   |
| Mixed enterprise (tablets, laptops, light IoT | SA1) balanced       |
| Push-to-talk voice with data                  | SA1: balanced       |
| Video surveillance cameras                    | SA6: UL-heavy       |
| Dense sensor/telemetry networks               | SA6: UL-heavy       |
| AGVs or robots reporting position and status  | SA6: UL-heavy       |
| Unknown or mixed traffic profile              | SA1: starting point |

{% hint style="info" %}
**NOTE:** Every GXC AP operating on the same frequency channel must use the same SA configuration. SA is therefore a network-level design decision rather than an individual device setting.
{% endhint %}

</details>

<details>

<summary><strong>Understand LTE Throughput</strong></summary>

The following throughput tables provide measured peak throughput values observed during controlled GXC testing.

Use these values as planning references, not guaranteed production throughput.

Actual performance depends on RF signal quality, spectrum availability, interference, channel bandwidth, MIMO configuration, modulation, device capability, AP density, user concurrency, mobility, and environmental conditions.

<p align="center"><strong>Single/Dual Carrier Peak Expected Throughput (Mbps)</strong></p>

<table><thead><tr><th width="95">MIMO Config</th><th>Dir/Mod</th><th width="100" align="center">SA1 10MHz</th><th width="100" align="center">SA1 20MHz</th><th width="100" align="center">SA2 10MHz</th><th width="100" align="center">SA2 20MHz</th><th width="100" align="center">SA6 10MHz</th><th width="100" align="center">SA6 20MHz</th></tr></thead><tbody><tr><td>DL 2T</td><td>DL-256QAM</td><td align="center">48</td><td align="center">96</td><td align="center">66</td><td align="center">131</td><td align="center">39</td><td align="center">78</td></tr><tr><td>DL 1T</td><td>DL-256QAM</td><td align="center">24</td><td align="center">48</td><td align="center">33</td><td align="center">66</td><td align="center">20</td><td align="center">39</td></tr><tr><td>UL 1T</td><td>UL-64QAM</td><td align="center">14</td><td align="center">29</td><td align="center">7</td><td align="center">14</td><td align="center">18</td><td align="center">36</td></tr></tbody></table>

<p align="center"><strong>Carrier Aggregation Peak Expected Throughput (Mbps)</strong></p>

<table><thead><tr><th width="95">MIMO Config</th><th>Dir/Mod</th><th width="120" align="center">SA1 2×20MHz</th><th align="center">SA1 2×10MHz</th><th align="center">SA1 20+10MHz</th><th align="center">SA2 2×20MHz</th><th width="111" align="center">SA2 2×10MHz</th><th width="120" align="center">SA2 20+10MHz</th><th width="120" align="center">SA6 2×20MHz</th><th width="120" align="center">SA6 2×10MHz</th><th width="120" align="center">SA6 20+10MHz</th></tr></thead><tbody><tr><td>DL 2T</td><td>DL-256QAM</td><td align="center">192</td><td align="center">96</td><td align="center">144</td><td align="center">262</td><td align="center">131</td><td align="center">197</td><td align="center">157</td><td align="center">78</td><td align="center">118</td></tr><tr><td>DL 1T</td><td>DL-256QAM</td><td align="center">96</td><td align="center">48</td><td align="center">72</td><td align="center">131</td><td align="center">66</td><td align="center">98</td><td align="center">78</td><td align="center">39</td><td align="center">59</td></tr><tr><td>UL 1T</td><td>UL-64QAM</td><td align="center">58</td><td align="center">29</td><td align="center">43</td><td align="center">29</td><td align="center">14</td><td align="center">22</td><td align="center">72</td><td align="center">36</td><td align="center">54</td></tr></tbody></table>

{% hint style="warning" %}
**IMPORTANT:** These values represent measured performance under controlled conditions. They should not be interpreted as guaranteed per-user throughput or as a substitute for detailed RF and capacity engineering.
{% endhint %}

</details>

<details>

<summary><strong>Understand MIMO, Modulation, and Channel Width</strong></summary>

**MIMO Configuration**

MIMO refers to the number of spatial streams used simultaneously for data transmission or reception. Higher-order MIMO can increase throughput when supported by the AP, client device, antenna configuration, and RF conditions.

| Configuration | Description                                   | Typical Devices                                                       |
| ------------- | --------------------------------------------- | --------------------------------------------------------------------- |
| DL 2T (2×2)   | Two simultaneous downlink streams from the AP | Supported by many enterprise devices and CPEs                         |
| DL 1T (1×1)   | One downlink stream from the AP               | Basic devices or deployments where higher-order MIMO is not available |
| UL 1T (1×1)   | One uplink stream to the AP                   | Common LTE UL configuration                                           |

**Modulation**

Modulation determines how much data can be transmitted in each radio signal. Higher-order modulations can carry more bits per transmission, but requires better RF conditions.

**Channel Width**

The *Single/Dual Carrier* table's column headers (10 MHz, 20 MHz) represent the spectrum allocated to the deployment. Wider channels generally provide greater throughput capacity when the additional spectrum is available and supported by the deployment.

</details>

<details>

<summary><strong>Consider Carrier Aggregation</strong></summary>

CA combines multiple LTE carriers to provide additional usable spectrum capacity to supported devices. For example, two 20 MHz carriers can provide an aggregate 40 MHz spectrum allocation.

| Combination | Channel 1 | Channel 2 | Effective BW  | Use Case                                                                  |
| ----------- | --------- | --------- | ------------- | ------------------------------------------------------------------------- |
| 2×20 MHz    | 20        | 20        | 40 equivalent | Maximum capacity: use when two 20 MHz grants are available                |
| 2×10 MHz    | 10        | 10        | 20 equivalent | Two narrower grants bonded: same total as a single 20 MHz channel         |
| 20+10 MHz   | 20        | 10        | 30 equivalent | Asymmetric CA: useful when one wider and one narrower grant are available |

{% hint style="info" %}
**NOTE:** CA can increase available capacity when multiple supported carriers are available. Before including CA in the capacity design, verify spectrum availability, device support, AP and network configuration, and applicable deployment constraints.
{% endhint %}

</details>

<details>

<summary><strong>LTE Capacity Design Considerations</strong></summary>

* Use measured throughput values as planning references rather than theoretical maximums.
* Select the SA profile based on the dominant traffic direction.
* Use wider channel bandwidths where additional spectrum is available and additional capacity is required.
* Validate RF quality before relying on higher-order MIMO or modulation.
* Design AP density around expected peak operational demand rather than average utilization.
* Carefully evaluate uplink requirements for surveillance, telemetry, industrial automation, and sensor-heavy environments.
* Consider CA where additional spectrum is available and supported by the deployment.
* Validate device capabilities when determining realistic throughput.

The resulting LTE capacity design should establish the capacity-driven cell count before coverage and architecture are finalized.

</details>

### 5G Capacity

This section provides guidance for understanding 5G capacity on the Onyx platform.

<details>

<summary><strong>5G Capacity Overview</strong></summary>

5G capacity planning determines how much traffic the network can support and how many cells are required to meet the expected peak demand.

5G NR TDD uses the same spectrum for downlink and uplink transmission. The network therefore uses a slot pattern to determine how radio resources are allocated between the two directions.

For 5G deployments, capacity planning should consider:

* Peak downlink throughput
* Peak uplink throughput
* Traffic direction and application behavior
* TDD slot pattern
* Channel bandwidth
* MIMO configuration
* Modulation
* Device capability
* RF conditions
* Expected peak device concurrency
* Mobility and operational requirements

{% hint style="info" %}
**NOTE:** The throughput values in this section are based on measured performance during controlled GXC field and laboratory testing using CBRS and mid-band 5G spectrum configurations. Actual performance varies with spectrum availability, RF conditions, interference, device capability, MIMO configuration, mobility, environmental obstructions, AP density, user concurrency, and overall deployment design.
{% endhint %}

</details>

<details>

<summary><strong>Select the 5G TDD Slot Pattern</strong></summary>

5G TDD uses the same spectrum for uplink and downlink transmission. A slot pattern determines how radio resources are distributed between the two directions.

* **Downlink traffic** moves from the network to devices, such as tablets, AR headsets, and handheld devices.
* **Uplink traffic** moves from devices to the network, such as cameras, sensors, robots, scanners, and telemetry systems.

A deployment with many cameras, sensors, or robots may require greater uplink allocation. A deployment dominated by video delivery, software downloads, or AR content may require greater downlink allocation.

**5-Slot Patterns**

Provides simplified scheduling behavior and predictable traffic allocation.

| Pattern | DL/UL Distribution | Recommended Deployment Environment                                            |
| ------- | ------------------ | ----------------------------------------------------------------------------- |
| DDDSU   | 74% DL / 23% UL    | Downlink-heavy applications including content delivery and media distribution |
| DDSUU   | 54% DL / 43% UL    | Balanced enterprise traffic and mixed-use environments                        |
| DSUUU   | 34% DL / 63% UL    | Uplink-heavy environments including surveillance and telemetry workloads      |

**10-Slot Patterns**

Provides finer control over downlink and uplink resource allocation, for mixed enterprise workloads.

| Pattern    | DL/UL Distribution | Recommended Deployment Environment                                                     |
| ---------- | ------------------ | -------------------------------------------------------------------------------------- |
| DDDDDDDSUU | 77% DL / 21% UL    | Downlink-heavy applications such as video delivery, AR/VR, and content distribution    |
| DSUUUUDSUU | 25% DL / 72% UL    | Mixed enterprise traffic including handheld devices, laptops, and general connectivity |
| DDSUUUUUUU | 20% DL / 77% UL    | Uplink-heavy environments such as surveillance, telemetry, and industrial sensors      |

{% hint style="info" %}
**NOTE:** The DL and UL percentages represent the approximate allocation of data-carrying resources. They do not necessarily sum to 100% because TDD frame structures also include special and other non-DL/UL resources.
{% endhint %}

**Choosing Between 5-Slot and 10-Slot Patterns**

Consider dominant traffic direction, aggregate throughput requirement, scheduling behavior, latency requirements, synchronization and coexistence requirements, and operational simplicity.

</details>

<details>

<summary><strong>Choose a Slot Pattern by Traffic Profile</strong></summary>

**Heavy Downlink Applications**

Examples include video delivery, AR/VR, content distribution, and software distribution. Both DDDSU and DDDDDDDSUU allocate the majority of airtime to downlink.

| Pattern              | Split           | Best when                                                                                                                      |
| -------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| DDDSU (5-slot)       | 74% DL / 23% UL | Simpler scheduling preferred, predictable DL delivery, no coexistence constraint, lower operational complexity                 |
| DDDDDDDSUU (10-slot) | 77% DL / 21% UL | Maximum DL throughput ceiling required, fine-grained DL/UL balancing needed, adjacent networks require 10-slot synchronization |

{% hint style="info" %}
**NOTE:** DDDSU is the recommended starting point for most Heavy DL deployments. DDDDDDDSUU delivers marginally higher DL capacity and is the right choice when squeezing maximum downlink throughput from available spectrum is the priority.
{% endhint %}

**Mixed-Use Applications**

Examples include general enterprise connectivity, handheld devices, laptops, balanced industrial workloads.

| Pattern              | Split           | Best When                                                                                                       |
| -------------------- | --------------- | --------------------------------------------------------------------------------------------------------------- |
| DDSUU (5-slot)       | 54% DL / 43% UL | Balanced enterprise environment, operational simplicity preferred, predictable traffic allocation               |
| DSUUUUDSUU (10-slot) | 25% DL / 72% UL | Greater flexibility needed to tune DL/UL balance dynamically, adjacent networks require 10-slot synchronization |

{% hint style="info" %}
**NOTE:** DDSUU is the recommended starting point for most Mixed Use deployments. DSUUUUDSUU provides more fine-grained control over the DL/UL balance and suits environments where traffic patterns vary significantly across shifts or operational periods.
{% endhint %}

**Heavy Uplink Applications**

Examples include surveillance cameras, telemetry sensors, AGVs, and industrial monitoring. Both DSUUU and DDSUUUUUUU allocate the majority of airtime to uplink.

| Pattern              | Split           | Best when                                                                                                                        |
| -------------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| DSUUU (5-slot)       | 34% DL / 63% UL | Many devices uploading frequently, low-latency UL response needed, high device concurrency, operational simplicity preferred     |
| DDSUUUUUUU (10-slot) | 20% DL / 77% UL | Maximum raw UL throughput ceiling required, sustained bulk continuous uploads, adjacent networks require 10-slot synchronization |

{% hint style="info" %}
**NOTE:** For most Heavy UL deployments, DSUUU is the recommended starting point: more frequent uplink scheduling opportunities reduce per-device queuing delay, which matters with high concurrent device activity. DDSUUUUUUU delivers a higher aggregate UL throughput ceiling and is the right choice when bulk continuous upload capacity is the priority and latency tolerance is higher.
{% endhint %}

</details>

<details>

<summary><strong>Understand 5G Throughput</strong></summary>

The following throughput tables provide measured peak throughput values observed during controlled GXC testing.

{% hint style="warning" %}
**IMPORTANT:** Use these values as deployment planning references, not guaranteed per-user throughput in a shared production environment. Actual performance varies with RF quality, channel bandwidth, MIMO configuration, modulation, device capability, AP density, user concurrency, mobility, and environmental conditions.
{% endhint %}

**Peak Expected Throughput (Mbps) · 10-Slot Patterns**

<p align="center"><strong>10-slot · DDDDDDDSUU (77% DL / 21% UL): Heavy Downlink</strong></p>

<table><thead><tr><th width="100">MIMO Config</th><th width="120">Dir/Mod</th><th width="100" align="center">10MHz</th><th width="100" align="center">20MHz</th><th width="101" align="center">40MHz</th><th width="100" align="center">50MHz</th><th width="105" align="center">100MHz</th></tr></thead><tbody><tr><td>DL 4T</td><td>DL-256QAM</td><td align="center">124</td><td align="center">263</td><td align="center">546</td><td align="center">685</td><td align="center">1370</td></tr><tr><td>DL 2T</td><td>DL-256QAM</td><td align="center">63</td><td align="center">135</td><td align="center">280</td><td align="center">351</td><td align="center">703</td></tr><tr><td>DL 1T</td><td>DL-256QAM</td><td align="center">32</td><td align="center">69</td><td align="center">144</td><td align="center">180</td><td align="center">361</td></tr><tr><td>UL 2T</td><td>UL-256QAM</td><td align="center">15</td><td align="center">31</td><td align="center">64</td><td align="center">81</td><td align="center">161</td></tr><tr><td>UL 2T</td><td>UL-64QAM</td><td align="center">12</td><td align="center">24</td><td align="center">51</td><td align="center">64</td><td align="center">125</td></tr><tr><td>UL 1T</td><td>UL-256QAM</td><td align="center">7</td><td align="center">16</td><td align="center">32</td><td align="center">40</td><td align="center">80</td></tr><tr><td>UL 1T</td><td>UL-64QAM</td><td align="center">6</td><td align="center">12</td><td align="center">25</td><td align="center">32</td><td align="center">62</td></tr></tbody></table>

<p align="center"><strong>10-slot · DSUUUUDSUU (25% DL / 72% UL): Mixed Use</strong></p>

<table><thead><tr><th width="95">MIMO Config</th><th width="120">Dir/Mod</th><th width="100" align="center">10MHz</th><th width="100" align="center">20MHz</th><th width="100" align="center">40MHz</th><th width="100" align="center">50MHz</th><th width="105" align="center">100MHz</th></tr></thead><tbody><tr><td>DL 4T</td><td>DL-256QAM</td><td align="center">55</td><td align="center">117</td><td align="center">243</td><td align="center">305</td><td align="center">609</td></tr><tr><td>DL 2T</td><td>DL-256QAM</td><td align="center">28</td><td align="center">60</td><td align="center">124</td><td align="center">156</td><td align="center">312</td></tr><tr><td>DL 1T</td><td>DL-256QAM</td><td align="center">14</td><td align="center">31</td><td align="center">64</td><td align="center">80</td><td align="center">160</td></tr><tr><td>UL 2T</td><td>UL-256QAM</td><td align="center">43</td><td align="center">91</td><td align="center">189</td><td align="center">237</td><td align="center">471</td></tr><tr><td>UL 2T</td><td>UL-64QAM</td><td align="center">34</td><td align="center">72</td><td align="center">149</td><td align="center">187</td><td align="center">365</td></tr><tr><td>UL 1T</td><td>UL-256QAM</td><td align="center">21</td><td align="center">46</td><td align="center">95</td><td align="center">119</td><td align="center">236</td></tr><tr><td>UL 1T</td><td>UL-64QAM</td><td align="center">17</td><td align="center">36</td><td align="center">74</td><td align="center">93</td><td align="center">183</td></tr></tbody></table>

<p align="center"><strong>10-slot · DDSUUUUUUU (20% DL / 77% UL): Heavy Uplink</strong></p>

<table><thead><tr><th width="95">MIMO Config</th><th>Dir/Mod</th><th width="100" align="center">10MHz</th><th width="100" align="center">20MHz</th><th width="100" align="center">40MHz</th><th width="100" align="center">50MHz</th><th width="105" align="center">100MHz</th></tr></thead><tbody><tr><td>DL 4T</td><td>DL-256QAM</td><td align="center">44</td><td align="center">92</td><td align="center">192</td><td align="center">241</td><td align="center">482</td></tr><tr><td>DL 2T</td><td>DL-256QAM</td><td align="center">22</td><td align="center">47</td><td align="center">98</td><td align="center">124</td><td align="center">247</td></tr><tr><td>DL 1T</td><td>DL-256QAM</td><td align="center">11</td><td align="center">24</td><td align="center">51</td><td align="center">63</td><td align="center">127</td></tr><tr><td>UL 2T</td><td>UL-256QAM</td><td align="center">49</td><td align="center">103</td><td align="center">215</td><td align="center">270</td><td align="center">536</td></tr><tr><td>UL 2T</td><td>UL-64QAM</td><td align="center">38</td><td align="center">81</td><td align="center">169</td><td align="center">212</td><td align="center">415</td></tr><tr><td>UL 1T</td><td>UL-256QAM</td><td align="center">24</td><td align="center">52</td><td align="center">107</td><td align="center">135</td><td align="center">268</td></tr><tr><td>UL 1T</td><td>UL-64QAM</td><td align="center">19</td><td align="center">41</td><td align="center">85</td><td align="center">106</td><td align="center">208</td></tr></tbody></table>

**Peak Expected Throughput (Mbps) · 5-Slot Patterns**

<p align="center"><strong>5-slot · DDDSU (74% DL / 23% UL): Heavy Downlink</strong></p>

<table><thead><tr><th width="95">MIMO Config</th><th>Dir/Mod</th><th width="100" align="center">10MHz</th><th width="100" align="center">20MHz</th><th width="100" align="center">40MHz</th><th width="100" align="right">50MHz</th><th width="105" align="right">100MHz</th></tr></thead><tbody><tr><td>DL 4T</td><td>DL-256QAM</td><td align="center">119</td><td align="center">253</td><td align="center">526</td><td align="right">660</td><td align="right">1319</td></tr><tr><td>DL 2T</td><td>DL-256QAM</td><td align="center">61</td><td align="center">130</td><td align="center">270</td><td align="right">338</td><td align="right">677</td></tr><tr><td>DL 1T</td><td>DL-256QAM</td><td align="center">31</td><td align="center">67</td><td align="center">138</td><td align="right">173</td><td align="right">347</td></tr><tr><td>UL 2T</td><td>UL-256QAM</td><td align="center">16</td><td align="center">33</td><td align="center">69</td><td align="right">86</td><td align="right">171</td></tr><tr><td>UL 2T</td><td>UL-64QAM</td><td align="center">12</td><td align="center">26</td><td align="center">54</td><td align="right">68</td><td align="right">150</td></tr><tr><td>UL 1T</td><td>UL-256QAM</td><td align="center">8</td><td align="center">17</td><td align="center">34</td><td align="right">43</td><td align="right">86</td></tr><tr><td>UL 1T</td><td>UL-64QAM</td><td align="center">6</td><td align="center">13</td><td align="center">27</td><td align="right">34</td><td align="right">66</td></tr></tbody></table>

<p align="center"><strong>5-slot · DDSUU (54% DL / 43% UL): Mixed Use</strong></p>

<table><thead><tr><th width="95">MIMO config</th><th>Dir/Mod</th><th width="100" align="center">10MHz</th><th width="100" align="center">20MHz</th><th width="100" align="center">40MHz</th><th width="100" align="center">50MHz</th><th width="105" align="center">100MHz</th></tr></thead><tbody><tr><td>DL 4T</td><td>DL-256QAM</td><td align="center">87</td><td align="center">185</td><td align="center">384</td><td align="center">482</td><td align="center">964</td></tr><tr><td>DL 2T</td><td>DL-256QAM</td><td align="center">45</td><td align="center">95</td><td align="center">197</td><td align="center">247</td><td align="center">495</td></tr><tr><td>DL 1T</td><td>DL-256QAM</td><td align="center">23</td><td align="center">49</td><td align="center">101</td><td align="center">127</td><td align="center">254</td></tr><tr><td>UL 2T</td><td>UL-256QAM</td><td align="center">29</td><td align="center">62</td><td align="center">129</td><td align="center">162</td><td align="center">321</td></tr><tr><td>UL 2T</td><td>UL-64QAM</td><td align="center">23</td><td align="center">49</td><td align="center">101</td><td align="center">127</td><td align="center">249</td></tr><tr><td>UL 1T</td><td>UL-256QAM</td><td align="center">15</td><td align="center">31</td><td align="center">64</td><td align="center">81</td><td align="center">161</td></tr><tr><td>UL 1T</td><td>UL-64QAM</td><td align="center">12</td><td align="center">24</td><td align="center">51</td><td align="center">64</td><td align="center">125</td></tr></tbody></table>

<p align="center"><strong>5-slot · DSUUU (34% DL / 63% UL): Heavy Uplink</strong></p>

<table><thead><tr><th width="95">MIMO Config</th><th>Dir/Mod</th><th width="100" align="center">10MHz</th><th width="100" align="center">20MHz</th><th width="100" align="center">40MHz</th><th width="100" align="right">50MHz</th><th width="105" align="right">100MHz</th></tr></thead><tbody><tr><td>DL 4T</td><td>DL-256QAM</td><td align="center">55</td><td align="center">117</td><td align="center">243</td><td align="right">305</td><td align="right">609</td></tr><tr><td>DL 2T</td><td>DL-256QAM</td><td align="center">28</td><td align="center">60</td><td align="center">124</td><td align="right">156</td><td align="right">312</td></tr><tr><td>DL 1T</td><td>DL-256QAM</td><td align="center">14</td><td align="center">31</td><td align="center">64</td><td align="right">80</td><td align="right">160</td></tr><tr><td>UL 2T</td><td>UL-256QAM</td><td align="center">43</td><td align="center">91</td><td align="center">189</td><td align="right">237</td><td align="right">471</td></tr><tr><td>UL 2T</td><td>UL-64QAM</td><td align="center">34</td><td align="center">72</td><td align="center">149</td><td align="right">187</td><td align="right">365</td></tr><tr><td>UL 1T</td><td>UL-256QAM</td><td align="center">21</td><td align="center">46</td><td align="center">95</td><td align="right">119</td><td align="right">236</td></tr><tr><td>UL 1T</td><td>UL-64QAM</td><td align="center">17</td><td align="center">36</td><td align="center">74</td><td align="right">93</td><td align="right">183</td></tr></tbody></table>

</details>

<details>

<summary><strong>Understand 5G MIMO, Modulation, and Channel Bandwidth</strong></summary>

**MIMO Configuration**

Higher-order MIMO can increase throughput and spectral efficiency when supported by the AP, client device, antenna configuration, and RF conditions.

| Configuration | Description                                    | Typical devices                                              |
| ------------- | ---------------------------------------------- | ------------------------------------------------------------ |
| DL 4T (4×4)   | Four simultaneous downlink streams from the AP | High-end devices, industrial CPEs with four receive antennas |
| DL 2T (2×2)   | Two simultaneous downlink streams from the AP  | Mid-range smartphones, most enterprise CPEs                  |
| DL 1T (1×1)   | One downlink stream from the AP                | Basic devices, coverage-edge scenarios                       |
| UL 2T (2×2)   | Two simultaneous uplink streams to the AP      | Most smartphones and standard devices                        |
| UL 1T (1×1)   | One uplink stream to the AP                    | Most smartphones and standard devices                        |

**Modulation**

Modulation determines how much data can be transmitted in each radio signal; higher modulation orders carry more bits per transmission but only work well with good signal quality.

| Modulation | Condition                                                |
| ---------- | -------------------------------------------------------- |
| 256-QAM    | Close range, strong signal, clear line of sight          |
| 64-QAM     | Moderate range or some obstruction: 75% of 256-QAM speed |

**Channel Bandwidth**

The channel-width values in the throughput tables represent the spectrum allocated to the deployment. Wider channel bandwidths generally provide greater throughput capacity when additional spectrum is available and supported.

</details>

<details>

<summary><strong>5G Capacity Design Considerations</strong></summary>

* Use measured throughput values as planning references.
* Select the slot pattern based on the dominant traffic direction.
* Consider wider channel bandwidths where additional spectrum is available.
* Validate RF quality before relying on higher-order MIMO or higher-order modulation.
* Design AP density around peak operational demand.
* Carefully evaluate uplink requirements for surveillance, telemetry, industrial automation, and sensor-heavy environments.
* Consider device capability when determining realistic throughput.
* Align the slot pattern, bandwidth, MIMO configuration, modulation, and RF design with the actual deployment requirements.

The resulting 5G capacity design should establish the capacity-driven cell count before coverage and architecture are finalized.

</details>

<details>

<summary><strong>Worked Example - Application Profile</strong></summary>

| Device            | Peak Concurrent | DL/Device | UL/Device | Class    |
| ----------------- | :-------------: | :-------: | :-------: | -------- |
| Handheld scanner  |        50       |  0.5 Mbps | 0.25 Mbps | Light    |
| IP camera (1080p) |        30       |    n/a    |   4 Mbps  | Heavy UL |
| Supervisor tablet |        10       |   5 Mbps  |   1 Mbps  | Moderate |

Handheld scanners generally transmit small bursts of data and receive work information.

IP cameras continuously transmit video to a recording or monitoring system, creating a significant uplink load.

Supervisor tablets receive dashboards and operational information and generate a smaller amount of uplink traffic.

</details>

<details>

<summary><strong>Worked Example - Total Throughput Demand</strong></summary>

Calculate the aggregate demand for each direction:

**Downlink**

```
Handheld scanners: 50 × 0.5 Mbps = 25 Mbps

IP cameras: 30 × 0 Mbps = 0 Mbps

Supervisor tablets: 10 × 5 Mbps = 50 Mbps

(50 × 0.5) + (30 × 0) + (10 × 5) = 25 + 0 + 50 = 75 Mbps DL
```

**Uplink**

```
Handheld scanners: 50 × 0.25 Mbps = 12.5 Mbps

IP cameras: 30 × 4 Mbps = 120 Mbps

Supervisor tablets: 10 × 1 Mbps = 10 Mbps

(50 × 0.25) + (30 × 4) + (10 × 1) = 12.5 + 120 + 10 = 142.5 Mbps UL
```

**Peak throughput requirement: 75 Mbps DL / 142.5 Mbps UL.**

The uplink requirement is approximately 1.9× the downlink requirement.

The cameras are the dominant uplink load, accounting for 120 of the 142.5 Mbps total UL requirement.

**Design Implication**

The deployment must be sized to satisfy the uplink requirement, because UL is the binding capacity constraint for this example.

</details>

<details>

<summary><strong>Worked Example - LTE Capacity Scenario</strong></summary>

**Scenario:** LTE (4G), CBRS (b48), Single Carrier, 40 MHz, Indoor (40 foot ceilings)

**DL:** 75 Mbps **UL:** 142.5 Mbps **Binding direction:** UL

Because this workload is strongly uplink-dominant, **SA6 (60% DL / 40% UL)** is selected.

The selected configuration provides 157 Mbps DL per cell and 72 Mbps UL per cell.

**Minimum cells · uplink (binding constraint)**

```
cell(142.5 Mbps UL demand ÷ 72 Mbps UL/cell) = 1.98 cells = 2 cells
```

**Minimum cells · downlink (check)**

```
cell(75 Mbps DL demand ÷ 157 Mbps DL/cell) = 0.47cell = 1 cell
```

**Required Cell Count: 2 cells**

The two-cell design delivers 314 Mbps DL capacity, 144 Mbps UL capacity, and 1.5 Mbps UL headroom.

</details>

<details>

<summary><strong>Worked Example - 5G Capacity Scenario</strong></summary>

**Scenario:** 5G · CBRS (n48) · Single carrier · 40 MHz · Indoor (40 ft ceilings).

**DL:** 75 Mbps **UL:** 142.5 Mbps **Binding direction:** UL

Because the workload is strongly uplink-dominant, the DDSUUUUUUU 10-slot pattern is selected.

For this example, use DL 4T / 256-QAM, UL 2T / 64-QAM, 40 MHz bandwidth, and the DDSUUUUUUU pattern.

**Minimum cells · uplink (binding constraint)**

```
cell(142.5 Mbps UL demand ÷ 169 Mbps ULcell) = cell(.84) = 1 cell
```

**Minimum cells · downlink (check)**

```
cell(75 DL demand ÷ 192 DL per cell) = ceil(0.39) = 1 cell
```

**Required Cell Count: 1 cell (uplink-bound)**

The resulting measured planning values are 192 Mbps DL per cell and 169 Mbps UL per cell.

**142.5 Mbps ÷ 169 Mbps = 0.84 cells → 1 cell**

**Required cell count = 1 cell**

The single-cell design provides 192 Mbps DL capacity, 169 Mbps UL capacity, and 26.5 Mbps UL headroom.

</details>

<details>

<summary><strong>LTE vs. 5G - Same 20 MHz Channel</strong></summary>

To isolate the pure LTE-vs-5G difference from the effect of CA, compare both technologies using the same device profile, site, and 20 MHz channel.

|                      | LTE (SA6)                | 5G (DDSUUUUUUU)             |
| -------------------- | ------------------------ | --------------------------- |
| TDD configuration    | SA6 (60% DL / 40% UL     | DDSUUUUUUU) 20% DL / 77% UL |
| Peak UL per cell     | 36 Mbps (UL 1T, 64-QAM)  | 103 Mbps (UL 2T, 256-QAM)   |
| Peak DL per cell     | 78 Mbps (DL 2T, 256-QAM) | 92 Mbps (DL 4T, 256-QAM)    |
| Capacity floor       | 4 cells                  | 2 cells                     |
| UL headroom at floor | 1.5 Mbps (tight)         | 63.5 Mbps (comfortable)     |
| Aggregate backhaul   | 456 Mbps                 | 390 Mbps                    |
| Backhaul requirement | 1 Gbps fiber             | 1 Gbps fiber                |

For this uplink-heavy workload, the 5G configuration provides substantially more uplink capacity per cell.

{% hint style="warning" %}
**IMPORTANT:** This comparison illustrates the effect of the selected radio configurations for this workload. It should not be interpreted as a universal LTE-versus-5G cell-count rule.
{% endhint %}

</details>

<details>

<summary><strong>Capacity Design Output</strong></summary>

At the end of Step 1, the capacity assessment should establish:

* Peak downlink requirement
* Peak uplink requirement
* Binding traffic direction
* Selected technology
* Applicable LTE SA or 5G slot pattern
* Applicable channel bandwidth
* Applicable MIMO and modulation assumptions
* Capacity-driven cell count
* Preliminary aggregate backhaul requirement

These outputs establish the capacity floor for the deployment.

The capacity-driven cell count should then be carried into *Step 2* [*Coverage*](/#coverage).

The final radio count is determined by the greater of the capacity requirement or coverage requirement.

</details>

#### Next Step

Next, proceed to *Step 2* [*Coverage*](/plan-your-network/coverage) to determine whether the physical site and propagation environment require additional radios. The final radio count is determined by the greater of the capacity-driven requirement and the coverage-driven requirement.


# Coverage

Coverage design answers a different question from capacity: "*How many radios are required to provide usable coverage across the physical site?*"

*Step 1* [*Capacity*](/plan-your-network/capacity) established the capacity-driven radio count. This step determines the coverage-driven radio count. Together, these establish the range that the architecture must accommodate.

The final radio count is determined by whichever requirement is greater:

```
Final radio count = max(capacity-driven count, coverage-driven count)
```

### Do this in the Calculator

{% stepper %}
{% step %}

## Set the Site and Coverage Parameters

In the **Site & Coverage** panel, set:

* **Deployment Type**: Indoor or Outdoor
* **Environment**
  * Indoor: Open Office/Showroom, Warehouse (Low Racks), Warehouse (Dense Racks)
  * Outdoor: Open Campus/Yard, Parking Lot/Loading Dock, Industrial Perimeter
* **Clutter Level** · (Independent of **Environment**) Low / Medium / High
* **UL Device Class**: Handset / External Antenna / CPE
* **Region**: US (CBRS) or UK/EU/AU
* **Total Site Area**: In sq ft, sq m, or acres

<p align="center"><strong>Figure: ROM Calculator: Site &#x26; Coverage Panel</strong></p>

<div data-with-frame="true"><figure><img src="https://2839344875-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcsOm7izkwc75UBmow1N0%2Fuploads%2F7qSZPDm9yupJXqYEP4qn%2Fimage.png?alt=media&#x26;token=e73deb14-b0f5-4cbb-beed-fdf43a924577" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}

## Review the Coverage Estimate

In the **Estimated APs** panel, review:

* **Coverage estimate**: Shows the number of APs required to provide coverage based on the selected site characteristics.
* **sq ft/AP**: Shows the effective coverage baseline and multipliers used by the calculator.

For example, the calculator may display a calculation such as:

```
25,000 × 1 (clutter) × 1.25 (auto) × 1 (stance)
```

This provides visibility into how the calculator arrived at the coverage estimate.

<div data-with-frame="true"><figure><img src="https://2839344875-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcsOm7izkwc75UBmow1N0%2Fuploads%2FqXEkMJnCKCKmaDzH2p7A%2Fimage.png?alt=media&#x26;token=7492ea25-1b1d-44dc-bfc6-aa3d629ee3e8" alt=""><figcaption></figcaption></figure></div>

{% hint style="info" %}
**NOTE**: In case of segmented sites, the calculator evaluates one Environment / Clutter combination per run. It does not automatically segment a mixed site into different coverage zones. If a site contains a warehouse floor, office area, loading dock, and outdoor yard, evaluate each zone separately and combine the resulting requirements.
{% endhint %}

{% hint style="warning" %}
**IMPORTANT:** Do not treat the entire site as a single coverage zone when different areas have significantly different propagation characteristics, mounting conditions, or operational requirements.
{% endhint %}
{% endstep %}
{% endstepper %}

### Understanding the Methodology

#### Gathering Coverage Requirements

Before estimating the radio count, capture the physical and operational characteristics of the site.

* **Total area**: Record the total site area and separate indoor and outdoor areas where appropriate.
* **Site segmentation**: Identify areas that require separate coverage treatment, such as warehouse floors, mezzanines, loading docks, offices, yards, and outdoor operational areas.
* **Indoor/outdoor mix**: Identify the proportion of indoor and outdoor coverage and any transition areas between them.
* **Terrain and clutter**: Document conditions that can affect propagation, including open floor areas, racks, machinery, containers, walls, terrain changes, and building-to-building distances.
* **Ceiling and mounting height**: Record AP mounting heights and identify significant variations across the site.
* **Mobility profile**: Identify how devices move through the coverage area: Stationary devices, pedestrians, forklifts, AGVs, vehicles, or other mobile devices.
* **Coverage requirements**: Identify where service is required and the performance expected in each area.

{% hint style="warning" %}
**Common mistake to avoid**: Do not treat the entire site as a single coverage zone. A warehouse floor, loading dock, office area, and outdoor yard may have very different propagation characteristics, mounting heights, obstructions, device densities, mobility patterns, coverage requirements. Segment the site first, then estimate coverage for each zone.
{% endhint %}

<details>

<summary><strong>Coverage Rules of Thumb</strong></summary>

The following values provide initial planning estimates for radio count. They are not substitutes for an RF design. Actual radio count depends on frequency, antenna configuration, mounting height, propagation environment, required signal level, interference, mobility, and application requirements.

**Indoor Coverage Estimates**

<table><thead><tr><th>Clutter</th><th>Example</th><th width="134">Avg. Height</th><th>Coverage per AP</th><th>AP Density</th></tr></thead><tbody><tr><td>Low</td><td>Open office space, minimal walls, mostly LOS</td><td>125 ft</td><td>~25,000 sq ft</td><td>4 APs</td></tr><tr><td>Medium</td><td>Open warehouse spaces with low to medium shelves, miscellaneous layout, some partitions</td><td>80 ft</td><td>~20,000 sq ft</td><td>5–6 APs</td></tr><tr><td>High</td><td>Manufacturing floor / Warehouse with dense walls, high metal racks, cold storage, heavy machinery</td><td>50 ft</td><td>~7,000 sq ft</td><td>13–15 APs</td></tr></tbody></table>

**Outdoor Coverage and Capacity Estimates (Omni Antennas)**

| Design Intent     | Area              | Radius   | AP Count  | Notes                                                                                                             |
| ----------------- | ----------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------------------- |
| Coverage-Oriented | \~1,000,000 sq ft | \~800 ft | \~1 AP    | Assumes 47 dBm EIRP, wide-area mobility. Corresponds to "Open Campus / Yard" in the table below.                  |
| Capacity-Oriented | \~300,000 sq ft   | \~440 ft | \~3–4 APs | Higher device density, uplink-heavy applications. Corresponds to "Parking Lot / Loading Dock" in the table below. |

**Outdoor Range by Directional Antennas (33°–120° Beamwidth)**

| Device Class        | Range           | Conditions                                                            |
| ------------------- | --------------- | --------------------------------------------------------------------- |
| Smartphones/Tablets | 2,500–5,000 ft  | Standard beamwidth, Line of Sight (LOS) or near-LOS, RSRP to -110 dBm |
| CPE with High-Gain  | Up to 12,000 ft | Specialized antennas, optimal alignment, high-SINR, LOS required      |

**Outdoor Coverage Estimates by Environment**

| Environment                |   Height |     Radius | Area                          |
| -------------------------- | -------: | ---------: | ----------------------------- |
| Open Campus / Yard         | 20–30 ft | 700–800 ft | \~1,000,000 sq ft (coverage)  |
| Parking Lot / Loading Dock | 12–20 ft | 400–500 ft | \~300,000 sq ft (capacity)    |
| Industrial Perimeter       | 25–35 ft | 500–750 ft | 400,000–800,000 sq ft (mixed) |

**Outdoor Coverage Considerations**

The estimates above assume omnidirectional external antennas unless otherwise specified.

When planning outdoor coverage:

* Set AP spacing according to the actual coverage and capacity objectives.
* Account for buildings, foliage, machinery, vehicles, containers, and other RF obstructions.
* Consider directional antennas where range, uplink performance, or interference control is a priority.
* Consider the frequency band and applicable regional regulatory requirements when estimating achievable coverage.
* Validate outdoor propagation before finalizing AP and antenna placement.
* Consider uplink performance as well as downlink coverage, particularly for surveillance, telemetry, and industrial applications.

</details>

#### How the Calculator Estimates Coverage

The ROM Calculator starts with a baseline area per AP and applies multipliers based on the deployment characteristics.

The coverage formula used by the calculator:

```
APs_cov = ⌈ Area ÷ (Base × Clutter × Auto × Stance) × (1 + Buffer) ⌉
```

Where:

* **Base** = 25,000 / 17,500 / 10,000 sq ft/AP indoors (Coverage / Balanced / Capacity-oriented design intent: auto-derived, scored from Density + DL/UL throughput + Use Case, no manual goal needed), or an outdoor environment baseline × the same intent factor (1.0 / 0.70 / 0.45).
* **Clutter** = Low 1.0× · Medium 0.8× · High 0.6×.
* **Auto** = `min(DLscale, ULcap)`, where DLscale reflects your Channel BW (US) or AP Power Class (EMEA), and ULcap depends on UL Device Class (Handset 1.1× · Ext. Antenna 1.25× · CPE 1.5×).

  <table><thead><tr><th width="150">Region</th><th>Formula</th></tr></thead><tbody><tr><td>US (5G)</td><td><code>DLscale = 10^(10·log10(BW/20)/10)</code> ,<br>20 MHz=1.0×, 40 MHz=2.0×, 100 MHz=5.0×</td></tr><tr><td>EMEA (5G)</td><td><code>ΔP = 10·log10(P/5W)</code>; <code>DLscale = 10^(ΔP/10)</code>: e.g. 40 W ≈ +9 dB</td></tr></tbody></table>
* **Stance** = Your Planning Stance multiplier (Conservative / Prudent / Opportunistic, set in the **Planning Parameters** panel, see [*What to Bring*](/#what-to-bring)).

#### Next Step

Next, proceed to *Step 3* [*Architecture*](/plan-your-network/architecture) to determine how the capacity-driven and coverage-driven radio counts come together into a deployable Onyx network. Architecture resolves where you land between the capacity floor established in *Step 1* [*Capacity*](/plan-your-network/capacity) and the coverage ceiling established here: determining the Shared Cell or Multi-Cell configuration, fronthaul topology, Onyx Edge server requirements, switching, and backhaul needed to support the final radio count.


# Architecture

Architecture design converts the capacity and coverage requirements into a deployable Onyx network. It determines how the required cells and radios are organized, connected, and deployed across the site.

Capacity determines how many cells are required. Coverage determines how many radios are required. Architecture determines how those cells and radios are organized and connected.

The architecture should answer:

* How many radios and cells are required?
* Which Onyx architecture best fits the deployment?
* How should the radios be connected?
* What fronthaul architecture is required?
* How many Onyx Edge servers are required?
* What switching is required?
* What backhaul is required?
* What redundancy or availability requirements apply?
* What architecture-specific RF and installation components are required?

### Do this in the Calculator

{% stepper %}
{% step %}

## Review the Architecture Recommendations

Once Capacity and Coverage inputs are set, review the following cards:

* **Architecture Recommendation**: e.g., "5G Multi-Cell (Standard)" or "Shared Cell 1×8," with a short rationale and specs (MIMO, bandwidth, handover behavior).

<div data-with-frame="true"><figure><img src="https://2839344875-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcsOm7izkwc75UBmow1N0%2Fuploads%2F3um6rOKLjfg4Vh3Oh3cX%2Fimage.png?alt=media&#x26;token=878acf0f-9eb6-410f-83c6-4a6ddf645011" alt=""><figcaption></figcaption></figure></div>

* **Frame Structure Recommendation** (LTE SA / 5G slot pattern): Your recommended pattern, starred (\*), alongside the alternatives and their DL:UL ratio and Mbps, so you can see why one was preferred.

<div data-with-frame="true"><figure><img src="https://2839344875-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcsOm7izkwc75UBmow1N0%2Fuploads%2FjTkXAFTJ84gtBoj5EF45%2Fimage.png?alt=media&#x26;token=eb0a247e-95fe-4912-8820-697aba2ab2b9" alt=""><figcaption></figcaption></figure></div>

* **Shared Cell Configuration Guide**: RUs/cell, resulting cell count, and handoffs for 1×8, 2×4, and 4×2 configurations. This table only appears when Shared Cell itself is the recommended architecture, not when Multi-Cell is recommended and Shared Cell is offered only as an alternative.

<div data-with-frame="true"><figure><img src="https://2839344875-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcsOm7izkwc75UBmow1N0%2Fuploads%2FfDef8r3SbgA2LXGO8GKI%2Fimage.png?alt=media&#x26;token=e0dea429-2739-431a-84ca-06999babb7bc" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}

## Explore Alternatives

**Explore Alternatives is genuinely contextual, not a fixed list.** The suggestions in the sidebar change based on your current inputs: e.g., "Add continuous mobility" only appears for use cases like AGVs; "Switch to 5G NR" only appears while LTE is selected; "What if clutter is higher?" appears once other high-impact levers have already been tried.

Use it to pressure-test a design before committing to it.
{% endstep %}
{% endstepper %}

### Architecture Options

Every Onyx 5G cell takes one of three shapes. The choice is about **where the gNB functions live**, and it is the decision that most affects the bill of materials.

It is a choice **per cell, not per site**, so one Onyx Edge can carry all three at once. See *One network, mixed architectures* below.

{% hint style="info" %}
**The three architectures are 5G. On LTE there is one, and it is Integrated.** Every Onyx LTE access point is a complete eNodeB carrying the RAN stack onboard, reached over ordinary IP backhaul. There is no LTE Radio Unit, no LTE fronthaul and no FHM, so Distributed and Super Cell are 5G capabilities. An LTE site scales by adding access points, each one its own cell, with handover between them.
{% endhint %}

|                      | [Integrated](/plan-your-network/architecture/integrated)                               | [Distributed](/plan-your-network/architecture/distributed)    | [Super Cell](/plan-your-network/architecture/super-cell) |
| -------------------- | -------------------------------------------------------------------------------------- | ------------------------------------------------------------- | -------------------------------------------------------- |
| **CU / DU**          | in the AP                                                                              | on Onyx Edge                                                  | on Onyx Edge                                             |
| **Onyx Edge role**   | Core only                                                                              | Core + CU + DU                                                | Core + CU + DU                                           |
| **FHM**              | no                                                                                     | no                                                            | **required**                                             |
| **Transport to AP**  | backhaul, ordinary IP                                                                  | eCPRI fronthaul                                               | eCPRI fronthaul                                          |
| **What you cable**   | one CAT6 run to each AP, carrying PoE++ power on indoor models, or a wireless mesh hop | **fiber to every radio**, plus power at the radio position    | same as Distributed                                      |
| **Cells**            | one per AP                                                                             | one per RU                                                    | **one across up to 64 RUs**                              |
| **Handover on site** | yes                                                                                    | yes                                                           | **none**                                                 |
| **Access points**    | `5g-gnb` family: G227, G228, G238, G243, G244, G430, G443                              | `5g-access-points` family: G105, G505, G506, G509             | same as Distributed                                      |
| **Best for**         | small sites, fast pilots, and anywhere fiber to the radio is impractical               | wider band choice, radios sited away from baseband, DAS feeds | continuous mobility across one large space               |

{% hint style="warning" %}
**Super Cell is Distributed with an FHM added.** Same RUs, same CU and DU on Onyx Edge. The FHM makes several RUs share one cell ID. Without it, each RU is its own cell and devices hand over between them.
{% endhint %}

{% hint style="info" %}
**"eCPRI fronthaul" means fiber in practice, and that is the difference that shows up in the installation quote.** eCPRI is carried over Ethernet, so a short 10G copper run does work, between an RU and a switch in the same rack for example. Past that it is fiber. Every Onyx RU takes fronthaul on a 10G SFP+ cage and ships with single-mode long-range optics, and the link also carries PTP and SyncE timing on a latency budget measured in microseconds. That budget, not the connector, is what rules out a long copper run.

An integrated gNB AP has no such constraint. Its backhaul is ordinary IP on a latency budget measured in milliseconds, so it runs over existing CAT6, through existing switches, and across a wireless mesh hop. An indoor model such as the G227 takes backhaul and PoE++ power on that one cable.

So the practical question is whether you can get fiber to every radio position. Where you can, Distributed and Super Cell are open to you. Where you cannot, Integrated is what will actually deploy.
{% endhint %}

{% content-ref url="/pages/QyiptWj4pYGC7z43lArJ" %}
[Integrated](/plan-your-network/architecture/integrated)
{% endcontent-ref %}

{% content-ref url="/pages/iNgFIkqhyPpuBkKnZeZP" %}
[Distributed](/plan-your-network/architecture/distributed)
{% endcontent-ref %}

{% content-ref url="/pages/z8ELpXy3wWG1SOe1gCVu" %}
[Super Cell](/plan-your-network/architecture/super-cell)
{% endcontent-ref %}

### One network, mixed architectures

The three modes are not mutually exclusive. Every cell terminates on the same 5G Core inside Onyx Edge, so a single site can run all three side by side.

<figure><img src="https://2839344875-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcsOm7izkwc75UBmow1N0%2Fuploads%2FQE2TOd9J9aF58sLeQdil%2Farch-mixed.svg?alt=media" alt="One network carrying all three architectures: an integrated gNB AP, a directly attached RU, and an FHM-based Super Cell, all terminating on the same 5G Core in Onyx Edge."><figcaption><p>All three on one Onyx Edge. Every cell lands on the same Core, so one SIM works across all of them.</p></figcaption></figure>

An integrated gNB AP brings its own CU and DU and attaches to the Core. RU-based cells use the CU and DU inside the same Onyx Edge. Because every cell lands on the same Core, they share one subscriber database, one QoS policy set and one Onyx Portal, and a single SIM works across all of them.

In practice that means a warehouse can run a Super Cell over the pick faces where AGVs and scanners move continuously, a single integrated AP at the gatehouse, and a directly attached RU on the yard mast, all on one network. Within the Super Cell there is no handover at all; moving between cells is an ordinary inter-cell handover.

### RF distribution and transport

These describe how RF reaches the coverage area and how the AP is connected, not where the gNB functions run. They are a separate choice rather than an alternative to the three modes, and most of them work with any of the three.

|                              | Integrated | Distributed | Super Cell | Attaches at                                                       |
| ---------------------------- | :--------: | :---------: | :--------: | ----------------------------------------------------------------- |
| **DAS**                      |     yes    |     yes     |     yes    | the RF output of the AP or RU                                     |
| **Mesh** · backhaul link     |     yes    |     yes     |     yes    | rides any cell, because the link is ordinary 3GPP 5G              |
| **Mesh** · the node's own AP |     yes    |      no     |     no     | the AP inside a Mesh Node is an integrated gNB (G228, G244)       |
| **Sectorized outdoor**       |     yes    |     yes     |     yes    | antenna choice on any outdoor unit                                |
| **Multi-Port Attach**        |     no     |     yes     |     yes    | splits one 4×4 RU into two 2×2 sectors, still one RU and one cell |

{% hint style="info" %}
**A mesh link has two ends, and they have different rules.** The *backhaul* side is a 3GPP 5G connection, so it can ride whatever cell covers that spot, integrated or O-RAN. The *access* side, the AP inside the Mesh Node that serves local devices, must be an integrated gNB, because all it receives is IP backhaul over the mesh hop. An O-RAN RU cannot sit there: it needs eCPRI fronthaul with PTP and SyncE timing over fiber, which a wireless hop does not carry.
{% endhint %}

* **DAS**: Distributes RF across floors, areas, or complex building structures. Onyx supports both passive and active DAS with 1, 2, or 4-port MIMO distribution, and both RF and O-RAN DAS interfaces. Useful where public and private networks share infrastructure in a large venue.
* **Mesh**: Mesh Nodes provide wireless backhaul where Ethernet or fiber is impractical: temporary sites, outdoor yards, areas that cannot be cabled. Evaluate against throughput, latency, and reliability before selecting. Select APs act as the gateway node; on 5G this is supported on the G228 and G244.
* **Sectorized outdoor**: Sector antennas give directional coverage to improve range, manage interference, or concentrate capacity where devices actually are.
* **Multi-Port Attach**: Partitions one 4×4 RU into two independent 2×2 sectors, each driving its own directional antenna at a separate area. The RU still presents as one RU on one NR Cell, so it occupies a single RU slot on an FHM. It is an RU feature, so it does not apply to integrated gNB APs. Trades per-sector downlink throughput for coverage reach. See [5G AP Deployment Modes](https://docs.gxc.io/docs/application-notes/5g-ap-deployment-modes).

{% hint style="info" %}
**What the calculator doesn't model:** Multi-floor DAS designs, and whether Mesh is the right call for a specific backhaul-limited zone. These still need the manual guidance below.
{% endhint %}

### TDD Frame Direction

LTE and 5G TDD configurations allocate radio resources between downlink and uplink traffic. The appropriate configuration depends on the dominant traffic direction established during capacity planning.

| Use case                             | Calculator's stated rule | Actual output (5G, default inputs) | Matches stated rule? |
| ------------------------------------ | ------------------------ | ---------------------------------- | -------------------- |
| Video Surveillance & Broadcast       | UL-dominant → 2D1S7U     | **2D1S7U** (38:100, UL-Dominant)   | Yes                  |
| Machine Vision & Real-time Control   | UL-dominant → DSUUU      | **DSUUU** (24:44, UL-Leaning)      | Yes (directionally)  |
| Logistics, AGVs & Automated Vehicles | DL-dominant → DDDSU      | **DDDSU** (52:16, DL-Leaning)      | Yes                  |
| AR/VR & High-bandwidth Immersive     | DL-dominant → DDDSU      | **DDDSU** (52:16, DL-Leaning)      | Yes                  |
| IoT, Telemetry & Sensors             | "Balanced" → DDDSU       | **DSUUU** (24:44, UL-Leaning)      | **No**               |
| General Enterprise / Voice & Data    | "Balanced" → DDDSU       | **DDDSU** (52:16, DL-Leaning)      | Yes                  |

### Indoor Architecture Considerations

For indoor deployments:

* Use Shared Cell or DAS architectures where consistent signal distribution is required across multiple areas.
* Consider distributed antenna layouts for large open environments with high user mobility.
* Use appropriate Shared Cell configurations for high-density user or device environments.
* Use DAS where multi-floor facilities or complex building layouts make conventional AP placement impractical.
* Optimize AP placement to reduce dead zones and improve mobility and roaming behavior.
* Account for racks, machinery, walls, mezzanines, and other RF obstructions.
* Validate coverage and capacity across operational areas rather than only along building perimeters.

### Outdoor Architecture Considerations

For outdoor deployments:

* Use Mesh-enabled APs where wired infrastructure is limited or unavailable.
* Use sector antennas where directional coverage, range, capacity, or interference control is required.
* Design around physical obstructions such as vehicles, containers, machinery, buildings, and terrain.
* Account for mobility patterns across campuses, logistics yards, ports, and industrial sites.
* Validate RF propagation across all required operational areas.
* Consider uplink performance as well as downlink coverage when positioning outdoor APs and antennas.
* Evaluate wireless backhaul capacity and latency when using Mesh.

#### Architecture Design Output

At the end of this step, you should have established:

* Required cell count
* Required AP/RU count
* Selected architecture
* Shared Cell configuration, where applicable
* Fronthaul topology
* Onyx Edge requirements
* Switching requirements
* Backhaul requirements
* Mobility and handover considerations
* Redundancy and availability requirements
* Architecture-specific RF components

This defines how the capacity and coverage requirements will be implemented as a physical and logical Onyx network.

#### Next Step

Next, proceed to *Step 4* [*Accessories*](/plan-your-network/accessories) to identify the equipment, RF components, installation hardware, and other items required to build the preliminary BoM.


# Integrated

An integrated deployment puts the whole gNB inside the access point. The AP performs the Central Unit, Distributed Unit and Radio Unit functions itself, and connects to Onyx Edge over ordinary backhaul. Onyx Edge provides the 5G Core.

This is the simplest Onyx architecture. There is no fronthaul, no Fronthaul Multiplexer, and no timing distribution to design.

## What it looks like

<figure><img src="https://2839344875-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcsOm7izkwc75UBmow1N0%2Fuploads%2FHFmm5Dv9CLLC3sNw1Ens%2Farch-integrated.svg?alt=media" alt="Integrated architecture: the gNB AP performs CU, DU and RU, connecting to Onyx Edge over ordinary backhaul. Each AP is its own cell."><figcaption><p>The AP is the whole gNB. Onyx Edge provides the Core, and each AP is its own cell.</p></figcaption></figure>

Each AP is a complete base station and its own cell. A device moving between two APs performs a normal inter-cell handover.

## Access points

Every model in the `5g-gnb` hardware family is an integrated base station. Their specification sheets describe them as *integrated base station (gNB)*, and their network port is labeled **Backhaul**, not Fronthaul, which is the quickest way to tell the two families apart.

| Model            | Placement | MIMO | Power per port | Bands               |
| ---------------- | --------- | ---- | -------------- | ------------------- |
| **G227**         | Indoor    | 2T2R | 250 mW         | n48, n78            |
| **G430**         | Indoor    | 4T4R | 250 mW         | n48, n78            |
| **G228**         | Outdoor   | 2T2R | 250 mW         | n48, n77, n78       |
| **G238-n78H-DC** | Outdoor   | 2T2R | 3 W            | n78 (3600–3800 MHz) |
| **G243-n48**     | Outdoor   | 2T2R | 5 W            | n48                 |
| **G243-n78H-AC** | Outdoor   | 2T2R | 10 W           | n78 (3600–3800 MHz) |
| **G244-n48**     | Outdoor   | 2T2R | 5 W            | n48                 |
| **G443**         | Outdoor   | 4T4R | 5 W            | n48, n78            |

For full specifications see [Onyx Hardware](https://docs.gxc.io/hw/onyx-hardware/gxc-5g-and-lte-hardware).

{% hint style="info" %}
**NOTE**: Select outdoor models also act as Mesh APs, serving as gateway nodes for Mesh Node wireless backhaul. This is currently supported on the G228 and the G244.
{% endhint %}

{% hint style="info" %}
**These are a per-cell choice, not a per-site one.** An integrated AP can sit on the same network as RU-based cells. It brings its own CU and DU and attaches to the Core on Onyx Edge, so a site can run an integrated AP in one area and a Distributed or Super Cell deployment in another.
{% endhint %}

{% hint style="info" %}
**LTE works this way too, and only this way.** The models above are the 5G gNB family. Every Onyx LTE access point is also a complete base station with the RAN stack onboard: the G100 and G101, the G229 and G249, and the G501. Because GXC builds no LTE Radio Unit and no LTE fronthaul, Integrated is the only shape an LTE cell takes.
{% endhint %}

## Choose this when

* The site needs a small number of APs, and each one can cover its area on its own.
* Cell boundaries fall somewhere devices do not routinely cross while holding a session, so handover is acceptable.
* Cabling is constrained. Backhaul is ordinary IP transport, so it is far more forgiving than fronthaul on distance, media and timing.
* You want the shortest path to a working network, or a pilot that will grow later.

## Choose something else when

* Devices move continuously across the coverage area and cannot tolerate a handover gap. AGVs, live video contribution and full-duplex intercom all fail here. Use [Super Cell](/plan-your-network/architecture/super-cell) instead.
* Many radios must serve one large space as a single cell.
* You need the RF flexibility of separating the radio from the baseband, for example feeding a DAS head end.

## What it costs

|                  |                                                                          |
| ---------------- | ------------------------------------------------------------------------ |
| **Hardware**     | Integrated gNB APs · Onyx Edge (Core)                                    |
| **Not required** | FHM, fronthaul fiber, PTP/SyncE timing distribution                      |
| **Transport**    | Standard IP backhaul to each AP, over CAT6, fiber or a wireless mesh hop |

Because there is no FHM and no fronthaul, this is the lowest-cost and lowest-complexity option per site, and the easiest to extend one AP at a time.

## Design considerations

**Plan for handover at the boundaries.** Each AP is its own cell. Work out where cell edges land relative to how people and machines actually move, and confirm any latency-sensitive workload can absorb the interruption.

**Capacity is per AP.** There is no pooling across APs. Size each one against the devices in its own coverage area.

**Backhaul is not fronthaul.** The AP needs enough backhaul for its user traffic, but none of the latency and timing discipline that eCPRI fronthaul demands.

***

## Related

* [Distributed](/plan-your-network/architecture/distributed): separating the radio from the baseband
* [Super Cell](/plan-your-network/architecture/super-cell): many radios behaving as one cell
* [5G Onyx Architecture Solution Brief](https://docs.gxc.io/docs/solution-briefs/5g-onyx-architecture-solution-brief)


# Distributed

A distributed deployment splits the gNB. The Central Unit and Distributed Unit run on Onyx Edge; the access point contains only the Radio Unit. The two connect over eCPRI fronthaul using the O-RAN 7.2x functional split.

Onyx Edge therefore hosts the 5G Core, the CU and the DU together in one appliance, with the radios pushed out to where coverage is needed.

## What it looks like

<figure><img src="https://2839344875-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcsOm7izkwc75UBmow1N0%2Fuploads%2FiLnn0eosK3hZanuHEK1T%2Farch-distributed.svg?alt=media" alt="Distributed architecture: CU and DU run on Onyx Edge, the AP contains only the RU, connected over eCPRI fronthaul."><figcaption><p>CU and DU on Onyx Edge, RU in the AP, joined by eCPRI fronthaul. Each RU is still its own cell.</p></figcaption></figure>

Each RU is still its own cell. A device crossing between two RUs performs a handover, exactly as in an integrated deployment. Removing that handover is what [Super Cell](/plan-your-network/architecture/super-cell) adds, by putting an FHM in this same path.

## Radio units

Every model in the `5g-access-points` hardware family is an O-RAN RU. Their specification sheets describe them as *O-RAN compliant Access Point*, Option 7-2a Category A, and their network port is labeled **Fronthaul**.

| Model        | Placement | MIMO | Bands                 |
| ------------ | --------- | ---- | --------------------- |
| **G105**     | Indoor    | 4T4R | n48, n78 (n77 future) |
| **G505**     | Outdoor   | 4T4R | n48, n78              |
| **G506**     | Outdoor   | 4T4R | n77, n78              |
| **G509-n26** | Outdoor   | 2T2R | n26 (FDD)             |
| **G509-n28** | Outdoor   | 2T2R | n28 (FDD)             |
| **G509-n41** | Outdoor   | 4T4R | n41                   |
| **G509-n79** | Outdoor   | 4T4R | n79                   |

The G509 family is the route to bands outside mid-band TDD. n26 and n28 are FDD and sub-GHz, so they propagate considerably further at correspondingly narrower channel bandwidths. See [Private 5G Spectrum](/private-5g-spectrum).

{% hint style="info" %}
**These are a per-cell choice, not a per-site one.** Distributed cells can share a network with integrated gNB APs. The RUs use the CU and DU on Onyx Edge; an integrated AP brings its own and attaches to the same Core. Both appear in the same Onyx Portal.
{% endhint %}

## Choose this when

* You need a band the integrated gNB family does not cover, particularly n26, n28, n41 or n79.
* Radios must sit where baseband cannot, for example distributed around a plant while the Edge stays in a comms room.
* The deployment will grow into [Super Cell](/plan-your-network/architecture/super-cell). Distributed is the foundation it builds on, so starting here avoids replacing hardware later.
* You are feeding a DAS head end, which takes RF from the radio layer.

## Choose something else when

* One or two APs would cover the site and cabling is awkward. Fronthaul is stricter than backhaul, so [Integrated](/plan-your-network/architecture/integrated) is simpler.
* Devices cross RU boundaries mid-session. Distributed alone still hands over; add an FHM and use [Super Cell](/plan-your-network/architecture/super-cell).

## What it costs

|               |                                                                                               |
| ------------- | --------------------------------------------------------------------------------------------- |
| **Hardware**  | Onyx RUs · Onyx Edge (Core + CU + DU)                                                         |
| **Transport** | eCPRI fronthaul, 10 Gbps SFP+ per RU. Fiber in practice: copper reaches only as far as a rack |
| **Timing**    | IEEE 1588v2 PTP and SyncE across the fronthaul                                                |

Fronthaul is the real constraint. It carries far more than user traffic and is sensitive to latency and timing, so it dictates cable type, distance and switching in a way ordinary backhaul does not.

## Design considerations

**Fronthaul sets where radios can go.** Plan cable routes before finalizing radio positions, not after. This is the most common source of late redesign.

**Timing is part of the design.** PTP and SyncE must reach every RU. TDD depends on frame alignment, and a radio that loses timing does not serve traffic.

**Boundaries still exist.** Splitting the gNB does not remove handover. Each RU remains its own cell until an FHM combines them.

**One Edge, many radios.** CU and DU are centralized, so capacity and policy are managed in one place rather than per AP.

***

## Related

* [Super Cell](/plan-your-network/architecture/super-cell): add an FHM and this becomes one logical cell
* [Integrated](/plan-your-network/architecture/integrated): when the AP can be the whole gNB
* [5G Onyx Architecture Solution Brief](https://docs.gxc.io/docs/solution-briefs/5g-onyx-architecture-solution-brief)


# Super Cell

A Super Cell deployment places a Fronthaul Multiplexer between Onyx Edge and the radio units, so that many RUs broadcast as **one logical cell** under a single DU.

{% hint style="warning" %}
**Super Cell is** [**Distributed**](/plan-your-network/architecture/distributed) **with an FHM added.** Same RUs, same CU and DU on Onyx Edge. The FHM makes several RUs share one cell ID. Without it, each RU is its own cell and devices hand over between them.
{% endhint %}

## What it looks like

<figure><img src="https://2839344875-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcsOm7izkwc75UBmow1N0%2Fuploads%2FN5vq6JhPcbe08E8Awjl6%2Farch-super-cell.svg?alt=media" alt="Super Cell architecture: an FHM makes many RUs broadcast as one logical cell, so devices never cross a cell boundary."><figcaption><p>An FHM makes many RUs broadcast as one cell. Devices move across the whole area without a handover.</p></figcaption></figure>

Because every RU broadcasts the same cell, a device moving across the whole coverage area never crosses a cell boundary. There is no handover to perform, and therefore no handover gap.

## Why this matters

Handover is the failure mode behind most problems in mobile industrial workloads. An AGV that loses its supervisory link stops. A camera feed drops frames. A full-duplex intercom path breaks. Super Cell removes the failure mode rather than tuning around it, because there is no boundary to cross.

## Scale

|             |                                                  |
| ----------- | ------------------------------------------------ |
| RUs per FHM | up to **8**                                      |
| Cascaded    | a primary FHM feeding up to **8 secondary FHMs** |
| Maximum     | **64 RUs** operating as a single Shared Cell     |

An RU running Multi-Port Attach still counts as **one** RU against these limits. It presents two 2×2 sectors on one NR Cell, not two RUs, so it occupies a single FHM slot.

## Configuration

Within one FHM group, RUs can be grouped into cells to trade mobility against capacity:

| Config  | RUs per cell | Cells | Handoffs | Best for                            |
| ------- | -----------: | ----: | -------: | ----------------------------------- |
| **1×8** |            8 |     1 |        0 | Maximum mobility and coverage       |
| **2×4** |            4 |     2 |        1 | Balanced capacity and mobility      |
| **4×2** |            2 |     4 |       ≤3 | Maximum density, high-traffic areas |

Reconfiguring between these is software-only in Onyx Orchestrator. No hardware change and no redeployment. Start at 1×8 and move toward 4×2 as device density grows.

{% hint style="info" %}
**These are a per-cell choice, not a per-site one.** A Super Cell can share a network with the other two. The FHM group forms one cell; an integrated AP or a directly attached RU elsewhere on the site forms another. All of them terminate on the same Core, so one SIM works across the lot.
{% endhint %}

## Choose this when

* Devices move continuously and cannot tolerate a connection gap: AGVs and AMRs, live video contribution, wireless intercom, mobile robotics.
* One large space needs uniform coverage from several radios: a warehouse, a factory floor, an airport pier, an outside broadcast compound.
* The RF environment changes as inventory or structures move, making stable cell planning difficult.
* Dense RU deployment would otherwise create inter-cell interference. Sharing one cell removes it.

## Choose something else when

* The site needs only one or two radios. The FHM has nothing to aggregate. Use [Integrated](/plan-your-network/architecture/integrated).
* Coverage areas are genuinely separate, with no one moving between them mid-session. Separate cells are simpler and give more aggregate capacity.
* Peak capacity in one small area matters more than mobility. More cells means more total capacity, so multi-cell may serve better.

## What it costs

|               |                                                                                          |
| ------------- | ---------------------------------------------------------------------------------------- |
| **Hardware**  | Onyx RUs · **FHM** (primary, plus secondaries if cascading) · Onyx Edge (Core + CU + DU) |
| **Transport** | eCPRI fronthaul, RU to FHM and FHM to Edge                                               |
| **Timing**    | IEEE 1588v2 PTP and SyncE, distributed through the FHM                                   |

The FHM is the addition over [Distributed](/plan-your-network/architecture/distributed). It aggregates fronthaul from the RUs and holds the timing that keeps them coherent as one cell.

## Design considerations

**Capacity is shared, not multiplied.** Eight RUs in one cell extend coverage; they do not give eight times the capacity. The cell's capacity is divided across everything attached to it. Where density matters more than mobility, use more cells.

**Plan RU placement for the workload, not for even coverage.** For uplink-heavy workflows, radios belong where the devices transmit from, not spaced evenly.

**The FHM is in the fronthaul path.** It needs rack space, power and fronthaul to both the Edge and every RU it serves.

**Start at 1×8.** Mobility is the reason to choose Super Cell. Split into more cells only when measured density requires it, and that change is software-only.

***

## Related

* [Distributed](/plan-your-network/architecture/distributed): the architecture this builds on
* [5G Onyx Shared Cell / Super Cell Architecture Solution Brief](https://docs.gxc.io/docs/solution-briefs/5g-onyx-shared-cell-super-cell-architecture-solution-brief)
* [Use Case Workflows](https://docs.gxc.io/usecases-workflows): the workloads that depend on handover-free mobility


# Accessories

This is the final step in the ROM design workflow. Unlike Capacity, Coverage, and Architecture, the ROM AP Calculator does not automate this step.

Once the required AP count, coverage approach, and architecture have been established, identify the equipment and installation components required to deploy the system and complete the preliminary BoM.

The calculator's Print/PDF export can be used as supporting material for an early quote request, but it is not a parts-level BoM.

### What to Include in the BoM

The final BoM should include every component required to deploy and operate the selected architecture.

* **Network Components**: Include the network infrastructure required to connect and operate the cellular system. The exact components depend on the architecture selected in *Step 3* [*Architecture*](/plan-your-network/architecture).
  * Onyx Edge servers or gateways
  * Access Points (APs)
  * Fronthaul Multiplexers (FHMs), where required
  * Ethernet or fiber switches
  * SFPs and other optical transceivers
  * Backhaul connectivity
* **RF Components**: Include the RF components required to provide the planned coverage:

  * Antennas
  * Antenna cables
  * RF connectors
  * Mounting hardware
  * Sector antennas, where applicable
  * DAS components, where applicable

  For outdoor deployments, also account for the appropriate mounting and environmental requirements.
* **Subscriber Components**: Include the components and information required to provision devices on the network:

  * SIMs
  * Subscriber/device inventory
  * Device-specific connectivity requirements

  The required subscriber components depend on the device population and deployment model.
* **Installation Components**: Include the physical infrastructure required to install and operate the equipment:
  * AP mounting hardware
  * Rack hardware
  * Fiber cabling
  * Ethernet cabling
  * Power requirements
  * Grounding and surge protection, where required
  * Outdoor-rated enclosures, where applicable
  * Outdoor mounting components, where applicable


# Getting Started

## Introduction

As connectivity becomes core infrastructure, enterprises are increasingly adopting private Long-Term Evolution (LTE) and Fifth Generation (5G) networks that are robust and secure enough to meet their operational requirements for coverage, capacity, mobility, reliability, and access control—capabilities that enterprise Wi-Fi was not designed to deliver at industrial scale.

GXC's Onyx™ platform provides a flexible, scalable, and secure foundation for private LTE and 5G deployments across a wide range of indoor and outdoor enterprise environments. It brings coverage, capacity, mobility, reliability, and access control together in a single, integrated system—providing the connectivity infrastructure that modern enterprises need.

### What this Guide Covers

This guide provides a practical framework for designing Onyx-powered private cellular networks, guiding you from *“I have a site and a use case”* to a preliminary network design suitable for developing a quote and Bill of Materials (BoM).

### Who This Guide Is For

This guide is intended for customer technical teams designing their own deployments and for GXC partners developing customer proposals.

### What You'll Get

By the end of this guide, you'll have:

* **A radio plan** — The number of radios required, the appropriate radio type, and their recommended placement.
* **A network design** — The required infrastructure—Onyx Edge servers, fronthaul, backhaul, switches, and the overall deployment architecture.
* **A Bill of Materials (BoM)** — The BoM that you can use to request a quote or build a customer proposal.

### Onyx ROM AP Calculator

At each step, the guide walks you through the [*Onyx Rough Order of Magnitude (ROM) AP Calculator*](https://www.gxc.io/rom-ap-calculator/)—a live tool that turns your deployment requirements into design recommendations. This guide also explains the manual methods and reference data behind those results, enabling you to validate the recommendations and develop them into a complete preliminary design and BoM.

<p align="center"><strong>Figure: Onyx ROM AP Calculator Interface</strong></p>

<div data-with-frame="true"><figure><img src="https://2839344875-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcsOm7izkwc75UBmow1N0%2Fuploads%2FKLHYKD5BZHlqmNQNpCfm%2Fimage.png?alt=media&amp;token=faa65ed4-6b46-4cd3-aa88-bd047e2d7191" alt=""><figcaption></figcaption></figure></div>

{% hint style="info" %}
**NOTE**: The calculator's estimates — like the rules of thumb they're built on — are a reliable starting point, not a substitute for an RF survey at sites with significant clutter, height variation, challenging propagation conditions, or strict coverage SLAs. For projects requiring a detailed RF design, GXC offers RF design as a service.
{% endhint %}

### What to Bring

Before you begin, gather the following information.

Each item maps directly to one of the [*ROM Calculator's*](https://www.gxc.io/rom-ap-calculator/) three input panels.

<table><thead><tr><th valign="top">Bring this</th><th valign="top">ROM Calculator Panel / Fields</th></tr></thead><tbody><tr><td valign="top"><p><strong>Your Site</strong></p><ul><li>Size</li><li>Indoor/outdoor split</li><li>Terrain</li><li>Obstructions</li><li>Ceiling heights</li><li>Zones with different coverage needs</li></ul></td><td valign="top"><p><strong>Site &#x26; Coverage</strong></p><ul><li>Deployment Type</li><li>Environment</li><li>Clutter Level</li><li>Total Site Area</li></ul></td></tr><tr><td valign="top"><p><strong>Your Use Cases</strong></p><ul><li>Voice</li><li>Video</li><li>Industrial automation</li><li>Internet of Things (IoT)</li><li>Surveillance</li><li>Telemetry</li><li>Broadcast</li><li>Other operational applications</li></ul></td><td valign="top"><p><strong>Capacity &#x26; Application</strong></p><ul><li>Primary Use Case</li><li>Latency Requirement</li></ul></td></tr><tr><td valign="top"><p><strong>Your Devices</strong></p><ul><li>Types</li><li>Capabilities</li><li>Expected concurrency</li><li>Bandwidth needs</li></ul></td><td valign="top"><p><strong>Capacity &#x26; Application</strong></p><ul><li>Downlink / User</li><li>Uplink / User</li></ul><p><strong>Site &#x26; Coverage</strong></p><ul><li>UL Device Class</li></ul></td></tr><tr><td valign="top"><p><strong>Your Scale</strong></p><ul><li>Expected users/devices</li><li>Peak concurrency</li></ul></td><td valign="top"><p><strong>Capacity &#x26; Application</strong></p><ul><li>Concurrent Devices</li><li>Device Mobility</li></ul></td></tr><tr><td valign="top"><p><strong>Your Spectrum and Backhaul</strong></p><ul><li>CBRS</li><li>n77/n78 or other regional bands</li><li>Existing wired connectivity</li></ul></td><td valign="top"><p><strong>Capacity &#x26; Application</strong></p><ul><li>Technology</li><li>Channel BW</li></ul><p><strong>Site &#x26; Coverage</strong></p><ul><li>Region</li><li>AP Power Class</li></ul><p><strong>Planning Parameters</strong></p><ul><li>Backhaul / Cabling</li></ul></td></tr><tr><td valign="top"><p><strong>Your Design Preferences</strong></p><ul><li>How conservative your estimate should be</li><li>How much growth/overlap margin to plan for</li></ul></td><td valign="top"><p><strong>Planning Parameters</strong></p><ul><li>Planning Stance</li><li>Overlap / Growth Buffer</li></ul></td></tr></tbody></table>

### Before you Begin

New to private cellular terminology or concepts?

* [*GXC Glossary*](/glossary) — Learn common private cellular and Onyx terminology.
* [*Private 5G Spectrum and Regulations*](/private-5g-spectrum) — Understand supported spectrum bands and regulatory considerations.
* [*Introduction to GXC Onyx*](/) — Review the overall Onyx platform architecture and components.
* [*Onyx Hardware*](https://docs.gxc.io/hw/onyx-hardware/gxc-5g-and-lte-hardware) — Learn about supported Onyx Edge gateways, Access Points (APs), antennas, and related hardware.
* [*Security and Compliance*](/security-and-compliance) — Review security features, compliance certifications, and applicable regulatory requirements.
* [*Use Cases*](https://docs.gxc.io/usecases-workflows/) — Explore real-world customer deployments, including the 2025 Australian Grand Prix deployment.

### Where this Guide is Going

Network design follows four steps, in this order:

<p align="center"><strong>Capacity → Coverage → Architecture → Accessories</strong></p>

Capacity sets a floor, Coverage sets a ceiling, Architecture resolves where you land between them, and Accessories completes the system.

<div data-with-frame="true"><figure><img src="https://2839344875-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcsOm7izkwc75UBmow1N0%2Fuploads%2FrezCVGdNSR3AO2huQbvs%2Fdesign-steps.png?alt=media&amp;token=30c1a776-a3bf-4cfa-a5cc-c325832505c0" alt="" width="563"><figcaption></figcaption></figure></div>

## Step 1 - Capacity

Capacity planning determines how much wireless throughput the deployment must support and how many cells are required to meet that demand.

<details>

<summary><strong>Why Capacity Comes First?</strong></summary>

Capacity is the foundation of the network design. Getting the capacity requirement wrong can lead to an inappropriate technology or architecture choice resulting in an under- or over-sized deployment.

Because Onyx LTE and 5G use distinct hardware platforms, technology selection should be considered early in the design. Coverage, Architecture, and Accessories then build on the capacity requirement established here.

This is why the ROM AP Calculator asks for the application-level inputs early in the workflow and why its Technology Assessment should be considered alongside the calculated capacity requirement.

</details>

### Do this in the Calculator

{% stepper %}
{% step %}
In the **Capacity & Application** panel, set:

* **Technology** — 4G / LTE or 5G NR
* **Channel BW** — (Only for 5G NR) 20 / 40 / 100 MHz
* **Primary Use Case** — The category that best represents the dominant application (General Enterprise / Voice & Data, IoT/Telemetry & Sensors, Video Surveillance & Broadcast, Logistics/AGVs & Automated Vehicles, Machine Vision & Real-time Control, AR/VR & High-bandwidth Immersive)
* **Latency Requirement** — Not Sensitive / Moderate / <30 ms

  (LTE delivers >50 ms; 5G NR delivers <30 ms)
* **Downlink / User** — <3 / 3–50 / >50 Mbps
* **Uplink / User** — <1 / 1–10 / >10 Mbps
* **Concurrent Devices** — <25 / 25–100 / 100+
* **Device Mobility** — Fixed / Mobile / Continuous

<p align="center"><strong>Figure: ROM Calculator - Capacity &#x26; Application Panel</strong></p>

<div data-with-frame="true"><figure><img src="https://2839344875-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcsOm7izkwc75UBmow1N0%2Fuploads%2FKalIGIZgStuCeW1KrzYz%2Fimage.png?alt=media&amp;token=e0b38f4a-4b04-417a-ad9f-0b2e2bdc0491" alt=""><figcaption></figcaption></figure></div>

The calculator uses these inputs to estimate traffic demand and determine the capacity-driven AP count.
{% endstep %}

{% step %}
In the **Estimated APs** panel, review:

* **Capacity estimate:&#x20;*****n*****&#x20;APs (DL needs&#x20;*****X*****&#x20;· UL needs&#x20;*****Y*****)** — The estimated AP count and the calculated downlink and uplink requirements. The larger of *X* and *Y* is your capacity-driven cell count, and the calculator identifies the binding direction, such as "UL-limited".

<p align="center"><strong>Figure: ROM Calculator - Estimated APs Panel</strong></p>

<div data-with-frame="true"><figure><img src="https://2839344875-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcsOm7izkwc75UBmow1N0%2Fuploads%2F7uStfd37tv6TpKLkx2RY%2Fimage.png?alt=media&amp;token=fd0d064f-07bf-4860-bbb0-c96d2d095126" alt=""><figcaption></figcaption></figure></div>

* **Technology Assessment** — Indicates whether the selected technology is a good fit, with the reasoning behind the recommendation.

<p align="center"><strong>Figure: ROM Calculator - Technology Assessment Panel</strong></p>

<div data-with-frame="true"><figure><img src="https://2839344875-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcsOm7izkwc75UBmow1N0%2Fuploads%2FAkKop86hHSvbFbjiJlyN%2Fimage.png?alt=media&amp;token=b2426e77-657f-4b53-b174-b325fd274e5c" alt=""><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}

#### Understanding the Methodology

The Calculator performs the capacity calculation automatically. This section explains the methodology so that you can validate the recommendation and adapt it when the deployment does not fit the Calculator's generic application categories.

The Calculator's built-in capacity estimate applies a 0.65 concurrency factor to the device count in your selected Concurrent Devices bucket before computing throughput demand — it never evaluates 100% of devices as simultaneously active.

The manual method below (Application Profile → Total Throughput Demand) does not apply this factor, because it uses your own per-application peak-concurrency figures directly — a number you've already defined as "simultaneously active during peak operating conditions." This is intentional as the manual method is more precise when you know your actual peak concurrency, while the Calculator's 0.65 factor is a generic estimate for when you don't.

{% hint style="info" %}
**NOTE:** The Calculator provides a planning estimate. It does not replace a detailed capacity or RF design when application requirements, device behavior, spectrum availability, or site conditions require more detailed analysis.
{% endhint %}

{% stepper %}
{% step %}
Determine the Application Profile.

The application profile is an inventory of the devices and applications that will use the network.

For each device category, capture:

* **Application** — What does the device or application do? Examples include Automated Guided Vehicle (AGV) navigation, video surveillance, handheld scanning, voice, and Supervisory Control and Data Acquisition (SCADA).
* **Peak concurrent devices** — How many devices of that type are expected to be simultaneously active during peak operating conditions?

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> Size the network for the expected peak operating workload, not simply the total number of deployed devices or the average traffic level. Identify how many devices are expected to be active simultaneously and what traffic each application generates during the peak operating condition.</p></div>
* **Downlink requirement** — How much data does the application receive?
* **Uplink requirement** — How much data does the application transmit?
* **Latency requirement** — How sensitive is the application to network delay?
* **Mobility** — Is the device stationary, pedestrian, or vehicle-mounted?

<details>

<summary><strong>Why Application Profiling Comes First?</strong></summary>

Not all devices place the same demands on the network.

A handheld barcode scanner may use only a small amount of bandwidth, while a 4K surveillance camera can generate a continuous high-volume uplink stream. Similarly, an AGV performing real-time navigation may have more demanding latency requirements than a sensor that periodically reports a measurement.

Understanding the complete application profile provides the baseline for calculating network capacity and determining the required AP density.

</details>

**Application Traffic Classes**

{% hint style="info" %}
**NOTE:** The following ranges provide general planning guidance for classifying application traffic. They are illustrative ranges, not guaranteed application requirements.
{% endhint %}

| Class    | Examples                                             | Typical Range      |
| -------- | ---------------------------------------------------- | ------------------ |
| Light    | Voice, messaging, telemetry                          | 100–300 kbps       |
| Moderate | IoT, monitoring systems, standard video applications | 500 kbps – 3 Mbps  |
| Heavy    | AR/VR, machine vision, real-time video analytics     | 10 Mbps or greater |

{% hint style="info" %}
**NOTE:** Actual bandwidth depends on application design, concurrency, video resolution, frame rate, compression, operational workload, and device behavior. Use application-specific requirements whenever they are available.
{% endhint %}

**ROM Calculator Bandwidth Tiers**

The Calculator uses broader planning buckets than the application traffic ranges above. These DL and UL values are what the calculator maps to your Downlink/User and Uplink/User selections.

| Class        | Examples                                   | DL      | UL       |
| ------------ | ------------------------------------------ | ------- | -------- |
| Light / Low  | Voice, messaging, telemetry                | 2 Mbps  | 0.5 Mbps |
| Moderate     | IoT, monitoring, standard video            | 20 Mbps | 5 Mbps   |
| Heavy / High | AR/VR, machine vision, real-time analytics | 75 Mbps | 25 Mbps  |

{% hint style="info" %}
**NOTE**: The Calculator applies a 0.65 concurrency factor to the device count used in its capacity calculation. Do not independently apply an additional concurrency reduction when interpreting the Calculator's estimate. For deployments where the expected traffic profile does not map well to the Calculator's generic tiers, validate the result using the application-specific calculation described below.
{% endhint %}
{% endstep %}

{% step %}
Calculate the Total Throughput Demand.

1. Calculate the aggregate throughput requirement for the defined peak operating condition.\
   \
   For each device category:<br>

   ```
   Total DL demand = active devices × DL bandwidth per device

   Total UL demand = active devices × UL bandwidth per device
   ```
2. Sum the results across all device categories.

   \
   Calculate downlink and uplink independently because enterprise applications rarely generate equal traffic in both directions.

   \
   The result is the peak throughput requirement that the network must support during the defined peak operating condition.

{% hint style="info" %}
**NOTE:** Capacity planning should use the expected peak concurrent workload rather than average utilization. Designing only for average traffic can result in insufficient capacity during normal operational peaks.
{% endhint %}
{% endstep %}

{% step %}
Select the Technology and Architecture.

With the peak throughput requirement established, compare it against the capabilities of the Onyx LTE and 5G platforms.

Technology selection should consider: Peak downlink throughput, peak uplink throughput, application latency requirements, device capabilities, spectrum availability, MIMO capability, expected device concurrency, mobility requirements, capacity-driven cell count, deployment architecture, and future operational requirements.

Cell capacity is determined from the LTE or 5G SA TDD tables below (frame format × bandwidth × MIMO):

```
APs_cap = max(⌈TotalDL ÷ CellDL⌉, ⌈TotalUL ÷ CellUL⌉)
```

**LTE or 5G?**

In many deployments, technology selection needs to be made early because GXC Onyx LTE and 5G use distinct hardware platforms.

**LTE vs 5G At a Glance**

|                                  | LTE                                                                                                                                                                                   | 5G                                                                         |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| Latency Characteristics          | Suitable for moderate-latency enterprise applications (>50 ms)                                                                                                                        | Supports lower-latency and real-time workloads (<30 ms)                    |
| Typical Use Cases                | General enterprise connectivity, telemetry, IoT                                                                                                                                       | Real-time analytics, robotics, machine vision, broadcast video             |
| Estimated Peak AP Throughput     | \~40 Mbps @ 20 MHz (general baseline); \~105 Mbps/cell at 20 MHz for the default Config1 configuration (up to 96 RRC users) — see the table below for the full range by configuration | Up to 300+ Mbps with 4×4 MIMO @ 40 MHz, depending on deployment conditions |
| Channel BW options in calculator | Fixed (2×20 MHz CA reference)                                                                                                                                                         | 20 / 40 / 100 MHz, selectable                                              |

{% hint style="info" %}
**NOTE:** Actual throughput and latency depend on spectrum allocation, RF conditions, antenna configuration, device capability, mobility, interference, and overall deployment design. Use the measured throughput tables in this guide as planning references rather than guaranteed production performance.
{% endhint %}

**LTE and 5G Hardware Considerations**

GXC Onyx LTE and 5G use distinct hardware platforms. Selecting the appropriate technology is therefore an important early design decision.

If an existing LTE deployment later requires 5G capability, a supported 5G architecture may be available for specific configurations. This is not a standard LTE-to-5G migration model.
{% endstep %}
{% endstepper %}

### LTE Capacity

This section provides guidance for understanding LTE capacity on the Onyx platform.

<details>

<summary><strong>LTE Capacity Overview</strong></summary>

LTE capacity planning determines how much traffic the network can support and how many cells are required to meet the expected peak demand.

LTE Time Division Duplex (TDD) shares the available radio spectrum between downlink and uplink transmission. Capacity therefore depends not only on channel bandwidth and MIMO configuration, but also on how radio resources are divided between the two directions.

For LTE deployments, capacity planning should consider:

* Peak downlink throughput
* Peak uplink throughput
* Traffic direction and application behavior
* TDD Subframe Assignment (SA)
* Channel bandwidth
* MIMO configuration
* Modulation
* Carrier Aggregation (CA), where supported
* Device capability
* RF conditions
* Expected peak device concurrency

The goal is to select an LTE configuration that provides sufficient capacity in both directions while avoiding unnecessary cell deployment.

</details>

<details>

<summary><strong>Select the LTE TDD Subframe Assignment</strong></summary>

LTE Time Division Duplex (TDD) uses the same frequency channel for downlink and uplink traffic. The network alternates between the two directions, allocating a defined portion of radio resources to each.

The Subframe Assignment (SA) determines this DL/UL allocation.

Think of the radio channel as a road shared by traffic moving in two directions. Allocating more time to one direction increases capacity in that direction, but leaves less capacity available for the other.

**Why Does it Matter?**

Choosing the appropriate SA profile is an important part of LTE capacity planning.

For example, a surveillance deployment may continuously transmit video from cameras to a recording system. Selecting a heavily downlink-oriented SA profile for such a deployment would allocate insufficient airtime to uplink traffic.

**Available SA Profiles**

<table><thead><tr><th width="125">SA</th><th width="125">DL</th><th width="125">UL</th><th>Traffic Profile</th></tr></thead><tbody><tr><td>SA1</td><td>70%</td><td>30%</td><td>Balanced traffic</td></tr><tr><td>SA2</td><td>85%</td><td>15%</td><td>Downlink-heavy traffic</td></tr><tr><td>SA6</td><td>60%</td><td>40%</td><td>Uplink-heavy traffic</td></tr></tbody></table>

**Choosing an SA Profile Rule of Thumb**

* **Balanced traffic** — General enterprise connectivity, tablets, laptops, and mixed IoT → Consider **SA1** as the starting point.
* **Primarily downlink traffic** — Streaming video, software updates, command delivery, and content distribution → Consider **SA2**.
* **Primarily uplink traffic** — Cameras, sensors, AGVs, telemetry, and industrial monitoring → Consider **SA6**.

For example, a surveillance deployment may continuously transmit video from cameras to a recording or monitoring system. A heavily downlink-oriented SA would allocate insufficient airtime to this uplink traffic.

These recommendations are starting points — the final selection should be based on the calculated application traffic profile.

| Application                                    | Recommended SA       |
| ---------------------------------------------- | -------------------- |
| CPE routers serving broadband traffic          | SA2 — DL-heavy       |
| Video streaming to displays or signage         | SA2 — DL-heavy       |
| Handheld scanners downloading work orders      | SA2 — primarily DL   |
| Mixed enterprise — tablets, laptops, light IoT | SA1 — balanced       |
| Push-to-talk voice with data                   | SA1 — balanced       |
| Video surveillance cameras                     | SA6 — UL-heavy       |
| Dense sensor/telemetry networks                | SA6 — UL-heavy       |
| AGVs or robots reporting position and status   | SA6 — UL-heavy       |
| Unknown or mixed traffic profile               | SA1 — starting point |

{% hint style="info" %}
**NOTE:** Every GXC AP operating on the same frequency channel must use the same SA configuration. SA is therefore a network-level design decision rather than an individual device setting.
{% endhint %}

</details>

<details>

<summary><strong>Understand LTE Throughput</strong></summary>

The following throughput tables provide measured peak throughput values observed during controlled GXC testing.

Use these values as planning references, not guaranteed production throughput.

Actual performance depends on RF signal quality, spectrum availability, interference, channel bandwidth, MIMO configuration, modulation, device capability, AP density, user concurrency, mobility, and environmental conditions.

<p align="center"><strong>Single/Dual Carrier Peak Expected Throughput (Mbps)</strong></p>

<table><thead><tr><th width="95">MIMO Config</th><th>Dir/Mod</th><th width="100" align="center">SA1 10MHz</th><th width="100" align="center">SA1 20MHz</th><th width="100" align="center">SA2 10MHz</th><th width="100" align="center">SA2 20MHz</th><th width="100" align="center">SA6 10MHz</th><th width="100" align="center">SA6 20MHz</th></tr></thead><tbody><tr><td>DL 2T</td><td>DL-256QAM</td><td align="center">48</td><td align="center">96</td><td align="center">66</td><td align="center">131</td><td align="center">39</td><td align="center">78</td></tr><tr><td>DL 1T</td><td>DL-256QAM</td><td align="center">24</td><td align="center">48</td><td align="center">33</td><td align="center">66</td><td align="center">20</td><td align="center">39</td></tr><tr><td>UL 1T</td><td>UL-64QAM</td><td align="center">14</td><td align="center">29</td><td align="center">7</td><td align="center">14</td><td align="center">18</td><td align="center">36</td></tr></tbody></table>

<p align="center"><strong>Carrier Aggregation Peak Expected Throughput (Mbps)</strong></p>

<table><thead><tr><th width="95">MIMO Config</th><th>Dir/Mod</th><th width="120" align="center">SA1 2×20MHz</th><th align="center">SA1 2×10MHz</th><th align="center">SA1 20+10MHz</th><th align="center">SA2 2×20MHz</th><th width="111" align="center">SA2 2×10MHz</th><th width="120" align="center">SA2 20+10MHz</th><th width="120" align="center">SA6 2×20MHz</th><th width="120" align="center">SA6 2×10MHz</th><th width="120" align="center">SA6 20+10MHz</th></tr></thead><tbody><tr><td>DL 2T</td><td>DL-256QAM</td><td align="center">192</td><td align="center">96</td><td align="center">144</td><td align="center">262</td><td align="center">131</td><td align="center">197</td><td align="center">157</td><td align="center">78</td><td align="center">118</td></tr><tr><td>DL 1T</td><td>DL-256QAM</td><td align="center">96</td><td align="center">48</td><td align="center">72</td><td align="center">131</td><td align="center">66</td><td align="center">98</td><td align="center">78</td><td align="center">39</td><td align="center">59</td></tr><tr><td>UL 1T</td><td>UL-64QAM</td><td align="center">58</td><td align="center">29</td><td align="center">43</td><td align="center">29</td><td align="center">14</td><td align="center">22</td><td align="center">72</td><td align="center">36</td><td align="center">54</td></tr></tbody></table>

{% hint style="warning" %}
**IMPORTANT:** These values represent measured performance under controlled conditions. They should not be interpreted as guaranteed per-user throughput or as a substitute for detailed RF and capacity engineering.
{% endhint %}

</details>

<details>

<summary><strong>Understand MIMO, Modulation, and Channel Width</strong></summary>

**MIMO Configuration**

MIMO refers to the number of spatial streams used simultaneously for data transmission or reception. Higher-order MIMO can increase throughput when supported by the AP, client device, antenna configuration, and RF conditions.

| Configuration | Description                                   | Typical Devices                                                       |
| ------------- | --------------------------------------------- | --------------------------------------------------------------------- |
| DL 2T (2×2)   | Two simultaneous downlink streams from the AP | Supported by many enterprise devices and CPEs                         |
| DL 1T (1×1)   | One downlink stream from the AP               | Basic devices or deployments where higher-order MIMO is not available |
| UL 1T (1×1)   | One uplink stream to the AP                   | Common LTE UL configuration                                           |

**Modulation**

Modulation determines how much data can be transmitted in each radio signal. Higher-order modulations can carry more bits per transmission, but requires better RF conditions.

**Channel Width**

The *Single/Dual Carrier* table's column headers (10 MHz, 20 MHz) represent the spectrum allocated to the deployment. Wider channels generally provide greater throughput capacity when the additional spectrum is available and supported by the deployment.

</details>

<details>

<summary><strong>Consider Carrier Aggregation</strong></summary>

CA combines multiple LTE carriers to provide additional usable spectrum capacity to supported devices. For example, two 20 MHz carriers can provide an aggregate 40 MHz spectrum allocation.

<table><thead><tr><th width="136">Combination</th><th width="115" align="center">Channel 1</th><th width="115" align="center">Channel 2</th><th>Effective BW</th><th>Use Case</th></tr></thead><tbody><tr><td>2×20 MHz</td><td align="center">20</td><td align="center">20</td><td>40 equivalent</td><td>Maximum capacity — use when two 20 MHz grants are available</td></tr><tr><td>2×10 MHz</td><td align="center">10</td><td align="center">10</td><td>20 equivalent</td><td>Two narrower grants bonded — same total as a single 20 MHz channel</td></tr><tr><td>20+10 MHz</td><td align="center">20</td><td align="center">10</td><td>30 equivalent</td><td>Asymmetric CA — useful when one wider and one narrower grant are available</td></tr></tbody></table>

{% hint style="info" %}
**NOTE:** CA can increase available capacity when multiple supported carriers are available. Before including CA in the capacity design, verify spectrum availability, device support, AP and network configuration, and applicable deployment constraints.
{% endhint %}

</details>

<details>

<summary><strong>LTE Capacity Design Considerations</strong></summary>

* Use measured throughput values as planning references rather than theoretical maximums.
* Select the SA profile based on the dominant traffic direction.
* Use wider channel bandwidths where additional spectrum is available and additional capacity is required.
* Validate RF quality before relying on higher-order MIMO or modulation.
* Design AP density around expected peak operational demand rather than average utilization.
* Carefully evaluate uplink requirements for surveillance, telemetry, industrial automation, and sensor-heavy environments.
* Consider CA where additional spectrum is available and supported by the deployment.
* Validate device capabilities when determining realistic throughput.

The resulting LTE capacity design should establish the capacity-driven cell count before coverage and architecture are finalized.

</details>

### 5G Capacity

This section provides guidance for understanding 5G capacity on the Onyx platform.

<details>

<summary><strong>5G Capacity Overview</strong></summary>

5G capacity planning determines how much traffic the network can support and how many cells are required to meet the expected peak demand.

5G NR TDD uses the same spectrum for downlink and uplink transmission. The network therefore uses a slot pattern to determine how radio resources are allocated between the two directions.

For 5G deployments, capacity planning should consider:

* Peak downlink throughput
* Peak uplink throughput
* Traffic direction and application behavior
* TDD slot pattern
* Channel bandwidth
* MIMO configuration
* Modulation
* Device capability
* RF conditions
* Expected peak device concurrency
* Mobility and operational requirements

{% hint style="info" %}
**NOTE:** The throughput values in this section are based on measured performance during controlled GXC field and laboratory testing using CBRS and mid-band 5G spectrum configurations. Actual performance varies with spectrum availability, RF conditions, interference, device capability, MIMO configuration, mobility, environmental obstructions, AP density, user concurrency, and overall deployment design.
{% endhint %}

</details>

<details>

<summary><strong>Select the 5G TDD Slot Pattern</strong></summary>

5G TDD uses the same spectrum for uplink and downlink transmission. A slot pattern determines how radio resources are distributed between the two directions.

* **Downlink traffic** moves from the network to devices, such as tablets, AR headsets, and handheld devices.
* **Uplink traffic** moves from devices to the network, such as cameras, sensors, robots, scanners, and telemetry systems.

A deployment with many cameras, sensors, or robots may require greater uplink allocation. A deployment dominated by video delivery, software downloads, or AR content may require greater downlink allocation.

**5-Slot Patterns**

Provides simplified scheduling behavior and predictable traffic allocation.

| Pattern | DL/UL Distribution | Recommended Deployment Environment                                            |
| ------- | ------------------ | ----------------------------------------------------------------------------- |
| DDDSU   | 74% DL / 23% UL    | Downlink-heavy applications including content delivery and media distribution |
| DDSUU   | 54% DL / 43% UL    | Balanced enterprise traffic and mixed-use environments                        |
| DSUUU   | 34% DL / 63% UL    | Uplink-heavy environments including surveillance and telemetry workloads      |

**10-Slot Patterns**

Provides finer control over downlink and uplink resource allocation, for mixed enterprise workloads.

| Pattern    | DL/UL Distribution | Recommended Deployment Environment                                                     |
| ---------- | ------------------ | -------------------------------------------------------------------------------------- |
| DDDDDDDSUU | 77% DL / 21% UL    | Downlink-heavy applications such as video delivery, AR/VR, and content distribution    |
| DSUUUUDSUU | 25% DL / 72% UL    | Mixed enterprise traffic including handheld devices, laptops, and general connectivity |
| DDSUUUUUUU | 20% DL / 77% UL    | Uplink-heavy environments such as surveillance, telemetry, and industrial sensors      |

{% hint style="info" %}
**NOTE:** The DL and UL percentages represent the approximate allocation of data-carrying resources. They do not necessarily sum to 100% because TDD frame structures also include special and other non-DL/UL resources.
{% endhint %}

**Choosing Between 5-Slot and 10-Slot Patterns**

Consider dominant traffic direction, aggregate throughput requirement, scheduling behavior, latency requirements, synchronization and coexistence requirements, and operational simplicity.

</details>

<details>

<summary><strong>Choose a Slot Pattern by Traffic Profile</strong></summary>

**Heavy Downlink Applications**

Examples include video delivery, AR/VR, content distribution, and software distribution. Both DDDSU and DDDDDDDSUU allocate the majority of airtime to downlink.

| Pattern              | Split           | Best when                                                                                                                      |
| -------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| DDDSU (5-slot)       | 74% DL / 23% UL | Simpler scheduling preferred, predictable DL delivery, no coexistence constraint, lower operational complexity                 |
| DDDDDDDSUU (10-slot) | 77% DL / 21% UL | Maximum DL throughput ceiling required, fine-grained DL/UL balancing needed, adjacent networks require 10-slot synchronization |

{% hint style="info" %}
**NOTE:** DDDSU is the recommended starting point for most Heavy DL deployments. DDDDDDDSUU delivers marginally higher DL capacity and is the right choice when squeezing maximum downlink throughput from available spectrum is the priority.
{% endhint %}

**Mixed-Use Applications**

Examples include general enterprise connectivity, handheld devices, laptops, balanced industrial workloads.

| Pattern              | Split           | Best When                                                                                                       |
| -------------------- | --------------- | --------------------------------------------------------------------------------------------------------------- |
| DDSUU (5-slot)       | 54% DL / 43% UL | Balanced enterprise environment, operational simplicity preferred, predictable traffic allocation               |
| DSUUUUDSUU (10-slot) | 25% DL / 72% UL | Greater flexibility needed to tune DL/UL balance dynamically, adjacent networks require 10-slot synchronisation |

{% hint style="info" %}
**NOTE:** DDSUU is the recommended starting point for most Mixed Use deployments. DSUUUUDSUU provides more fine-grained control over the DL/UL balance and suits environments where traffic patterns vary significantly across shifts or operational periods.
{% endhint %}

**Heavy Uplink Applications**

Examples include surveillance cameras, telemetry sensors, AGVs, and industrial monitoring. Both DSUUU and DDSUUUUUUU allocate the majority of airtime to uplink.

| Pattern              | Split           | Best when                                                                                                                        |
| -------------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| DSUUU (5-slot)       | 34% DL / 63% UL | Many devices uploading frequently, low-latency UL response needed, high device concurrency, operational simplicity preferred     |
| DDSUUUUUUU (10-slot) | 20% DL / 77% UL | Maximum raw UL throughput ceiling required, sustained bulk continuous uploads, adjacent networks require 10-slot synchronisation |

{% hint style="info" %}
**NOTE:** For most Heavy UL deployments, DSUUU is the recommended starting point — more frequent uplink scheduling opportunities reduce per-device queuing delay, which matters with high concurrent device activity. DDSUUUUUUU delivers a higher aggregate UL throughput ceiling and is the right choice when bulk continuous upload capacity is the priority and latency tolerance is higher.
{% endhint %}

</details>

<details>

<summary><strong>Understand 5G Throughput</strong></summary>

The following throughput tables provide measured peak throughput values observed during controlled GXC testing.

{% hint style="warning" %}
**IMPORTANT:** Use these values as deployment planning references, not guaranteed per-user throughput in a shared production environment. Actual performance varies with RF quality, channel bandwidth, MIMO configuration, modulation, device capability, AP density, user concurrency, mobility, and environmental conditions.
{% endhint %}

**Peak Expected Throughput (Mbps) — 10-Slot Patterns**

<p align="center"><strong>10-slot · DDDDDDDSUU (77% DL / 21% UL) — Heavy Downlink</strong></p>

<table><thead><tr><th width="100">MIMO Config</th><th width="120">Dir/Mod</th><th width="100" align="center">10MHz</th><th width="100" align="center">20MHz</th><th width="101" align="center">40MHz</th><th width="100" align="center">50MHz</th><th width="105" align="center">100MHz</th></tr></thead><tbody><tr><td>DL 4T</td><td>DL-256QAM</td><td align="center">124</td><td align="center">263</td><td align="center">546</td><td align="center">685</td><td align="center">1370</td></tr><tr><td>DL 2T</td><td>DL-256QAM</td><td align="center">63</td><td align="center">135</td><td align="center">280</td><td align="center">351</td><td align="center">703</td></tr><tr><td>DL 1T</td><td>DL-256QAM</td><td align="center">32</td><td align="center">69</td><td align="center">144</td><td align="center">180</td><td align="center">361</td></tr><tr><td>UL 2T</td><td>UL-256QAM</td><td align="center">15</td><td align="center">31</td><td align="center">64</td><td align="center">81</td><td align="center">161</td></tr><tr><td>UL 2T</td><td>UL-64QAM</td><td align="center">12</td><td align="center">24</td><td align="center">51</td><td align="center">64</td><td align="center">125</td></tr><tr><td>UL 1T</td><td>UL-256QAM</td><td align="center">7</td><td align="center">16</td><td align="center">32</td><td align="center">40</td><td align="center">80</td></tr><tr><td>UL 1T</td><td>UL-64QAM</td><td align="center">6</td><td align="center">12</td><td align="center">25</td><td align="center">32</td><td align="center">62</td></tr></tbody></table>

<p align="center"><strong>10-slot · DSUUUUDSUU (25% DL / 72% UL) — Mixed Use</strong></p>

<table><thead><tr><th width="95">MIMO Config</th><th width="120">Dir/Mod</th><th width="100" align="center">10MHz</th><th width="100" align="center">20MHz</th><th width="100" align="center">40MHz</th><th width="100" align="center">50MHz</th><th width="105" align="center">100MHz</th></tr></thead><tbody><tr><td>DL 4T</td><td>DL-256QAM</td><td align="center">55</td><td align="center">117</td><td align="center">243</td><td align="center">305</td><td align="center">609</td></tr><tr><td>DL 2T</td><td>DL-256QAM</td><td align="center">28</td><td align="center">60</td><td align="center">124</td><td align="center">156</td><td align="center">312</td></tr><tr><td>DL 1T</td><td>DL-256QAM</td><td align="center">14</td><td align="center">31</td><td align="center">64</td><td align="center">80</td><td align="center">160</td></tr><tr><td>UL 2T</td><td>UL-256QAM</td><td align="center">43</td><td align="center">91</td><td align="center">189</td><td align="center">237</td><td align="center">471</td></tr><tr><td>UL 2T</td><td>UL-64QAM</td><td align="center">34</td><td align="center">72</td><td align="center">149</td><td align="center">187</td><td align="center">365</td></tr><tr><td>UL 1T</td><td>UL-256QAM</td><td align="center">21</td><td align="center">46</td><td align="center">95</td><td align="center">119</td><td align="center">236</td></tr><tr><td>UL 1T</td><td>UL-64QAM</td><td align="center">17</td><td align="center">36</td><td align="center">74</td><td align="center">93</td><td align="center">183</td></tr></tbody></table>

<p align="center"><strong>10-slot · DDSUUUUUUU (20% DL / 77% UL) — Heavy Uplink</strong></p>

<table><thead><tr><th width="95">MIMO Config</th><th>Dir/Mod</th><th width="100" align="center">10MHz</th><th width="100" align="center">20MHz</th><th width="100" align="center">40MHz</th><th width="100" align="center">50MHz</th><th width="105" align="center">100MHz</th></tr></thead><tbody><tr><td>DL 4T</td><td>DL-256QAM</td><td align="center">44</td><td align="center">92</td><td align="center">192</td><td align="center">241</td><td align="center">482</td></tr><tr><td>DL 2T</td><td>DL-256QAM</td><td align="center">22</td><td align="center">47</td><td align="center">98</td><td align="center">124</td><td align="center">247</td></tr><tr><td>DL 1T</td><td>DL-256QAM</td><td align="center">11</td><td align="center">24</td><td align="center">51</td><td align="center">63</td><td align="center">127</td></tr><tr><td>UL 2T</td><td>UL-256QAM</td><td align="center">49</td><td align="center">103</td><td align="center">215</td><td align="center">270</td><td align="center">536</td></tr><tr><td>UL 2T</td><td>UL-64QAM</td><td align="center">38</td><td align="center">81</td><td align="center">169</td><td align="center">212</td><td align="center">415</td></tr><tr><td>UL 1T</td><td>UL-256QAM</td><td align="center">24</td><td align="center">52</td><td align="center">107</td><td align="center">135</td><td align="center">268</td></tr><tr><td>UL 1T</td><td>UL-64QAM</td><td align="center">19</td><td align="center">41</td><td align="center">85</td><td align="center">106</td><td align="center">208</td></tr></tbody></table>

**Peak Expected Throughput (Mbps) — 5-Slot Patterns**

<p align="center"><strong>5-slot · DDDSU (74% DL / 23% UL) — Heavy Downlink</strong></p>

<table><thead><tr><th width="95">MIMO Config</th><th>Dir/Mod</th><th width="100" align="center">10MHz</th><th width="100" align="center">20MHz</th><th width="100" align="center">40MHz</th><th width="100" align="right">50MHz</th><th width="105" align="right">100MHz</th></tr></thead><tbody><tr><td>DL 4T</td><td>DL-256QAM</td><td align="center">119</td><td align="center">253</td><td align="center">526</td><td align="right">660</td><td align="right">1319</td></tr><tr><td>DL 2T</td><td>DL-256QAM</td><td align="center">61</td><td align="center">130</td><td align="center">270</td><td align="right">338</td><td align="right">677</td></tr><tr><td>DL 1T</td><td>DL-256QAM</td><td align="center">31</td><td align="center">67</td><td align="center">138</td><td align="right">173</td><td align="right">347</td></tr><tr><td>UL 2T</td><td>UL-256QAM</td><td align="center">16</td><td align="center">33</td><td align="center">69</td><td align="right">86</td><td align="right">171</td></tr><tr><td>UL 2T</td><td>UL-64QAM</td><td align="center">12</td><td align="center">26</td><td align="center">54</td><td align="right">68</td><td align="right">150</td></tr><tr><td>UL 1T</td><td>UL-256QAM</td><td align="center">8</td><td align="center">17</td><td align="center">34</td><td align="right">43</td><td align="right">86</td></tr><tr><td>UL 1T</td><td>UL-64QAM</td><td align="center">6</td><td align="center">13</td><td align="center">27</td><td align="right">34</td><td align="right">66</td></tr></tbody></table>

<p align="center"><strong>5-slot · DDSUU (54% DL / 43% UL) — Mixed Use</strong></p>

<table><thead><tr><th width="95">MIMO config</th><th>Dir/Mod</th><th width="100" align="center">10MHz</th><th width="100" align="center">20MHz</th><th width="100" align="center">40MHz</th><th width="100" align="center">50MHz</th><th width="105" align="center">100MHz</th></tr></thead><tbody><tr><td>DL 4T</td><td>DL-256QAM</td><td align="center">87</td><td align="center">185</td><td align="center">384</td><td align="center">482</td><td align="center">964</td></tr><tr><td>DL 2T</td><td>DL-256QAM</td><td align="center">45</td><td align="center">95</td><td align="center">197</td><td align="center">247</td><td align="center">495</td></tr><tr><td>DL 1T</td><td>DL-256QAM</td><td align="center">23</td><td align="center">49</td><td align="center">101</td><td align="center">127</td><td align="center">254</td></tr><tr><td>UL 2T</td><td>UL-256QAM</td><td align="center">29</td><td align="center">62</td><td align="center">129</td><td align="center">162</td><td align="center">321</td></tr><tr><td>UL 2T</td><td>UL-64QAM</td><td align="center">23</td><td align="center">49</td><td align="center">101</td><td align="center">127</td><td align="center">249</td></tr><tr><td>UL 1T</td><td>UL-256QAM</td><td align="center">15</td><td align="center">31</td><td align="center">64</td><td align="center">81</td><td align="center">161</td></tr><tr><td>UL 1T</td><td>UL-64QAM</td><td align="center">12</td><td align="center">24</td><td align="center">51</td><td align="center">64</td><td align="center">125</td></tr></tbody></table>

<p align="center"><strong>5-slot · DSUUU (34% DL / 63% UL) — Heavy Uplink</strong></p>

<table><thead><tr><th width="95">MIMO Config</th><th>Dir/Mod</th><th width="100" align="center">10MHz</th><th width="100" align="center">20MHz</th><th width="100" align="center">40MHz</th><th width="100" align="right">50MHz</th><th width="105" align="right">100MHz</th></tr></thead><tbody><tr><td>DL 4T</td><td>DL-256QAM</td><td align="center">55</td><td align="center">117</td><td align="center">243</td><td align="right">305</td><td align="right">609</td></tr><tr><td>DL 2T</td><td>DL-256QAM</td><td align="center">28</td><td align="center">60</td><td align="center">124</td><td align="right">156</td><td align="right">312</td></tr><tr><td>DL 1T</td><td>DL-256QAM</td><td align="center">14</td><td align="center">31</td><td align="center">64</td><td align="right">80</td><td align="right">160</td></tr><tr><td>UL 2T</td><td>UL-256QAM</td><td align="center">43</td><td align="center">91</td><td align="center">189</td><td align="right">237</td><td align="right">471</td></tr><tr><td>UL 2T</td><td>UL-64QAM</td><td align="center">34</td><td align="center">72</td><td align="center">149</td><td align="right">187</td><td align="right">365</td></tr><tr><td>UL 1T</td><td>UL-256QAM</td><td align="center">21</td><td align="center">46</td><td align="center">95</td><td align="right">119</td><td align="right">236</td></tr><tr><td>UL 1T</td><td>UL-64QAM</td><td align="center">17</td><td align="center">36</td><td align="center">74</td><td align="right">93</td><td align="right">183</td></tr></tbody></table>

</details>

<details>

<summary><strong>Understand 5G MIMO, Modulation, and Channel Bandwidth</strong></summary>

**MIMO Configuration**

Higher-order MIMO can increase throughput and spectral efficiency when supported by the AP, client device, antenna configuration, and RF conditions.

| Configuration | Description                                    | Typical devices                                              |
| ------------- | ---------------------------------------------- | ------------------------------------------------------------ |
| DL 4T (4×4)   | Four simultaneous downlink streams from the AP | High-end devices, industrial CPEs with four receive antennas |
| DL 2T (2×2)   | Two simultaneous downlink streams from the AP  | Mid-range smartphones, most enterprise CPEs                  |
| DL 1T (1×1)   | One downlink stream from the AP                | Basic devices, coverage-edge scenarios                       |
| UL 2T (2×2)   | Two simultaneous uplink streams to the AP      | Most smartphones and standard devices                        |
| UL 1T (1×1)   | One uplink stream to the AP                    | Most smartphones and standard devices                        |

**Modulation**

Modulation determines how much data can be transmitted in each radio signal; higher modulation orders carry more bits per transmission but only work well with good signal quality.

| Modulation | Condition                                                 |
| ---------- | --------------------------------------------------------- |
| 256-QAM    | Close range, strong signal, clear line of sight           |
| 64-QAM     | Moderate range or some obstruction — 75% of 256-QAM speed |

**Channel Bandwidth**

The channel-width values in the throughput tables represent the spectrum allocated to the deployment. Wider channel bandwidths generally provide greater throughput capacity when additional spectrum is available and supported.

</details>

<details>

<summary><strong>5G Capacity Design Considerations</strong></summary>

* Use measured throughput values as planning references.
* Select the slot pattern based on the dominant traffic direction.
* Consider wider channel bandwidths where additional spectrum is available.
* Validate RF quality before relying on higher-order MIMO or higher-order modulation.
* Design AP density around peak operational demand.
* Carefully evaluate uplink requirements for surveillance, telemetry, industrial automation, and sensor-heavy environments.
* Consider device capability when determining realistic throughput.
* Align the slot pattern, bandwidth, MIMO configuration, modulation, and RF design with the actual deployment requirements.

The resulting 5G capacity design should establish the capacity-driven cell count before coverage and architecture are finalized.

</details>

<details>

<summary><strong>Worked Example - Application Profile</strong></summary>

| Device            | Peak Concurrent | DL/Device | UL/Device | Class    |
| ----------------- | :-------------: | :-------: | :-------: | -------- |
| Handheld scanner  |        50       |  0.5 Mbps | 0.25 Mbps | Light    |
| IP camera (1080p) |        30       |     —     |   4 Mbps  | Heavy UL |
| Supervisor tablet |        10       |   5 Mbps  |   1 Mbps  | Moderate |

Handheld scanners generally transmit small bursts of data and receive work information.

IP cameras continuously transmit video to a recording or monitoring system, creating a significant uplink load.

Supervisor tablets receive dashboards and operational information and generate a smaller amount of uplink traffic.

</details>

<details>

<summary><strong>Worked Example - Total Throughput Demand</strong></summary>

Calculate the aggregate demand for each direction:

**Downlink**

```
Handheld scanners: 50 × 0.5 Mbps = 25 Mbps

IP cameras: 30 × 0 Mbps = 0 Mbps

Supervisor tablets: 10 × 5 Mbps = 50 Mbps

(50 × 0.5) + (30 × 0) + (10 × 5) = 25 + 0 + 50 = 75 Mbps DL
```

**Uplink**

```
Handheld scanners: 50 × 0.25 Mbps = 12.5 Mbps

IP cameras: 30 × 4 Mbps = 120 Mbps

Supervisor tablets: 10 × 1 Mbps = 10 Mbps

(50 × 0.25) + (30 × 4) + (10 × 1) = 12.5 + 120 + 10 = 142.5 Mbps UL
```

**Peak throughput requirement: 75 Mbps DL / 142.5 Mbps UL.**

The uplink requirement is approximately 1.9× the downlink requirement.

The cameras are the dominant uplink load, accounting for 120 of the 142.5 Mbps total UL requirement.

**Design Implication**

The deployment must be sized to satisfy the uplink requirement, because UL is the binding capacity constraint for this example.

</details>

<details>

<summary><strong>Worked Example - LTE Capacity Scenario</strong></summary>

**Scenario:** LTE (4G), CBRS (b48), Single Carrier, 40 MHz, Indoor (40 foot ceilings)

**DL:** 75 Mbps **UL:** 142.5 Mbps **Binding direction:** UL

Because this workload is strongly uplink-dominant, **SA6 (60% DL / 40% UL)** is selected.

The selected configuration provides 157 Mbps DL per cell and 72 Mbps UL per cell.

**Minimum cells — uplink (binding constraint)**

```
cell(142.5 Mbps UL demand ÷ 72 Mbps UL/cell) = 1.98 cells = 2 cells
```

**Minimum cells — downlink (check)**

```
cell(75 Mbps DL demand ÷ 157 Mbps DL/cell) = 0.47cell = 1 cell
```

**Required Cell Count: 2 cells**

The two-cell design delivers 314 Mbps DL capacity, 144 Mbps UL capacity, and 1.5 Mbps UL headroom.

</details>

<details>

<summary><strong>Worked Example - 5G Capacity Scenario</strong></summary>

**Scenario:** 5G · CBRS (n48) · Single carrier · 40 MHz · Indoor (40 ft ceilings).

**DL:** 75 Mbps **UL:** 142.5 Mbps **Binding direction:** UL

Because the workload is strongly uplink-dominant, the DDSUUUUUUU 10-slot pattern is selected.

For this example, use DL 4T / 256-QAM, UL 2T / 64-QAM, 40 MHz bandwidth, and the DDSUUUUUUU pattern.

**Minimum cells — uplink (binding constraint)**

```
cell(142.5 Mbps UL demand ÷ 169 Mbps ULcell) = cell(.84) = 1 cell
```

**Minimum cells — downlink (check)**

```
cell(75 DL demand ÷ 192 DL per cell) = ceil(0.39) = 1 cell
```

**Required Cell Count: 1 cell (uplink-bound)**

The resulting measured planning values are 192 Mbps DL per cell and 169 Mbps UL per cell.

**142.5 Mbps ÷ 169 Mbps = 0.84 cells → 1 cell**

**Required cell count = 1 cell**

The single-cell design provides 192 Mbps DL capacity, 169 Mbps UL capacity, and 26.5 Mbps UL headroom.

</details>

<details>

<summary><strong>LTE vs. 5G - Same 20 MHz Channel</strong></summary>

To isolate the pure LTE-vs-5G difference from the effect of CA, compare both technologies using the same device profile, site, and 20 MHz channel.

|                      | LTE (SA6)                | 5G (DDSUUUUUUU)              |
| -------------------- | ------------------------ | ---------------------------- |
| TDD configuration    | SA6 — 60% DL / 40% UL    | DDSUUUUUUU — 20% DL / 77% UL |
| Peak UL per cell     | 36 Mbps (UL 1T, 64-QAM)  | 103 Mbps (UL 2T, 256-QAM)    |
| Peak DL per cell     | 78 Mbps (DL 2T, 256-QAM) | 92 Mbps (DL 4T, 256-QAM)     |
| Capacity floor       | 4 cells                  | 2 cells                      |
| UL headroom at floor | 1.5 Mbps (tight)         | 63.5 Mbps (comfortable)      |
| Aggregate backhaul   | 456 Mbps                 | 390 Mbps                     |
| Backhaul requirement | 1 Gbps fiber             | 1 Gbps fiber                 |

For this uplink-heavy workload, the 5G configuration provides substantially more uplink capacity per cell.

{% hint style="warning" %}
**IMPORTANT:** This comparison illustrates the effect of the selected radio configurations for this workload. It should not be interpreted as a universal LTE-versus-5G cell-count rule.
{% endhint %}

</details>

<details>

<summary><strong>Capacity Design Output</strong></summary>

At the end of Step 1, the capacity assessment should establish:

* Peak downlink requirement
* Peak uplink requirement
* Binding traffic direction
* Selected technology
* Applicable LTE SA or 5G slot pattern
* Applicable channel bandwidth
* Applicable MIMO and modulation assumptions
* Capacity-driven cell count
* Preliminary aggregate backhaul requirement

These outputs establish the capacity floor for the deployment.

The capacity-driven cell count should then be carried into [*Step 2 — Coverage*](#step-2-coverage).

The final radio count is determined by the greater of the capacity requirement or coverage requirement.

</details>

#### Next Step

Next, proceed to [*Step 2 — Coverage*](#step-2-coverage) to determine whether the physical site and propagation environment require additional radios. The final radio count is determined by the greater of the capacity-driven requirement and the coverage-driven requirement.

## Step 2 - Coverage

Coverage design answers a different question from capacity: "*How many radios are required to provide usable coverage across the physical site?*"

[*Step 1 - Capacity*](#step-1-capacity) established the capacity-driven radio count. Step 2 determines the coverage-driven radio count. Together, these establish the range that the architecture must accommodate.

The final radio count is determined by whichever requirement is greater:

```
Final radio count = max(capacity-driven count, coverage-driven count)
```

### Do this in the Calculator

{% stepper %}
{% step %}
In the **Site & Coverage** panel, set:

* **Deployment Type** — Indoor or Outdoor
* **Environment** —
  * Indoor: Open Office/Showroom, Warehouse (Low Racks), Warehouse (Dense Racks)
  * Outdoor: Open Campus/Yard, Parking Lot/Loading Dock, Industrial Perimeter
* **Clutter Level** — (Independent of **Environment**) Low / Medium / High
* **UL Device Class** — Handset / External Antenna / CPE
* **Region** — US (CBRS) or UK/EU/AU
* **Total Site Area** — In sq ft, sq m, or acres

<p align="center"><strong>Figure: ROM Calculator — Site &#x26; Coverage Panel</strong></p>

<div data-with-frame="true"><figure><img src="https://2839344875-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcsOm7izkwc75UBmow1N0%2Fuploads%2Foyg5eV6c4XnbpoCcsgM9%2Fimage.png?alt=media&amp;token=85144bfc-09e4-4b4c-b8b9-2aa243811126" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the **Estimated APs** panel, review:

* **Coverage estimate** — Shows the number of APs required to provide coverage based on the selected site characteristics.
* **sq ft/AP** — Shows the effective coverage baseline and multipliers used by the calculator.

For example, the calculator may display a calculation such as:

```
25,000 × 1 (clutter) × 1.25 (auto) × 1 (stance)
```

This provides visibility into how the calculator arrived at the coverage estimate.

<div data-with-frame="true"><figure><img src="https://2839344875-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcsOm7izkwc75UBmow1N0%2Fuploads%2Fc4Q38Xy1PCZ72UCmNZuU%2Fimage.png?alt=media&amp;token=ecd2e03b-1b74-47ef-9838-49294d4eb06b" alt=""><figcaption></figcaption></figure></div>

{% hint style="info" %}
**NOTE**: In case of segmented sites, the calculator evaluates one Environment / Clutter combination per run. It does not automatically segment a mixed site into different coverage zones. If a site contains a warehouse floor, office area, loading dock, and outdoor yard, evaluate each zone separately and combine the resulting requirements.
{% endhint %}

{% hint style="warning" %}
**IMPORTANT:** Do not treat the entire site as a single coverage zone when different areas have significantly different propagation characteristics, mounting conditions, or operational requirements.
{% endhint %}
{% endstep %}
{% endstepper %}

### **Understanding the Methodology**

#### **Gathering Coverage Requirements**

Before estimating the radio count, capture the physical and operational characteristics of the site.

* **Total area** — Record the total site area and separate indoor and outdoor areas where appropriate.
* **Site segmentation** — Identify areas that require separate coverage treatment, such as warehouse floors, mezzanines, loading docks, offices, yards, and outdoor operational areas.
* **Indoor/outdoor mix** — Identify the proportion of indoor and outdoor coverage and any transition areas between them.
* **Terrain and clutter** — Document conditions that can affect propagation, including open floor areas, racks, machinery, containers, walls, terrain changes, and building-to-building distances.
* **Ceiling and mounting height** — Record AP mounting heights and identify significant variations across the site.
* **Mobility profile** — Identify how devices move through the coverage area: Stationary devices, pedestrians, forklifts, AGVs, vehicles, or other mobile devices.
* **Coverage requirements** — Identify where service is required and the performance expected in each area.

{% hint style="warning" %}
**Common mistake to avoid**: Do not treat the entire site as a single coverage zone. A warehouse floor, loading dock, office area, and outdoor yard may have very different propagation characteristics, mounting heights, obstructions, device densities, mobility patterns, coverage requirements. Segment the site first, then estimate coverage for each zone.
{% endhint %}

<details>

<summary><strong>Coverage Rules of Thumb</strong></summary>

The following values provide initial planning estimates for radio count. They are not substitutes for an RF design. Actual radio count depends on frequency, antenna configuration, mounting height, propagation environment, required signal level, interference, mobility, and application requirements.

**Indoor Coverage Estimates**

<table><thead><tr><th>Clutter</th><th>Example</th><th width="134">Avg. Height</th><th>Coverage per AP</th><th>AP Density</th></tr></thead><tbody><tr><td>Low</td><td>Open office space, minimal walls, mostly LOS</td><td>125 ft</td><td>~25,000 sq ft</td><td>4 APs</td></tr><tr><td>Medium</td><td>Open warehouse spaces with low to medium shelves, miscellaneous layout, some partitions</td><td>80 ft</td><td>~20,000 sq ft</td><td>5–6 APs</td></tr><tr><td>High</td><td>Manufacturing floor / Warehouse with dense walls, high metal racks, cold storage, heavy machinery</td><td>50 ft</td><td>~7,000 sq ft</td><td>13–15 APs</td></tr></tbody></table>

**Outdoor Coverage and Capacity Estimates (Omni Antennas)**

| Design Intent     | Area              | Radius   | AP Count  | Notes                                                                                                             |
| ----------------- | ----------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------------------- |
| Coverage-Oriented | \~1,000,000 sq ft | \~800 ft | \~1 AP    | Assumes 47 dBm EIRP, wide-area mobility. Corresponds to "Open Campus / Yard" in the table below.                  |
| Capacity-Oriented | \~300,000 sq ft   | \~440 ft | \~3–4 APs | Higher device density, uplink-heavy applications. Corresponds to "Parking Lot / Loading Dock" in the table below. |

**Outdoor Range by Directional Antennas (33°–120° Beamwidth)**

| Device Class        | Range           | Conditions                                                            |
| ------------------- | --------------- | --------------------------------------------------------------------- |
| Smartphones/Tablets | 2,500–5,000 ft  | Standard beamwidth, Line of Sight (LOS) or near-LOS, RSRP to -110 dBm |
| CPE with High-Gain  | Up to 12,000 ft | Specialized antennas, optimal alignment, high-SINR, LOS required      |

**Outdoor Coverage Estimates by Environment**

| Environment                |   Height |     Radius | Area                          |
| -------------------------- | -------: | ---------: | ----------------------------- |
| Open Campus / Yard         | 20–30 ft | 700–800 ft | \~1,000,000 sq ft (coverage)  |
| Parking Lot / Loading Dock | 12–20 ft | 400–500 ft | \~300,000 sq ft (capacity)    |
| Industrial Perimeter       | 25–35 ft | 500–750 ft | 400,000–800,000 sq ft (mixed) |

**Outdoor Coverage Considerations**

The estimates above assume omnidirectional external antennas unless otherwise specified.

When planning outdoor coverage:

* Set AP spacing according to the actual coverage and capacity objectives.
* Account for buildings, foliage, machinery, vehicles, containers, and other RF obstructions.
* Consider directional antennas where range, uplink performance, or interference control is a priority.
* Consider the frequency band and applicable regional regulatory requirements when estimating achievable coverage.
* Validate outdoor propagation before finalizing AP and antenna placement.
* Consider uplink performance as well as downlink coverage, particularly for surveillance, telemetry, and industrial applications.

</details>

#### How the Calculator Estimates Coverage

The ROM Calculator starts with a baseline area per AP and applies multipliers based on the deployment characteristics.

The coverage formula used by the calculator:

```
APs_cov = ⌈ Area ÷ (Base × Clutter × Auto × Stance) × (1 + Buffer) ⌉
```

Where:

* **Base** = 25,000 / 17,500 / 10,000 sq ft/AP indoors (Coverage / Balanced / Capacity-oriented design intent — auto-derived, scored from Density + DL/UL throughput + Use Case, no manual goal needed), or an outdoor environment baseline × the same intent factor (1.0 / 0.70 / 0.45).
* **Clutter** = Low 1.0× · Medium 0.8× · High 0.6×.
* **Auto** = `min(DLscale, ULcap)`, where DLscale reflects your Channel BW (US) or AP Power Class (EMEA), and ULcap depends on UL Device Class (Handset 1.1× · Ext. Antenna 1.25× · CPE 1.5×).

  <table><thead><tr><th width="150">Region</th><th>Formula</th></tr></thead><tbody><tr><td>US (5G)</td><td><code>DLscale = 10^(10·log10(BW/20)/10)</code> —<br>20 MHz=1.0×, 40 MHz=2.0×, 100 MHz=5.0×</td></tr><tr><td>EMEA (5G)</td><td><code>ΔP = 10·log10(P/5W)</code>; <code>DLscale = 10^(ΔP/10)</code> — e.g. 40 W ≈ +9 dB</td></tr></tbody></table>
* **Stance** = Your Planning Stance multiplier (Conservative / Prudent / Opportunistic, set in the **Planning Parameters** panel — see [*What to bring*](#what-to-bring)).

#### Next Step

Next, proceed to [*Step 3 - Architecture*](#step-3-architecture) to determine how the capacity-driven and coverage-driven radio counts come together into a deployable Onyx network. Architecture resolves where you land between the capacity floor established in [*Step 1*](#step-1-capacity) and the coverage ceiling established here — determining the Shared Cell or Multi-Cell configuration, fronthaul topology, Onyx Edge server requirements, switching, and backhaul needed to support the final radio count.

## Step 3 - Architecture

Architecture design converts the capacity and coverage requirements into a deployable Onyx network. It determines how the required cells and radios are organized, connected, and deployed across the site.

Capacity determines how many cells are required. Coverage determines how many radios are required. Architecture determines how those cells and radios are organized and connected.

The architecture should answer:

* How many radios and cells are required?
* Which Onyx architecture best fits the deployment?
* How should the radios be connected?
* What fronthaul architecture is required?
* How many Onyx Edge servers are required?
* What switching is required?
* What backhaul is required?
* What redundancy or availability requirements apply?
* What architecture-specific RF and installation components are required?

### Do this in the Calculator

{% stepper %}
{% step %}
Once Capacity and Coverage inputs are set, review the following cards:

* **Architecture Recommendation** — e.g., "5G Multi-Cell (Standard)" or "Shared Cell 1×8," with a short rationale and specs (MIMO, bandwidth, handover behavior).<br>

  <div data-with-frame="true"><figure><img src="https://2839344875-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcsOm7izkwc75UBmow1N0%2Fuploads%2FeG5jyeELuUoisy67YFHH%2Fimage.png?alt=media&amp;token=28cc230b-384c-4933-b577-9dbfbb8775a9" alt=""><figcaption></figcaption></figure></div>
* **Frame Structure Recommendation** (LTE SA / 5G slot pattern) — Your recommended pattern, starred (\*), alongside the alternatives and their DL:UL ratio and Mbps, so you can see why one was preferred.<br>

  <div data-with-frame="true"><figure><img src="https://2839344875-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcsOm7izkwc75UBmow1N0%2Fuploads%2FrvpPhH0iHmfIESGCFFKC%2Fimage.png?alt=media&amp;token=97e614d8-00d3-40cd-9daa-304c5c8a0025" alt=""><figcaption></figcaption></figure></div>
* **Shared Cell Configuration Guide** — RUs/cell, resulting cell count, and handoffs for 1×8, 2×4, and 4×2 configurations. This table only appears when Shared Cell itself is the recommended architecture, not when Multi-Cell is recommended and Shared Cell is offered only as an alternative.<br>

  <div data-with-frame="true"><figure><img src="https://2839344875-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcsOm7izkwc75UBmow1N0%2Fuploads%2FnwUZm8SRi4jIf1TsvbUW%2Fimage.png?alt=media&amp;token=b86b3de9-4192-455f-894c-2ea4ce580006" alt=""><figcaption></figcaption></figure></div>

**Explore Alternatives is genuinely contextual, not a fixed list.** The suggestions in the sidebar change based on your current inputs — e.g., "Add continuous mobility" only appears for use cases like AGVs; "Switch to 5G NR" only appears while LTE is selected; "What if clutter is higher?" appears once other high-impact levers have already been tried. Use it to pressure-test a design before committing to it.
{% endstep %}
{% endstepper %}

### **Architecture Options**

Depending on the deployment requirements, an Onyx architecture may include one or more of the following approaches:

* **Shared Cell** — Shared Cell architectures distribute radio resources across multiple antenna locations and can provide consistent coverage across larger areas. Use Shared Cell where a distributed RF architecture is appropriate for the physical environment and traffic requirements.
* **Direct Attach** — Direct-attach architectures connect supported APs directly to the appropriate Onyx Edge infrastructure. This approach can be appropriate for smaller or simpler deployments where a distributed architecture is not required.
* **DAS** — DAS integration can be used where RF distribution across multiple areas, floors, or complex building structures is required.
* **Mesh** — Mesh-enabled APs can extend the deployment into areas where wired infrastructure is limited or unavailable. Mesh should be evaluated against throughput, latency, reliability, and backhaul requirements before selection.
* **Sectorized Outdoor Architecture** — Outdoor deployments may use sector antennas to provide directional coverage, improve range, manage interference, or concentrate capacity where devices are located.

{% hint style="info" %}
**What the calculator doesn't model:** Multi-floor DAS designs, and whether Mesh is the right call for a specific backhaul-limited zone. These still need the manual guidance below.
{% endhint %}

**TDD Frame Direction**

LTE and 5G TDD configurations allocate radio resources between downlink and uplink traffic. The appropriate configuration depends on the dominant traffic direction established during capacity planning.

| Use case                             | Calculator's stated rule | Actual output (5G, default inputs) | Matches stated rule? |
| ------------------------------------ | ------------------------ | ---------------------------------- | -------------------- |
| Video Surveillance & Broadcast       | UL-dominant → 2D1S7U     | **2D1S7U** (38:100, UL-Dominant)   | Yes                  |
| Machine Vision & Real-time Control   | UL-dominant → DSUUU      | **DSUUU** (24:44, UL-Leaning)      | Yes (directionally)  |
| Logistics, AGVs & Automated Vehicles | DL-dominant → DDDSU      | **DDDSU** (52:16, DL-Leaning)      | Yes                  |
| AR/VR & High-bandwidth Immersive     | DL-dominant → DDDSU      | **DDDSU** (52:16, DL-Leaning)      | Yes                  |
| IoT, Telemetry & Sensors             | "Balanced" → DDDSU       | **DSUUU** (24:44, UL-Leaning)      | **No**               |
| General Enterprise / Voice & Data    | "Balanced" → DDDSU       | **DDDSU** (52:16, DL-Leaning)      | Yes                  |

**Shared Cell trade-off, per the calculator's Shared Cell Configuration Guide:**

| Config | RUs/Cell | Cells | Handoffs | Best for                     |
| ------ | -------: | ----: | -------: | ---------------------------- |
| 1×8    |        8 |     1 |        0 | Max mobility · coverage      |
| 2×4    |        4 |     2 |        1 | Balanced capacity + mobility |
| 4×2    |        2 |     4 |       ≤3 | Max density · high-traffic   |

Reconfiguring between these is software-only in Onyx Orchestrator — no hardware changes or redeployment. Start with 1×8 and reconfigure as device density grows.

**Indoor Architecture Considerations**

For indoor deployments:

* Use Shared Cell or DAS architectures where consistent signal distribution is required across multiple areas.
* Consider distributed antenna layouts for large open environments with high user mobility.
* Use appropriate Shared Cell configurations for high-density user or device environments.
* Use DAS where multi-floor facilities or complex building layouts make conventional AP placement impractical.
* Optimize AP placement to reduce dead zones and improve mobility and roaming behavior.
* Account for racks, machinery, walls, mezzanines, and other RF obstructions.
* Validate coverage and capacity across operational areas rather than only along building perimeters.

**Outdoor Architecture Considerations**

For outdoor deployments:

* Use Mesh-enabled APs where wired infrastructure is limited or unavailable.
* Use sector antennas where directional coverage, range, capacity, or interference control is required.
* Design around physical obstructions such as vehicles, containers, machinery, buildings, and terrain.
* Account for mobility patterns across campuses, logistics yards, ports, and industrial sites.
* Validate RF propagation across all required operational areas.
* Consider uplink performance as well as downlink coverage when positioning outdoor APs and antennas.
* Evaluate wireless backhaul capacity and latency when using Mesh.

#### Architecture Design Output

At the end of Step 3, you should have established:

* Required cell count
* Required AP/RU count
* Selected architecture
* Shared Cell configuration, where applicable
* Fronthaul topology
* Onyx Edge requirements
* Switching requirements
* Backhaul requirements
* Mobility and handover considerations
* Redundancy and availability requirements
* Architecture-specific RF components

This defines how the capacity and coverage requirements will be implemented as a physical and logical Onyx network.

#### Next Step

Next, proceed to [*Step 4 — Accessories*](#step-4-accessories) to identify the equipment, RF components, installation hardware, and other items required to build the preliminary BoM.

## Step 4 - Accessories

This is the final step in the ROM design workflow. Unlike Capacity, Coverage, and Architecture, the ROM AP Calculator does not automate this step.

Once the required AP count, coverage approach, and architecture have been established, identify the equipment and installation components required to deploy the system and complete the preliminary BoM.

The calculator's Print/PDF export can be used as supporting material for an early quote request, but it is not a parts-level BoM.

### What to Include in the BoM

The final BoM should include every component required to deploy and operate the selected architecture.

* Network Components — Include the network infrastructure required to connect and operate the cellular system. The exact components depend on the architecture selected in [*Step 3 - Architecture*](#step-3-architecture).
  * Onyx Edge servers or gateways
  * Access Points (APs)
  * Fronthaul Multiplexers (FHMs), where required
  * Ethernet or fiber switches
  * SFPs and other optical transceivers
  * Backhaul connectivity
* RF Components — Include the RF components required to provide the planned coverage:

  * Antennas
  * Antenna cables
  * RF connectors
  * Mounting hardware
  * Sector antennas, where applicable
  * DAS components, where applicable

  For outdoor deployments, also account for the appropriate mounting and environmental requirements.
* Subscriber Components — Include the components and information required to provision devices on the network:

  * SIMs
  * Subscriber/device inventory
  * Device-specific connectivity requirements

  The required subscriber components depend on the device population and deployment model.
* Installation Components — Include the physical infrastructure required to install and operate the equipment:
  * AP mounting hardware
  * Rack hardware
  * Fiber cabling
  * Ethernet cabling
  * Power requirements
  * Grounding and surge protection, where required
  * Outdoor-rated enclosures, where applicable
  * Outdoor mounting components, where applicable

## Getting a Full Estimate

The BoM components above cover the equipment required for a given architecture, but several accessory quantities — antenna and cable counts, FHM requirements, RU/gNodeB configuration, and outdoor-unit accessories — depend heavily on the specific deployment's physical layout and are not produced by the calculator. Adding these manually without confirming they apply to your design can significantly overstate the estimate.

For a validated BoM and a formal quote, contact GXC Sales with the outputs from your ROM Calculator session. GXC Sales will confirm the accessory and configuration details — such as tenant/antenna counts, FHM requirements, and RU or outdoor-unit accessories — that apply to your specific deployment.

## Contact GXC Sales

To convert the preliminary BoM into a priced, deployment-ready quote, contact [GXC Sales](https://www.gxc.io/contact-us). Sales involvement is especially useful when your design includes an outdoor unit, since outdoor accessories, tenant/antenna counts, and other site-dependent components are best confirmed before final pricing.


# Deploy Your First Network

Between a validated design and a network carrying real traffic there are seven stages. What follows is a map rather than a manual: each stage links to the operations guide that documents it in full.

Read it end to end before you begin. Several stages have prerequisites that are painful to discover late.

{% hint style="info" %}
**NOTE**: The steps below assume you have a design and hardware on site. If you are still sizing the network, start with [*Plan Your Network*](/plan-your-network). If you are still deciding whether private cellular fits, start with [*Is Onyx Right for You?*](/is-onyx-right-for-you).
{% endhint %}

## Before you start

Have these settled. Each one blocks a later stage.

| Prerequisite                      | Why it blocks                                                                                                                                                                     |
| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Spectrum access confirmed**     | On CBRS, radios cannot transmit until the SAS authorises them. Outside the US, a local license must be in hand.                                                                   |
| **CPI arranged** (CBRS only)      | A Certified Professional Installer must verify and sign each radio's installation record. Certification is held by an individual: line one up before installation day, not after. |
| **Site prepared**                 | Rack space, power, and cooling for Onyx Edge. Fronthaul cabling to every radio location. Mounting, and for outdoor units enclosures, grounding, and surge protection.             |
| **Onyx Portal account activated** | Portal access requires account activation and MFA enrolment.                                                                                                                      |
| **Networking mode decided**       | NAT or Bridge determines how Onyx integrates with your LAN. Changing it later means reconfiguring the network.                                                                    |
| **SIMs on hand**                  | Devices cannot attach without provisioned credentials.                                                                                                                            |
| **Device compatibility verified** | Confirm your actual device population supports your band against [*End Devices*](https://docs.gxc.io/devices).                                                                    |

### Decide NAT or Bridge now

This choice shapes everything downstream, so make it deliberately.

**NAT mode**: Onyx Edge acts as a secure gateway between the private RAN and your enterprise network. It assigns device IP addresses from a local pool, and NAT on the N6 interface means your LAN sees only the Onyx Edge address. Devices, APs, and FHMs are not directly reachable from the enterprise network. Choose this for strong isolation and simple IP management, where you do not need to reach individual devices.

**Bridge (APN-on-VLAN) mode**: Onyx Edge bridges device traffic directly into enterprise VLANs with no NAT. Each APN maps to a dedicated VLAN, your own DHCP assigns device addresses, and devices appear as native enterprise devices with full visibility and policy control. The N6 interface becomes a VLAN trunk. Choose this for deep integration with existing enterprise routing, security, and management tooling.

Bridge mode is also what makes per-device-group segmentation possible, so if network segmentation matters to your security posture, it is the stronger choice. See the [*5G Onyx Portal 4.x Operations Guide*](/docs/network-configuration-and-operations-guides/5g-onyx-portal-4.x-operations).

## The sequence

Work through these in order. Each stage depends on the one before it.

{% stepper %}
{% step %}

### Get into the Portal

Activate your Onyx Portal user account, install an authenticator app, and complete MFA enrolment. Store your MFA backup codes somewhere you will still be able to reach them if you lose the device.

Where your organization uses an identity provider, the Portal supports SSO instead, see the [*5G Onyx Portal 4.x Operations Guide*](/docs/network-configuration-and-operations-guides/5g-onyx-portal-4.x-operations).

→ [*5G Onyx Portal 4.x Operations Guide*](/docs/network-configuration-and-operations-guides/5g-onyx-portal-4.x-operations)
{% endstep %}

{% step %}

### Install the hardware

Rack and power the Onyx Edge. Mount radios at the locations your coverage plan specifies and run fronthaul to each. Where an FHM is in the design, cable the RUs to it and the FHM to the Edge.

Record the exact installed position of every radio as you go: geographic coordinates, height above ground level, azimuth, downtilt, and antenna gain. On CBRS these are the values the CPI certifies and the SAS registers, and they must match physical reality. Capturing them during installation is far easier than deriving them afterwards.

→ Per-model installation guides under [*Onyx Hardware*](https://docs.gxc.io/hw/onyx-hardware/gxc-5g-and-lte-hardware)
{% endstep %}

{% step %}

### Create the venue

A venue represents the physical site. Create it first: equipment is placed within it.

Upload and calibrate floor plans while you are here. Calibration is what makes equipment positions and coverage visualisation meaningful later, and it is quick to do now and tedious to retrofit.

→ [*5G Onyx Portal 4.x Operations Guide*](/docs/network-configuration-and-operations-guides/5g-onyx-portal-4.x-operations)
{% endstep %}

{% step %}

### Create the network

Create the network under the correct customer account, then configure Core and RAN parameters: including the networking mode you decided above.

{% hint style="warning" %}
**NOTE**: Network creation requires GXC Administrator, Partner Administrator, or Super Administrator privileges, and networks can only be created under customer accounts. Confirm you have the right role and the right account selected before you start.
{% endhint %}

→ [*5G Onyx Portal 4.x Operations Guide*](/docs/network-configuration-and-operations-guides/5g-onyx-portal-4.x-operations)
{% endstep %}

{% step %}

### Add the equipment

Register the Onyx Edge, then the APs, then the FHM and any Mesh Nodes. Place each on the venue floor plan as you add it.

→ [*5G Onyx Portal 4.x Operations Guide*](/docs/network-configuration-and-operations-guides/5g-onyx-portal-4.x-operations)
{% endstep %}

{% step %}

### Register with the SAS: CBRS only

Radios on CBRS cannot transmit until the SAS authorises them. The full workflow runs: CPI account setup, deployment creation in the SAS portal, CBSD records for each radio, CPI signing, SAS parameter configuration in the Onyx Portal, then grant verification.

Onyx handles SAS communication through an integrated Domain Proxy, so you manage this from the Portal rather than radio by radio. Large or DAS deployments can use bulk registration.

Expect this stage to take longer than the others. It involves an external portal, a credentialed individual, and a regulator's system.

→ [*Private 5G Spectrum and Regulations*](/private-5g-spectrum)
{% endstep %}

{% step %}

### Create subscriber groups, then subscribers

Groups come first: a subscriber account is assigned to a group, and the group carries the QoS and policy that applies to its devices.

Define groups along the lines your workloads actually need. Cameras, handhelds, AGVs, and laptops have genuinely different requirements, and separating them here is what lets you police them independently later. Collapsing everything into one group is the most common day-one mistake, and it removes your ability to protect critical traffic under load.

Then create subscriber accounts and provision SIMs. Bulk assignment is available for larger fleets. Enable IMEI verification where the device population is known: it binds each SIM to authorised hardware and blocks SIM-swap attacks.

→ [*5G Onyx Portal 4.x Operations Guide*](/docs/network-configuration-and-operations-guides/5g-onyx-portal-4.x-operations)
{% endstep %}

{% step %}

### Attach a device and verify

Insert a provisioned SIM, confirm the device attaches and gets an address, and run a subscriber speed test from the Portal.

Then verify the network rather than the single device:

* **Coverage**: walk the site and check signal at the planned worst-case points, not just near the radios.
* **Uplink under load**: for most workloads the uplink binds first. Test it with several devices active, not one.
* **Mobility**: move a device across the full coverage area while a session is open. On a Shared Cell deployment there should be no handover interruption at all.
* **Alerts**: confirm alerts are configured and reaching someone.

→ [*5G Onyx Portal 4.x Operations Guide*](/docs/network-configuration-and-operations-guides/5g-onyx-portal-4.x-operations)
{% endstep %}

{% step %}

### Apply QoS

With traffic flowing, map each workload to the right 3GPP 5QI so applications share spectrum without competing. This is what keeps a control loop responsive while a firmware download runs.

Give bulk traffic (firmware, backups) a low-priority non-GBR class and a schedule. Left unclassified, it will contend with production traffic at the worst moment.

[*Use Cases*](https://docs.gxc.io/usecases-workflows/) list throughput, latency, and 5QI mapping for common workflows.

→ [*5G Onyx Portal 4.x Operations Guide*](/docs/network-configuration-and-operations-guides/5g-onyx-portal-4.x-operations)
{% endstep %}
{% endstepper %}

## Before you call it done

* **Security posture reviewed**: segmentation applied, firewall policy in place, RBAC roles assigned, MFA enforced. See [*Security and Compliance*](/security-and-compliance).
* **Log export configured**, if your compliance regime needs retention beyond the Portal's 60 days.
* **Alerts routed** to someone who will act on them.
* **An owner named.** A private network is infrastructure. Subscriber lifecycle, firmware updates, alert response, and (on CBRS) the SAS relationship all need a person.

## Related reading

* [*5G Onyx Portal 4.x Operations*](/docs/network-configuration-and-operations-guides/5g-onyx-portal-4.x-operations): the complete 5G operations guide
* [*4G Onyx Portal 4.x Operations*](/docs/network-configuration-and-operations-guides/4g-onyx-portal-4.x-operations): the LTE equivalent
* [*4G Onyx Edge On-Premises 4.x Installation and Operations*](/docs/network-configuration-and-operations-guides/4g-onyx-edge-on-premises-4.x-installation-and-operations): Edge software installation and upgrade
* [*5G Onyx Portal 4.x Alerts Reference*](https://docs.gxc.io/docs/network-configuration-and-operations-guides/5g-onyx-portal-4.x-alerts-reference): every alert and what it means

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# Security and Compliance

Enterprises adopt private cellular partly for security: a network whose access is controlled by SIM credentials you issue, carrying traffic that never leaves your site. What follows is how Onyx delivers that, and where your responsibilities begin.

It is an orientation, not a specification. For the full control-by-control detail, see the [*Onyx Security Specification*](/docs/onyx-software/onyx-security-specification).

## Why private cellular starts ahead

Two properties are structural, not features that have to be configured:

**Access is cryptographic, not shared-secret.** There is no password to leak. A device joins because it holds a SIM or eSIM credential you provisioned, authenticated by 4G/5G AKA with Milenage challenge-response. Revoking access means revoking a credential in the Onyx Portal: it takes effect network-wide, immediately.

**Traffic can be made not to leave the building.** In an on-premises deployment, the user plane and control plane both terminate on the Onyx Edge appliance at your site. Application data is handed to your enterprise network locally. Only minimal operational metadata reaches GXC's cloud Orchestrator.

## The three planes

Cellular networks separate traffic into three planes, and Onyx secures each differently. Understanding this split is what makes the rest of the security model legible.

<table><thead><tr><th width="180">Plane</th><th>Carries</th><th>Where it terminates (on-premises)</th></tr></thead><tbody><tr><td><strong>User plane</strong></td><td>Application traffic: the actual data payloads moving between devices and your services</td><td>Onyx Edge, on site</td></tr><tr><td><strong>Control plane</strong></td><td>Signaling that establishes sessions, authenticates devices, and enforces mobility and QoS</td><td>Onyx Edge, on site</td></tr><tr><td><strong>Management plane</strong></td><td>Configuration, monitoring, orchestration, authentication records, logs</td><td>Onyx Portal / Orchestrator, cloud or on-prem</td></tr></tbody></table>

{% hint style="info" %}
**NOTE**: Your enterprise network is deliberately unaware of control plane and management plane operations. It sees user plane traffic handed off at the Onyx Edge and nothing else.
{% endhint %}

### Deployment model changes the boundary

**On-premises (4G and 5G)**: user and control plane traffic terminate locally. Sensitive application and session data stays inside enterprise boundaries. This is the stronger data-sovereignty position and the default assumption throughout this documentation.

**Cloud (4G)**: traffic is routed to a cloud-hosted Onyx Edge over encrypted transport, with IPSec tunnels between the Onyx APs and the Edge using AES-CBC-128 with HMAC-SHA2-256-128 integrity protection. Faster to deploy, no on-site infrastructure, but the data boundary moves.

If data sovereignty is a hard requirement, choose on-premises. Confirm this before the architecture step, because it is expensive to change afterwards.

## How each plane is protected

### User plane

Over the air, traffic between the device and the network is ciphered and integrity-protected: up to 128-EEA2 / 128-EIA2 on 4G, and up to 128-NEA3 / 128-NIA3 on 5G on-premises.

Inside the enterprise, **APN-mapped VLANs isolate traffic by device group**. This is the control that matters most in practice and the one most often left unconfigured. It lets you place cameras, handhelds, and AGVs on separate subnets with separate policies, with DHCP-based assignment giving precise IP tracking. Segmentation you would apply to any other enterprise network applies here too, but you have to apply it.

Onyx does not persist user plane data. It remains in volatile memory and is never stored.

You can layer your own end-to-end protection (TLS or VPN between the device and your application services) on top of all of this, and for sensitive workloads you should.

### Control plane

* **NAS signaling is encrypted** between device and Onyx Edge, using SNOW-3G and AES-CTR across 4G (128-EEA1/EEA2) and 5G (128-NEA1/NEA2).
* **SUCI encryption** (5G on-premises) conceals subscriber identifiers using AES-128-CTR with HMAC-SHA-256, per 3GPP Profile A. This is what prevents permanent subscriber identifiers being harvested over the air.
* **IMSI Lock with IMEI binding** ties a SIM or eSIM to specific authorised hardware, blocking SIM transfers, SIM-swap attacks, and device impersonation. Worth enabling wherever the device population is known and stable.

### Management plane

* **TLS 1.2/1.3** secures management traffic across all components, using ECDHE-RSA-AES-128-GCM-SHA256, DHE-RSA-AES-256-GCM-SHA384, AES-256-GCM-SHA384, and AES-128-GCM-SHA256 cipher suites.
* **Software updates are cryptographically signed** and verified before installation.
* **SIM/eSIM credentials and authentication tokens** move from the Orchestrator to the Onyx Edge over encrypted channels only.
* **At rest**, management data is encrypted; credentials are protected by AWS key management services; backups are encrypted with geographic redundancy; AWS IMDSv2 protects instance metadata.

## Administrative access

### Onyx Portal

* **Tenant isolation**: each partner and customer tenant runs in a logically isolated environment, preventing cross-tenant exposure.
* **SSO with MFA**, plus CAPTCHA/reCAPTCHA against automated credential abuse, and bcrypt-hashed credentials against brute-force and rainbow-table attacks.
* **RBAC** enforces least privilege across all Portal functions.
* **Enterprise IdP integration** aligns Portal authentication with your existing identity framework. See [*4G & 5G Onyx Portal Integration with Customer IdP*](https://docs.gxc.io/docs/application-notes/4g-and-5g-onyx-portal-integration-with-customer-idp) and [*4G & 5G Onyx Portal MFA*](https://docs.gxc.io/docs/application-notes/4g-and-5g-onyx-portal-mfa).
* **AWS WAF** guards the web interface; **AWS GuardDuty** watches for infrastructure threats and anomalies.
* **Audit logging** covers all access, configuration, and authentication events, retained for **60 days**.

{% hint style="warning" %}
**NOTE**: Audit log retention is 60 days. If your compliance regime requires longer, export logs to your own SIEM through the API integration before they age out.
{% endhint %}

### Equipment access

| Component     | Access model                                                                                                                                                                                                                                                                                             |
| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Onyx Edge** | Key-based SSH and local console for the `agw_user` account, for basic debug, service restart, and reboot. Portal users get RBAC-restricted diagnostic commands. GXC Engineering holds direct key-based SSH for troubleshooting. Network port exposure is limited by design. All operations audit logged. |
| **Onyx AP**   | Generally isolated from the enterprise network, with no direct access. Configuration and updates arrive via the Onyx Edge. GXC Engineering has authenticated access for troubleshooting. All changes audit logged.                                                                                       |
| **Mesh Node** | Managed via the Onyx Edge, no direct network access. All changes audit logged.                                                                                                                                                                                                                           |
| **FHM** (5G)  | Managed via the Onyx Edge, no direct network access. All changes audit logged.                                                                                                                                                                                                                           |

### Third-party API integrations

Exporting telemetry and logs to external systems is **optional and entirely under your control**. Where enabled, integrations use tokenised, tightly scoped connections with short-lived tokens and continuous validation. All third-party API access is audit logged, with the same 60-day retention.

## Certifications

* **SOC 2 Type I** - affirms GXC's internal controls for safeguarding customer data.
* **FCC Part 96** - certified for shared CBRS spectrum use in the United States. See [*Private 5G Spectrum and Regulations*](/private-5g-spectrum).

Per-model regulatory compliance appendices are published in each hardware installation guide.

## What remains yours

Onyx secures the network. It does not secure everything that touches the network. These are yours to own:

* **Network segmentation** - configuring APN-mapped VLANs and subnet policy so device groups are actually isolated from one another.
* **Firewall policy** - filtering at the boundary between the Onyx Edge and your enterprise network. Firewall configuration requirements are provided on request; see [*4G & 5G Firewall Configuration for Onyx Networks*](/docs/application-notes/4g-and-5g-firewall-configuration-for-onyx-networks).
* **Application-layer security** - TLS or VPN between devices and your services, for anything sensitive.
* **Credential lifecycle** - provisioning SIMs, and revoking them promptly when a device is lost, retired, or reassigned.
* **Portal access governance** - RBAC role assignment, MFA enforcement, and periodic access review.
* **Log retention beyond 60 days**, where your compliance regime requires it.

***

## Related reading

* [*Onyx Security Specification*](/docs/onyx-software/onyx-security-specification): the complete control-by-control detail, with data flow and sequence diagrams
* [*Private 5G Spectrum and Regulations*](/private-5g-spectrum): spectrum licensing and regulatory obligations
* [*5G Onyx Portal 4.x Operations Guide*](/docs/network-configuration-and-operations-guides/5g-onyx-portal-4.x-operations): how Onyx integrates with enterprise network topology
* [*Glossary*](/glossary): AKA, NAS, SUCI, IMSI, APN, RBAC, and related terms

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# Glossary

This glossary defines terms commonly used across GXC’s product interfaces and documentation.

***

### 0-9

#### 3GPP

**3rd Generation Partnership Project** – A global collaboration of regional standards organizations responsible for developing and maintaining specifications for mobile communication technologies, including 3G, 4G LTE, and 5G. 3GPP ensures interoperability and consistency across global cellular networks.

#### 4G

**4th Generation Cellular** – A mobile communication standard developed by 3GPP that offers higher data speeds, lower latency, and improved spectral efficiency compared to 3G. Technologies under 4G include LTE and LTE-Advanced.

#### 5G

**5th Generation Cellular** – The latest mobile communication standard developed by 3GPP, designed to provide ultra-high data rates, low latency, massive device connectivity, and support for emerging use cases such as autonomous systems, IoT, and immersive media.

#### 5G Core

GXC’s embedded 5G Core network supporting 5G [*SA*](#sa) architecture, with core functions including [*AMF*](#amf), [*SMF*](#smf), [*UPF*](#upf), and [*UDM*](#udm). It provides subscriber management, mobility management, session management, user-plane processing, and connectivity to external data networks for private 5G deployments.

***

### A

#### ACS

**Auto-Configuration Server** – Manages [*AP*](#ap) configuration and prioritization in [*Onyx Edge Pools*](#onyx-edge-pool).

#### AES

**Advanced Encryption Standard** – A symmetric encryption algorithm widely used in GXC networks for securing user traffic, signaling, and configuration data. AES is recognized for its strong security and efficiency, supporting key sizes of 128, 192, or 256 bits.

#### AGL

**Above Ground Level** - The height of an antenna measured relative to the ground directly beneath the installation site.

#### agw\_user

A limited-privilege user account in the Onyx Edge server, used by GXC partner and customer administrators to collect logs, restart services, restore factory settings, etc.

#### AKA

**Authentication and Key Agreement** – A mutual authentication protocol used primarily in mobile networks. AKA ensures that both the UE and the network can verify each other's identity, establishing shared cryptographic keys to secure communication.

#### Alert

A real-time notification in the [*Onyx Portal*](#onyx-portal) triggered by [*Alert Rules*](#alert-rule). Alerts are categorized by severity (Critical, Major, Minor, Other) and are used to monitor system health, troubleshoot issues, and maintain network performance.

#### Alert Counter Panel

An interface element in the [*Onyx Portal*](#onyx-portal) that displays real-time, color-coded counts of active Critical, Major, Minor, and Other alerts.

#### Alert Mute Rule

A user-defined rule in the [*Onyx Portal*](#onyx-portal) that temporarily suppresses alert email notifications based on severity, type, or equipment to prevent notification fatigue during planned maintenance or debugging windows.

#### Alert Receiver

A user or system configured to receive email notifications when [*Onyx Portal*](#onyx-portal) [*Alert Rules*](#alert-rule) are triggered.

#### Alert Rule

A GXC-defined rule in the [*Onyx Portal*](#onyx-portal) to monitor specific network metrics or behaviors and trigger an [*Alert*](#alert) when a condition is met.

#### AMF

**Access and Mobility Function** – The [*5G Core*](#id-5g-core) function responsible for managing user access, mobility events, and signaling between devices and the network.

#### ANR

**Automatic Neighbor Relation** – A self-optimizing network feature that automates the detection and management of neighbor cells. ANR helps maintain accurate neighbor lists for handovers, improving mobility performance and reducing manual configuration.

#### AMSL

**Above Mean Sea Level** - The height of an antenna or location measured relative to mean sea level.

#### AP

**Access Point** – GXC equipment that provides 4G or 5G radio access to UE. In 4G networks, the AP integrates radio and baseband processing functions. In 5G networks, GXC may use a disaggregated [*RAN*](#ran) architecture in which radio functions are provided by an [*RU*](#ru) and higher-layer RAN functions are provided by the [*DU*](#du) and [*CU*](#cu).

#### APN

**Access Point Name** – A network identifier used by [*UE*](#ue) to connect to an external [*PDN*](#pdn), such as the Internet or an enterprise [*LAN*](#lan). In GXC deployments, the APN also specifies routing and [*QoS*](#qos) rules.

#### APN-Mapped VLANs

[*VLAN*](#vlan) segmentation mapped to specific [*APNs*](#apn), used for isolating device traffic and applying granular access policies.

#### Application Group

A logical collection of user-defined applications for traffic shaping, prioritization, and [*QoS*](#qos) control within the GXC network.

#### ARP

**Allocation and Retention Priority** – [*QoS*](#qos) parameter that influences bearer setup and prioritization under network load.

#### Authorized State

A [*CBSD*](#cbsd) state indicating that the [*SAS*](#sas) has granted spectrum access and authorized the CBSD to transmit.

#### AWS

**Amazon Web Services** – A cloud platform used to deploy GXC services.

#### AWS GuardDuty

[*AWS*](#aws) threat detection service monitoring for anomalies and malicious activity in Onyx infrastructure.

#### AWS KMS

**AWS Key Management Service** – [*AWS*](#aws)-managed service for creating, managing, and using cryptographic keys to secure stored data.

***

### B

#### Backhaul

The communication link that transports user and control plane traffic between the [*Onyx Edge (Core)*](#onyx-edge-core-only) and [*RAN*](#ran) elements such as [*APs*](#ap) or [*FHMs*](#fhm). GXC supports both wired and wireless backhaul options, including LTE Mesh.

#### Bcrypt

A password hashing function designed to be computationally intensive, making brute-force attacks more difficult. Bcrypt automatically incorporates a salt and allows configurable complexity (cost), helping protect stored credentials from rainbow table and brute-force attacks.

#### BPF

**Band Pass Filter** – Device that allows selected frequency bands to pass while blocking others—used in [*DAS*](#das) for spectrum isolation.

#### BRF

**Band Reject Filter** – Filter that blocks specific frequency bands to reduce interference in shared [*DAS*](#das) environments.

#### BTS-CBSD

**Base Transceiver Station CBSD** – Fixed [*CBSD*](#cbsd) base station that provides wireless connectivity to end-user devices and [*CPE-CBSDs*](#cpe-cbsd) in [*CBRS*](#cbrs) deployments.

***

### C

#### CA

**Carrier Aggregation** – An [*AP*](#ap) transmission mode that combines multiple carriers (contiguous or non-contiguous) across the same or different frequency bands to increase bandwidth, enhance data rates, and optimize spectrum usage in GXC networks.

#### CA Certificate

**Certificate Authority Certificate** - A digital certificate used to verify the authenticity of certificates presented by trusted systems and services.

#### CAPTCHA

**Completely Automated Public Turing test to tell Computers and Humans Apart** – A challenge-response test used to determine whether the user is a human or an automated bot. [*reCAPTCHA*](#recaptcha), a variant helps protect login and registration interfaces from automated abuse by requiring [*Onyx Portal*](#onyx-portal) users to perform tasks that are easy for humans but difficult for machines.

#### Category A CBSD

<30 dBm/10 MHz CBSD – Low-power [*CBSD*](#cbsd) with transmit power under 30 dBm per 10 MHz; suitable for indoor or limited-range deployments.

#### Category B CBSD

<47 dBm/10 MHz CBSD – High-power [*CBSD*](#cbsd) capable of up to 47 dBm per 10 MHz; typically used for wide-area or outdoor coverage.

#### CBRS

Citizens Broadband Radio Service – A shared spectrum band (3550–3700 MHz) in the U.S., used for private 4G and 5G networks.

#### &#xD;CBRS-NID

**CBRS Network ID** – A unique identifier used to distinguish private networks operating within the [*CBRS*](#cbrs) band. In GXC deployments, the CBRS-NID is typically configured in APs and other [*CBSDs*](#cbsd) to associate them with the correct network instance, enabling [*SAS*](#sas) registration, policy enforcement, and operational segmentation.

#### &#xD;CBSD

**Citizens Broadband Radio Service Device** – A device authorized under [*FCC*](#fcc) rules to transmit in the CBRS band (3550–3700 MHz). In GXC networks, [*CBSDs*](#cbsd) include both [*BTS-CBSDs*](#bts-cbsd) (acting as fixed base stations) and [*CPE-CBSDs*](#cpe-cbsd) (fixed end-user devices). All CBSDs must register with the [*SAS*](#sas) and comply with dynamic frequency coordination requirements to prevent interference and ensure regulatory compliance.

#### CBSD Installation Parameters

The location, antenna, and deployment information required to register a [*CBSD*](#cbsd) with the [*SAS*](#sas).

#### CBSD Operational Parameters

Radio operating settings submitted to the [*SAS*](#sas), such as frequency range, bandwidth, and transmit power.

#### CBSD Registered State

A [*CBSD*](#cbsd) state indicating that registration with the [*SAS*](#sas) has been successfully completed.

#### CBSD Registration Request

A [*SAS*](#sas) request used to register a [*CBSD*](#cbsd) and establish its operational record.

#### Cell

A defined coverage area within a mobile network served by one or more [*RUs*](#ru). In GXC deployments, a cell may include multiple [*RUs*](#ru) operating under a single [*DU*](#du), especially in [*Shared Cell*](#shared-cell) configurations, enabling seamless coverage and mobility.

#### Cell ID

A unique identifier assigned to each [*Cell*](#cell) in a mobile network. [*UE*](#ue) use the Cell ID to distinguish between different cells for registration, handovers, and mobility management. In GXC’s [*Shared Cell*](#shared-cell) architecture, all [*RUs*](#ru) within a shared deployment share the same Cell ID to eliminate intra-site handovers.

#### Center Frequency

The frequency at the midpoint of a radio channel or spectrum allocation.

#### Channel

A defined range of radio frequencies used for wireless communication.

#### CLI

**Command-Line Interface** – A text-based interface used to configure, monitor, and manage the [*Onyx Edge*](#onyx-edge). Accessible via [*SSH*](#ssh), the CLI complements the GUI-based [*Onyx Portal*](#onyx-portal) and is used in scenarios requiring direct system access.

#### Client Certificate

A digital certificate used to authenticate a device or application when establishing a secure connection.

#### Core

The central part of a cellular network that manages subscriber authentication, mobility, session establishment, policy control, and routing of user traffic between the [*RAN*](#ran) and external networks. In GXC deployments, the core is hosted on the [*Onyx Edge*](#onyx-edge) and is provided by the [*EPC*](#epc) for LTE networks and the [*5G Core*](#id-5g-core) for 5G networks.

#### C-Plane

**Control Plane** – The signaling layer of the network that manages session establishment, mobility, handovers, and authentication between the [*core*](#core) and [*UE*](#ue). In GXC deployments, the C-Plane is handled by the [*CU*](#cu) and the core functions hosted on the [*Onyx Edge*](#onyx-edge), ensuring reliable network coordination and policy enforcement.

#### CPE

**Customer Premise Equipment** – On-site network equipment, such as routers and modems, that connect end users to the provider’s core or access network.

#### CPE-CBSD

Fixed [*CBSD*](#cbsd) that functions as a non-mobile [*UE*](#ue), typically with higher transmit power than standard End-User Devices (EUDs) and therefore exceeding EUD power limits.

#### CPI

**Certified Professional Installer** – A technician certified under [*FCC*](#fcc) requirements to register [*CBSDs*](#cbsd) with the [*SAS*](#sas). The CPI is responsible for providing accurate deployment data such as device location, antenna height, gain, and installation parameters to ensure regulatory compliance in [*CBRS*](#cbrs) networks. GXC deployments rely on CPI-verified installations for [*SAS*](#sas) approval and operation.

#### CPRI

**Common Public Radio Interface** – Legacy interface standard for connecting baseband units to [*RUs*](#ru). Largely replaced by [*eCPRI*](#ecpri) in 5G deployments for better bandwidth and latency performance.

#### CSV

**Comma-Separated Values** – A plain-text file format in which each line represents a data record with comma-separated values—widely used by [*Onyx Portal*](#onyx-portal) for data import/export.

#### CU

**Central Unit** – A higher-layer 5G [*RAN*](#ran) component that handles control and user plane functions such as [*RRC*](#rrc), mobility management, session control, and data forwarding. Integrated into the [*Onyx Edge*](#onyx-edge), the [*CU*](#cu) works in tandem with the [*DU*](#du) to deliver scalable, low-latency private 5G services.

#### CU-CP

**Central Unit-Control Plane** – In 5G networks, the control plane component of the [*CU*](#cu), responsible for managing [*RRC*](#rrc), signaling, handovers, mobility, and session establishment.

#### Customer

An end-user organization using a GXC Onyx Private Cellular Network for its enterprise connectivity needs. Customers can manage their network directly via the [*Onyx Portal*](#onyx-portal) or work with a [*GXC Partner*](#gxc-partner) for managed services.

#### CU-UP

**Central Unit-User Plane** – In 5G networks, the user plane component of the [*CU*](#cu) responsible for forwarding user data traffic, packet routing, QoS enforcement, and buffering.

***

### D

#### DAS

**Distributed Antenna System** – A network of spatially separated antennas connected to a common signal source, designed to improve wireless coverage within large or complex environments. In GXC deployments, DAS supports both passive and active configurations, enabling shared infrastructure for public and private cellular services using filters, diplexers, and [*SAS*](#sas)-registered [*RUs*](#ru).

#### Dashboard

A real-time display in the Onyx Portal that presents network-level metrics and operational status for traffic, equipment, and subscribers.

#### dBi

**Decibels Relative to Isotropic Radiator** – A unit of measurement for antenna gain relative to a theoretical isotropic radiator that radiates power equally in all directions. Higher dBi values indicate more directional antennas.

#### dBm

**Decibel-milliwatts** – Unit of power relative to 1 milliwatt. In wireless networks, dBm is used to express signal strength, transmit power, and receiver sensitivity. For example, a signal strength of -50 dBm is stronger than -80 dBm.

#### DC

**Dual Carrier** – An AP transmission mode in which an AP simultaneously transmits on two frequency carriers, improving throughput and reliability.

#### Default Network

The currently selected network instance in the [Onyx Portal](#onyx-portal) that determines which data is displayed across all Onyx Portal screens.

#### Default Network Selector

An [*Onyx Portal*](#onyx-portal) interface element that allows users to choose the default network to operate in.

#### DHE

**Diffie–Hellman Ephemeral** – A key exchange protocol using temporary keys for each session, ensuring forward secrecy in [*TLS*](#tls) communications.

#### DHCP

**Dynamic Host Configuration Protocol** – A network management protocol that automatically assigns IP addresses and other configuration parameters—such as subnet mask, gateway—to UE on a network, enabling them to communicate effectively.

#### DL

**Downlink** – Transmission from network to UE.

#### DNS

**Domain Name System** – Internet system that resolves domain names to IP addresses.

#### DP

**Domain Proxy** – An [*Onyx Portal*](#onyx-portal) module that handles communication with the [*SAS*](#sas) on behalf of [*CBSDs*](#cbsd) for dynamic frequency management.

#### DU

**Distributed Unit** – A lower-layer 5G [*RAN*](#ran) component responsible for real-time baseband processing functions including MAC and physical layer operations. Integrated into the [*Onyx Edge*](#onyx-edge), the [*DU*](#du) connects to multiple [*RUs*](#ru) over the fronthaul interface. It works in tandem with the [*CU*](#cu) as part of GXC’s disaggregated [*RAN*](#ran) architecture.

***

### E

#### EARFCN

**E-UTRA Absolute Radio Frequency Channel Number** – Identifies LTE radio carriers with a specific frequency.

#### ECDHE

**Elliptic Curve Diffie–Hellman Ephemeral** – A key exchange method that provides forward secrecy for [*TLS*](#tls) sessions by generating temporary keys based on elliptic curve cryptography.

#### eCPRI

**Enhanced Common Public Radio Interface** – An improved version of [CPRI](#cpri) with better performance for 5G [fronthaul](#fronthaul).

#### EEA2

**EPS Encryption Algorithm 2** – An LTE confidentiality algorithm based on [*AES*](#aes) in counter mode, used for [*OTA*](#ota) encryption.

#### EIA2

**EPS Integrity Algorithm 2** – An LTE integrity algorithm based on [*AES*](#aes), used to ensure the authenticity of signaling messages.

#### EIRP

**Effective Isotropic Radiated Power** – The total radio power transmitted by an antenna, including antenna gain and accounting for transmission losses.

#### eNB / eNodeB

**Evolved Node B** – LTE base station that connects [*UE*](#ue) to the [*EPC*](#epc).

#### EPC

**Evolved Packet Core** – The [*LTE Core*](#lte-core) network architecture used to manage data, mobility, authentication, and session control. It includes the [*MME*](#mme), [*SGW*](#sgw), [*PGW*](#pgw), and [*HSS*](#hss) functions. In GXC deployments, the EPC is integrated into the [*Onyx Edge*](#onyx-edge) as part of the LTE Core, enabling secure, localized, and scalable private LTE network operations.

#### ESC

**Environmental Sensing Capability** - A network of sensors used in the [*CBRS*](#cbrs) band to detect incumbent federal radar activity and notify the [*SAS*](#sas) when spectrum protection is required.

#### eSIM

**Embedded SIM** – A programmable SIM chip embedded directly into a [*UE*](#ue), eliminating the need for a physical SIM card slot. It supports remote provisioning and simplifies UE deployment, particularly in IoT and enterprise environments.

#### eSync

**Edge Synchronization Module** – A GXC module that provides timing services such as [*GPS*](#gps)-based synchronization, [*PTP*](#ptp) Grandmaster functionality, and [*SyncE*](#synce) output. It ensures accurate time and phase alignment for 4G/5G networks when [*Onyx Edge*](#onyx-edge) or [*FHMs*](#fhm) require an external synchronization source.

#### Ethernet Backhaul&#xD;

A network connection that transports traffic between access network equipment and the core network using Ethernet.

#### EUTRA

**Evolved Universal Terrestrial Radio Access** – Radio access part of [*LTE*](#lte), including [*eNodeB*](#enb-enodeb) and [*UE*](#ue).

#### Event

A system-recorded occurrence that reflects a change or activity within the network—such as an equipment status update, configuration change, or user action. Events provide an audit trail and operational visibility for diagnostics and historical review.

***

### F

#### F1

**F1 Interface** – In 5G networks, the F1 interface connects the [*DU*](#du) and [*CU*](#cu) within a [*gNodeB*](#gnb-gnodeb). In GXC deployments, both DU and CU functions are integrated within the [*Onyx Edge*](#onyx-edge), and the F1 interface is implemented internally to support the split [*RAN*](#ran) architecture and efficient coordination between radio and control functions.

#### FCAPS

**Fault, Configuration, Accounting, Performance, Security** – A framework for network management functionality.

#### FCC

**Federal Communications Commission** – The U.S. regulatory authority that governs spectrum allocation, device certification, and telecommunications compliance, including rules for [*CBRS*](#cbrs) and private 5G deployments.

#### FCC ID

A unique identifier assigned by the [*FCC*](#fcc) to certify that a wireless device complies with regulatory standards for radio frequency transmission and electromagnetic emissions.

#### FHM

**Fronthaul Multiplexer** – GXC 5G equipment that aggregates and synchronizes fronthaul signals between the [*Onyx Edge*](#onyx-edge) and multiple [*RUs*](#ru). It enables [*Shared Cell*](#shared-cell) functionality by virtualizing multiple RUs into a single cell, supporting extended coverage and efficient spectrum usage.

#### Fiber Uplink

A fiber-optic network connection used to provide high-speed connectivity between network devices.

#### Floor Plan Calibration

An [*Onyx Portal*](#onyx-portal) feature that allows you to map the latitude and longitude coordinates of each floor in a venue and visualize it on a map.

#### Fronthaul

In a split 5G architecture, the low-latency, time-sensitive link between the [*DU*](#du) and the [*RU*](#ru). GXC uses [*O-RAN*](#o-ran) 7.2x-compliant interfaces over fiber to transport radio data between these components.

#### FQDN

**Fully Qualified Domain Name** – Complete domain name including hostname and domain (e.g., *server.example.com*).

#### Free Running

A timing fallback mode used when an [*Onyx Edge*](#onyx-edge) or [*AP*](#ap) loses its primary synchronization source. In this mode, the equipment maintains its last known timing reference autonomously, which may lead to drift over time.

#### FSM

**Finite State Machine** – Indicates the current operational state of an [*AP*](#ap), helping administrators assess readiness, faults, or provisioning status.

#### FWA

**Fixed-Wireless Access** – Provides broadband Internet using wireless connections instead of fiber or DSL.

***

### G

#### G100

GXC 4G indoor AP equipment.

#### G101

GXC 4G indoor AP equipment.

#### G105

GXC 5G indoor AP equipment.

#### G227

GXC 5G indoor AP equipment.

#### G229

GXC 4G indoor low-power AP equipment.

#### G238-n78H

GXC 5G outdoor high-power band n78 AP equipment.

#### G243-n48

GXC 5G outdoor band n48 AP equipment.

#### G243-n78H

GXC 5G outdoor high-power band n78 AP equipment.

#### G249

GXC 4G outdoor AP equipment.

#### G430

GXC 5G indoor AP equipment.

#### G443

GXC 5G outdoor AP equipment.

#### G501

GXC 4G outdoor high-power AP equipment.

#### G505

GXC 5G outdoor high-power AP equipment.

#### G509-n28

GXC 5G outdoor band n28 AP equipment.

#### G509-n41

GXC 5G outdoor band n41 AP equipment.

#### GAA

**General Authorized Access** - The lowest-priority [*CBRS*](#cbrs) access tier that permits shared use of available spectrum without acquiring a Priority Access License.

#### GCM

**Galois/Counter Mode** – An [*AES*](#aes) encryption mode that combines counter mode encryption with Galois field authentication, providing both confidentiality and integrity.

#### gNB / gNodeB

**Next Generation Node B** – The 5G base station that provides radio access to [*UE*](#ue), manages control signaling, and interfaces with the [*5G Core*](#id-5g-core) network. In GXC deployments, the gNodeB includes the [*DU*](#du) and [*CU*](#cu), and operates in conjunction with the [*Onyx Edge*](#onyx-edge).

#### GNSS

**Global Navigation Satellite System** - A satellite-based positioning system used to provide location and timing information.

#### GM01

GXC 4G GM01 Mesh Node equipment.

#### GM02

GXC 4G GM02 Mesh Node equipment.

#### GM03

GXC 5G GM03 Mesh Node equipment.

#### GPS

**Global Positioning System** – A satellite-based system used in GXC deployments to deliver precise timing and location information. GPS timing is critical for synchronizing [*TDD*](#tdd) operations, via components such as the [*Onyx Edge*](#onyx-edge) or [*FHM*](#fhm).

#### GPS Antenna

A receiver antenna that captures [*GPS*](#gps) satellite signals to provide accurate timing and location information. In GXC [*APs*](#ap), it ensures synchronization for [*TDD*](#tdd) and ensures coordination across the [*RAN*](#ran).

#### Grant

An authorization issued by the [*SAS*](#sas) that permits a [*CBSD*](#cbsd) to transmit on specific frequencies under defined operating conditions.

#### Grant Request

A [*SAS*](#sas) request submitted by a [*CBSD*](#cbsd) or [*DP*](#dp) to obtain spectrum resources for transmission.

#### GXC Partner

An organization authorized to deploy, manage, or resell GXC’s private cellular solutions, often collaborating on implementation, support, and customer success.

#### GXC Root

The top-level administrative account used by GXC to manage the Onyx Portal.

***

### H

#### HA

**High Availability** – A redundancy architecture designed to ensure service continuity in [*Onyx Edge*](#onyx-edge) failure scenarios using [*Onyx Edge Pools*](#onyx-edge-pool).

#### HAAT

**Height Above Average Terrain** - The height of an antenna relative to the average elevation of the surrounding terrain.

#### Handover

The process of transferring an active session or connection from one cell to another as a [*UE*](#ue) moves.

#### Handover Hysteresis

The signal strength difference (in dB) that a neighboring cell must exceed over the current serving cell before initiating handover. Used to prevent rapid switching between cells when signal levels fluctuate, ensuring stable connections and reducing unnecessary network overhead.

#### Heartbeat

A periodic message exchanged with the [*SAS*](#sas) to maintain an active grant and authorization to transmit.

#### HMAC

**Hash-Based Message Authentication Code** – A mechanism combining a cryptographic hash (e.g., SHA-256) with a secret key to verify data integrity and authenticity.

#### HSS

**Home Subscriber Server** – Stores subscriber profiles and performs authentication in [*LTE*](#lte).

***

### I

#### ICCID

**Integrated Circuit Card Identifier** – A unique identifier assigned to each [*SIM*](#sim) card or [*eSIM*](#esim) profile, used primarily for inventory and provisioning management.

#### IdP

**Identity Provider** – A trusted third-party service that manages user authentication and identity. It validates credentials during [*SSO*](#sso) and provides user attributes to the [*Onyx Portal*](#onyx-portal) for [*RBAC*](#rbac).

#### IMEI

**International Mobile Equipment Identity** – A globally unique number used to identify a [*UE*](#ue) on a cellular network.

#### IMDSv2

**Instance Metadata Service version 2** – An updated version of [*AWS*](#aws) metadata service that enhances security by requiring session-oriented requests with tokens to access instance metadata. IMDSv2 mitigates common metadata-related attacks and protects sensitive data, such as IAM credentials, on cloud instances.

#### IMSI

**International Mobile Subscriber Identity** – A unique identifier assigned to a subscriber’s [*SIM*](#sim) or [*eSIM*](#esim) profile. It is used by the mobile network to authenticate the subscriber, manage sessions, and enforce access control for the associated [*UE*](#ue).

#### Interference

Unwanted radio signals that degrade or disrupt wireless communications.

#### IoT

**Internet of Things** – Network of physical devices connected via the Internet, enabling data exchange and automation.

#### IP

**Internet Protocol** – Network protocol for routing packets between devices.

#### IPSec

**Internet Protocol Security** – A protocol suite for securing [*IP*](#ip) communications by authenticating and encrypting IP traffic. In GXC’s 4G networks, [*APs*](#ap) and [*Onyx Edge*](#onyx-edge) can be configured to support IPSec for enhanced security.

#### ISO

**International Organization for Standardization - ISO image** – A disk image file format used to package and install Onyx Edge software.

***

### K

#### KPI

**Key Performance Indicator** – A measurable metric used to evaluate the performance of networks, equipment, etc. against defined objectives.

***

### L

#### LAN

**Local Area Network** – A local network connecting computers and equipment.

#### LCI

**Local Configuration Interface** – The web interface hosted on [*AP*](#ap) equipment used for local configuration tasks including uploading certificates and enabling [IPSec](#ipsec), etc.

#### LTE

**Long-Term Evolution** – 4G mobile communication standard developed by 3GPP. In GXC deployments, [*LTE*](#lte) supports OnGo-based private networks operating in the U.S. within the [*CBRS*](#cbrs) band (3550–3700 MHz).

#### LTE Core

GXC’s integrated 4G LTE Core, based on the [*EPC*](#epc) architecture, includes the [*MME*](#mme), [*SGW*](#sgw), [*PGW*](#pgw), and [*HSS*](#hss) functions. It manages mobility, authentication, session handling, and traffic routing within GXC’s private LTE deployments. The LTE Core is embedded in the [*Onyx Edge*](#onyx-edge), enabling secure and localized network operation.

***

### M

#### MAC Address

**Media Access Control Address** – Hardware address uniquely identifying a network interface.

#### MCC

**Mobile Country Code** – A three-digit numeric code used to identify the country of a mobile subscriber within cellular networks. It is part of the [*IMSI*](#imsi) and works in conjunction with [*MNC*](#mnc) to uniquely identify a mobile operator. MCC values are defined by International Telecommunication Union Telecommunication Standardization Sector (ITU-T) and are essential for roaming, network selection, and regulatory compliance.

#### Mesh

A GXC networking configuration where [*Mesh Nodes*](#mesh-node) wirelessly relay traffic between [*APs*](#ap) or between an AP and the [*Onyx Edge*](#onyx-edge). Mesh is used to extend coverage in areas without wired backhaul and provides resilient, self-healing connectivity in challenging environments.

#### Mesh Node

GXC equipment that wirelessly relays traffic between [*APs*](#ap) or to the [*Onyx Edge*](#onyx-edge), expanding network coverage in locations where cabling is impractical, such as remote or obstructed areas.

#### MFA

**Multi-Factor Authentication** – An [*Onyx Portal*](#onyx-portal) security feature that requires users to authenticate with two credentials, their Onyx Portal password and a [*TOTP*](#totp) generated by an authenticator app like the Google Authenticator or Microsoft Authenticator.

#### MFA Backup Code

Codes generated during [*MFA*](#mfa) setup that can be used instead of [*TOTPs*](#totp). Each code is single-use only and expires after it is used. MFA Backup Code are critical for access recovery.

#### MFA Secret

A cryptographic key stored in an authenticator app to generate [*TOTPs*](#totp). If a user loses access to their [MFA](#mfa) device or backup codes, the MFA secret must be reset to regain access to the [*Onyx Portal*](#onyx-portal).

#### MHz

**Megahertz** – Frequency unit equal to one million hertz.

#### MILENAGE

A set of cryptographic algorithms used within the SIM-based authentication process in mobile networks, supporting the [*AKA*](#aka) mechanism. MILENAGE defines functions for authentication, key generation, and data integrity checks, helping to ensure that SIM credentials are securely validated.

#### MIMO

**Multiple Input, Multiple Output** – A wireless technology that uses multiple antennas at both the transmitter and receiver to improve data throughput and signal reliability. GXC APs support MIMO for enhanced 4G/5G performance.

#### MME

**Mobility Management Entity** – The [*LTE Core*](#lte-core) function responsible for handling signaling related to mobility and security for [*UE*](#ue).

#### MNC

**Mobile Network Code** – A two- or three-digit code used in combination with the [*MCC*](#mcc) to uniquely identify a mobile network operator within a country. Together, MCC and [*MNC*](#mnc) form the [*PLMN*](#plmn) identifier, which is essential for network selection, roaming, and SIM provisioning.

#### MNO

**Mobile Network Operator** – Company providing wireless communications services.

#### M-Plane

**Management Plane** – Handles configuration, software updates, fault management, and monitoring for APs, RUs, and [*DUs*](#du). In GXC networks, the M-Plane operates through protocols like [*TR-069*](#tr-069) and [*O-RAN*](#o-ran) M-Plane interfaces, integrated into the Onyx Platform to support remote lifecycle management and diagnostics.

#### MSIN

**Mobile Subscriber Identifier** – Part of [*IMSI*](#imsi) that uniquely identifies a subscriber within a network.

#### mTLS

**Mutual Transport Layer Security** – An extension of [*TLS*](#tls) where both the client and server present and verify digital certificates to authenticate each other. mTLS provides strong, bidirectional authentication and encrypted communication, frequently used in securing APIs, service-to-service communications, and orchestrated deployments.

#### Multi-APN-VLAN Mode

A specialized [*Onyx Edge*](#onyx-edge) deployment mode allowing traffic separation using [*VLANs*](#vlan) per [*APN*](#apn). Enables fine-grained control over traffic segmentation across applications. Also referred to as the Bridge mode.

#### Multiplexing

A technique for sending multiple data streams over a single channel. In mobile networks, it includes time (TDM), frequency (FDM), and code (CDM) multiplexing.

#### Multi-Step Registration

A [*CBSD*](#cbsd) registration workflow in which installation parameters and operational parameters are submitted through separate systems before registration is completed.

***

### N

#### N6

**N6 Interface** – In 5G networks, the N6 interface connects the [*UPF*](#upf) on the [*Onyx Edge*](#onyx-edge) to external data networks, such as the Internet or private enterprise [*LANs*](#lan). It serves as the 5G equivalent of the [SGi](#sgi) interface in 4G, routing outbound user-plane traffic from the [*5G Core*](#id-5g-core) to external destinations.

#### NaaS

**Network-as-a-Service** – GXC’s model of delivering private mobile networks as a service, including orchestration, monitoring, and lifecycle management.

#### NAS

**Non-Access Stratum** – In 4G and 5G networks, NAS is a signaling protocol layer between the [*UE*](#ue) and the core network. It handles key control plane functions such as authentication, mobility management, and session setup. In GXC deployments, NAS signaling is processed by the [*MME*](#mme) in 4G and by [*AMF*](#amf) in 5G, both hosted on the [*Onyx Edge*](#onyx-edge).

#### NAT

**Network Address Translation** – A method that maps private IP addresses to public IP addresses for outbound traffic. NAT enables multiple devices on a private network to share a single public IP, conserves address space, and enhances security by obscuring internal network details.

#### NAT Mode

A network configuration mode in which [*Onyx Edge*](#onyx-edge) performs [*NAT*](#nat) for user traffic. This allows UE to access external networks using the Onyx Edge’s IP address while preserving internal IP schemes. NAT mode simplifies integration into existing enterprise networks by avoiding routing conflicts and enabling secure, outbound-only communication without requiring external IPs for each device.

#### NEA1

**NR Encryption Algorithm 1** – A 5G confidentiality algorithm based on SNOW 3G, used for [*OTA*](#ota) encryption.

#### NEA2

**NR Encryption Algorithm 2** – A 5G confidentiality algorithm based on [*AES*](#aes) in counter mode, used for [*OTA*](#ota) encryption.

#### NEA3

**NR Encryption Algorithm 3** – A 5G confidentiality algorithm based on the ZUC (Zu Chongzhi) stream cipher, used for [*OTA*](#ota) encryption.

#### Neighbor Cell Table

A table maintained by [*APs*](#ap) containing detailed information (cell ID, PCI, RSRP, etc.) about neighboring cells used for handover decisions.

#### Neighbor Frequency Table

A table maintained by APs listing frequencies UE should measure for detecting neighbor cells; populated based on [SAS](#sas) grants.

#### NETCONF

**Network Configuration Protocol** – Used in Onyx solution for secure management of 5G RUs and [FHMs](#fhm) via [M-Plane](#m-plane) interfaces.

#### Ng

**Ng Interface** – In GXC 5G networks, the Ng interface connects [*gNodeBs*](#gnb-gnodeb) to the [*5G Core*](#id-5g-core) hosted on the [*Onyx Edge*](#onyx-edge). It includes both N2 (control plane) and N3 (user plane) interfaces for managing UE sessions, signaling, and data forwarding.

#### NIA3

**NR Integrity Algorithm 3** – A 5G integrity algorithm based on the ZUC stream cipher, ensuring the authenticity of signaling messages.

#### NOC

**Network Operations Center** – Centralized location for monitoring and managing networks.

#### Notifications Panel

Displays [*Onyx Portal*](#onyx-portal) broadcast announcements, such as planned downtime and scheduled upgrades. Accessible via the Notifications icon in the Onyx Portal header.

#### NR

**New Radio** – The radio access technology used in 5G networks. NR enables higher throughput, lower latency, and more efficient spectrum use compared to LTE, supporting a wide range of use cases from enhanced mobile broadband to ultra-reliable low-latency communication.

***

### O

#### Onyx Edge

A core component of the GXC solution that integrates core network and [*RAN*](#ran) functions to enable communication between [*APs*](#ap) and external networks. In 5G networks, it can be deployed in either [*Onyx Edge Core+NR*](#onyx-edge-corenr) (standard deployment) or [*Onyx Edge Core Only*](#onyx-edge-core-only) models.

#### Onyx Edge Core Only

A 5G deployment model in which the [*Onyx Edge*](#onyx-edge) functions exclusively as the [*5G Core*](#id-5g-core), while the [*gNodeB*](#gnb-gnodeb) ([*DU*](#du) and [*CU*](#cu)) is hosted externally by a third-party vendor. This mode is primarily intended for integration with non-GXC RAN components and is offered with limited support.

#### Onyx Edge Core+NR

The standard 5G deployment model in which a single [*Onyx Edge*](#onyx-edge) hosts both the [*5G Core*](#id-5g-core) and the [*gNodeB*](#gnb-gnodeb) (comprising [*DU*](#du) and [*CU*](#cu)). It enables end-to-end control, ultra-low latency, and local breakout—ideal for standalone, high-performance private networks in enterprise environments.

#### Onyx Edge On-Premises

A 4G and 5G deployment mode where the [*Onyx Edge*](#onyx-edge) runs locally at the enterprise site. This mode ensures low latency, localized data processing, and supports mission-critical applications that require high reliability and data sovereignty.

#### Onyx Edge Pool

A logical grouping of [*Onyx Edge*](#onyx-edge) in a network for redundancy and scalability. Pools simplify management and load balancing across Onyx Edge.

#### Onyx ES2

GXC 4G ONYX-ES2 Ruggedized Onyx Edge server.

#### Onyx ES4

GXC 4G ONYX-ES4 Onyx Edge server.

#### Onyx ES7

GXC 5G ONYX-ES7 Onyx Edge server.

#### Onyx ES8

GXC 5G ONYX-ES8 Outdoor Onyx Edge server.

#### Onyx Orchestrator

GXC’s centralized platform for lifecycle management and automation of equipment. It enables remote provisioning, software upgrades, configuration management, performance monitoring, and fault management across multiple deployments, ensuring scalable and consistent operations.

#### Onyx Portal

A cloud-native, GUI-based interface used by GXC, GXC partners, and customers to monitor and manage GXC-deployed private cellular networks.

#### Onyx Platform

The GXC private cellular networking platform, consisting of the [*Onyx Portal*](#onyx-portal), [*Onyx Edge*](#onyx-edge), radio access components, and supporting services.

#### O-RAN

**Open Radio Access Network** – An industry initiative and architecture framework that promotes open, interoperable, and intelligent [*RAN*](#ran) interfaces and disaggregated network components.

#### OTA

**Over-the-Air** – Refers to wireless communication between UE and the network. In GXC deployments, OTA commonly describes encryption and integrity protection of 4G/5G signaling and user traffic.

***

### P

#### PAL

**Priority Access License** – A licensed [*CBRS*](#cbrs) spectrum access tier that provides priority rights to specific frequency channels within a geographic area.

#### PCI

**Physical Cell Identity** – A unique identifier used by LTE and 5G [*Cells*](#cell) to distinguish neighboring cells during radio operations.

#### PDN

**Packet Data Network** – An external network (e.g., Internet or corporate LAN) that UE connect to.

#### PGW

**PDN Gateway / Packet Data Network Gateway** – The [*LTE Core*](#lte-core) function that routes user traffic to external data networks.

#### PKI

**Public Key Infrastructure** – Framework used to manage digital certificates and encryption keys.

#### PLMN

**Public Land Mobile Network Identifier** – A unique identifier for a mobile network operator, composed of an [*MCC*](#mcc) and an [*MNC*](#mnc). The PLMN identifies the network that a subscriber is connected to and is used for network selection, roaming, and authentication in both public and private cellular deployments (e.g., GXC-assigned PLMN IDs).

#### PoE

**Power over Ethernet** - A technology that delivers electrical power and network connectivity over a single Ethernet cable.

#### POI

**Point of Interface** – Connection point between [*AP*](#ap) and [*DAS*](#das) infrastructure.

#### PRB

**Physical Resource Block** – The smallest unit of resource allocation in 4G/5G radio scheduling, representing a specific time-frequency slot that the network assigns to a subscriber/UE for uplink or downlink transmission.

#### Private 4G / Private 5G

A cellular network deployed for exclusive use by an enterprise or organization. Built on 3GPP 4G or 5G technology, it uses licensed or shared spectrum (such as [*CBRS*](#cbrs)) to deliver secure, high-performance connectivity.

#### Provisioning Server

A backend service in GXC’s architecture responsible for initializing and configuring [*Onyx Edge*](#onyx-edge) and [*Mesh Node*](#mesh-node) equipment during onboarding. It automates tasks such as device registration to ensure secure and consistent deployment across GXC networks.

#### PSD

**Power Spectral Density** - The amount of transmitted power distributed across a unit of bandwidth, typically expressed in dBm/MHz.

#### PSS

**Primary Synchronization Signal** - A synchronization signal used by [*UE*](#ue) to detect and synchronize with a cellular network.

#### PTP

**Precision Time Protocol** – IEEE 1588 protocol for time synchronization over networks.

***

### Q

#### QAM

**Quadrature Amplitude Modulation** – A modulation method that encodes data by varying signal amplitude and phase. In GXC’s networks, higher-order QAM (e.g., 64-QAM, 256-QAM) improves spectral efficiency and data throughput, enabling faster wireless performance under good signal conditions.

#### QoS

**Quality of Service** – Network mechanisms to manage traffic performance and prioritization based on application or subscriber.

***

### R

#### RAN

**Radio Access Network** – The radio portion of the mobile network that connects [*UE*](#ue) to the core network through radio access infrastructure.

#### RBAC

**Role-Based Access Control** – A security model that restricts system access based on user roles. In the [*Onyx Portal*](#onyx-portal), RBAC ensures that administrators, partners, and customers only access functions and data appropriate to their assigned role.

#### reCAPTCHA

A Google security service that helps prevent automated brute-force login attempts while allowing access for real users. It appears on the [*Onyx Portal*](#onyx-portal) login screen only after a failed login attempt.

#### RF

**Radio Frequency** – The range of electromagnetic frequencies used for wireless communication and signal transmission.

#### RRC

**Radio Resource Control** – A protocol in the [*RAN*](#ran) that manages connection setup, mobility, and resource allocation between [*UE*](#ue) and the network.

#### RRH

**Remote Radio Head** – A radio transmitter unit used in [DAS](#das) systems.

#### RSA

**Rivest–Shamir–Adleman** – An asymmetric encryption algorithm used for secure key exchange, digital signatures, and [*TLS*](#tls) certificate authentication in GXC networks.

#### RSRP

**Reference Signal Received Power** – Measures the power level of LTE reference signals.

#### RSRQ

**Reference Signal Received Quality** – Measures LTE signal quality including interference and signal strength.

#### RSSI

**Received Signal Strength Indicator** – Measures total received power including signal and interference.

#### RU

**Radio Unit** – In 5G networks, the RU handles [*RF*](#rf) functions as part of a disaggregated [*RAN*](#ran) architecture—e.g., GXC G505. In GXC documentation, the RU may also be referred to as [*AP*](#ap).

***

### S

#### S1

**S1 Interface** – In GXC 4G networks, the S1 interface connects [*APs*](#ap) to the [*LTE Core*](#lte-core) hosted on the [*Onyx Edge*](#onyx-edge). It includes S1-MME (control plane) and S1-U (user plane) sub-interfaces for forwarding user data, enabling complete connectivity between [*UE*](#ue) and the core network.

#### SA

**Standalone** – A 5G network deployment model where 5G radios operate alongside a native 5G Core, without relying on legacy 4G infrastructure. GXC’s 5G deployments use the SA model to enable advanced features such as ultra-low latency, network slicing, and full control plane/user plane separation.

#### SAS

**Spectrum Access System** – A cloud-based service that dynamically manages spectrum assignments in the [*CBRS*](#cbrs) band, ensuring interference protection and regulatory compliance.

#### SAS User ID

A unique identifier assigned by a [*SAS*](#sas) provider to an organization or deployment owner for [*CBRS*](#cbrs) operations.

#### SC

**Single Carrier** – An [*AP*](#ap) transmission mode in which an AP uses a single frequency carrier to transmit data. It is typically used in simpler or lower-throughput deployments and is supported in both 4G and 5G networks.

#### Sector

A coverage area served by a directional antenna or radio cell.

#### SFP

**Small Form-factor Pluggable**
&#x20;\- A compact, hot-swappable transceiver module used for network connectivity over fiber or copper media.

#### SFP+

**Enhanced Small Form-factor Pluggable** - A higher-speed version of the [*SFP*](#sfp) transceiver module commonly used for 10 Gbps network connections.

#### SGi

**SGi Interface** – In 4G networks, the SGi interface connects the [*PGW*](#pgw) (hosted on the [*Onyx Edge*](#onyx-edge)) to external IP networks such as the Internet or enterprise LAN. It carries outbound user plane traffic from the LTE Core and is typically mapped to a physical interface (e.g., eth0).

#### SGW

**Serving Gateway** – The LTE Core function that routes and forwards user data packets between the [*eNodeB*](#enb-enodeb) and [*PGW*](#pgw).

#### Shared Cell

A 5G deployment model in which multiple [*RUs*](#ru) operate under a single [*DU*](#du) with a unified cell ID. In GXC’s architecture, this eliminates intra-site handovers, reduces signaling overhead, and ensures seamless mobility and consistent performance across large or complex environments such as warehouses and factories.

#### SIM

**Subscriber Identity Module** – A physical smart card inserted into a [*UE*](#ue) to authenticate and identify the subscriber on a mobile network. It stores credentials such as the [*IMSI*](#imsi) and encryption keys used during network access. Also, see [*eSIM*](#esim).

#### SLO

**Single Log Out** – When users log out from the [*Onyx Portal*](#onyx-portal) using [*SSO*](#sso), they are simultaneously logged out from all other integrated applications within their organization’s SSO environment.

#### SLA

**Service Level Agreement** – Contract defining performance metrics between a service provider and customer.

#### Slot Pattern

A time-domain configuration in 5G [*TDD*](#tdd) that defines the arrangement of downlink, uplink, and flexible symbols within a slot. Similar to [*SSF*](#ssf) in LTE, slot patterns impact latency, throughput, and UL/DL switching behavior.

#### SMA Connector

**SubMiniature Version A Connector** – A threaded [*RF*](#rf) connector used to attach external antennas (e.g., GPS or LTE) to network equipment. Common in GXC APs and timing modules.

#### SMF

**Session Management Function** – The 5G Core function handling session establishment, modification, and teardown.

#### SNOW

**SNOW 3G** - A 3GPP stream cipher algorithm used in LTE for confidentiality and integrity protection of signaling and user data.

#### SOC 2

A compliance framework developed by the American Institute of Certified Public Accountants (AICPA) that verifies an organization’s security, availability, processing integrity, confidentiality, and privacy controls.

SOC 2 Type I certification confirms that GXC’s security controls are properly designed and implemented at a specific point in time, demonstrating our commitment to protecting customer data.

#### Spectrum Analyzer

An [*Onyx Portal*](#onyx-portal) feature that visualizes uplink and downlink [*RF*](#rf) power characteristics for monitoring and troubleshooting radio performance.

#### Spectrum Inquiry

A [*SAS*](#sas) request used to determine available frequencies and spectrum resources at a [*CBSD*](#cbsd) location.

#### S-Plane

**Synchronization Plane** – Provides timing and synchronization across distributed [*RAN*](#ran) components to maintain aligned transmissions. GXC supports synchronization through [*PTP*](#ptp) and other timing mechanisms critical for interference-free operations, especially in shared and adjacent cell deployments.

#### SSF

**Special Subframe Configuration** – A timing pattern used in [*TDD*](#tdd) LTE systems to define the guard period between uplink and downlink slots. It affects latency and throughput performance.

#### SSH

**Secure Shell** – Protocol for secure remote access to the [*Onyx Edge*](#onyx-edge).

#### SSO

**Single Sign-On** – An authentication method that allows users to log in once and gain access to multiple applications in their organization’s SSO environment, including the [*Onyx Portal*](#onyx-portal), without needing to re-authenticate. GXC supports SSO via integration with customer [*IdPs*](#idp).

#### SUCI

**Subscription Concealed Identifier** – A privacy-enhancing identifier used in 5G networks to protect the [*SUPI*](#supi) when transmitted over the air. The SUCI is a cryptographically generated, temporary identifier derived from the SUPI, preventing interception and tracking by unauthorized parties.

#### SUPI

**Subscription Permanent Identifier** – A unique, permanent identifier assigned to a mobile subscriber, typically based on the [*IMSI*](#imsi). In 5G, the SUPI remains protected and is never directly transmitted in clear text; instead, it is concealed using [*SUCI*](#suci).

#### Subscriber

An end user/UE authorized to access the network using a GXC-issued [*SIM*](#sim) or [*eSIM*](#esim). Subscribers are managed through the [*Onyx Portal*](#onyx-portal) and associated with policies and identities for secure connectivity.

#### SyncE

**Synchronous Ethernet** – A timing protocol used in mobile networks to distribute frequency synchronization over Ethernet links. In GXC systems, SyncE helps maintain precise timing between [*Onyx Edge*](#onyx-edge) and connected [*RUs*](#ru), supporting [*TDD*](#tdd) alignment and fronthaul stability.

#### Synchronization Source

The source used by network equipment to obtain timing and frequency synchronization.

***

### T

#### TAC

**Tracking Area Code** – Identifies a specific tracking area within a network.

#### TAI

**Tracking Area Identity** – Uniquely identifies a tracking area used in mobility management.

#### TAU

**Tracking Area Update** – Procedure for updating [*UE’s*](#ue) location within a new tracking area.

#### TDD

**Time Division Duplex** – A transmission method that separates uplink and downlink signals by allocating them alternating time slots on the same frequency channel.

#### TFT

**Traffic Flow Template** – Defines filters for bearer traffic matching.

#### Timing Reference

A clock or synchronization signal used to maintain accurate network timing.

#### TLS

**Transport Layer Security** – In 4G and 5G networks, TLS secures communication channels between GXC components by encrypting and authenticating management and signaling traffic. It is used across interfaces such as those between the [*Onyx Portal*](#onyx-portal), [*Onyx Edge*](#onyx-edge), and [*APs*](#ap) to ensure secure configuration, control, and data integrity.

#### TOTP

**Time-Based One-Time Password** – A temporary, automatically generated numeric password used for [*MFA*](#mfa), generated via apps like Google Authenticator or Microsoft Authenticator.

#### TR-069

**Technical Report 069 / CPE WAN Management Protocol (CWMP)** – A broadband device management protocol defined by the Broadband Forum that enables remote configuration, monitoring, and firmware updates of [*CPE*](#cpe). In GXC networks, TR-069 is used to manage 4G [*APs*](#ap), simplifying provisioning and lifecycle operations through secure, centralized control.

#### TTT

**Time to Trigger** – The duration that a qualifying signal condition must persist before initiating a handover, preventing unnecessary switching due to brief fluctuations.

#### Transport Layer

The time-synchronized, high-speed communication infrastructure that connects the Onyx Edge to distributed [*RUs*](#ru). Built on protocols such as IEEE 1588v2 [*PTP*](#ptp) and [*SyncE*](#synce), the transport layer enables deterministic performance and precise coordination in 4G/5G fronthaul networks.

***

### U

#### UDM

**Unified Data Management** – The [*5G Core*](#id-5g-core) network function responsible for managing subscriber-related data and supporting authentication and subscription management.

#### UE

**User Equipment** – An end-user device authorized to access the network using a [*SIM*](#sim) or [*eSIM*](#esim), such as a smartphone, tablet, or IoT sensor.

#### Upgrade Group

A logical grouping of [*Onyx Edge*](#onyx-edge), [*AP*](#ap), or [*Mesh Node*](#mesh-node) equipment at the network level, used to manage coordinated software upgrades or rollbacks.

#### UL

**Uplink** – Data transmission direction from UE to network.

#### UPF

**User Plane Function** – The [*5G Core*](#id-5g-core) network function responsible for forwarding user data packets between the RAN and external data networks, including applying traffic handling and [*QoS*](#qos) policies.

#### Upstream IdP User

An Onyx Portal user authenticated via an external [*IdP*](#idp). A corresponding user account is created within the Onyx Portal to provide fallback access in cases where the IdP fails to release required [*SSO*](#sso) attributes.

#### U-Plane

**User Plane** – The data layer of the network responsible for carrying user traffic (e.g., application data and internet access). Managed by the UPF in 5G or by SGW/PGW in LTE, the User Plane in GXC systems is optimized for low-latency, high-throughput delivery and is embedded within the Onyx Edge for localized traffic handling.

#### Uu

**Uu Interface** – In 4G and 5G networks, the Uu interface is the radio interface between the UE and the base station ([*eNodeB*](#enb-enodeb) in 4G or [*gNodeB*](#gnb-gnodeb) in 5G). It carries both control and user plane traffic over the air and is the primary link for access connectivity.

***

### V

#### Venue

A logical location in the [*Onyx Portal*](#onyx-portal) representing a real-world location (e.g., warehouse, factory) where [*APs*](#ap) are deployed. A venue can be assigned floor plans and used for floor calibration.

#### VLAN

**Virtual LAN** – Logical segmentation of a physical network into multiple broadcast domains. Also, see [*Multi-APN-VLAN Mode*](#multi-apn-vlan-mode).

***

### W

#### WAF

**Web Application Firewall** – A security solution that protects web applications by filtering and monitoring HTTP/HTTPS traffic between a web application and the Internet. WAFs help block common attacks such as cross-site scripting (XSS), Structured Query Language (SQL) injection, and other "Open Worldwide Application Security Project" (OWASP) Top 10 vulnerabilities.

***


# Copyright

©2026 GXC, LLC. All rights reserved.

The documentation on this site is protected by copyright. No part of it may be reproduced, stored in a retrieval system, or transmitted in any form or by any means — electronic, mechanical, photocopying, recording, or otherwise — without the prior written permission of GXC.

**Trademarks**

The names of GXC's products are trademarks of GXC. The names of other products mentioned on this site may be trademarks or registered trademarks of their respective companies.

**Disclaimer**

The documentation on this site is produced by GXC for the use of its customers. The information provided is subject to change without notice and may not cover all details or variations in equipment, or address every possible issue related to the installation, operation, or maintenance of the product. While every effort has been made to ensure accuracy, GXC disclaims liability for any difficulties arising from the interpretation of the information contained herein.


# GXC Onyx Documentation

Welcome to the GXC documentation hub. Whether you're designing a private cellular network, deploying Onyx infrastructure, or managing day-to-day operations, you'll find everything you need here.

***

## Let's Get Started!

Wherever you are in your Private Wireless journey, the sections below provide resources to help you learn more about GXC’s Private Wireless offering.

Use the links in the four cards to jump directly to documents within each topic, or scroll down to explore the full list of articles available on this page.

If you have any questions about any of the documents just contact your GXC representative or reach out to us at [gxc.io](https://gxc.io).

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="image">Cover image</th></tr></thead><tbody><tr><td><a href="#design-and-deployment-guides"><strong>Design &#x26; Deployment Guides</strong></a></td><td>Architecture briefs and end-to-end guidance for planning and deploying 4G and 5G Onyx networks.</td><td><a href="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FqOdgIYY9Dn6vraFiV48W%2FDesign%20and%20Deployment%20guide.png?alt=media&amp;token=b8ff3e82-7ff4-4408-ad25-bd3e9ec958e8">Design and Deployment guide.png</a></td></tr><tr><td><a href="#installation-and-operations-guides">Installation &#x26; Operations Guides</a></td><td>Step-by-step installation procedures and operations guides for Onyx Portal and Onyx Edge.</td><td data-object-fit="fill"><a href="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQZHJbeJWch3mTgyiUOpH%2FInstallation%20and%20Operations%20cover.png?alt=media&amp;token=828faf0e-fd48-477a-af7c-895d92bbe8c1">Installation and Operations cover.png</a></td></tr><tr><td><a href="#onyx-software"><strong>Onyx Software</strong></a></td><td>Software Descriptions and Specifications</td><td><a href="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fp7EUiml9e3H2xtALlU3W%2FOnyx%20Software%20cover.png?alt=media&amp;token=83c9636f-321f-477d-8bcc-a458ae442e0b">Onyx Software cover.png</a></td></tr><tr><td><a href="#application-notes"><strong>Application Notes</strong></a></td><td>Technical reference guides for site surveys, RF planning, and network configuration.</td><td><a href="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FeJUwKsU7vYyYyMYB5Mge%2FChatGPT%20Image%20Mar%206%2C%202026%2C%2011_35_08%20AM.png-ApplicationNotes.png?alt=media&amp;token=6acde509-4013-4e04-bed5-4c3ef5386c09">ChatGPT Image Mar 6, 2026, 11_35_08 AM.png-ApplicationNotes.png</a></td></tr></tbody></table>

***

## Design & Deployment Guides

Plan and architect your private cellular network.

| Guide                                                                                                                          | Description                                                                                  |
| ------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------- |
| [4G & 5G Onyx Design Guide](/docs/onyx-design-guide/onyx-design-guide)                                                         | Comprehensive guide covering network design principles, site planning, and deployment steps. |
| [5G Architecture Solution Brief](/docs/solution-briefs/5g-onyx-architecture-solution-brief)                                    | High-level overview of the GXC 5G architecture and core network components.                  |
| [5G Private Cellular and DAS Solution Brief](/docs/solution-briefs/5g-onyx-private-cellular-and-das-solution-brief)            | Comparison and integration guidance for private cellular and distributed antenna systems.    |
| [5G Shared Cell Architecture Solution Brief](/docs/solution-briefs/5g-onyx-shared-cell-super-cell-architecture-solution-brief) | Integrating multiple Access Points in a single logical Cell.                                 |

## Installation & Operations Guides

Deploy and manage your Onyx infrastructure.

| Guide                                                                                                                                                         | Description                                                          |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
| [5G Onyx Portal 3.1.5 Operations Guide](/docs/network-configuration-and-operations-guides/5g-onyx-portal-4.x-operations)                                      | Configure and operate the Onyx Portal network management system (5G) |
| [5G Onyx Portal 3.1.5 Alerts Reference](/docs/network-configuration-and-operations-guides/5g-onyx-portal-4.x-alerts-reference)                                | List and descriptions of the Onyx Portal 5G Alerts                   |
| [4G Onyx Portal 3.1.5 Operations Guide](/docs/network-configuration-and-operations-guides/5g-onyx-portal-4.x-operations)                                      | Configure and operate the Onyx Portal network management system (4G) |
| [4G Onyx Portal 3.1.5 Alerts Reference](/docs/network-configuration-and-operations-guides/4g-onyx-portal-4.x-alerts-reference)                                | List and descriptions of Onyx Portal 4G Alerts                       |
| [4G Onyx Edge On-Premises 3.1.3 Operations Guide](/docs/network-configuration-and-operations-guides/4g-onyx-edge-on-premises-4.x-installation-and-operations) | Install and manage Onyx Edge in an on-premises deployment.           |

## Onyx Software

Learn about our platform software and specifications

| Platform                                                         | Description                                                                                           |
| ---------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| [Onyx Edge](/docs/onyx-software/onyx-edge-specification)         | Specifications for Packet Core, 5G CU/DU, access point management, deployment options, and debugging. |
| [Onyx Portal](/docs/onyx-software/onyx-portal-specification)     | Specifications for Onyx Portal management, web-based orchestration, and Domain Proxy services.        |
| [Onyx RAN](/docs/onyx-software/onyx-ran-specification)           | Specifications for GXC RAN 4G and 5G radio access capabilities.                                       |
| [Onyx Security](/docs/onyx-software/onyx-security-specification) | Specifications for Onyx security architecture, data flows, access controls, and compliance.           |

## Application Notes

Technical reference material for planning and troubleshooting.

| Note                                                                                                                                              | Description                                                                                                                                          |
| ------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| [4G & 5G Firewall Config for Onyx Networks Application Note](/docs/application-notes/4g-and-5g-firewall-configuration-for-onyx-networks)          | Overview of network ports and firewall requirements for the Onyx Platform.                                                                           |
| [4G & 5G Onyx Networking Modes Application Note](/docs/application-notes/4g-and-5g-onyx-networking-modes)                                         | Overview of networking modes supported by the Onyx 4G and 5G platforms for enterprise deployments.                                                   |
| [4G & 5G Onyx Survey Solution Application Note](/docs/application-notes/4g-and-5g-onyx-survey-solution)                                           | Guidelines for conducting RF site surveys using GXC tools.                                                                                           |
| [5G Spectrum Analyzer Application Note](/docs/application-notes/5g-onyx-spectrum-analyzer)                                                        | Overview of the Onyx 5G Spectrum Analyzer for per-RU RF visibility, interference detection, and troubleshooting without external spectrum analyzers. |
| [4G & 5G Multi-Factor Authentication Application Note](/docs/application-notes/4g-and-5g-onyx-portal-mfa)                                         | Overview of multi-factor authentication for Onyx Portal access.                                                                                      |
| [4G & 5G Onyx Portal Integration with Customer IdP Application Note](/docs/application-notes/4g-and-5g-onyx-portal-integration-with-customer-idp) | Overview of IdP-to-IdP SAML Proxying Integration                                                                                                     |
| [4G Platform - Mesh Node Application Note](/docs/application-notes/4g-onyx-platform-mesh-node)                                                    | Overview of private cellular network design using GXC Mesh Nodes.                                                                                    |
| [4G Onyx AP Deployment Modes Application Note](/docs/application-notes/4g-ap-deployment-modes)                                                    | Specifications for GXC Access Point deployment modes and carrier configurations.                                                                     |
| [4G Onyx QoS Management Application Note](/docs/application-notes/4g-onyx-qos-management)                                                         | Overview of QoS management in the GXC Onyx platform.                                                                                                 |
| [4G Onyx Edge HA Application Note](/docs/application-notes/4g-onyx-edge-ha)                                                                       | Overview of MME high availability in the Onyx Edge platform.                                                                                         |

***

{% hint style="info" %}
If you can't find what you're looking for, reach out to GXC support at [gxc.io](https://www.gxc.io/).
{% endhint %}


# Onyx Edge Specification

The GXC Onyx Edge is a 3GPP-compliant private cellular platform that powers secure, high-performance Onyx 4G and 5G networks. Designed for scalability and edge resilience, the Onyx Edge supports critical enterprise-grade features tailored for different industry verticals.

## Packet Core

| <p>LTE Core</p><p></p><ul><li>3GPP-compliant S1, NAS, and SGi interfaces</li><li>High Availability via Onyx Edge Pools, ensuring 99.999% system reliability</li><li>Seamless inter-AP handovers over the S1 interface</li></ul>                             |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <p>5G SA Core</p><p></p><ul><li>3GPP-compliant Ng, N6 interfaces</li></ul>                                                                                                                                                                                  |
| QoS policy enforcement for subscriber data sessions                                                                                                                                                                                                         |
| UE IP address allocation via NAT (from local IP pools) or enterprise DHCP relay                                                                                                                                                                             |
| VLAN-based traffic segregation using APN-mapped VLANs for traffic isolation                                                                                                                                                                                 |
| Integrated database for subscription and policy management                                                                                                                                                                                                  |
| CPE monitoring for latency reporting                                                                                                                                                                                                                        |
| <p>Security and connectivity<br></p><ul><li>IPSec tunneling over the S1 interface for secure AP–Onyx Edge backhaul</li><li>Secure management interface over TLS for FCAPS operations</li><li>Encrypted NAS control plane between UE and Onyx Edge</li></ul> |

## 5G CU/DU

| 3GPP-compliant NR stack and F1 and Ng interfaces           |
| ---------------------------------------------------------- |
| ORAN-compliant 7.2x split architecture using eCPRI         |
| MIMO 4T4R (DL and UL)                                      |
| Configurable TDD patterns (DL-heavy and UL-heavy)          |
| Modulation order up to 256 QAM for DL and UL               |
| QoS-aware Scheduler                                        |
| Secure management interface over TLS for FCAPS operations  |
| Timing and synchronization via S-Plane using PTP and SyncE |
| Support for PTP Grandmaster Clock and Boundary Clock roles |
| Intra-DU handovers                                         |

## Access Point Management

| Management interface over TR-069 for LTE APs                                                       |
| -------------------------------------------------------------------------------------------------- |
| ORAN-compliant M-plane interface over NETCONF for RUs and FHMs                                     |
| Integrated SAS Domain Proxy for CBRS spectrum management                                           |
| <p>IP address management via DHCP:<br></p><ul><li>For 4G APs</li><li>For 5G FHMs and RUs</li></ul> |

## Deployment Options

| LTE Core available as an on-premises appliance or AWS hosted instance |
| --------------------------------------------------------------------- |
| 5G Core CU/DU available as an on-premises appliance                   |
| 5G Core available as an on-premises appliance                         |

## Debuggability

| Remote debugging capabilities      |
| ---------------------------------- |
| Metrics, log, and event generation |

## Product SKUs

<table><thead><tr><th width="239.5555419921875">SKU</th><th>Description</th></tr></thead><tbody><tr><td>GXC-OCSLP-001-LTE</td><td>Onyx LTE Connect SW Indoor/Outdoor per AP/Radio/eNB - 1 Yr</td></tr><tr><td>GXC-OCSLP-003-LTE</td><td>Onyx LTE Connect SW Indoor/Outdoor per AP/Radio/eNB - 3 Yr</td></tr><tr><td>GXC-OCSLP-005-LTE</td><td>Onyx LTE Connect SW Indoor/Outdoor per AP/Radio/eNB - 5 Yr</td></tr><tr><td>GXC-OCSLP-001-5G</td><td>Onyx 5G Connect SW Indoor/Outdoor per AP/Radio/gNB - 1 Yr</td></tr><tr><td>GXC-OCSLP-003-5G</td><td>Onyx 5G Connect SW Indoor/Outdoor per AP/Radio/gNB - 3 Yr</td></tr><tr><td>GXC-OCSLP-005-5G</td><td>Onyx 5G Connect SW Indoor/Outdoor per AP/Radio/gNB - 5 Yr</td></tr></tbody></table>

\* For hardware specifications, refer to the Onyx Edge Hardware Specifications.

\* Specifications and IDs are subject to change without prior notice.

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# Onyx Portal Specification

The GXC Onyx Portal is a cloud-native service for managing 4G and 5G Onyx networks with embedded Domain Proxy for SAS integration. It provides real-time visibility and comprehensive operations, administration, and management capabilities simplifying enterprise deployments.&#x20;

![](https://content.gitbook.com/content/Zc9hpHmiTCrh1sn4mWXn/blobs/ybnCq6cGQ8bE2HS2xe4g/media/image3.png)

## Onyx Portal (Web-based GUI) with Orchestrator

| Cloud native, highly scalable architecture                                                                                                                                                                                                                                                                                                                                                                                 |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Single pane of glass to configure, monitor, and manage network-wide operations                                                                                                                                                                                                                                                                                                                                             |
| Multi-tenant architecture for GXC partner and customer accounts                                                                                                                                                                                                                                                                                                                                                            |
| Real-time dashboard with metrics and status at network, equipment, subscriber levels                                                                                                                                                                                                                                                                                                                                       |
| <p>Network and venue management</p><p></p><ul><li>Network- and venue-level radio configurations</li><li>Venue floorplan visualization for indoor deployments</li></ul>                                                                                                                                                                                                                                                     |
| <p>Equipment management</p><p></p><ul><li>(4G) Onyx Edge (Core), Access Points, Mesh Node</li><li>(5G) Onyx Edge (Core), Onyx Edge (Core+NR), Access Points, FHM</li><li>Provisioning support for Onyx Edge and Mesh Node onboarding</li><li>Equipment upgrade groups for controlled, simultaneous software updates</li><li>Remote command execution on Onyx Edge</li><li>Equipment inventory with export option</li></ul> |
| <p>Subscriber management</p><p></p><ul><li>Integrated SIM provisioning (physical and eSIM)</li><li>IMEI-based device binding and SIM swap prevention</li><li>(4G) Mesh Node–AP affinity management</li><li>Bulk provisioning subscriber accounts</li></ul>                                                                                                                                                                 |
| <p>Traffic management</p><p></p><ul><li>Default QoS configuration per APN</li><li>(4G) Custom traffic policies and QoS configuration at application group level</li><li>Traffic management applied at subscriber group level via application group associations</li></ul>                                                                                                                                                  |
| <p>Alerts and events monitoring and management</p><p></p><ul><li>Custom alert rules</li><li>Per-user severity-based alert email notifications</li><li>Mute/unmute alert email notifications</li><li>Key equipment and subscriber-level events logging</li><li>Alert-to-equipment and alert-to-event mapping</li></ul>                                                                                                      |
| <p>User management</p><p></p><ul><li>Multi-account user support</li><li>Configurable user session timeout</li><li>Export users list</li></ul>                                                                                                                                                                                                                                                                              |
| Integrated analytics summary and plot reports with export option                                                                                                                                                                                                                                                                                                                                                           |
| Equipment diagnostic logs with export option                                                                                                                                                                                                                                                                                                                                                                               |
| Operations audit logs with 60-days retention and export option                                                                                                                                                                                                                                                                                                                                                             |
| Onyx Portal user notifications (broadcast messaging)                                                                                                                                                                                                                                                                                                                                                                       |
| <p>Security features</p><p></p><ul><li>Hosted on AWS Cloud, with AWS WAF for web application protection and GuardDuty for continuous threat detection</li><li>SSO and MFA authentication via IdP integration</li><li>Role-based user access control</li></ul>                                                                                                                                                              |
| Secure API support for integration with third-party applications                                                                                                                                                                                                                                                                                                                                                           |
| Support and documentation                                                                                                                                                                                                                                                                                                                                                                                                  |

## Domain Proxy

| <p>SAS for CBRS Band (n48)</p><p></p><ul><li>Integrated SAS support for CBRS Band n48 via embedded Domain Proxy</li><li>Intelligent spectrum management based on availability and preference</li><li>Category A and B CBSD support</li><li>BTS and CPE CBSD support</li><li>Alerts for SAS events and frequency changes</li><li>Integrated with Federated Wireless SAS</li><li>Extended transmission timer expiry support</li><li>(5G) CBSD groups for FHM-associated APs</li></ul> |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

## Product SKUs

<table><thead><tr><th width="239.8333740234375">SKU</th><th>Description</th></tr></thead><tbody><tr><td>GXC-OCSLP-001-LTE</td><td>Onyx LTE Connect SW Indoor/Outdoor per AP/Radio/eNB - 1 Yr</td></tr><tr><td>GXC-OCSLP-003-LTE</td><td>Onyx LTE Connect SW Indoor/Outdoor per AP/Radio/eNB - 3 Yr</td></tr><tr><td>GXC-OCSLP-005-LTE</td><td>Onyx LTE Connect SW Indoor/Outdoor per AP/Radio/eNB - 5 Yr</td></tr><tr><td>GXC-OCSLP-001-5G</td><td>Onyx 5G Connect SW Indoor/Outdoor per AP/Radio/gNB - 1 Yr</td></tr><tr><td>GXC-OCSLP-003-5G</td><td>Onyx 5G Connect SW Indoor/Outdoor per AP/Radio/gNB - 3 Yr</td></tr><tr><td>GXC-OCSLP-005-5G</td><td>Onyx 5G Connect SW Indoor/Outdoor per AP/Radio/gNB - 5 Yr</td></tr></tbody></table>

\* Specifications and IDs are subject to change without prior notice.

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# Onyx RAN Specification

The GXC Radio Access Network (RAN) software delivers a 3GPP-compliant, high-performance 4G and 5G solution for secure private cellular networks. Fully integrated with the Onyx Edge platform, it enables scalable, low-latency wireless connectivity for diverse enterprise and industrial environments.

## 4G

| Fully integrated with Onyx Edge and Onyx Portal                                                                                                                                                                                                                                                                                                                                                                                          |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 3GPP-compliant RAN stack with Uu and S1 interfaces                                                                                                                                                                                                                                                                                                                                                                                       |
| TR-069-based remote management interface                                                                                                                                                                                                                                                                                                                                                                                                 |
| SAS integration via Domain Proxy                                                                                                                                                                                                                                                                                                                                                                                                         |
| GNSS and PTP time synchronization mode support                                                                                                                                                                                                                                                                                                                                                                                           |
| QoS-aware Scheduler                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Link adaptation support                                                                                                                                                                                                                                                                                                                                                                                                                  |
| MME pooling support with UE load balancing across pooled MMEs                                                                                                                                                                                                                                                                                                                                                                            |
| CBRS n48 frequency band support                                                                                                                                                                                                                                                                                                                                                                                                          |
| <p>Carrier modes</p><p></p><ul><li>Single Carrier (SC): 1 cell per AP; up to 96 UE per AP</li><li>Dual Carrier (DC): 2 cells per AP; up to 96 + 96 UE per AP</li><li>Carrier Aggregation (CA): Combines carriers for enhanced throughput</li></ul>                                                                                                                                                                                       |
| <p>Radio configuration (via Onyx Portal)</p><p></p><ul><li>Configurable bandwidth, transmit power, and center frequency (SAS dependent)</li><li>Bandwidth configuration: Up to 40 MHz for CA, and 20 MHz for SC, per cell in DC</li><li><p>Subframe distribution configuration – DL/UL distribution</p><ul><li>Frame structure options: SA1, SA2, SA6</li><li>SSF configuration (SSF5/SSF7) for extended radio range</li></ul></li></ul> |
| <p>Mobility and handovers</p><p></p><ul><li>UE-assisted Automatic Neighbor Relations (ANR) management</li><li>Intra-Onyx Edge handovers across APs</li></ul>                                                                                                                                                                                                                                                                             |
| <p>Mesh Node and backhaul</p><p></p><ul><li><p>Multi-hop LTE relay support for extended range:</p><ul><li>Tunnels traffic to the Onyx Edge through one or more LTE APs in the path</li><li>Operates on the same CBRS band for both access and backhaul</li><li>Utilizes FCC-certified CPE as a SAS CBSD for high-power transmission</li><li>Secure management interface for FCAPS operations</li></ul></li></ul>                         |
| <p>Distributed Antenna System (DAS)</p><p></p><ul><li>Multi-antenna coverage extension for large indoor and enterprise environments</li><li>SAS integration via CBSD groups</li></ul>                                                                                                                                                                                                                                                    |
| <p>Security features</p><p></p><ul><li>IPSec support for secure backhaul</li><li>3GPP-compliant ciphering and integrity protection over Air interface</li></ul>                                                                                                                                                                                                                                                                          |

## 5G

| Fully integrated with Onyx Edge and Onyx Portal                                                                                                                                                                                                                                                                                              |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <p>Fronthaul interface</p><p></p><ul><li>O-RAN-compliant fronthaul based on 7.2x split architecture</li><li>VLAN-based separation for CU-S-plane</li></ul>                                                                                                                                                                                   |
| NETCONF-based in-band M-plane interface                                                                                                                                                                                                                                                                                                      |
| Time synchronization based on PTP and SyncE                                                                                                                                                                                                                                                                                                  |
| n48, n77, and n78 frequency band support                                                                                                                                                                                                                                                                                                     |
| MIMO 4T4R support                                                                                                                                                                                                                                                                                                                            |
| SAS integration via Domain Proxy                                                                                                                                                                                                                                                                                                             |
| Supports indoor and outdoor RU models based on form factor and power requirements                                                                                                                                                                                                                                                            |
| <p>Carrier modes<br></p><ul><li>Single Carrier (SC): 1 cell per AP; supports up to 128 UE per AP</li></ul>                                                                                                                                                                                                                                   |
| <p>Radio configuration (via Onyx Portal)</p><p></p><ul><li>Transmission power: Up to 37 dBm</li><li>Bandwidth: 20, 40, 50, 100 MHz (band and RU dependent)</li><li><p>Slot patterns:</p><ul><li>77% DL, 21% UL (DDDDDDDSUU)</li><li>74% DL, 23% UL (DDDSU)</li><li>54% DL, 43% UL (DDSUU)</li><li>34% DL, 63% UL (DSUUU)</li></ul></li></ul> |
| <p>Fronthaul Multiplexer (FHM)</p><p></p><ul><li>O-RAN-compliant Shared Cell functionality for extended radio coverage</li><li>Supports multiplexing of up to 8 RUs into a single cell</li><li>NETCONF-based M-plane interface</li><li>SAS integration via CBSD groups</li><li>Time synchronization based on PTP and SyncE</li></ul>         |
| <p>Distributed Antenna System (DAS)</p><p></p><ul><li>Multi-antenna coverage extension for large indoor and enterprise environments</li><li>SAS integration via CBSD groups</li></ul>                                                                                                                                                        |

## Product SKUs

<table><thead><tr><th width="245.1112060546875">SKU</th><th>Description</th></tr></thead><tbody><tr><td>GXC-OCSLP-001-LTE</td><td>Onyx LTE Connect SW Indoor/Outdoor per AP/Radio/eNB - 1 Yr</td></tr><tr><td>GXC-OCSLP-003-LTE</td><td>Onyx LTE Connect SW Indoor/Outdoor per AP/Radio/eNB - 3 Yr</td></tr><tr><td>GXC-OCSLP-005-LTE</td><td>Onyx LTE Connect SW Indoor/Outdoor per AP/Radio/eNB - 5 Yr</td></tr><tr><td>GXC-OCSLP-001-5G</td><td>Onyx 5G Connect SW Indoor/Outdoor per AP/Radio/gNB - 1 Yr</td></tr><tr><td>GXC-OCSLP-003-5G</td><td>Onyx 5G Connect SW Indoor/Outdoor per AP/Radio/gNB - 3 Yr</td></tr><tr><td>GXC-OCSLP-005-5G</td><td>Onyx 5G Connect SW Indoor/Outdoor per AP/Radio/gNB - 5 Yr</td></tr></tbody></table>

\* For hardware specifications, refer to the Access Point and FHM Hardware Specifications.

\* Specifications and IDs are subject to change without prior notice.

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# Onyx Security Specification

GXC's Onyx solution is a fully integrated, cloud-orchestrated platform for deploying and managing secure, private 4G and 5G cellular networks. Designed for enterprise and industrial environments, Onyx delivers robust, multi-layered security across the radio, edge, core, and management planes, ensuring data sovereignty and enterprise control.

## Security Architecture

Cellular networks operate across three distinct planes that separate functions for optimal performance, scalability, and security:

* End-to-end encryption and segmentation across all network layers
* Zero trust enforcement with least-privilege access control
* Full enterprise control over user, control, and management plane data
* Secure device onboarding and identity protection with SIM-based and cryptographic mechanisms
* Scalable orchestration and monitoring through the centralized Onyx Portal

## Data Flow and Security

Cellular networks operate across three distinct planes that separate functions for optimal performance, scalability, and security:

* **User Plane (Data Plane)** – Transports all application-level traffic between user devices and enterprise application services or external destinations, including the actual data payloads.
* **Control Plane** – Manages signaling between user devices and the network to establish, manage, and secure sessions, authenticate devices, and enforce mobility and QoS policies.
* **Management Plane** – Handles configuration, monitoring, orchestration, authentication records, and logs. It supports administrative control and operational visibility across the network.

The Onyx platform implements layered security across all three planes, ensuring enterprise data sovereignty and compliance while maintaining seamless usability and scale.

### **(4G & 5G) On-Premises Deployments**&#x20;

In on-premises deployments, user and control plane traffic terminate locally, ensuring full enterprise data ownership. Only minimal operational metadata is sent to the cloud-based Orchestrator, preserving data sovereignty by keeping sensitive application and session data within enterprise boundaries.

<p align="center"><strong>Data Flow &#x26; Security in 4G &#x26; 5G On-Premises Deployments</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FugUGmmbe9tyTWe1nBnRI%2Fimage.png?alt=media&amp;token=1d15d37f-baec-4618-8095-cbf05bea7aa0" alt=""><figcaption></figcaption></figure></div>

<p align="center"><strong>4G On-Premises Sequence Diagram</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FygYC3wunT8nW8ndANX8t%2Fimage.png?alt=media&amp;token=fbafa964-48d3-424a-88d4-ce45a6cb65f2" alt=""><figcaption></figcaption></figure></div>

<p align="center"><strong>5G On-Premises Sequence Diagram</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FOlequWlJYcaApC4e893n%2Fimage.png?alt=media&amp;token=eb7d1540-b62b-46cf-b4e2-add7e121e4cf" alt=""><figcaption></figcaption></figure></div>

### **(4G) Cloud Deployments**

In cloud deployments, all traffic is securely routed to a cloud-hosted Onyx Edge, enabling centralized orchestration without on-premises infrastructure. All communications are encrypted in transit, providing rapid scalability and simplified deployment while maintaining robust security controls.

<p align="center"><strong>Data Flow &#x26; Security in 4G Cloud Deployments</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FiO39aSGwuWTU0DWrScEN%2Fimage.png?alt=media&amp;token=6ff0c578-103c-4be6-8f13-10a812c785d1" alt=""><figcaption></figcaption></figure></div>

<p align="center"><strong>4G Cloud Sequence Diagram</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FZKe30kwqvmQOxCQsn1RF%2Fimage.png?alt=media&amp;token=7bf4935a-938b-4960-b97a-157d52a81b99" alt=""><figcaption></figcaption></figure></div>

## User Plane

<p align="center"><strong>User Plane in On-Premises Deployments</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FRJLCpbcxjDII9vPG5cee%2Fimage.png?alt=media&amp;token=c3869e53-409d-4c2a-95b2-c1a09ae1f37c" alt=""><figcaption></figcaption></figure></div>

<p align="center"><strong>User Plane in Cloud Deployments</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F1uJFDMGDxowMTOD8lRI7%2Fimage.png?alt=media&amp;token=8dae9831-d0cb-4534-94e5-8b96142adc31" alt=""><figcaption></figcaption></figure></div>

**Protection in Transit**

* (4G) OTA ciphering protects communication between UE and Onyx RAN using up to 128-EEA2 for encryption and 128-EIA2 for integrity protection
* (5G, On-Premises) OTA ciphering protects communication between UE and Onyx Edge using up to 128-NEA3 for encryption and 128-NIA3 for integrity protection
* (4G, Cloud) IPSec tunnels secure traffic between Onyx APs and the Onyx Edge using AES\_CBC-128 encryption cipher with HMAC-SHA2-256-128 integrity protection
* (On-Premises) APN-mapped VLANs isolate traffic by device group, enabling bridge networking mode, and limiting device exposure across VLAN segments. This supports enforcement of enterprise-managed segmentation and access policies at device group level.\
  VLAN IP domain segregation, combined with DHCP-based IP assignment, enables precise IP tracking and policy-driven access control. Enterprises can assign devices to specific subnets, monitor usage, and enforce local security controls across the enterprise LAN.
* (Cloud) Enterprise-managed firewall enforces traffic filtering and restricts malicious activity
* Enterprises can enforce end-to-end security protocols such as TLS or VPN between UE and enterprise application services to protect user traffic
* (On-Premises) Data is processed locally and handed over to the enterprise network, maintaining full enterprise control
* (Cloud) Data is securely routed to the Onyx Edge

**Protection at Rest**

* Data remains in volatile memory and is never stored persistently

## Control Plane

<p align="center"><strong>Control Plane in On-Premises Deployments</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0s5dQ4JvPWuH8aF3BMaY%2Fimage.png?alt=media&amp;token=01a43e0e-aa75-48b0-845f-86e18ef33fee" alt=""><figcaption></figcaption></figure></div>

<p align="center"><strong>Control Plane in Cloud Deployments</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FRztSk4898u0oRfNJXCCH%2Fimage.png?alt=media&amp;token=3684e4be-f1c6-4aa9-91cf-403a1951f657" alt=""><figcaption></figcaption></figure>

**Protection in Transit**

* (4G, Cloud) IPSec tunnels secure traffic between Onyx APs and the Onyx Edge using AES\_CBC-128 encryption cipher with HMAC-SHA2-256-128 integrity protection
* Encrypted NAS signaling protects communication between UE and Onyx Edge using SNOW-3G and AES-CTR encryption across 4G (128-EEA1/EEA2) and 5G (128-NEA1/NEA2) networks
* 4G/5G AKA authenticates devices and establishes shared encryption keys
* Milenage performs SIM-based challenge-response authentication and key derivation
* (5G, On-Premises) SUCI encryption shields subscriber identifiers using AES-128 in CTR mode with HMAC-SHA-256 integrity protection (3GPP Profile A)
* IMSI Lock with IMEI binding restricts SIM/eSIM usage to authorized devices to prevent unauthorized SIM transfers, SIM swap attacks, and device impersonation
* (On-Premises) All signaling transactions terminate at the Onyx Edge
* (Cloud) Signaling is securely routed to the Onyx Edge
* (Cloud) Enterprise-managed firewall enforces traffic filtering and restricts malicious activity
* Enterprise network remains oblivious to control plane operations

**Protection at Rest**

* Minimal control plane data required for Orchestrator operations is encrypted in transit and securely stored on the Orchestrator using encryption at rest

## Management Plane

<p align="center"><strong>Management Plane in On-Premises Deployments</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FrSWMwoiswS1FJzEsns23%2Fimage.png?alt=media&amp;token=fa86ae93-02b6-4fb0-9d60-ddc69f82baca" alt=""><figcaption></figcaption></figure>

<p align="center"><strong>Management Plane in Cloud Deployments</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FSqVomNvWEmYgzVWDOuRA%2Fimage.png?alt=media&amp;token=e34f920c-4fe6-4359-b93a-6bc2d6da52b8" alt=""><figcaption></figcaption></figure>

**Protection in Transit**

* TLS encryption (TLS 1.2/1.3) secures management traffic across all components using TLS\_ECDHE\_RSA\_WITH\_AES\_128\_GCM\_SHA256, TLS\_DHE\_RSA\_WITH\_AES\_256\_GCM\_SHA384, TLS\_AES\_256\_GCM\_SHA384, and TLS\_AES\_128\_GCM\_SHA256 cipher suites
* (5G) Secure NETCONF interface enables authenticated, automated RAN setup and configuration
* Cryptographically signed OTA equipment software updates are securely delivered and verified to ensure integrity and authenticity
* SIM/eSIM credentials and authentication tokens are transmitted from the Orchestrator to the Onyx Edge over encrypted channels
* Integrated CBRS Domain Proxy enables compliant, interference-free shared spectrum operations through encrypted communication with the SAS
* Enterprise-managed firewall enforces traffic filtering and restricts malicious activity
* Minimal management metadata is securely sent to the Orchestrator
* Enterprise network remains oblivious to management operations

**Protection at Rest**

* Data is encrypted to ensure confidentiality and prevent unauthorized access
* AWS key management services and credential safeguards protect stored credentials and sensitive assets
* Backups of configuration and operational data are encrypted and stored with geographical redundancy
* AWS IMDSv2 strengthens instance-level metadata protection, securing credentials and sensitive metadata in cloud instances
* Cryptographically signed OTA update packages are verified before installation to ensure software integrity

## Device Access

Device access in the Onyx platform is secured through layered controls within the enterprise network. The Onyx Portal / Orchestrator securely manage SIM provisioning, access policies, and configuration, providing control and end-to-end visibility across the network.

<p align="center"><strong>Device Access in On-Premises Deployments</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FkKMWA2f2LRYGDoImlGAc%2Fimage.png?alt=media&amp;token=c9adc0c7-d636-43c8-b415-17bbff59a045" alt=""><figcaption></figcaption></figure>

<p align="center"><strong>Device Access in Cloud Deployments</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fg8oqCn14CPjxc0GZU264%2Fimage.png?alt=media&amp;token=09131b5a-d0da-4a5f-892d-f48ca4179b84" alt=""><figcaption></figcaption></figure>

* (4G) OTA ciphering protects communication between UE and Onyx RAN using up to 128-EEA2 for encryption and 128-EIA2 for integrity protection
* (5G, On-Premises) OTA ciphering protects communication between UE and Onyx Edge using up to 128-NEA3 for encryption and 128-NIA3 for integrity protection
* (4G, Cloud) IPSec tunnels secure traffic between Onyx APs and the Onyx Edge using AES\_CBC-128 encryption cipher with HMAC-SHA2-256-128 integrity protection
* Encrypted NAS signaling protects communication between UE and Onyx Edge using SNOW-3G and AES-CTR encryption across 4G (128-EEA1/EEA2) and 5G (128-NEA1/NEA2) networks
* 4G/5G AKA authenticates devices and establishes shared encryption keys
* Milenage performs SIM-based challenge-response authentication and key derivation
* (5G, On-Premises) SUCI encryption shields subscriber identifiers using AES-128 in CTR mode with HMAC-SHA-256 integrity protection (3GPP Profile A)
* IMSI Lock with IMEI binding restricts SIM/eSIM usage to authorized devices to prevent unauthorized SIM transfers, SIM swap attacks, and device impersonation
* (On-Premises) APN-mapped VLANs isolate traffic by device group, enabling bridge networking mode, and limiting device exposure across VLAN segments. This supports enforcement of enterprise-managed segmentation and access policies at device group level.\
  VLAN IP domain segregation, combined with DHCP-based IP assignment, enables precise IP tracking and policy-driven access control. Enterprises can assign devices to specific subnets, monitor usage, and enforce local security controls across the enterprise LAN.
* (Cloud) Enterprise-managed firewall enforces traffic filtering and restricts malicious activity
* Enterprises can enforce end-to-end security protocols such as TLS or VPN between UE and enterprise application services to protect user traffic

## **GXC Equipment Access**

**Onyx Edge**

* Supports key-based SSH and local console access for the “agw\_user” account, enabling customers to log on to collect basic debug information, restart services, reboot the system, etc.
* Onyx Portal users have RBAC-restricted access to a limited set of diagnostic commands and troubleshooting features; all operations are audit logged
* GXC Engineering has direct login and key-based SSH access for troubleshooting operations
* Network port exposure is limited by design to minimize the attack surface
* All user operations and administrative actions are audit logged

**Onyx AP**

* GXC Engineering has secure, authenticated access for troubleshooting operations
* Configuration and updates are delivered via the Onyx Edge; all changes are audit logged
* Onyx APs are generally isolated from the enterprise network, preventing direct network access

**Mesh Node**

* Managed via the Onyx Edge with no direct network access
* Configuration and updates are delivered via the Onyx Edge; all changes are audit logged

**(5G) FHM**

* Managed via the Onyx Edge with no direct network access
* Configuration and updates are delivered via the Onyx Edge; all changes are audit logged

## Onyx Portal User Access & Third-Party Integrations

**Onyx Portal User Access**

* Logically isolated environments for each GXC partner and customer tenant enforce administrative separation and secure access boundaries, preventing cross-tenant data exposure
* SSO with MFA strengthens user authentication for Onyx Portal access
* CAPTCHA mechanisms, including reCAPTCHA, prevent automated credential abuse by bots
* Bcrypt-hashed user credentials mitigate brute-force and rainbow table attacks
* RBAC enforces least-privilege access for all Onyx Portal functions
* Flexible integration with enterprise IdPs enables seamless alignment with existing authentication frameworks and security policies
* Comprehensive audit logging tracks all access, configuration, and authentication events, with 60 days log retention
* AWS WAF protects Onyx Portal web interface against common attack vectors
* AWS GuardDuty continuously detects infrastructure threats and anomalies

**Third-Party API Integrations**

* API integrations allowing enterprises to export telemetry and logs to third-party applications are entirely optional and controlled by enterprise policy
* All API integrations use tokenized, tightly scoped connections with short-lived tokens
* Continuous validation and strict token-scoped permissions ensure secure access
* Comprehensive audit logging tracks all third-party API access and activities with 60 days log retention

## Compliance & Certifications

* FCC-certified for Part 96 compliance, supporting shared CBRS spectrum use in the United States
* SOC 2 Type I certification affirms GXC's internal controls to safeguard customer data

\* Specifications are subject to change without prior notice.

\* For definitions of acronyms and abbreviations used in this spec sheet, refer to the *GXC Glossary*.

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# 5G Onyx Architecture Solution Brief

## Overview

GXC’s 5G private wireless solution delivers carrier-grade performance with enterprise-grade simplicity. The fully integrated, scalable solution eliminates the complexities and operational overhead associated with traditional telecom deployments.

* **Seamless Integration** – GXC unifies 5G radio, transport, and core components into a cohesive system, eliminating multi-vendor complexity and enabling fast, reliable deployment.
* **Cost-Optimized Architecture** – Runs on scalable infrastructure and commodity hardware with flexible licensing, lowering total cost of ownership.
* **Easy Deployment, Built-In Flexibility** – Pre-integrated components and intuitive management tools simplify deployment and operations—even for IT teams without deep telecom expertise.
* **High-Capacity, Low-Latency Design** – Built for real-time responsiveness and large-scale connectivity, the solution supports bandwidth-intensive applications, concurrent device traffic, and mission-critical services.
* **Streamlined Security and Operations** – Integrated tools for SIM lifecycle management, security policy enforcement, and software updates provide centralized control with minimal operational overhead.
* **Future-Ready by Design** – GXC’s architecture supports software-defined upgrades, modular expansion, and full alignment with 3GPP and Open RAN standards—keeping your network ready for tomorrow.

### Key Concepts

<p align="center"><strong>GXC 5G Architecture</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FEydasWZo21AbhiVKmLud%2Fimage.png?alt=media&amp;token=9fe0973f-fff1-4260-aada-da0971284e36" alt=""><figcaption></figcaption></figure></div>

#### Core System Components

* **Onyx Edge: Integrated Edge Compute Platform** – A compact, all-in-one on-site appliance that integrates the 5G Core, Central Unit (CU), and Distributed Unit (DU). Onyx Edge enables low latency, local breakout, and on-premises application hosting—streamlining deployment and reducing external dependencies.
* **5G Core (5GC)** – Embedded within Onyx Edge, the 5G Core manages control and user plane functions such as authentication, session management, and mobility handling. This ensures data sovereignty and real-time responsiveness for enterprise applications.
* **Radio Access Network (RAN)** – Implements a 3-layer RU–DU–CU architecture using the O-RAN 7.2x functional split. Real-time processing occurs at the edge (DU), while the CU handles centralized control—enabling proximity-based radio access and high-performance, low-latency communications.
* **Transport Layer** – Connects the Onyx Edge to distributed RUs via high-speed, time-synchronized links using IEEE 1588v2 Precision Time Protocol (PTP) and Synchronous Ethernet (SyncE). This enables deterministic performance, low jitter, and precise timing for 5G fronthaul and TDD alignment.
* **Fronthaul Multiplexer (FHM)** – Aggregates and synchronizes traffic between the DU and connected RUs. FHM abstracts individual RUs into a unified radio layer, simplifies network design, and ensures cohesive coverage with minimal operational overhead.
* **Onyx Portal** – A cloud-native management interface providing a single pane of glass for configuring, monitoring, and managing private networks. It offers real-time visibility into network, equipment, and subscriber metrics, simplifying enterprise deployment and operations. The portal also supports integration with external systems via open APIs.

<p align="center"><strong>Onyx Portal Dashboard</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FlDgfmosMYq7af8fYbivN%2Fimage.png?alt=media&amp;token=3bbffa35-8b76-4e06-a328-24bda9040d48" alt=""><figcaption></figcaption></figure>

* **Mesh Node** – Enables wireless backhaul between a GXC Gateway Node and Access Points (APs) using self-interference mitigation techniques. Paired with a Mesh AP and orchestrated via the Onyx Platform, it delivers rapid, cable-free coverage extension—ideal for environments where wired infrastructure is unavailable.

#### Functional Capabilities

* **5G Standalone** – 5G deployment model that delivers low latency, high throughput, and flexible architecture through an on-premises, service-based core.
* **Open RAN-based Private Wireless** – Offers significant advantages including reduced costs using commercial off-the-shelf components, flexibility in selecting edge compute and radio units from multiple vendors, and support for a wide range of global frequency bands. Additionally, it enables transparent and touchless software upgrades, supports feature evolution—such as ultra-low latency, RedCap, and zero-frame drop broadcasting—without requiring hardware replacement. Critically, it allows for phased integration with existing infrastructure, avoiding costly rip-and-replace scenarios while ensuring scalable, future-ready connectivity.
* **Shared Cell Architecture with a Unified Radio Layer** – Enables multiple RUs to function as a single logical cell under one DU enabling more efficient spectrum utilization. This architecture improves user mobility, eliminates intercell interference, and simplifies RF planning—particularly in high-density environments like factories and warehouses.
* **DAS Support and Integration** – Support for both passive and active Distributed Antenna Systems (DAS) enabling shared infrastructure for public and private networks. It supports 1, 2, or 4-port MIMO distribution, automatic CBRS SAS registration, and both RF and O-RAN DAS interfaces—delivering centralized, cost-effective coverage even in complex venues.
* **High-Capacity, Flexible Spectrum Support** – Supports up to eight simultaneous carrier frequencies and synchronized TDD operation, allowing for optimized uplink/downlink balance, expanded coverage, and efficient spectrum utilization.
* **CBRS and Open Standards Support** – Fully compatible with CBRS and other localized spectrum bands. Adheres to O-RAN and 3GPP standards, ensuring vendor interoperability and seamless integration into existing enterprise IT infrastructure.
* **End-to-End Security** – Embedded across all layers, including SIM-based authentication, role-based access control, traffic segmentation, encryption, and secure management protocols. This ensures robust security and regulatory compliance.

## Summary

GXC’s 5G private wireless solution empowers enterprises with a future-ready network designed for performance, flexibility, and control. With an edge-based architecture, it delivers low latency and high-capacity throughput, making it ideal for real-time, bandwidth-intensive applications.

Built on open standards and engineered for rapid deployment, GXC’s 5G platform delivers robust security, operational agility, and long-term scalability—ensuring your network is ready for today and adaptable for tomorrow.

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# 5G Onyx Private Cellular and DAS Solution Brief

## Overview

Private cellular networks tailor wireless coverage and capacity to specific business requirements. Often, these purpose-built private networks are the only wireless network required, however in many mixed-use spaces, public wireless networks must co-exist to support a wider range of users. In facilities such as airports, hospitals, hotels, casinos, universities, and sporting arenas, Distributed Antenna Systems (DAS) are commonly used for public wireless network access. In these locations, 5G private networks can also be deployed alongside or through a DAS, using common antenna infrastructure. GXC’s Onyx Private 5G offers several options for antenna distribution and infrastructure sharing.

### Passive Distributed Antennas

Passive antenna distribution is used when a single radio or antenna pattern may not meet the coverage requirement, or in cases where the deployment of multiple active cells may not be feasible.

#### GXC Onyx 5G Passive Distribution

*Figure: Passive RU Antenna Distribution Options* illustrates passive antenna distribution options for the Onyx Private 5G Solution. One unique advantage of GXC’s solution is the ability to distribute and arrange antennas for 1-port, 2-port, and 4-port MIMO using passive coaxial cabling and couplers. This offers the network designer several options for matching coverage and capacity.

Using an example of a corporate campus, the parking garage might be best served with quad-SISO arrangement to achieve four times the coverage area per RU, whereas the auditorium might favor 4x4 MIMO distribution to accommodate high user density and network demand.

<p align="center"><strong>Passive RU Antenna Distribution Options</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fd1GWOahPDeqCaGxVKKnZ%2Fimage.png?alt=media&amp;token=7d4ba422-1b31-46eb-a1a8-0e563dbc4e21" alt=""><figcaption></figcaption></figure>

The antenna distribution methods shown in *Figure: Passive RU Antenna Distribution Options* can be applied to any cellular frequency band, including Citizens Broadband Radio Service (CBRS). Another unique feature of GXC’s Onyx platform is the automatic Spectrum Access System (SAS) registration for each passive antenna. This allows the Certified Professional Installer (CPI) the ability to specify location, gain, desired power, etc. and request individual grants for transmission.

#### GXC Onyx 5G Passive Distribution with Licensed Band DAS

When integrating private 5G with licensed-band DAS systems, the most common technique for band combining to the passive network is through a band diplexer, as shown in *Figure: DAS Diplexer Band Combining with GXC Onyx*.

<p align="center"><strong>DAS Diplexer Band Combining with GXC Onyx</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FIyPDv0kwpXkyAZ8T1hsc%2Fimage.png?alt=media&amp;token=0eb6f7d3-8634-45e0-a01d-7c6a2c8fa501" alt="" width="563"><figcaption></figcaption></figure>

In the special case of CBRS band, the adjacent C-band (3.7-3.98 GHz) and Auction 110 (3.45-3.55 GHz) spectrum may also be present on the DAS system. GXC’s filter and combining technology creates the necessary separation required to share the antenna infrastructure. For the example shown in *Figure: GXC CBRS and C-Band DAS: 2x2 MIMO Example*, the GXC G505 RU is hybrid-combined with the DAS operating in adjacent cellular bands using GXC filters BPF-001 and BRF- 001. This arrangement depicts a 2x2 MIMO distribution of 5G private wireless and licensed C-band.

<p align="center"><strong>GXC CBRS and C-Band DAS: 2x2 MIMO Example</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FUluHvsoj83GhccEwHQzr%2Fimage.png?alt=media&amp;token=a51f0996-98db-4767-8765-f8e352ea6dbc" alt=""><figcaption></figcaption></figure>

### Active Distributed Antennas

Active DAS systems are special cases where the antennas are only fed by the DAS (RU). These solutions place more active radios, often at lower power, at the edge of the network. This architecture requires that all supported frequencies travel through fiber optic distribution infrastructure to the DAS remote radio unit. For these systems, the two methods for interfacing with an active DAS are directly at RF (using an RRH, RU, gNB, or repeater) or with a digital signal source (such as a base station with a CPRI, eCPRI, or O- RAN fronthaul interconnect).

#### RF Signal Source for DAS

GXC offers RF-connectorized RUs in a range of power levels, from 24 dBm to 46 dBm, suitable for driving an active DAS Point of Interface (POI). As discussed with passive antenna distribution, another unique advantage with GXC Onyx for CBRS is the ability to register each DAS antenna with the SAS. Mechanisms are available for manual antenna data entry as well as automatic RU inventory and identification.

<p align="center"><strong>Active DAS and GXC Private Cellular with an RF DAS Interface</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FccrR9M7l3lwapjj05htz%2Fimage.png?alt=media&amp;token=2d13cdb5-6fcb-477a-9c13-a786391cec07" alt="" width="563"><figcaption></figcaption></figure>

#### Digital Signal Source for DAS

Macro network base stations provide a fronthaul interface between the edge compute platform and the remote radio using protocols such as CPRI, eCPRI, or O-RAN. Similarly, GXC’s Onyx 5G provides a fully compliant O-RAN interface for integration with a DAS vendor’s O-RAN digital DAS system input. As shown in *Figure: Active DAS and GXC Private Cellular with an O-RAN Digital DAS Interface*, these select DAS platforms eliminate the RF POI, RUs, RRHs, and offer the venue a significant power, space, and cost reduction.

<p align="center"><strong>Active DAS and GXC Private Cellular with an O-RAN Digital DAS Interface</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FlxCktcUQi5oXYDK94kp0%2Fimage.png?alt=media&amp;token=070ab3c0-1fb1-455d-988e-577dd9d39b23" alt=""><figcaption></figcaption></figure>

To learn more regarding active DAS vendor compatibility and supported private network bands, please contact GXC.

## Summary

GXC’s Onyx Private 5G addresses complex antenna distribution challenges by offering customers coverage and capacity options to optimize their network deployment. With unique features that include 1, 2, or 4-port MIMO distribution, automatic CBRS SAS registration, and both RF and O-RAN DAS interfaces, Onyx 5G can overlay with public networks across a multitude of DAS infrastructure deployments. This system flexibility and DAS compatibility offers customers a simplified, centralized, and cost-effective solution for deploying both private and public network services.

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# 5G Onyx Shared Cell / Super Cell Architecture Solution Brief

## Overview

Creating high-capacity, full-coverage indoor networks is challenging in complex environments—such as warehouses, airports, and manufacturing facilities—where dense layouts and difficult RF conditions hinder signal propagation and must accommodate varying user demands and mobility. Frequent reconfigurations and the movement of dense materials further complicate RF network planning. Meeting performance requirements (throughput, latency, reliability) in these dynamic settings often requires customized solutions.

The Shared Cell architecture represents a transformative approach to modern wireless network deployments, enabling a single logical cell to be seamlessly extended across multiple Radio Units (RUs). This advanced architecture is valuable where uniform coverage, capacity optimization, and simplified mobility management are critical.

### Key Concept

<p align="center"><strong>GXC Shared Cell Architecture</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FjmmuUr1rUoXZULiEZ4mx%2Fimage.png?alt=media&amp;token=3a73a733-955d-48b2-8370-8834260f7ce2" alt=""><figcaption></figcaption></figure>

In traditional cellular architectures, each RU defines a distinct cell, often requiring separate frequency allocations and complex interference management. GXC’s Shared Cell architecture redefines this approach by enabling multiple geographically distributed RUs to operate as a single logical cell under one Distributed Unit (DU), orchestrated through the Fronthaul Multiplexer (FHM).

This model allows for reuse of the same frequency channel across multiple RUs— maximizing the value of available spectrum while minimizing planning complexity. By consolidating radio coordination through the FHM, the system supports broad, seamless coverage and consistent performance without needing to segment frequency across individual cells.

With each RU serving its local area while maintaining a unified cell ID and channel, the network increases throughput capacity and user density—ideal for high-demand environments such as warehouses, factories, or distribution hubs. Additionally, frequency reuse in this shared cell configuration enables efficient scaling, lower interference, and simplified deployment.

### Operational Advantages

* **Seamless Mobility and Reduced Signaling Overhead** – Allows multiple RUs to function as a single logical cell under one DU enabling more efficient spectrum utilization. This improves user mobility, eliminates intercell interference, and simplifies RF planning—particularly in high-density environments like factories and campuses.
* **Uniform User Experience** – Consistent radio conditions are maintained across the extended coverage area, minimizing dropped calls and ensuring stable throughput, even at cell edges.
* **Simplified Network Architecture** – Reduced cell planning complexity and fewer handover-related failure points streamline network management and improve reliability.
* **Ideal for Private and Industrial Networks** – Shared Cell architecture is particularly well-suited for private 5G networks in enterprise environments, offering uninterrupted connectivity for critical applications and autonomous systems.

### GXC Solution

Drawing upon industry-standard O-RAN Alliance specifications, GXC has developed a unique alternative coverage approach that also enables increased capacity. This involves a complete architecture consisting of a single FHM supporting up to eight RU.

<p align="center"><strong>Single FHM Supporting up to Eight RUs</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FZnL2uV2Yi0wCm1UPFfwR%2Fimage.png?alt=media&amp;token=624c7a9c-856e-402c-aee5-2c259b09f83f" alt=""><figcaption></figcaption></figure>

For added coverage a main FHM can branch out to up to eight secondary FHMs, enabling up to 64 RUs operating collectively as a single "Shared Cell".

<p align="center"><strong>Primary and up to Eight Secondary FHMs Supporting 64 RUs</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FiYpguyCCrjgiBzIVCHJT%2Fimage.png?alt=media&amp;token=f3f2fb81-ae13-42ec-95c1-d2082fa0c041" alt=""><figcaption></figcaption></figure>

GXC's Shared Cell architecture offers a versatile and cost-effective approach to achieving a large single or multi-carrier coverage area.

#### Capacity Adjustments Within a Shared Cell

The capacity of a single cell can increase via flexible DU:RU associations. This allows for selectable shared cell coverage and capacity to match the needs of the deployment.

* **Highest Mobility (1x8 Shared Cell)** – One cell spans all eight RUs. UE see a single PCI (sector), resulting in zero handoffs as users move within the coverage area. This resembles Distributed Antenna System (DAS) functionality but utilizes standard O-RAN equipment.

<p align="center"><strong>1x8 Shared Cell</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FB41YnklHMQnAG0BxE9o2%2Fimage.png?alt=media&amp;token=cd774a49-6c5b-4af8-b7fb-b90e82c547c3" alt="" width="371"><figcaption></figcaption></figure>

* **Increased Throughput & Attachments (2x4 Shared Cell)** – Throughput and UE attachments are doubled. The network consists of two coverage cells (orange and blue), leading to a single handoff across the midline.

<p align="center"><strong>2x4 Shared Cell</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FLGoGG7Kr44KpW9uCz3iY%2Fimage.png?alt=media&amp;token=1dc9effe-8f0e-45bb-b572-9f1e9638fb02" alt="" width="352"><figcaption></figcaption></figure>

* **High Capacity (4x2 Shared Cell)** – Four cells are created, providing a 400% increase in throughput and density. This configuration may result in up to three handoff borders as UE move between cells.

<p align="center"><strong>4x2 Shared Cell</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F3WylGc3UepxM3CMOWu2Y%2Fimage.png?alt=media&amp;token=e140dd5d-4f29-4650-ab88-971710fbd8e0" alt="" width="359"><figcaption></figcaption></figure>

In low user density environments where a single RU lacks sufficient coverage and mobility, a 1x8 Shared Cell is an ideal solution. However, there are situations where an increase in user capacity is required. In these situations, a 2x4 or 4x2 Shared Cell configuration is a better approach.

These configurations also excel in highly reflective open areas without physical cell isolation, such as large indoor spaces like warehouses and stadiums.

Network options are user-configurable, allowing for deployments ranging from high-mobility to high-capacity environments with minimal equipment changes.

<p align="center"><strong>Shared Cell Models Comparison</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FBs6H4FdtHfGdzIYLUv4J%2Fimage.png?alt=media&amp;token=90257810-4c4f-48d9-8ec1-2c7b739d6ae2" alt=""><figcaption></figcaption></figure>

## Summary

The GXC Shared Cell architecture offers a next-generation solution for wireless networks by extending a single cell across multiple RUs. This approach enables operators to achieve enhanced coverage, greater spectral efficiency, and a consistent, high-quality user experience.

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# 5G Onyx Portal 4.x Operations


# Overview

GXC's 5G Onyx Solution is a fully integrated enterprise-grade private 5G platform designed to deliver secure, high-performance wireless connectivity. Tailored for industrial, campus, and large commercial deployments, the architecture combines 5G NR radio infrastructure with an on-premises 5G Core and centralized orchestration tools.

The Onyx architecture consists of several key components that work together to provide secure connectivity, centralized management, and scalable private 5G deployment.

<p align="center"><strong>GXC 5G Private Network Architecture</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmO15liXPVWa3MMBFCsEK%2Fimage.png?alt=media&amp;token=49eb6194-f835-4a94-ba9f-19742fa05759" alt=""><figcaption></figcaption></figure>

## 5G Onyx Edge Core

The 5G Onyx Edge Core provides the centralized control and user plane functions required for standalone (SA) 5G network operation. It performs subscriber authentication, session management, mobility control, and data routing between the radio access network and external data networks.

The platform integrates key 5G Core network functions, including:

* Access and Mobility Management Function (AMF)
* Session Management Function (SMF)
* User Plane Function (UPF)
* Authentication Server Function (AUSF)
* Unified Data Management (UDM)

Together, these functions enable secure device authentication, mobility management, policy enforcement, and efficient routing of user traffic between the private 5G network, enterprise LAN, and external networks.

The Onyx Edge 5G Core is supported only for on-premises deployment on ONYX-ES hardware.

Deployment Models:

* **Onyx Edge NR+Core** — This is GXC's standard 5G deployment model, in which the Onyx Edge hosts both the 5G Core and gNB functions. The Central Unit (CU) and Distributed Unit (DU) functions run on the Onyx Edge platform, while the Radio Unit (RU) provides the radio interface to user equipment (UE). This model provides a compact and integrated solution that simplifies installation while supporting full 5G standalone functionality.
* **Onyx Edge Core** — In this model, the Onyx Edge provides only the 5G Core network functions and interfaces with an external gNB infrastructure. This architecture enables integration with third-party radio access equipment and supports modular network deployments. GXC provides limited support for this deployment model. For details, contact GXC Technical Support.

{% hint style="info" %}
**NOTE:** In this release, Onyx Edge 5G is supported only for on-premises deployment on ONYX-ES hardware. Cloud-native deployment is not yet supported.
{% endhint %}

## Fronthaul Multiplexer (FHM)

The Fronthaul Multiplexer (FHM) is used in deployments that implement disaggregated RAN architectures with separate Radio Units (RUs) and Distributed Units (DUs). The FHM aggregates multiple fronthaul connections from RUs and consolidates them into a single interface toward the DU or integrated CU/DU system.

Key Functions:

* **Fronthaul Aggregation** — Aggregates high-bandwidth fronthaul traffic from multiple RUs into a single uplink toward the DU.
* **Precision Timing and Synchronization Optimization** — Provides precise timing synchronization using mechanisms such as IEEE 1588 Precision Time Protocol (PTP) or SyncE, which are required for time-division duplex (TDD) coordination and beamforming.
* **Scalable Deployment** — Supports deployment of multiple RUs across large sites or campuses while maintaining centralized DU or CU processing.

Deployment Scenarios:

* In large-scale indoor deployments, the FHM simplifies cabling and centralizes fronthaul management for ceiling- or wall-mounted RUs.
* In industrial outdoor environments, the FHM connects ruggedized RUs to a centrally located DU for streamlined network control and performance.

By decoupling the RU from the DU while maintaining high fronthaul fidelity, the FHM plays a pivotal role in delivering modular, scalable, and high-performance 5G networks tailored for complex enterprise needs.

## 5G RAN Architecture – CU, DU, and RU

GXC's 5G solution implements the disaggregated Radio Access Network (RAN) architecture defined by 3GPP and O-RAN standards. This architecture separates the traditional baseband processing into three functional components:

* **Radio Unit (RU)** — The RU provides radio frequency (RF) transmission and reception functions, including analog/digital conversion and beamforming. The RU is deployed at the network edge (e.g., light poles, towers, building rooftops) and connects to the DU over the fronthaul (e.g., eCPRI or Ethernet) interface.
* **Distributed Unit (DU)** — The DU is responsible for real-time processing tasks such as scheduling, MAC, and portions of the PHY layer. It is often deployed close to the RU (in the field or at edge data centers) to minimize latency. GXC's DU software runs on COTS hardware, either co-located with or separate from the RU.
* **Central Unit (CU)** — The CU performs non-real-time functions including RRC signaling, mobility control, and interface management with the 5G Core. It connects with the DU via the midhaul interface and typically resides in a centralized location, such as an enterprise data center or cloud region.

The GXC architecture supports multiple RAN deployment configurations, including:

* Integrated CU+DU+RU on Onyx Edge NR+Core for compact, turnkey deployments
* Split CU/DU with external RU for hybrid and distributed topologies
* Compatibility with O-RAN compliant third-party RUs in Onyx Edge Core deployments

This flexible architecture enables enterprises to optimize deployments based on coverage requirements, latency constraints, and physical site characteristics.

## 5G Access Points

GXC 5G Access Points function as gNB radio access nodes within the network. Depending on the deployment architecture, these devices may incorporate RU functionality or operate as integrated gNB nodes supporting CU, DU, and RU components. GXC 5G access infrastructure supports 5G NR frequency bands including n48 (CBRS), n77, n78. They support advanced features such as multiple-input multiple-output (MIMO) antenna systems and beamforming technologies to improve coverage and network capacity.

Select 5G APs can also operate as Mesh APs, serving as gateway nodes for Mesh Node backhaul. This mode is currently supported on the G228 low-power outdoor AP and the G244 high-power outdoor AP.

GXC's 5G AP lineup includes indoor APs with a compact form factor, ideal for smart factories and large indoor spaces, and ruggedized outdoor APs for industrial yards, campuses, and extended-range needs.

### 5G Mesh Nodes

Mesh Nodes enable wireless backhaul for APs where wired connectivity is unavailable. Each Mesh Node integrates a G244 or G228 AP with a mesh-capable radio to wirelessly connect back to the Onyx Edge. Using self-interference mitigation techniques, Mesh Nodes support simultaneous access and wireless backhaul traffic over the same CBRS band. This architecture supports flexible and rapid deployment of network infrastructure, making it ideal for temporary setups or complex physical environments.

5G Onyx networks support the Mesh Node GM03, a hardened mesh node providing higher power output and improved backhaul performance for demanding outdoor or industrial environments.

For more information, see the *GM03 Mesh Node Hardware Installation and Configuration Guide*.

{% hint style="info" %}
**NOTE:** Mesh Node GM03 is available only for early adopter trials in this release. For more information, contact GXC Technical Support.
{% endhint %}

## Spectrum Access and SAS Integration

For deployments operating in CBRS Band 48, the GXC solution integrates with certified Spectrum Access Systems (SAS) for dynamic spectrum allocation and interference coordination. The SAS integration enables automated spectrum authorization and real-time coordination with other CBRS systems, ensuring compliance with FCC regulatory requirements. SAS registration is handled seamlessly via the Onyx Platform, simplifying deployment and ongoing operation.

## Subscriber and SIM Management

The Onyx system supports physical SIM cards and embedded SIM (eSIM), with centralized policy management via the Onyx Portal. The UDM and AUSF functions in Onyx Edge manage subscriber identities, profiles, and authentication, while network slicing and QoS are enforced to match enterprise-level access control policies.

## Onyx Orchestrator

The Onyx Orchestrator is GXC's cloud-hosted backend service that manages the entire network infrastructure. It maintains configuration data, synchronizes settings across network components, and ensures policy enforcement. Onyx Edge and APs communicate regularly with the orchestrator to report their operational status and receive configuration updates. This orchestration layer is critical for maintaining network integrity, applying real-time configuration changes, and monitoring performance metrics.

## Onyx Portal

The Onyx Portal provides a centralized, web-based interface for monitoring and managing the private network. It is designed for intuitive control and visibility across all connected components, enabling simplified operation of enterprise private 5G deployments.


# Onyx Portal Login and Navigation

This section provides information for Onyx Portal users to get started using the Onyx Portal, including initial login procedures, portal navigation, and basic configurations to help users to familiarize themselves with the Onyx Portal's features and functions.

## Multi-factor Authentication

Multi-factor Authentication (MFA), also referred to as Two-Factor Authentication (2FA), is a layered approach to securing your Onyx Portal user account. A combination of two authenticators verifies your identity before you can log on to the Onyx Portal. Your Onyx Portal user ID/password is the first factor of authentication. A Time-based One-time Password (TOTP) generated by an authenticator app installed on your mobile phone is the second factor of authentication.

{% hint style="info" %}
**NOTE:** MFA is enabled system-wide for all Onyx Portal users and cannot be disabled.
{% endhint %}

{% hint style="info" %}
**NOTE:** If you log on to Onyx Portal using your customer organization's SSO credentials, you must follow your organization's MFA requirements.
{% endhint %}

**MFA workflow:**

{% stepper %}
{% step %}
Install an authenticator app on your mobile phone.

See [Install the Authenticator App](#install-the-authenticator-app).
{% endstep %}

{% step %}
Log on to the Onyx Portal and activate your MFA.

See [Activate Your MFA](#activate-your-mfa).
{% endstep %}

{% step %}
Whenever you log on to the Onyx Portal, use the current MFA OTP displayed in your authenticator app as your second factor of authentication.

See [Log On to the Onyx Portal](#log-on-to-the-onyx-portal).
{% endstep %}

{% step %}
If your mobile phone is compromised or lost, or your MFA backup codes are unavailable or exhausted, reset your MFA secrets.

See [Reset Your MFA Secrets](#reset-your-mfa-secrets).
{% endstep %}
{% endstepper %}

## Single Sign-On Authentication with IdP Support

Single Sign-On (SSO) and Identity Provider (IdP) are authentication mechanisms that work together to provide a seamless and secure user authentication experience across the Onyx Portal and other applications in the user's SSO ecosystem.

SSO is an authentication mechanism that allows users to access multiple applications and services with a single set of login credentials. Instead of requiring users to remember separate usernames and passwords for each application, SSO allows them to log in once and access all integrated applications or services without additional login steps. SSO simplifies the user experience, enhances security, and reduces the burden of managing multiple sets of user credentials.

An IdP is a trusted service that manages and authenticates user identities. It acts as the central authentication authority for user authentication within an ecosystem of applications. When a user tries to access an application that relies on the IdP for authentication, the IdP verifies the user's identity and grants or denies access accordingly. It also provides the user's identity information, such as username or email address, to the other applications or services.

The Onyx Portal can be integrated with a customer organization's existing IdP for user authentication. In which case, the user accounts exist in the customer's IdP. When a user attempts to access the Onyx Portal, the user is redirected to the customer's IdP login page. The IdP verifies the user's identity and issues a token or assertion that can be used to authenticate the user's access to the Onyx Portal and other applications or services within the customer's SSO ecosystem. This eliminates the need for the user to repeatedly provide login credentials.

If a customer's IdP cannot release the user attributes required for SSO user authentication (onyxPortalTenantId and onyxPortalRole) to the Onyx IdP, to enable SSO authentication for Onyx Portal users in the customer's organization, the user accounts are created in the Onyx Portal. To enable SSO authentication for such users, an "Upstream IdP User" parameter must be enabled at the user account level.

**Single Sign-On with IdP Support workflow:**

* (GXC Administrators) Configure SSO authentication with IdP configuration in the customer's Onyx Portal account.

  For more information, see Configure SSO Authentication with IdP Configuration.
* (All SSO users) When you log on to the Onyx Portal, in the Login page, click the **Sign in to an organization** link, then enter your organization's name. You are redirected to your organization's IdP page. Complete the authentication requirements as directed.

  For more information, see [Log On to the Onyx Portal](#log-on-to-the-onyx-portal).

## Activate Your Onyx Portal User Account

When your Onyx Portal user account is created you will receive an email from <onyx.accounts@gxc.io> with a link to verify your email ID (Onyx Portal user ID) and set your password. To activate your Onyx Portal user account, you must verify your email ID and set your password.

{% hint style="info" %}
**NOTE:** If you have issues with activating your Onyx Portal user account, contact your Onyx Portal Administrator.
{% endhint %}

**To verify your email ID and set your password:**

{% stepper %}
{% step %}
In the email from <onyx.accounts@gxc.io> with the subject line "Email Verification and Password Creation Link", click the link to verify your email ID and set your password.

The **GXC Set Password** page is displayed.
{% endstep %}

{% step %}
Enter the following details, then click **Continue**.

* **New Password** – (Required) Your new password.
* **Confirm Password** – (Required) Renter your new password.

Your Onyx Portal password must conform to the following requirements:

* Contain at least eight characters
* Contain at least one integer
* Contain at least one uppercase character
* Contain at least one lowercase character
* Contain at least one special character from the following: !@#$%^&\*
  {% endstep %}
  {% endstepper %}

## Set Up MFA

To set up your MFA, you must have an authenticator app installed on your mobile phone. If you don't already have it, you must install an authenticator app to activate and use your MFA. For more information, see [Install the Authenticator App](#install-the-authenticator-app).

### Install the Authenticator App

To activate and use MFA, you must install an authenticator app on your mobile phone. Any authenticator app that generates TOTPs using the standard "HMAC-based One-time Password" (HOTP) algorithms—such as Google Authenticator, Microsoft Authenticator, or DUO Mobile—can be used. The authenticator app generates the TOTPs used as the second factor of authentication.

This document describes how to use the Google Authenticator app, which is available for Android on the Google Play Store and for iPhone on the App Store.

### Activate Your MFA

{% hint style="info" %}
**NOTE:** Activating your MFA is a one-time procedure.
{% endhint %}

**To activate your MFA:**

{% stepper %}
{% step %}
Using a supported web browser visit [https://portal.gxc.io](https://portal.gxc.io/).

The Onyx Portal Login page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FMCNXuZZwcItTgPuD3GNo%2Fimage.png?alt=media&amp;token=2262f472-a308-4fd7-9dc9-0d84c16bb319" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details, then click **Login**:

* **Email** – (Required) Your Onyx Portal logon ID (email address).

The GXC IdP Login page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FaWE7qyTguawBrswZjzcu%2Fimage.png?alt=media&amp;token=d67d7e4b-a2b5-4590-aefe-14294ff66158" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details, then click **Login**:

* **Username** – (Required) Your Onyx Portal username (email address).
* **Password** – (Required) Your Onyx Portal password.
* **I'm not a robot** – (Displayed only if you fail a login attempt. Required.) Select to validate reCAPTCHA—a seamless fraud detection service that stops bots and other automated attacks by rate-limiting log on attempts while allowing valid users.

{% hint style="info" %}
**NOTE:** The **I'm not a robot** checkbox for reCAPTCHA validation is displayed only if you fail an Onyx Portal login attempt. For example, when you enter an incorrect username or password.
{% endhint %}

The **Activate Multi-Factor Authentication** dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJapBuGDYkAewH0wE6PWr%2Fimage.png?alt=media&amp;token=f583f603-18ea-4e96-835e-7ed12a60f350" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
On your mobile phone, open the authenticator app and scan the QR code displayed in the **Activate Multi-Factor Authentication** dialog box > **QR Code** section.

For example, if you are using the Google Authenticator app:

* If it is your first time setting up an MFA in the app, click **Scan a QR code**.
* If you have previously set up other MFA in the app, click > **Scan a QR code**.
* If you are unable to scan the QR code, click **Enter a setup key**, then manually enter the alphanumeric key displayed in the **Activate Multi-Factor Authentication** dialog box > **Setup Key** section.

To copy the setup key to your clipboard, click (copy).

The authenticator app displays a six-digit OTP.

You have activated your MFA successfully.

Hereon, every time you log in to the Onyx Portal, you must use the current OTP displayed in your authenticator app as your second factor of authentication.
{% endstep %}

{% step %}
Save your MFA backup codes to a safe location.

After activating your MFA, whenever you log on to the Onyx Portal, if you are unable to obtain an OTP from the authenticator app, instead of an OTP, you can use one of these backup codes as your second factor of authentication. For more information, see [MFA Backup Codes](#mfa-backup-codes).

To save your MFA backup codes as a text file, in the **Activate Multi-Factor Authentication** dialog box > **Backup Codes** section > click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKvLjHCGrlR5uzUeiZIhu%2Fimage.png?alt=media&amp;token=b7363482-b391-4790-9095-b24692307594" alt="" data-size="line"> (download).

{% hint style="info" %}
**NOTE:** If you do not download your backup codes before you confirm your MFA activation (Step 6), a text file containing your MFA backup codes is automatically downloaded to your computer. In your Downloads folder, look for the most recent text file with the name format "OnyxPortal\_BackupCodes\_*\<portal>*\_*\<date\_timestamp>*.txt".
{% endhint %}
{% endstep %}

{% step %}
Confirm your MFA is activated (Step 4).

You can log on to the Onyx Portal up to five times without activating your MFA (Step 4). To skip activating your MFA (Step 4), click **Skip**. After you exhaust your five grace logins, to access the Onyx Portal you must activate your MFA.

To confirm your MFA is activated (Step 4), click **Confirm MFA OTP**. The **Confirm MFA OTP** dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FHMIZcy1dNfcHguPPtxFD%2Fimage.png?alt=media&amp;token=b3065f1f-2650-489e-8b25-0144fa34a832" alt="" width="385"><figcaption></figcaption></figure>

Enter the MFA OTP displayed in the authenticator app on your mobile phone and click **Submit**.

The Onyx Portal Dashboard is displayed.
{% endstep %}
{% endstepper %}

### MFA Backup Codes

After activating your MFA, if your mobile phone is unavailable or you are unable to obtain an OTP from the authenticator app, instead of an OTP, you can pro tem use a backup code as your second factor of authentication.

You must make sure to save your backup codes that are displayed when you activate your MFA and whenever you reset your MFA secrets. For more information, see [Activate Your MFA](#activate-your-mfa) and [Reset Your MFA Secrets](#reset-your-mfa-secrets) respectively.

{% hint style="info" %}
**NOTE:** Only if you have saved the backup codes that were generated when you activated your MFA or last reset your MFA secrets, whichever is recent, can you use the backup codes.
{% endhint %}

{% hint style="info" %}
**NOTE:** The MFA backup codes are single use only and cannot be reused.
{% endhint %}

{% hint style="info" %}
**NOTE:** If you have not saved your backup codes, or if you have exhausted all your backup codes, you can reset your MFA secrets to generate a new set of backup codes. For more information, see [Reset Your MFA Secrets](#reset-your-mfa-secrets).
{% endhint %}

{% hint style="info" %}
**NOTE:** When you reset your MFA secrets, any previous backup codes will become invalid.
{% endhint %}

{% hint style="info" %}
**NOTE:** If you are unable to obtain MFA OTPs to log in to the Onyx Portal and have exhausted your MFA backup codes, you will have to create a support ticket to contact GXC Technical Support for assistance. When the message *"You have exhausted your MFA backup codes. Please contact GXC Technical Support for assistance.*" is displayed, click the "*Technical Support*" link to enter the "Onyx Support Portal" and create the support ticket.
{% endhint %}

## Access the Onyx Portal

You can use any one of the following web browsers to access the Onyx Portal:

* Google Chrome (latest version)
* Mozilla Firefox (latest version)

## Log On to the Onyx Portal

You can log on to the Onyx Portal only if you have an Onyx Portal user account, or if SSO authentication is supported for your customer organization (your organization's IdP is integrated with the Onyx Portal/Onyx IdP).

For information to log on with your Onyx Portal credentials, see [Log On with Your Onyx Portal Credentials](#log-on-using-your-organizations-sso-credentials).

For information to log on with your customer organization SSO credentials, see [Log On using Your SSO Credentials](#log-on-using-your-organizations-sso-credentials).

### Log On Using Your Onyx Portal Credentials

{% hint style="info" %}
**NOTE:** Before you can log on to the Onyx Portal for the first time, you must activate your Onyx Portal user account. For more information, see [Activate Your Onyx Portal User Account](#activate-your-onyx-portal-user-account).
{% endhint %}

{% stepper %}
{% step %}
Open a supported web browser and visit [https://portal.gxc.io](https://portal.gxc.io/).

The Onyx Portal Login page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJ4ncjsrenWyoiafw8pEx%2Fimage.png?alt=media&amp;token=39babda0-4c08-4848-95ff-459ef0bbf641" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details, then click **Login**:

* **Email** – (Required) Your Onyx Portal logon ID (email address).

The IdP Login page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F79d0cq2uu8yc8MJa5fbj%2Fimage.png?alt=media&amp;token=632def43-2360-4436-b2ba-46f5b7f76370" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details, then click **Login**:

* **Email** – (Required) Your Onyx Portal username (email address).
* **Password** – (Required) Your Onyx Portal password.
* **I'm not a robot** – (Displayed only if you fail a login attempt. Required.) Select to validate reCAPTCHA—a seamless fraud detection service that stops bots and other automated attacks by rate-limiting log on attempts while allowing valid users.

{% hint style="info" %}
**NOTE:** The **I'm not a robot** checkbox for reCAPTCHA validation is displayed only if you fail an Onyx Portal login attempt. For example, when you enter an incorrect username or password.
{% endhint %}

The 2FA page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FNx2cUZzYQCHhZ1BLmfaX%2Fimage.png?alt=media&amp;token=84216ca0-897b-40bc-b81f-f1a4be09b437" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the six-digit MFA OTP displayed in the authenticator app on your mobile phone, then click **Login**.

{% hint style="info" %}
**NOTE:** The six-digit OTP refreshes every 30 seconds and is valid only for one minute.
{% endhint %}

{% hint style="info" %}
**NOTE:** If your mobile phone is not accessible or you are unable to obtain an MFA OTP, instead of an MFA OTP you can pro tem use an MFA backup code to authenticate your Onyx Portal logon. For more information, see [MFA Backup Codes](#mfa-backup-codes).
{% endhint %}

{% hint style="info" %}
**NOTE:** If you are unable to obtain MFA OTPs to log in to the Onyx Portal and you have exhausted your MFA backup codes, you will have to create a support ticket to contact GXC Technical Support for assistance. When the message "*You have exhausted your MFA backup codes. Please contact GXC Technical Support for assistance.*" is displayed, click the "*Technical Support*" link to enter the "Onyx Support Portal" and create the support ticket.
{% endhint %}

You are logged on to the Onyx Portal, and the Dashboard page is displayed.
{% endstep %}
{% endstepper %}

### Log On Using Your Organization's SSO Credentials

{% hint style="info" %}
**NOTE:** If you log on to the Onyx Portal using your customer organization's SSO credentials, you must follow your organization's MFA requirements.
{% endhint %}

{% hint style="info" %}
**NOTE:** To use SSO authentication, your organization's IdP must be integrated with the Onyx IdP. In this case, the user accounts exist in the customer IdP and are authenticated by the customer IdP.
{% endhint %}

{% stepper %}
{% step %}
From a supported web browser visit [https://portal.gxc.io](https://portal.gxc.io/).

The Onyx Portal Login page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Ffg4NxMZGzFJZ9s5apRuj%2Fimage.png?alt=media&amp;token=f9386588-88a0-442e-acd3-b7a4fca9f74c" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Click the **Sign in to an Organization** link.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F13HTAhkE9tRp7TV01TLR%2Fimage.png?alt=media&amp;token=01d8622f-2bf3-49fd-b7b8-c16bf9f329c9" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details, then click **Login**.

* **Organization Name** – (Required) Your organization's name.

Contact your Onyx Portal administrator for the organization name to use.

{% hint style="info" %}
**NOTE:** The **Organization Name** field is case-sensitive.
{% endhint %}
{% endstep %}

{% step %}
Your organization's IdP login page is displayed.

Enter the authentication information required by your organization's IdP and continue as instructed.

You are logged on to the Onyx Portal, and the Dashboard page is displayed.
{% endstep %}
{% endstepper %}

## Log Off from the Onyx Portal

**To log off from the Onyx Portal:**

{% stepper %}
{% step %}
In the upper-right corner of the page, click the current Onyx Portal account's name, then click **Logout**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FOd8HGLdjFCWsqnavoEan%2Fimage.png?alt=media&amp;token=87088ff8-9f85-4618-811b-08da157b2c9b" alt="" width="231"><figcaption></figcaption></figure>

You are logged out of the Onyx Portal.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FpzYaVneGnrElkTB54gLd%2Fimage.png?alt=media&amp;token=0b56bdf7-ac45-4afb-8303-249c6c960483" alt=""><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}

### Single Log Off

If you logged on to the Onyx Portal using SSO with IdP authentication, on logging out, you will also be logged out from all other active applications and services supported within your SSO ecosystem.

### Automatic Termination of Idle User Sessions

The Onyx Portal automatically terminates idle user sessions after a configurable timeout period. Session timeout is configurable at the GXC partner and customer account levels, and at individual user level, with the user-level configuration taking precedence over the GXC partner/customer level configuration.

For more information, see *Create GXC Partner Accounts* or *Edit GXC Partner Accounts* and *Create Customer Accounts* or *Edit Customer Accounts* respectively.

## Reset Your Forgotten Onyx Portal Password

If you have forgotten your Onyx Portal password, you can reset it from the Onyx Portal Login page. Your new password must conform to the following requirements:

* Contain at least eight characters
* Contain at least one integer
* Contain at least one uppercase character
* Contain at least one lowercase character
* Contain at least one special character from the following: !@#$%^&\*

{% stepper %}
{% step %}
In the Onyx Portal Login page, click the **Reset/Forgot Password?** link.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FWRb8h2NVu0eHddY6smcO%2Fimage.png?alt=media&amp;token=8a327507-7f4f-436b-bc8a-3548fd8da2d9" alt=""><figcaption></figcaption></figure>

The Reset Password page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FItiwswAidQ8L7WkZurYW%2Fimage.png?alt=media&amp;token=822b938c-7587-44d5-bb8b-4d4204a44be9" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details, then click **Continue**.

1. **Email** – Enter your logon ID (email address).
2. Solve the CAPTCHA and enter the answer in the field provided below the CAPTCHA image.

   An email is sent to your registered email address with a link to reset your password. Please note that the reset password link is valid for 24 hours and will expire afterward.
   {% endstep %}

{% step %}
Click the reset password link in the email.

The Reset Password page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FkeJYG0wA2EURWMUr7aOA%2Fimage.png?alt=media&amp;token=a10cb7b5-2d3c-4b84-946c-a9cc1d7a566a" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details, then click **Continue**.

* **New Password** – (Required) Enter your new password.
* **Confirm Password** – (Required) Renter your new password to confirm.

The Onyx Portal Login page is displayed.
{% endstep %}
{% endstepper %}

## Change Your Onyx Portal Password

You can choose to change your active Onyx Portal password anytime you are logged on to the Onyx Portal.

Your Onyx Portal password must conform to the following requirements:

* Contain at least eight characters
* Contain at least one integer
* Contain at least one uppercase character
* Contain at least one lowercase character
* Contain at least one special character from the following: !@#$%^&\*

{% stepper %}
{% step %}
In the upper-right corner of the page, click the current Onyx Portal account's name, then click **Reset Password**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F6qUYwlIUjMNUskSfjWHC%2Fimage.png?alt=media&amp;token=054355df-cad1-4900-bce1-54ef73bbb740" alt="" width="231"><figcaption></figcaption></figure>

The **Reset Password** page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FBkL6p4uahbXNvUxxNK3m%2Fimage.png?alt=media&amp;token=1716114f-af62-4dcc-94f4-274ae08ad1bf" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details:

* **Old Password** – (Required) Your current password.
* **New Password** – (Required) Your new password.
* **Confirm Password** – (Required) Renter your new password.
* **Logout from all devices** – Turn on to log out of your Onyx Portal account on all devices.
  {% endstep %}

{% step %}
In the upper-right corner of the page, click **Reset Password**.
{% endstep %}
{% endstepper %}

## Reset Your MFA Secrets

If your mobile phone is compromised or lost, or your MFA backup codes are unavailable or exhausted, you must reset your MFA secrets. Resetting your MFA secrets is equivalent to deleting your MFA registration, allowing you to set up your MFA again as if you are a new user.

{% hint style="info" %}
**NOTE:** If you do not have access to your phone temporarily, you can use the backup codes to log in. If you do not have the backup codes, you must reset your MFA secrets.
{% endhint %}

**To reset your MFA secrets:**

{% stepper %}
{% step %}
In the upper-right corner of the page, click the current Onyx Portal account's name, then click **Reset MFA Secrets**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fz4y1ePSMRDow8xTiuJbm%2Fimage.png?alt=media&amp;token=d94ff98c-b4ce-4c62-87d7-2914c311c416" alt="" width="231"><figcaption></figcaption></figure>

{% hint style="info" %}
**NOTE:** The **Reset MFA Secrets** option is enabled only if you have already activated your MFA. For more information, see [Activate Your MFA](#activate-your-mfa).
{% endhint %}

A confirmation dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FTCBTHI8CMp2nbQTYDWTE%2Fimage.png?alt=media&amp;token=45ccb213-e629-4535-a444-6d4201eb12bd" alt="" width="310"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To reset your MFA secrets, click **Yes**.

The **Reset MFA Secrets** dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F6V2Iky0QHu7uZbT9kEwG%2Fimage.png?alt=media&amp;token=82629f77-e9fa-444e-9364-5d3640352397" alt="" width="563"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
On your mobile phone, open the authenticator app and scan the QR code displayed in the **Reset MFA Secrets** dialog box > **QR Code** section.

For example, if you are using the Google Authenticator app:

* If it is your first time setting up MFA in the app, click **Scan a QR code**.
* If you have previously set up other MFA in the app, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F4oglx2ImnBnFzixr7gTZ%2Fimage.png?alt=media&amp;token=b373ee03-e810-4d30-9118-3f88a6e110b8" alt="" data-size="line"> > **Scan a QR code**.
* If you are unable to scan the QR code, click **Enter a setup key**, then enter the alphanumeric key displayed in the **Reset MFA Secrets** dialog box > **Setup Key** section.

To copy the setup key to your clipboard, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FvMC5Z0f8afQRepDeI1NT%2Fimage.png?alt=media&amp;token=26afcd51-1123-457e-8b80-7b8f6ed96b76" alt="" data-size="line"> (copy).

The authenticator app displays a six-digit OTP.

You have reset your MFA secrets successfully.

From now on, every time you log in to the Onyx Portal, you must use the current OTP displayed in your authenticator app as your second factor of authentication.
{% endstep %}

{% step %}
Save your MFA backup codes to a safe location.

Whenever you log on to the Onyx Portal, if you are unable to obtain an OTP from the authenticator app, instead of an OTP, you can use one of these backup codes as your second factor of authentication. For more information, see [MFA Backup Codes](#mfa-backup-codes).

To save your MFA backup codes as a text file, in the **Reset MFA Secrets** dialog box > **Backup Codes** section > click ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FTeFMEg9QVGEExmNL2Ic4%2Fimage.png?alt=media\&token=502156d3-188c-4053-83ea-3de35de48ed5) (download).

{% hint style="info" %}
**NOTE:** When you reset your MFA secrets, any previous backup codes will become invalid.
{% endhint %}

{% hint style="info" %}
**NOTE:** If you do not download your backup codes before you close the **Reset MFA Secrets** dialog box, a text file containing your MFA backup codes is automatically downloaded to your computer. In your Downloads folder, look for the most recent file with the name format "OnyxPortal\_BackupCodes\_*\<portal>*\_*\<date\_timestamp>*.txt".
{% endhint %}
{% endstep %}

{% step %}
To confirm your MFA secrets are reset (Step 3), click **Confirm MFA OTP**.

The **Confirm MFA OTP** dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fnu5yCckYNRuYeBnnipXR%2Fimage.png?alt=media&amp;token=7fa755d1-c939-4396-ab70-3d0aeec86e58" alt="" width="307"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the MFA OTP displayed in the authenticator app on your mobile phone and click **Submit**.
{% endstep %}

{% step %}
The next time you try to log on to the Onyx Portal, after your user ID/password is authenticated, the **2-Factor Authentication OTP** dialog box is displayed. Enter the OTP displayed in your authenticator app and click **Login**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F34LrSjIe0mUEVzSplJ30%2Fimage.png?alt=media&amp;token=c8887fe0-7e01-4e3e-939c-f680a0df312f" alt=""><figcaption></figcaption></figure>

After the OTP is authenticated, you are logged in to the Onyx Portal, and the Dashboard page is displayed.
{% endstep %}
{% endstepper %}

## User Interface and Navigation

The Onyx Portal's user interface is organized into three primary areas, the header area at the top of the window, the navigation menu to the left, and the content area. The header and the navigation menu are always visible in the Onyx Portal interface allowing for intuitive and quick navigation and operations.

### Header Area

The Onyx Portal interface's header area.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F94lvVEU2U3x4GPg5O3mC%2Fimage.png?alt=media&amp;token=8fc39a35-ce19-428c-a7ea-213ce5b1f972" alt=""><figcaption></figcaption></figure>

The Onyx Portal interface's header area displays the following:

* Default Network – The network for which data is currently displayed in the Onyx Portal. For more information on networks, see *Manage Networks*.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FEZDW6HQzwEYsBt4u3a24%2Fimage.png?alt=media&amp;token=9bdec771-128d-42c2-a2b8-f56de11cf91e" alt="" data-size="line">indicates the default network has not been selected.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FfpcqJLNfYjcjCSq6Q4Uu%2Fimage.png?alt=media&amp;token=27a42f28-966f-410b-838d-dd17e5b8be0a" alt="" data-size="line"> indicates the default network is a 4G network.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FAT40vbB8o0GDxQySp5nC%2Fimage.png?alt=media&amp;token=9969fe54-9123-4a9d-90b5-a3011377fa4d" alt="" data-size="line"> indicates the default network is a 5G network.
* <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FvVVGhj0ZKtZxCAvgmq3k%2Fimage.png?alt=media&amp;token=5fd5363b-8738-48a6-8239-0ae1c30f86f7" alt="" data-size="line"> (Active Alerts Counter) – The number of active Critical, Major, Minor, and Other alerts. The Other category accounts for alerts of Warning, Info, and Notice severities. To view alert details, click the panel. For more information on alerts, see *Manage Alerts*.
* <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FiSQ0ja8UfxaCuZofdSQt%2Fimage.png?alt=media&amp;token=14d82bca-c873-4a5b-a868-96e32db04f6f" alt="" data-size="line"> (Notifications) – Indicates any active Onyx Portal user notifications. For example, about a planned downtime for a software upgrade.

  To view a summary list of active notifications, click the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FhrQYln29pr95PRmKI9bm%2Fimage.png?alt=media&amp;token=3a810e90-49cc-4b2b-9be5-916675137584" alt="" data-size="line"> (Notifications) icon.

  <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FkRpl3rEQPqFvRd3hsR3x%2Fimage.png?alt=media&amp;token=789ce38e-1b88-41e3-9c99-4d3ecea89bd5" alt="" width="468"><figcaption></figcaption></figure>

  To view a notification's details, click its title.
* GXC\_&#x56;*\<x>.\<x>.\<x>* – The Onyx Portal's software version.
* *\<current Onyx Portal account's name>* – The currently selected Onyx Portal account's name. Click to access a shortcut menu to switch accounts, change your password, enable MFA, or log off from the Onyx Portal.

  <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FzVbiuw9etuZxAnuuGdYM%2Fimage.png?alt=media&amp;token=dadb5b9a-82a1-46d1-b527-23a4deb6c02f" alt="" width="231"><figcaption></figcaption></figure>

  * **Current Account**
    * *\<current Onyx Portal account's name>*
      * *\<current user's email ID>*
  * **Other Accounts**

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> You will find account switching options corresponding to your user role. As a GXC Administrator, you can switch between GXC Root, partner, and customer accounts. If you are a Partner Administrator, you can switch between your partner and customer accounts. Super Administrators, Administrators, and Viewers do not have the option to switch accounts.</p></div>

    * **(R) Select GXC Root** – Click to switch to the GXC Root account.
    * **(C) Select Customer** – Click to switch to a customer account. The **Switch Customer** dialog box is displayed. Click the customer account's name.
    * **(P) Select Partner** – Click to switch to a GXC partner account. The **Switch Partner** dialog box is displayed. Click the GXC partner account's name.

    For information on Onyx Portal accounts, see *Manage Onyx Portal Accounts*.
  * **Reset Password** – Click to change your Onyx Portal password. For more information, see [Change Your Onyx Portal Password](#change-your-onyx-portal-password).
  * **Reset MFA Secrets** – Click to reset your MFA secrets.
  * **Logout** – Click to log off from the Onyx Portal. For more information, see [Log Off from the Onyx Portal](#log-off-from-the-onyx-portal).

### Navigation Pane

You can use the navigation pane to quickly access the various Onyx Portal features. The navigation pane includes a collapse/expand toggle, allowing you to minimize the menu to icons only or expand it to display full labels. This provides additional screen space and helps you optimize your workspace layout based on your preferences and screen size.

Collapsed State:

* Displays icon-only navigation
* Maximizes screen real estate for viewing
* Maintains quick access to menu items via recognizable icons

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FWhNcSFRphF6JENbvch6S%2Fimage.png?alt=media&amp;token=2e98c8eb-790b-4672-a453-38682c62c62f" alt="" width="54"><figcaption></figcaption></figure>

Expanded State:

* Displays the full menu with icons and labels
* Provides traditional navigation experience
* Shows complete menu item names

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FOkHfw8QhW9yx47IQMZzj%2Fimage.png?alt=media&amp;token=96024b3b-da08-47aa-9204-bdb062010fbe" alt="" width="125"><figcaption></figcaption></figure>

* **Dashboard** – View an overview of the network's key metrics at a glance. For more information, see [Administrator Dashboard](#administrator-dashboard) and [Onyx Portal Dashboard](#onyx-portal-dashboard).
* **Network** – View details and manage networks under the selected Onyx Portal account. For more information, see *Manage Networks*.
* **Venues** – View details and manage venues in the selected network. For more information, see *Manage Venues*.
* **Equipment** – View details and manage Onyx Edge, Mesh Node, and AP equipment in the selected network. For more information, see *Manage Equipment*.
* **Subscribers** – View details and manage subscriber groups and subscriber accounts in the selected network. For more information, see *Manage Subscriber Groups and Accounts*.
* **Traffic** – View details and manage APNs, Applications, and Application Groups in the selected network. For more information, see *Manage Traffic*.
* **Analytics** – Generate Key Performance Indicator (KPI) reports that provide insight into the performance and status of your networks. For more information, see *Analytics*.
* **Alerts** – View details and manage alerts, alert rules, and alert receivers in the selected network. For more information, see *Manage Alerts*.
* **Administration** – View details and manage administrative functionality including Onyx Portal accounts, user accounts, cloud configurations, etc. For more information, see *Administration*.
* **Documentation** – View product release notes and user documentation.
* **Contact Us** – View the Onyx Technical Support Portal. Displays the Onyx Technical Support Portal to submit tickets and access the GXC Help Center.

### Administrator Dashboard

{% hint style="info" %}
**NOTE:** The Administrator Dashboard is exclusively available to GXC Administrators and GXC Partner Administrators.
{% endhint %}

GXC Administrators can use the Administrator Dashboard to monitor and manage administration activities across all Onyx Portal accounts. If you are a GXC Administrator, to view the Administrator Dashboard, you must select the "GXC Root" account. To exit the Administrator Dashboard, select any other Onyx Portal account.

GXC Partner Administrators can use the Administrator Dashboard to monitor and manage administration activities within their direct customer accounts. If you are a GXC Partner Administrator, to view the Administrator Dashboard, you must select your own GXC partner account. To exit the Administrator Dashboard, select any of your customer accounts.

To switch between Onyx Portal accounts, in the upper-right corner of the page, click the current Onyx Portal account's name.

You can use the navigation pane to quickly access the various Onyx Portal features. The navigation pane includes a collapse/expand toggle, allowing you to minimize the menu to icons only or expand it to display full labels. This provides additional screen space and helps you optimize your workspace layout based on your preferences and screen size.

Collapsed State:

* Displays icon-only navigation
* Maximizes screen real estate for viewing
* Maintains quick access to menu items via recognizable icons

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F2ob2QmOcKKZxRdYXot85%2Fimage.png?alt=media&amp;token=4519051d-d0d9-4c54-b53e-32b34ed177dd" alt="" width="66"><figcaption></figcaption></figure>

Expanded State:

* Displays the full menu with icons and labels
* Provides traditional navigation experience
* Shows complete menu item names

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FDRX1ixS7slBH54S2dZTc%2Fimage.png?alt=media&amp;token=ab53bf4c-e6da-4447-9ffe-1e796537abca" alt="" width="162"><figcaption></figcaption></figure>

When in the Administrator mode, the navigation pane displays the following options:

* **Dashboard** – Displays the Administrator Dashboard.
  * **Subscriber** – Doughnut pie chart representation of the number of subscribers grouped by customers. The chart shows the top five customers, with the remaining customers grouped under the Others category.
  * **Customer** – Doughnut pie chart representation of the number of customers grouped by partners. For GXC Administrators, the chart shows the top five partners, with the remaining partners grouped under the Others category.
  * **Access Point** – Doughnut pie chart representation of the number of access points grouped by customers. The chart shows the top five customers, with the remaining customers grouped under the Others category.
  * **Access Point by Model** – Pie chart representation of the number of access points by model across all networks.
  * **Data Volume** – Aggregated data usage across all networks for all customers, or all networks for the selected customer since the last one year. This graph excludes Mesh UE traffic.
    * **Total** – The data volume transmitted in uplink and downlink directions.
    * **Upload** – The data volume transmitted in uplink direction.
    * **Download** – The data volume transmitted in downlink direction.
    * Doughnut pie chart representation of the total data volume transmission per customer. The chart shows the top five customers, with the remaining customers grouped under the Others category.
* **Inventory** – (GXC Administrators) Displays the inventory list of all online and offline Onyx Edge, APs, and Mesh Nodes across all partners, customers, and networks.

  (GXC Partners Administrators) The inventory list of all online and offline Onyx Edge, APs, and Mesh Nodes across the partner's direct customers and networks.

  * **Onyx Edge** – The Onyx Edge Inventory table is sorted by customer and grouped by Onyx Edge pools. Each pool can be expanded and collapsed to view or hide all the Onyx Edge in that pool. Onyx Edge that are not part of any pool are displayed as individual rows in the table.
    * **Name** – The Onyx Edge's name.
    * **Hardware ID** – The Onyx Edge equipment's vendor-assigned serial number.
    * **Partner** – The associated GXC partner account, if applicable.
    * **Customer** – The associated customer account.
    * **Venue** – The name of the venue hosting the Onyx Edge.
    * **Network** – The name of the network hosting the Onyx Edge.
    * **Support Plan** – The support plan assigned to the GXC partner / customer owning the equipment—Basic, Basic Plus, Platinum, and Partner Managed. For more information, see *Support Plans*.
    * To search for a particular Onyx Edge, in the Search box, enter your search term (partner name, customer name, Onyx Edge name, hardware ID, venue, network, etc.).
    * **Download** – Click to download the Onyx Edge inventory list as a CSV format file.
  * **Access Point**
    * **Name** – The AP's name.
    * **Serial Number** – The AP equipment's vendor-assigned serial number.
    * **Model** – The AP's model.
    * **S/W Version** – The AP's software version.
    * **Partner** – The associated GXC partner account, if applicable.
    * **Customer** – The associated customer account.
    * **Venue** – The name of the venue hosting the AP.
    * **Network** – The name of the network hosting the AP.
    * **Support Plan** – The support plan assigned to the GXC partner / customer owning the equipment—Basic, Basic Plus, Platinum, and Partner Managed. For more information, see *Support Plans*.
    * To search for a particular AP, in the Search box, enter your search term (partner name, customer name, AP name, serial number, model, etc.).
    * **Download Access Points** – Click to download the inventory list as a CSV format file.
  * **Mesh Node** – (4G and 5G equipment.)
    * **Name** – The Mesh Node's name.
    * **Serial Number** – The Mesh Node equipment's vendor-assigned serial number.
    * **Model** – The Mesh Node's model.
    * **Partner** – The associated GXC partner account, if applicable.
    * **Customer** – The associated customer account.
    * **Venue** – The name of the venue hosting the Mesh Node.
    * **Network** – The name of the network hosting the Mesh Node.
    * **Support Plan** – The support plan assigned to the GXC partner / customer owning the equipment—Basic, Basic Plus, Platinum, and Partner Managed. For more information, see *Support Plans*.
    * To search for a particular Mesh Node, in the Search box, enter your search term (partner name, customer name, Mesh Node name, serial number, model, version, etc.).
    * **Download Access Points** – Click to download the inventory list as a CSV format file.
  * **FHM** – 5G equipment
    * **Name** – The FHM equipment's name.
    * **Serial Number** – The FHM equipment's vendor-assigned serial number.
    * **Model** – The FHM equipment's model.
    * **Partner** – The associated GXC partner account, if applicable.
    * **Customer** – The associated customer account.
    * **Venue** – The name of the venue hosting the FHM equipment.
    * **Network** – The name of the network hosting the FHM equipment.
    * **Support Plan** – The support plan assigned to the GXC partner / customer owning the equipment—Basic, Basic Plus, Platinum, and Partner Managed. For more information, see *Support Plans*.
    * To search for a particular FHM, in the Search box, enter your search term (partner name, customer name, FHM name, serial number, model, version, etc.).
    * **Download** – Click to download the inventory list as a CSV format file.
* **Analytics** – Generate Key Performance Indicator (KPI) reports that provide insight into the performance and status of networks. For more information, see *Analytics*.
* **SIM Provisioning** – View GXC SIM card and eSIM inventory and add, edit, and delete SIM and eSIM entries. For more information, see *Manage SIM Provisioning*.
* **Administration** – View and manage partner, customer, and user accounts, and cloud resources.
  * **Partners** – (GXC Administrators only) View, edit, and delete individual GXC partner accounts.
    * **Add Partner** – Click to add a GXC partner account.

      For information on creating and managing GXC partner accounts, see *Manage GXC Partner Accounts*.
  * **Customers** – (GXC Administrators) View, edit, and delete customer accounts across GXC's partners and GXC's direct customers.

    (GXC Partner Administrators) View, edit, and delete customer accounts across the partner's direct customers.

    * **Add Customer** – Click to add a customer account.

      For information on creating and managing customer accounts, see *Manage Customer Accounts*.
  * **Users** – (GXC Administrators) View, edit, delete, and suspend individual Onyx Portal user accounts across GXC's partners and GXC's direct customers.

    (GXC Partner Administrators) View, edit, delete, and suspend individual Onyx Portal user accounts across the GXC partner's direct customers.

    * **Add User** – Click to add a user account.
    * **Download Users** – Click to download the list of users as a CSV file.

    For information on creating and managing user accounts, see *Manage Onyx Portal User Accounts*.
  * **Cloud Resources** – View and manage cloud resource groups.

    * **Account ID** – The cloud account ID.
    * **Actions** – Options to update and delete the cloud account.
    * **Add Resource Group** – Click to add a cloud resource group.

    For information on creating and managing cloud resource groups, see *Manage Cloud Resource Groups*.
  * **Notifications** – (GXC Administrators only) View, activate, deactivate, edit, and delete user notifications for all Onyx Portal users.

    * **Add Notification** – Click to add a notification.

    For information on creating and managing notifications, see *Manage Notifications*.
* **Documentation** – View product release notes and user documentation.
* **Contact Us** – View the Onyx Technical Support Portal. Displays the Onyx Technical Support Portal to submit tickets and access the GXC Help Center.

### Onyx Portal Dashboard

The Onyx Portal Dashboard simplifies portal operations providing a quick view of the selected network's infrastructure details and its overall health including venues, subscribers and their status, traffic throughput, CBRS SAS status, and Backhaul (SGi) health status. The Onyx Portal Dashboard is available to all users of the Onyx Portal.

**To view the Onyx Portal Dashboard:**

{% hint style="info" %}
**NOTE:** Verify the selected Onyx Portal account and network in the header area. For more information, see *Header Area*.
{% endhint %}

{% stepper %}
{% step %}
In the navigation pane, click **Dashboard**.

The Dashboard displays the following details for the selected network:

* **Onyx Edge** – The total number of Onyx Edge in the network.
  * **Online** – The consolidated online status of all Onyx Edge in the network. The "Online Status" icon's color indicates the Onyx Edge's reachability from the Onyx Portal.

    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5kHVM8PeTvdfyB2irPKU%2Ficon-online-status-green.png?alt=media\&token=00b659f1-e0f8-4c94-8b83-5cb12e0d58e7) Green – Indicates all Onyx Edge are online.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FnpY81uW86eQrhLMAQlAa%2Ficon-online-status-amber.png?alt=media\&token=9507a829-3ad1-473e-a86a-75a2a5cba87f) Amber – Indicates some Onyx Edge are online and others offline.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FDW6zjy2wuS94vLFThbKY%2Ficon-online-status-red.png?alt=media\&token=e83defb8-cd20-4b25-b190-19205733a494) Red – Indicates all Onyx Edge are offline.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FiBXMp7IoYCtPZbmFedPm%2Ficon-online-status-grey.png?alt=media\&token=514b9ab8-c569-435d-a5ce-1ec59b9baa2f) Grey – Indicates data is loading or is not available.

    To view status per Onyx Edge, hover your cursor over the "Online Status" icon.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FvYmr0kiBmmyt5mlG59QM%2Fimage.png?alt=media&amp;token=f250f0bc-2b3e-4734-8e41-a2ee89362c0f" alt="" data-size="line"> – Indicates the Onyx Edge is online.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FaTRRmKAAJ9rxJd1TBUcf%2Fimage.png?alt=media&amp;token=0335ec93-771e-40cf-8246-939e68b14ef0" alt="" data-size="line"> – Indicates the Onyx Edge is offline.
  * **Service Status** – The consolidated service status of all Onyx Edge in the network. The "Service Status" icon's color indicates the status of services running on the Onyx Edge.

    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F1PPmt5foj5epXp7r8K7j%2Ficon-service-status-green.png?alt=media\&token=ad36a403-ed80-4f4e-b76e-57432391d9b5) Green – Indicates services on all Onyx Edge are up and running.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FdpCdK2qlZuKSfZ2O9M6m%2Ficon-service-status-amber.png?alt=media\&token=073b9f04-c8f5-4411-a0fb-36ae5d42e606) Amber – Indicates services on some Onyx Edge are facing manual or unexpected restarts.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fbw07zR5eM7D1LYjEE3h3%2Ficon-service-status-red.png?alt=media\&token=27357b0a-8573-44e1-a355-2f19e7328907) Red – Indicates services on all Onyx Edge are facing manual or unexpected restarts.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fr4h6g3VrPz2IZkSBsqSW%2Ficon-service-status-grey.png?alt=media\&token=92660af1-eeaf-4d4d-abfe-aa8775b67c66) Grey – Indicates all Onyx Edge are offline, or data is loading or is not available.

    To view status per Onyx Edge, hover your cursor over the "Service Status" icon.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8Mwi625Mx3ZuUSxdkFsR%2Fimage.png?alt=media&amp;token=69f374b6-696a-482b-82ff-772db7dd30cd" alt="" data-size="line"> – Indicates all services are up and running.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F9vndkn6KHKOp2HZxszX7%2Fimage.png?alt=media\&token=db8afe10-7baa-4108-9c5c-2d7e5121173d) – Indicates unexpected or manual restart of critical services.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FCru5vP9xBeoyAM60mlpm%2Fimage.png?alt=media\&token=117d3917-1fe6-4372-a24f-d059feaee841) – Indicates data is not available.
* **Access Point** – The total number of APs in the network.
  * **Online** – The consolidated online status of all APs in the network. The "Online Status" icon's color indicates reachability of APs from the Onyx Portal.

    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FLilUT9DSCvMp0g99HAkg%2Ficon-online-status-green.png?alt=media\&token=89243c45-5699-444f-8379-1d95949f7426) Green – Indicates all APs are online.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJZjLjNRq3rWAd4TQgx2v%2Ficon-online-status-amber.png?alt=media\&token=3b1739a1-8e42-4655-91f7-b2ebadb86cf8) Amber – Indicates some APs are online and others offline.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FqbzkduYXfO0ndOY3PXHM%2Ficon-online-status-red.png?alt=media\&token=394c3a63-9fc2-41b6-9544-df41b7d44bb5) Red – Indicates all APs are offline.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FfQCemysnkIEUfeReGDdA%2Ficon-online-status-grey.png?alt=media\&token=6917eb77-e720-4a30-8eb1-cbafb9e7e805) Grey – Indicates data is loading or is not available.

    To view status per AP, hover your cursor over the "Online Status" icon.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FOrYCS35emBo1ZxWECjg6%2Fimage.png?alt=media&amp;token=0574589f-835c-42a8-a5b8-26c700d17efe" alt="" data-size="line"> – Indicates the AP is online.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5wjSINo7NvZb9OAFVnGG%2Fimage.png?alt=media&amp;token=f58e3227-0715-4c29-befb-ed07ef3ca5db" alt="" data-size="line"> – Indicates the AP is offline.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FjCsf6xxIn5mlx15oOq0I%2Fimage.png?alt=media&amp;token=479a921f-268a-44a6-ae80-92ade688c6e3" alt="" data-size="line"> – Indicates any of the following:
      * The AP is offline.
      * The AP's cell state is shutdown.
      * The Onyx Edge associated with the AP is offline.
      * Data is not available.
  * **Service Status** – The consolidated service status of all APs in the network. The "Service Status" icon's color indicates the status of services running on the AP.

    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FE92hBMZd5NDtCL3CTnfG%2Ficon-service-status-green.png?alt=media\&token=e83ad137-8d43-4278-a7e6-d656038e6315) Green – Indicates services on all APs are up and running.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FGNRz95nCot0EMuLBhGof%2Ficon-service-status-amber.png?alt=media\&token=bb756d1f-1330-4bb1-93c2-5b5d5f9bd96e) Amber – Indicates services on some APs are facing manual or unexpected restarts.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FYZd8IOOo3JxFZMWp7Sba%2Ficon-service-status-red.png?alt=media\&token=ed5bb445-3e7e-4fa7-8b27-1160a5c79063) Red – Indicates services on all APs are facing manual or unexpected restarts.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fjdvosd7NCpCxuclcvDJR%2Ficon-service-status-grey.png?alt=media\&token=b0957b89-1f78-4711-a5c0-4a7f829145a0) Grey – Indicates all APs are offline, or data is not available.

    To view status per AP, hover your cursor over the "Service Status" icon.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FMVebpqvH2nqol4tf8cKQ%2Fimage.png?alt=media&amp;token=ce42cf9c-3763-41a7-be60-5422513bae67" alt="" data-size="line"> – Indicates all services are up and running.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FrgBEzvu7NOKidLwk9wx8%2Fimage.png?alt=media&amp;token=49020d0b-4a93-493b-b5f2-48aa6039f9ad" alt="" data-size="line"> – Indicates unexpected or manual restart of critical services.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FBQXgF6kYKHzVchK1GzWl%2Fimage.png?alt=media&amp;token=b49a5771-5dc7-48f3-b575-6ecae9c43445" alt="" data-size="line"> – Indicates any of the following:
      * The AP is offline.
      * The AP's cell state is shutdown.
      * The Onyx Edge associated with the AP is offline.
      * Data is not available.
  * **FHM** – The total number of FHM in the network.
    * **Online** – The consolidated online status of all FHM in the network. The "Online Status" icon's color indicates reachability of the FHM from the Onyx Portal.

      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FwQxbxkh3X5EaO2TLIcXK%2Ficon-online-status-green.png?alt=media\&token=175a0f47-8b1d-42f8-85a1-1302bc1e27b9) Green – Indicates all FHM are online.
      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FMyrdvGFnKeGpZMPPYyeU%2Ficon-online-status-amber.png?alt=media\&token=3d2b0abd-efbc-48ab-96d4-eeef2e09bc77) Amber – Indicates some FHM are online and some offline.
      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKOCmUO2FtZQzloIpqGwE%2Ficon-online-status-red.png?alt=media\&token=76b90ea3-b1ad-468a-97b6-24b41afdc8ac) Red – Indicates all FHM are offline.
      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FPeufubvNQa9jfLKrDSxd%2Ficon-online-status-grey.png?alt=media\&token=304dd691-3658-444d-86da-71796b6a5bb8) Grey – Indicates data is loading or is not available.

      To view status per FHM, hover your cursor over the "Online Status" icon.

      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FerlqYEXyCmWaeTE5uJaK%2Fimage.png?alt=media&amp;token=d5c3f042-620b-484b-a49d-538525f1a3f9" alt="" data-size="line"> – Indicates the FHM is online.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJYTyI7NBG29xyn3UrjGX%2Fimage.png?alt=media&amp;token=5820fdd4-2738-4706-92c4-c38bae1f40c8" alt="" data-size="line"> – Indicates the FHM is offline.
    * **Service Status** – The consolidated service status of all FHM in the network. The "Service Status" icon's color indicates the status of services running on the FHM.

      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FVTuzHQxYSlluXTsONvSs%2Ficon-service-status-green.png?alt=media\&token=9fca0ffc-badc-4102-9c15-12b6d6d7e92d) Green – Indicates services on all FHM are up and running.
      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fob2ikab4UssD8VB9npzx%2Ficon-service-status-amber.png?alt=media\&token=06b3f9be-6ca2-4a91-b3da-2cbf6874bc96) Amber – Indicates services on some FHM are facing manual or unexpected restarts.
      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F3samO43gTOpeTsXZCoXb%2Ficon-service-status-red.png?alt=media\&token=085338b3-d481-47be-ad4f-146bd4619981) Red – Indicates services on all FHM are facing manual or unexpected restarts.
      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FqLThxW8tAqNQhDYrpfIA%2Ficon-service-status-grey.png?alt=media\&token=539994e9-fb17-4e3b-baea-91be56a453a7) Grey – Indicates any of the following:
        * APs associated with the FHM are offline.
        * APs associated with the FHM are shut down.
        * All FHM are offline.
        * Data is not available.

      To view status per FHM, hover your cursor over the "Service Status" icon.

      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FBwcnzMPHDVdcseIu5zWn%2Fimage.png?alt=media&amp;token=54800bb8-0e10-45d3-b3c1-3e0fe371548a" alt="" data-size="line"> – Indicates all services are up and running.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FVTGGCWIRuv6cKpfasXUV%2Fimage.png?alt=media&amp;token=6e512f1a-6eef-4b8b-be51-a8031e45735f" alt="" data-size="line"> – Indicates unexpected or manual restart of critical services.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FPOK74BJ5nKWDJMxmbLuK%2Fimage.png?alt=media&amp;token=e8b0d744-3433-4314-a7e2-6efa984f041b" alt="" data-size="line"> – Indicates any of the following:
        * The AP associated with the FHM is offline.
        * The AP associated with the FHM is shutdown.
        * The FHM is offline.
        * Data is not available.
  * **Mesh Node** – The total number of Mesh Nodes in the network.
    * **Online** – The consolidated online status of all Mesh Nodes in the network. The "Online Status" icon's color indicates the Mesh Node's reachability from the Onyx Portal.

      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FwQxbxkh3X5EaO2TLIcXK%2Ficon-online-status-green.png?alt=media\&token=175a0f47-8b1d-42f8-85a1-1302bc1e27b9) Green – Indicates all Mesh Nodes are online.
      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FMyrdvGFnKeGpZMPPYyeU%2Ficon-online-status-amber.png?alt=media\&token=3d2b0abd-efbc-48ab-96d4-eeef2e09bc77) Amber – Indicates some Mesh Nodes are online and others offline.
      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKOCmUO2FtZQzloIpqGwE%2Ficon-online-status-red.png?alt=media\&token=76b90ea3-b1ad-468a-97b6-24b41afdc8ac) Red – Indicates all Mesh Nodes are offline.
      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FPeufubvNQa9jfLKrDSxd%2Ficon-online-status-grey.png?alt=media\&token=304dd691-3658-444d-86da-71796b6a5bb8) Grey – Indicates data is loading or is not available.

      To view status per Mesh Node, hover your cursor over the "Online Status" icon.

      * Indicates the Mesh Node is online.
      * Indicates the Mesh Node is offline.
    * **Service Status** – The consolidated service status of all Mesh Nodes in the network. The "Service Status" icon's color indicates the status of critical services (control\_proxy, pclient, cped) running on the Mesh Node.

      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FVTuzHQxYSlluXTsONvSs%2Ficon-service-status-green.png?alt=media\&token=9fca0ffc-badc-4102-9c15-12b6d6d7e92d) Green – Indicates services on all Mesh Nodes are up and running.
      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fob2ikab4UssD8VB9npzx%2Ficon-service-status-amber.png?alt=media\&token=06b3f9be-6ca2-4a91-b3da-2cbf6874bc96) Amber – Indicates services on some Mesh Nodes are facing manual or unexpected restarts, or a Mesh Node was power-cycled by the watchdog service in the last 10 minutes.
      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F3samO43gTOpeTsXZCoXb%2Ficon-service-status-red.png?alt=media\&token=085338b3-d481-47be-ad4f-146bd4619981) Red – Indicates services on all Mesh Nodes are facing manual or unexpected restarts, or more than 3 unexpected restarts occurred in the last 5 minutes.
      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FqLThxW8tAqNQhDYrpfIA%2Ficon-service-status-grey.png?alt=media\&token=539994e9-fb17-4e3b-baea-91be56a453a7) Grey – Indicates all Mesh Nodes are offline, or data is loading or is not available.

      To view status per Mesh Node, hover your cursor over the "Service Status" icon.
  * **Venue** – The total number of venues in the network.
    * The list of venues with their names and addresses. To view a venue's details, click its name.
  * **Subscribers**:
    * **Total Subscribers** – The total number of subscribers in the network.
      * **Connected** – The number of subscribers currently connected to the network.
      * **Idle** – The number of subscribers currently in idle state.
      * **Not Connected** – The number of subscribers currently not connected to the network.
      * **Unknown** – The number of subscribers currently with unknown connection status.
      * **Disabled** – The number of subscribers that have been disabled.
    * **Subscribers by APNs** – The number of subscribers per APN against the total subscriber count.
  * **Downlink/Uplink Traffic** – Trend chart of the throughput of all UE for the selected APN, downlink or uplink direction, and duration. This graph excludes Mesh UE traffic.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> In the APN dropdown, MeshBackhaul is available only to GXC Administrators.</p></div>
  * **Access Point/DAS SAS Status** – The AP's Spectrum Access System (SAS) status.
    * **Total** – The total number of APs/DAS.
    * **Unregistered** – The number of APs/DAS whose Citizens Broadband Radio Service Device (CBSD) are not registered with SAS yet or have deregistered.
    * **Registered** – The number of APs/DAS whose CBSD are registered with SAS but do not have grants.
    * **Granted** – The number of APs/DAS whose CBSD have received at least one grant but are not heart-beating on any grants.
    * **Authorized** – The number of APs/DAS whose CBSD are authorized to transmit on at least one grant.
    * **Suspended** – The number of APs/DAS whose CBSD cannot transmit on any of its grants. All grants are temporarily suspended by the SAS.
  * **Data Usage** – Total data usage across all Onyx Edge in the network in the selected duration. Note that this graph excludes Mesh UE traffic.
  * **Backhaul (SGi) Health** – Per Onyx Edge, the latency and packet loss data.
    * **Onyx Edge** – The Onyx Edge's name.
    * **Latency** – The Round-Trip Time (RTT) measured between the SGi interface and the destination IP address 8.8.8.8.
    * **Packet Loss %** – The ICMP packet loss percentage between SGi and 8.8.8.8.
    * **DL/UL** – Downlink and uplink TCP throughput between SGi and public iPerf server.
      {% endstep %}

{% step %}
In the upper-right corner, the panel indicates when the view was last updated.

To refresh the view, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FB4yaPQtjHv5UnmT2nw4n%2Fimage.png?alt=media&amp;token=1af94058-430c-4e6b-a62d-351c4ed5b4f5" alt="" data-size="line"> (refresh).
{% endstep %}
{% endstepper %}


# Manage Networks

The Onyx Portal enables you to add, configure, and manage your networks and network parameters such as throughput and bandwidth, and the usage policies around what the equipment can access. The Onyx Portal supports the creation of 4G and 5G specific networks.

## Networking / UE Exposure Modes

The Onyx 5G Platform supports two primary networking modes that determine how the Onyx Edge integrates with enterprise networks and manages UE traffic.

* Network Address Translation (NAT) Mode
* Multi-APN-VLAN (Bridge) Mode

The 5G NAT and Bridge modes provide flexibility between fully isolated, NAT-protected networks and slice-aware VLAN-integrated networks where enterprise IT retains control of addressing and policies.

### NAT Mode

In the 5G NAT mode, the Onyx Edge functions as a secure gateway between the private 5G RAN and the enterprise network (N6 interface). APs and FHMs connect to the Onyx Edge via dedicated private fronthaul links, isolated from the enterprise LAN. The Onyx Edge assigns IP addresses to UE (from its local pool) and to APs and FHMs (via its DHCP service on the fronthaul network). NAT applied on the N6 interface ensures strong isolation (the enterprise LAN sees only the Onyx Edge's NAT IP address and cannot directly access APs, FHMs, or UE). This mode provides simplified IP management and complete control over RAN infrastructure, ideal for security- and privacy-focused deployments where enterprises do not require direct access to individual UE devices.

### Bridge (APN-on-VLAN) Mode

In the 5G Bridge mode, the Onyx Edge bridges UE traffic directly into enterprise VLANs without applying NAT. APs/FHMs connect to the Onyx Edge via dedicated private fronthaul links, isolated from the enterprise LAN. The Onyx Edge assigns IP addresses to APs and FHMs via its DHCP service on the fronthaul network. Each APN is mapped to a dedicated VLAN by the Onyx Edge, allowing traffic segregation and policy enforcement. Enterprise DHCP service assigns IP addresses to UE per VLAN, making them directly accessible as native enterprise devices. The N6 interface is configured as a VLAN trunk to carry tagged UE traffic to the enterprise network. Unlike NAT mode (where UE are hidden behind the Onyx Edge IP address), Bridge mode provides complete enterprise visibility and policy control over connected UE while maintaining strong RAN isolation and per-APN traffic segregation through VLAN isolation. This mode is recommended for organizations seeking deep integration with enterprise routing, security, and management tools.

{% hint style="info" %}
**NOTE**: For detailed information on the networking modes, refer to the *4G & 5G Onyx Networking Modes Application Note*.
{% endhint %}

## Switch Default Network

When you log on to Onyx Portal, from the list of networks available under the selected Onyx Portal account, you must select the default network for your session. When you select a particular network, the Onyx Portal screens display data for that network.

**To switch the default network:**

{% stepper %}
{% step %}
After you log on to the Onyx Portal, in the header area of the page, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F9e61QkdRKJXPi0VYVR66%2Fimage.png?alt=media&amp;token=7fa1bc78-99f3-4f7c-b990-4a509cc49c9a" alt="" data-size="line"> (switch default network).

The **Networks** page displays the list of networks configured under the selected Onyx Portal account.
{% endstep %}

{% step %}
Click the name of the network that you want to switch to.

A confirmation dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fovk5u1cRQXG9I2Nhiuol%2Fimage.png?alt=media&amp;token=d4d4cb90-c48c-4b0c-a059-ca076ba88afe" alt="" width="490"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To confirm switching the network, click **Yes**.

The default network switches, and the selected network's name is displayed in the header area.

* <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FqGTfLKJmNu7pgHhpcqws%2Fimage.png?alt=media&amp;token=dcc8743c-c61d-427f-be0b-ef7620534571" alt="" data-size="line"> indicates the default network is a 4G network.
* <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXVdan1L9a74JxBo6hxfS%2Fimage.png?alt=media&amp;token=341f7f6f-b497-468f-86d7-61e48dedb3c9" alt="" data-size="line"> indicates the default network is a 5G network.
  {% endstep %}
  {% endstepper %}

## View Default Network's Details

**To view the default network's details:**

{% stepper %}
{% step %}
In the navigation pane, click **Network**.

The ***\<network name>*** page displays the default network's details.

* **Network** – The network's identifying details and associated equipment/subscriber counts.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQi1vWCsvMRT77DhzM7xd%2Fimage.png?alt=media&amp;token=f119c6a2-885b-4700-b769-bd1c1c63768e" alt="" width="375"><figcaption></figcaption></figure></div>

  * **Name** – The network's name.
  * **UE Display Short Name** – The network's short name that is displayed in UE screens.
  * **Description** – The network's description.
  * Counts of Onyx Edge, APs, FHM, APNs, and subscribers associated with the network.
* **Core** – The network's core (EPC/5GC) configuration, including UE exposure mode and PLMN identifiers.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F4kSSukLkV26u269pJeqO%2Fimage.png?alt=media&amp;token=425f295c-4199-4224-a8ef-32142bdeadfd" alt="" width="403"><figcaption></figcaption></figure></div>

  * **UE Exposure Mode** – The UE IP allocation mode—**NAT**, **Direct on APN-VLAN**.
  * **PLMN ID** – The network's PLMN ID (MCC+MNC concatenated).
  * **Slot Pattern** – The network's configured slot pattern.
* **SUCI Profile** – The network's SUCI encryption profile used to protect subscriber identifiers over the air.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FCbZeTmmZJC7Xqf39Fay0%2Fimage.png?alt=media&amp;token=4c1e1fa1-e10f-42f8-b306-d1d41edadd98" alt="" width="402"><figcaption></figcaption></figure></div>

  * **Profile ID** – The SUCI protection profile's identifier.
  * **Protection Scheme** – The SUCI encryption scheme in use (e.g., ProfileA).
  * **Public Key** – The home network public key used to encrypt the UE's SUCI.
* **SAS** – The Spectrum Access System (SAS) related information.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FL6pmhK2ijiOIYRpl8GKy%2Fimage.png?alt=media&amp;token=ceded7cc-03b7-45f1-8a59-ab9de82c5444" alt="" width="401"><figcaption></figcaption></figure></div>

  * **SAS Provider** – The SAS provider used by the network for CBRS spectrum coordination and access authorization.
* **Venues** – The list of venues associated with the network.<br>

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FHsQwlTxx8bZWSMKnmWkD%2Fimage.png?alt=media&amp;token=b3d27b5e-c843-46da-84fc-21153bda0ce4" alt=""><figcaption></figcaption></figure></div>
* **Download Root CA Certificate** – In the upper-right corner of the page, click to download the network's Root CA certificate (.pem file).<br>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> On enabling IPSec for an AP, this Root CA Certificate file, the AP Certificate and AP Private Key must be uploaded to the AP equipment's configuration interface. For more information see <em>Enable and Configure IPSec on AP Equipment</em>.</p></div>
* **Delete Network** – In the upper-right corner of the page, click to permanently delete the network, after confirmation; Fails if the network still has associated venues, Onyx Edge, APs, FHM, or Mesh Node.
  {% endstep %}
  {% endstepper %}

## View Available Networks

This section describes how to:

* [*View Summary Details of All Networks*](#view-summary-details-of-all-networks)
* [*View a Network's Details*](#view-a-networks-details)

### View Summary Details of All Networks

**To view the summary details of all networks under the selected Onyx Portal account:**

{% stepper %}
{% step %}
In the header area, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmEXKTfZ6JWaLJktYOkcQ%2Fimage.png?alt=media&amp;token=dc0b2bd8-3903-42a4-af5f-9f7e3efb9875" alt="" data-size="line"> (switch network).

The **Networks** page displays the summary details of all networks configured under the current Onyx Portal account.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FCeXv1kwUjYZg3MwsX60A%2Fimage.png?alt=media&amp;token=a14a2061-2876-487b-949e-56f30bb5e39e" alt=""><figcaption></figcaption></figure></div>

* **Name** – The network's name.
* **Venues** – The number of venues configured in the network.
* **4G/5G** – The network's type—4G or 5G. To sort the table by network type, click the column header.
* **Onyx Edge Appliances** – The number of Onyx Edge configured in the network.
* **Access Point** – The number of APs configured in the network.
* **Mesh Node** – The number of Mesh Nodes configured in the network. In the current release, Mesh Node is specific to 4G networks.
* **FHM** – The number of FHMs configured in the network. In the current release FHM is specific to 4G networks.
* **Actions** – Options to view details, edit, and delete networks.
  {% endstep %}
  {% endstepper %}

### View a Network's Details

**To view a network's details:**

{% stepper %}
{% step %}
In the header area, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F21q1e6ef40JpG8qztzs1%2Fimage.png?alt=media&amp;token=978a0f3b-adca-44bb-bcb8-f2169ec1a8d0" alt="" data-size="line"> (switch network).

The **Networks** page displays the summary details of all networks configured under the selected Onyx Portal account.
{% endstep %}

{% step %}
To view the details of a specific network, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **View**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXPFEGw2vr4xzGFrsN8jy%2Fimage.png?alt=media&amp;token=a7e56624-7027-4492-98fd-33677dc1c7db" alt="" width="110"><figcaption></figcaption></figure></div>

The ***\<network name>*** page displays the selected network's details.

* **Network** – The network's identifying details and associated equipment/subscriber counts.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQi1vWCsvMRT77DhzM7xd%2Fimage.png?alt=media&amp;token=f119c6a2-885b-4700-b769-bd1c1c63768e" alt="" width="375"><figcaption></figcaption></figure></div>

  * **Name** – The network's name.
  * **UE Display Short Name** – The network's short name that is displayed in UE screens.
  * **Description** – The network's description.
  * Counts of Onyx Edge, APs, FHM, APNs, and subscribers associated with the network.
* **Core** – The network's core (EPC/5GC) configuration, including UE exposure mode and PLMN identifiers.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F4kSSukLkV26u269pJeqO%2Fimage.png?alt=media&amp;token=425f295c-4199-4224-a8ef-32142bdeadfd" alt="" width="403"><figcaption></figcaption></figure></div>

  * **UE Exposure Mode** – The UE IP allocation mode—**NAT**, **Direct on APN-VLAN**.
  * **PLMN ID** – The network's PLMN ID (MCC+MNC concatenated).
  * **Slot Pattern** – The network's configured slot pattern.
* **SUCI Profile** – The network's SUCI encryption profile used to protect subscriber identifiers over the air.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FCbZeTmmZJC7Xqf39Fay0%2Fimage.png?alt=media&amp;token=4c1e1fa1-e10f-42f8-b306-d1d41edadd98" alt="" width="402"><figcaption></figcaption></figure></div>

  * **Profile ID** – The SUCI protection profile's identifier.
  * **Protection Scheme** – The SUCI encryption scheme in use (e.g., ProfileA).
  * **Public Key** – The home network public key used to encrypt the UE's SUCI.
* **SAS** – The Spectrum Access System (SAS) related information.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FL6pmhK2ijiOIYRpl8GKy%2Fimage.png?alt=media&amp;token=ceded7cc-03b7-45f1-8a59-ab9de82c5444" alt="" width="401"><figcaption></figcaption></figure></div>

  * **SAS Provider** – The SAS provider used by the network for CBRS spectrum coordination and access authorization.
* **Venues** – The list of venues associated with the network.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FHsQwlTxx8bZWSMKnmWkD%2Fimage.png?alt=media&amp;token=b3d27b5e-c843-46da-84fc-21153bda0ce4" alt=""><figcaption></figcaption></figure></div>
* **Download Root CA Certificate** – In the upper-right corner of the page, click to download the network's Root CA certificate (.pem file).<br>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> On enabling IPSec for an AP, this Root CA Certificate file, the AP Certificate and AP Private Key must be uploaded to the AP equipment's configuration interface. For more information see <em>Enable and Configure IPSec on AP Equipment</em>.</p></div>
* **Delete Network** – In the upper-right corner of the page, click to permanently delete the network, after confirmation; Fails if the network still has associated venues, Onyx Edge, APs, FHM, or Mesh Node.
  {% endstep %}
  {% endstepper %}

## Create Networks

This section describes how to create a 5G network.

{% hint style="info" %}
**NOTE:** You can create networks only if you are a GXC Administrator, Partner Administrator, or a Super Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** You can create networks only under customer accounts. Before you create a network, make sure you have selected the appropriate customer account.
{% endhint %}

**To create a 5G network:**

{% stepper %}
{% step %}
In the header area, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FONTdBQPv2NAu3YQRqdhO%2Fimage.png?alt=media&amp;token=b291fb53-c4fb-4da9-81e5-8f518e75300a" alt="" data-size="line"> (switch network).

The **Networks** page displays the summary details of all networks configured under the selected Onyx Portal account.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Add Network**.

The **Create Network** page > **Network** tab is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8kKFZZUcle9N5KK7CKjc%2Fimage.png?alt=media&amp;token=112d18fe-18d2-4c9f-80f1-83d5bc9a69a0" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

* **Network Name** – (Required) The network's name. The network name must be unique within the customer account and must be an alphanumeric string of 1–32 characters.
* **UE Display Short Network Name** – (Required) The network's short name that is displayed in UE screens.
* **Description** – (Required) The network's description.
  {% endstep %}

{% step %}
At the bottom of the page, click **Configure Core/RAN**.

The **Create Network** page > **Core/RAN** tab is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FPJpV72sP9ybeWdHDWCqd%2Fimage.png?alt=media&amp;token=6cc92d58-8a25-4475-9444-533ca4792e4d" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details.

* **4G / 5G** – Click the toggle button to select the 5G network type. Default setting: 4G.

{% hint style="info" %}
**NOTE:** After you create a network, its type cannot be changed.
{% endhint %}

* **APN on a VLAN** – To enable the "Direct on APN-VLAN" mode, turn on the toggle button. To enable the NAT mode, turn off the toggle button. Default setting: disabled (NAT mode). For more information, see [*Networking Modes*](#networking-modes).
* **Slot Pattern** – (Required) Select the slot pattern. The slot pattern 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. The UL/DL distribution percentages are displayed alongside each option.
  * **DDDDDDDSUU (DL 77%, UL 21%)** – Allocates approximately 77% of subframes within each radio frame for downlink transmission and the remaining 21% for uplink transmission.
  * **DDDSU (DL 74%, UL 23%)** – Allocates approximately 74% of subframes within each radio frame for downlink transmission and the remaining 23% for uplink transmission.
  * **DDSUU (DL 54%, UL 43%)** – Allocates approximately 54% of subframes within each radio frame for downlink transmission and the remaining 43% for uplink transmission.
  * **DSUUU (DL 34%, UL 63%)** – Allocates approximately 34% of subframes within each radio frame for downlink transmission and the remaining 63% for uplink transmission.
  * **DSUUUUDSUU (DL 25%, UL 72%)** – Allocates approximately 25% of subframes within each radio frame for downlink transmission and the remaining 72% for uplink transmission.
  * **DDSUUUUUUU (DL 20%, UL 77%)** – Allocates approximately 20% of subframes within each radio frame for downlink transmission and the remaining 77% for uplink transmission.
* **MCC** – (Required) The Mobile Country Code, a three-digit code that uniquely identifies the country or geographical area within the IMSI. Default value: 315.
* **MNC** – (Required) The Mobile Network Code, a three-digit code, combined with the MCC, uniquely identifies a mobile network operator within a country. Default value: 010.
  {% endstep %}

{% step %}
At the bottom of the page, click **Configure Users**.

The **Create Network** page > **Users** tab is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F09c0JQSRbFwcdy27TBXE%2Fimage.png?alt=media&amp;token=718ba1a3-365f-4aa8-9876-95a708193249" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

* **Users** – Click to select one or more users from the customer account who should have permission to manage this network. To remove access for a particular user, clear the corresponding checkbox. Default value: **User with All Network Access**.
  {% endstep %}

{% step %}
To save the network, in the upper-right corner of the page, click **Save Network**.

Saving the network automatically sets it as the default network for your current session.
{% endstep %}
{% endstepper %}

## Edit Networks

This section describes how to edit a network.

{% hint style="info" %}
**NOTE:** You can edit networks only if you are a GXC Administrator, Partner Administrator, or a Super Administrator.
{% endhint %}

**To edit a 5G network's settings:**

{% stepper %}
{% step %}
In the header area, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0IT8l7cgMBcdvn1s76mj%2Fimage.png?alt=media&amp;token=a28bb8ac-f98e-4a4e-a22a-5e45e6cab8c5" alt="" data-size="line"> (switch network).

The **Networks** page displays the summary details of all networks configured under the selected Onyx Portal account.
{% endstep %}

{% step %}
For the network that you want to edit, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FdA1GOu94gQO9guY39Q6X%2Fimage.png?alt=media&amp;token=83c5b30f-2037-4de7-9030-fd1bd0eb1b4b" alt="" width="110"><figcaption></figcaption></figure></div>

The **Edit Network** page > **Network** tab is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FkaqywRb4rYznaTmMc1gB%2Fimage.png?alt=media&amp;token=73534fc4-27b8-4338-8ae1-4d692eae5192" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Edit the following details as required.

* **Network Name** – (Required) The network's name. The name must be unique within the customer account and must be an alphanumeric string of 1–32 characters.
* **UE Display Short Network Name** – (Required) The network's short name that is displayed in UE screens.
* **Description** – (Required) The network's description.
  {% endstep %}

{% step %}
In the lower-left bottom of the page, click **Configure Core/RAN**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fu2j2iCMduVoK99VjRJNP%2Fimage.png?alt=media&amp;token=4e5fb26c-c594-40c1-abc6-03a8442d6661" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Edit the following details as required:

* **4G / 5G** – (Read only) Indicates the network type is 5G.
* **APN on a VLAN** – To enable the "Direct on APN-VLAN" mode, turn on the toggle button. To enable the NAT mode, turn off the toggle button. For more information, see [*Networking Modes*](#networking-modes).
* **Slot Pattern** – (Required) Select the slot pattern. The Slot Pattern 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. The UL/DL distribution percentages are displayed alongside each option.
  * **DDDDDDDSUU (DL 77%, UL 21%)** – Allocates approximately 77% of subframes within each radio frame for downlink transmission and the remaining 21% for uplink transmission.
  * **DDDSU (DL 74%, UL 23%)** – Allocates approximately 74% of subframes within each radio frame for downlink transmission and the remaining 23% for uplink transmission.
  * **DDSUU (DL 54%, UL 43%)** – Allocates approximately 54% of subframes within each radio frame for downlink transmission and the remaining 43% for uplink transmission.
  * **DSUUU (DL 34%, UL 63%)** – Allocates approximately 34% of subframes within each radio frame for downlink transmission and the remaining 63% for uplink transmission.
  * **DSUUUUDSUU (DL 25%, UL 72%)** – Allocates approximately 25% of subframes within each radio frame for downlink transmission and the remaining 72% for uplink transmission.
  * **DDSUUUUUUU (DL 20%, UL 77%)** – Allocates approximately 20% of subframes within each radio frame for downlink transmission and the remaining 77% for uplink transmission.
* **MCC** – (Required) The Mobile Country Code, a three-digit code that uniquely identifies the country or geographical area within the IMSI. Default value: 315.
* **MNC** – (Required) The Mobile Network Code, a three-digit code, when combined with the MCC, uniquely identifies a mobile network operator within a country. Default value: 010.
  {% endstep %}

{% step %}
In the lower-right bottom of the page, click **Configure Users**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FyEYJ8vZ40hlKXVpE9h8t%2Fimage.png?alt=media&amp;token=4b4c28bc-ff44-4349-852a-6f94614c6746" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Edit the following details as required:

* **Users** – Click to select one or more users from the customer account who should have permission to manage this network. To remove access for a particular user, clear the corresponding checkbox. Default value: **All Users**.
  {% endstep %}

{% step %}
To save your changes, in the upper-right corner of the page, click **Save Network**.
{% endstep %}
{% endstepper %}

## Delete Networks

{% hint style="info" %}
**NOTE:** You can delete networks only if you are a GXC Administrator, Partner Administrator, or a Super Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** You cannot delete a network if there are any venues, Onyx Edge, or APs associated with it.
{% endhint %}

**To delete a network:**

{% stepper %}
{% step %}
In the header area, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FsllqwvuTfLeHYsiTdsTr%2Fimage.png?alt=media&amp;token=f84fe008-ec2e-4e8e-ad60-57455101017c" alt="" data-size="line"> (switch network).

The **Networks** page displays the summary details of all networks configured under the selected Onyx Portal account.
{% endstep %}

{% step %}
To delete a particular network, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Delete**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQuaRRovXfGx6r7pK0QUw%2Fimage.png?alt=media&amp;token=4ad411ab-5c15-4d7f-b179-f2c6309c66c2" alt="" width="110"><figcaption></figcaption></figure></div>

A confirmation dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F96jGznf92bAkvxL0qkeI%2Fimage.png?alt=media&amp;token=c5c961c5-7ca2-4ee6-b2f4-f9f26b3fab0e" alt="" width="355"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To confirm deleting the network, click **Yes**.
{% endstep %}
{% endstepper %}


# Manage Venues

A venue represents a physical location in a private mobile network, such as a factory or a warehouse, hosting the AP(s). A venue can be a small facility or a multi-floor facility hosting multiple APs on each floor.

## View Venues

This section describes how to:

* [*View Summary Details of All Venues*](#view-summary-details-of-all-venues)
* [*View a Venue's Details*](#view-a-venues-details)

### View Summary Details of All Venues

**To view the summary details of all venues in the network:**

{% stepper %}
{% step %}
In the navigation pane, click **Venues**.

The **Venues** page displays the summary details of all venues configured in the network.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FizXjGcZR6kifSUEPvWbn%2Fimage.png?alt=media&amp;token=87e37238-1f5f-479a-93e4-f0a1c926d3e9" alt=""><figcaption></figcaption></figure></div>

* **Name** — The venue's name.
* **Description** — The venue's description.
* **Address** — The venue's postal address.
* **Actions** — Options to view details, edit, and delete venues.
  {% endstep %}
  {% endstepper %}

### View a Venue's Details

**To view a venue's details:**

{% stepper %}
{% step %}
In the navigation pane, click **Venues**.

The **Venues** page displays the summary details of all venues configured in the network.
{% endstep %}

{% step %}
To view a particular venue's details, click the venue's name.

Alternatively, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **View**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F9GfZEghHRiAcdO65dNuL%2Fimage.png?alt=media&amp;token=803ff0e6-89b4-4c58-97df-cf3b00c28902" alt="" width="110"><figcaption></figcaption></figure></div>

The ***\<venue name>*** page displays the venue's details.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FqlANLVBPMY6KRAaMxpbs%2Fimage.png?alt=media&amp;token=4edf64a4-7472-48a7-b8da-70ca81636102" alt=""><figcaption></figcaption></figure></div>

* **Name** — The venue's name.
* **Network** — The network's name.
* **Address** — The venue's address.
* **Description** — The venue's description.
* **Radio Range (SSF)** — (Displayed only if configured at the venue level or inherited from the network level.) Effective Isotropic Radiated Power (EIRP) and cell-selection thresholds are defined per range category below. The Radio Range parameter, also referred to as Signal Strength Floor (SSF), for all APs in the venue. SSF determines the signal strength thresholds for different coverage areas within a network, ensuring optimal connectivity and handover performance across varying distances and terrain conditions.
  * **Normal (SSF7)** — This SSF category represents the typical signal strength threshold for cell selection and handover within a network. It is used for areas where the network coverage is considered standard, and the signal strength is within the normal operating range.
  * **> 6miles (SSF5)** — This SSF category represents an extended coverage area where the signal strength may be weaker compared to the normal operating range. It is used for areas where the distance between the cell site and the UE exceeds six miles, requiring a lower signal strength threshold for cell selection and handover.
* **DL/UL Distribution (SA)** — (Displayed only if configured at the venue level or inherited from the network level.) The DL/UL Subframe Assignment (SA) for all APs in the venue. The DL/UL Distribution (SA) configuration refers to allocating transmission resources (specific subframes within the radio frame for DL and UL data transmissions) to facilitate efficient data exchange between the AP and UE.

  * **85%DL, 15%UL (SA2)** — Subframe Assignment 2. Allocates approximately 85% of subframes within each radio frame for downlink transmission and the remaining 15% for uplink transmission.
  * **70%DL, 30%UL (SA1)** — Subframe Assignment 1. Allocates approximately 70% of subframes within each radio frame for downlink transmission and the remaining 30% for uplink transmission.
  * **60%DL, 40%UL (SA6)** — Subframe Assignment 6. Allocates approximately 60% of subframes within each radio frame for downlink transmission and the remaining 40% for uplink transmission.

  For a comparison of the approximate throughputs for different DL/UL Distribution (SA) and Radio Range (SSF) configurations, see *Throughput Comparisons*.
* Satellite map visualization of the venue's location.
* **Floors** — The venue's floor plans, each shown with an approximate elevation and calibration status (for example, "Approx. 10 ft. Elevation | Not Calibrated").

  To add a floor plan, click **Add Floor**. For information on adding floor plans, see *Add Floor Plans*.
* **Onyx Edge** — The list of Onyx Edge associated with the venue and their online status (reachability from the Onyx Portal). To view an Onyx Edge's details, click its name. To add an Onyx Edge to the venue, click **Add Onyx Edge**. For information on adding Onyx Edge, see *Add Onyx Edge*.
* **Access Point** — The list of APs associated with the venue and their online status (reachability from the Onyx Portal). To view an AP's details, click its name. To add an AP to the venue, click **Add Access Point**. For information on adding APs, see *Add APs*.
* **FHM** — The list of FHM associated with the venue and their online status (reachability from the Onyx Portal). To view an FHM's details, click its name. To add an FHM to the venue, click **Add FHM**. For information on adding FHM to the venue, see *Add FHM*.
* **Mesh Node** — The list of Mesh Nodes associated with the venue and their online status (reachability from the Onyx Portal). To view a Mesh Node's details, click its name. To add a Mesh Node to the venue, click **Add Mesh Node**. For information on adding Mesh Nodes, see *Add Mesh Node*.
  {% endstep %}

{% step %}
Click the **CBSD Scanner** tab.

The **CBSD Scanner** tab provides venue-level CBRS scanning capabilities for CBSD planning and channel analysis. It supports RF planning by identifying available CBSD channels, detecting potential interference, and helping optimize spectrum allocation for network deployments.

The following screenshot displays the interface before performing a scan.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FLQEvw9TyNSi4eIkGbtmc%2Fimage.png?alt=media&amp;token=e74bb964-bb8a-4bad-bb67-53fca7a04fdd" alt=""><figcaption></figcaption></figure></div>

The following screenshot displays the results after performing a scan with a selected radius of 2 miles, resulting in 13 discovered POIs.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FT8H5pLTC0CAbB2qxT8MJ%2Fimage.png?alt=media&amp;token=02578338-0f51-48e1-a010-a78db0068c7c" alt=""><figcaption></figcaption></figure></div>

* **Venue CBRD Scanner**
  * **Venue Location** — The venue's geographic coordinates (latitude and longitude) that define the center point for spectrum analysis queries and serve as the reference location for all SAS database queries.
  * Interactive Map Display — Provides standard map and satellite imagery views of the geographic area surrounding the venue's coordinates, offering spatial context for understanding terrain characteristics and potential RF interference sources. The map displays a circular overlay representing the search radius around the venue location, with the venue marked at the center.
  * **Selected Radius** — User-configured parameter that defines the geographic search distance from the venue's center point, determining how far the system queries the federated SAS database to discover neighboring CBRS deployments. The system performs a box search that extends the specified distance in all directions from the venue coordinates.
  * **New Scan** — Initiates a fresh query to the SAS database using the current venue location and selected radius parameters, allowing administrators to refresh analysis with current SAS data in dynamic RF environments where devices frequently register and deregister.
  * **POIs** — Points of Interest (POIs). Displays a list of specific CBSD deployments discovered within the search radius. Each entry shows precise coordinates in decimal degrees. Checkboxes next to each POI enable administrators to select specific points for focused analysis. The **Select All** and **Clear All** buttons provide quick controls for managing selections, allowing to toggle between viewing specific or all discovered deployments.

    The following screenshot displays the POI detail popup.<br>

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FTEV0vqk7EK2x9vMaaAmG%2Fimage.png?alt=media&amp;token=fdb431dc-802a-4c71-906b-ca79aec176fe" alt=""><figcaption></figcaption></figure></div>

    \
    For each discovered deployment, the POI detail popup displays the geographic coordinates (latitude and longitude), CBSD category counts, and channels in use. The category counts show the number of Category A devices (lower-power systems up to 24 dBm EIRP per 10 MHz, typically representing indoor deployments) and Category B devices (higher-power systems up to 47 dBm EIRP per 10 MHz, representing outdoor infrastructure with larger coverage areas). The channels in use section lists each channel with the number of CBSDs operating on that frequency. Administrators can filter the Channel Usage and EIRP Distribution visualizations by selecting specific channels from the popup, enabling focused analysis to prioritize interference mitigation and select optimal channels.

    * **Channel Usage** — Displays spectrum utilization across the CBRS frequency band. The horizontal axis represents channel numbers, while the vertical axis indicates the number of CBSDs detected operating on each frequency block based on current SAS registrations and incumbent activity. Taller bars indicate significant existing activity while shorter bars suggest minimal utilization. The visualization responds dynamically to POI selections, updating to display only the channel usage associated with selected deployments.
    * **EIRP Distribution over CBRS Spectrum** — Displays the effective radiated power distribution for detected CBRS devices within the search radius. The horizontal axis represents EIRP assigned values in dBm/MHz, while the vertical axis indicates the number of CBSDs operating at each power level. The visualization differentiates between Category A devices (shown in light green) and Category B devices (shown in dark green), enabling administrators to assess the power profile of nearby deployments. Higher EIRP values indicate stronger potential interference sources, while the distribution pattern reveals whether neighboring networks operate primarily as low-power or high-power systems. Like the **Channel Usage** graph, this visualization responds dynamically to POI selections for focused analysis.
  * **Archived Scans** — A list of previously run scans for the venue, with a refresh control to reload the list. Select an archived scan to view its results without running a new query.

Administrators use scan results to make informed channel selection decisions by combining geographic distribution from the map with frequency utilization from the **Channel Usage** graph and power characteristics from the **EIRP Distribution over CBRS Spectrum** chart. By examining the **Channel Usage** graph for lower bars or gaps, administrators identify frequencies with minimal nearby activity. The **EIRP Distribution over CBRS Spectrum** chart complements this analysis by revealing the power levels of existing deployments, helping administrators understand interference potential based on both proximity and transmission strength. Administrators correlate this with POI geographic distribution to understand directional interference potential.

Clicking on POI markers reveals detailed deployment information. POI selection filters both the Channel Usage and EIRP Distribution visualizations to isolate individual deployment patterns, supporting detailed investigation and helping prioritize mitigation strategies based on deployment power levels, frequency utilization, and proximity.

The iterative analysis support allows administrators to modify the search radius or execute scans at different times to understand how the RF environment evolves and develop robust spectrum strategies that minimize interference, avoid congested portions of the spectrum, and ensure reliable network performance as the deployment landscape changes.
{% endstep %}

{% step %}
Click the **Survey** tab.

The **Survey** tab provides two sections for managing RF coverage assessment workflows: **Survey Logs** and **Coverage Overlays (KMZ from EINO)**.

* **Survey Logs** —&#x20;
  * To create an authentication token for linking the GXC Survey mobile app to this venue for field data collection, click **Generate Access Token**.
  * To upload a survey log file directly from your computer, click **Upload Local File**. Uploaded logs appear in a table showing File Name, Uploaded By, Uploaded At, Size, and Actions.
* **Coverage Overlays (KMZ from EINO)** — To add a coverage overlay file exported from EINO, click **Upload KMZ**. Uploaded overlays appear in a table showing File Name, Uploaded By, Uploaded At, and Actions.

{% hint style="info" %}
**NOTE:** For detailed information on the Survey solution, including detailed procedures for generating survey logs with the GXC Survey mobile application, loading and analyzing survey data in the Onyx Portal, and interpreting RF metrics, refer to the *4G & 5G Onyx Survey Solution Application Note*.
{% endhint %}
{% endstep %}

{% step %}
Click the **AP Markers** tab.

The **AP Markers** tab lets you place and manage AP marker records for the venue, independently of the physical AP inventory in the **Access Point** section on the Overview tab.

To create a marker, click **Add AP Marker**, or right-click directly on the survey map.

Each marker record includes:

* **Name** — The marker's name.
* **Serial Number** — The AP's serial number.
* **Device Class** — The AP's device class.
* **Latitude** / **Longitude** — The marker's coordinates.
* **Created By** / **Created At** — Audit information for the marker.
* **Actions** — Options to edit or delete the marker.
  {% endstep %}
  {% endstepper %}

## Manage Floor Plans

Floor plans enable you to visualize the layout of floors and the physical location of equipment on the floors on a map.

### Add Floor Plans

{% hint style="info" %}
**NOTE:** You can add floor plans only if you are a GXC Administrator, GXC Partner Administrator, or a Super Administrator.
{% endhint %}

**To add a floor plan to a venue:**

{% stepper %}
{% step %}
In the navigation pane, click **Venues**.

The **Venues** page displays the summary details of all venues configured in the network.
{% endstep %}

{% step %}
For the venue that you want to add floor plans to, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **View**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FBpHCJxyB6BdYCqzNb1Ak%2Fimage.png?alt=media&amp;token=b8bfebbe-1518-4ec6-909a-d824681d0772" alt="" width="110"><figcaption></figcaption></figure></div>

The ***\<venue name>*** page displays the venue's details.
{% endstep %}

{% step %}
In the **Floors** section, click **Add Floor**.

The **Create Floor** page is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F7lylpc46AT2MY6MbvARx%2Fimage.png?alt=media&amp;token=173b51b8-1337-4038-94a7-a623566e143f" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

* **Name** — (Required) Assign a name to the floor.
* **Floor No.** — (Required) Enter the floor level. It must be in the range of -10 to +99.
* **Upload Floor Image** — (Required) Click **Choose** and upload the floor plan. You can upload image files of type .jpeg, .jpg, or .png.
  {% endstep %}

{% step %}
To save the floor plan, in the upper-right corner of the page, click **Save Floor**.

The floor plan is saved to the venue.
{% endstep %}
{% endstepper %}

### Calibrate Floor Plans

{% hint style="info" %}
**NOTE:** You can calibrate floor plans only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

Calibrating floor plans allows you to map the latitude and longitude coordinates of each floor in a venue and visualize it on a map.

**To calibrate a floor plan:**

{% stepper %}
{% step %}
In the navigation pane, click **Venues**.

The **Venues** page displays the summary details of all venues configured in the network.
{% endstep %}

{% step %}
For the venue that you want to calibrate floor plans for, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **View**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FnJ0HCIJcJeSjLs64UhIy%2Fimage.png?alt=media&amp;token=74113d8c-1342-4098-8d8c-25edc8cbbf1a" alt="" width="110"><figcaption></figcaption></figure></div>

The ***\<venue name>*** page displays the venue's details.
{% endstep %}

{% step %}
In the **Floors** section, for the floor plan that you want to calibrate, click the ⋮ (options) icon, then click **Calibrate**.

The **Calibrate Floor Plan** page displays the floor plan's details.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQal7RoHHNZv1dfwfA6TW%2Fimage.png?alt=media&amp;token=e5132c6d-bc70-4a91-a0d3-830f93aa7690" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To calibrate the floor plan, adjust the point markers.
{% endstep %}

{% step %}
To save the calibration, in the upper-right corner of the page, click **Save Calibration**.
{% endstep %}
{% endstepper %}

### Recalibrate Floor Plans

{% hint style="info" %}
**NOTE:** You can recalibrate floor plans only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

Recalibrating floor plans allows you to map the latitude and longitude coordinates of each floor in a venue and visualize it on a map. You can recalibrate a floor plan only if the floor plan has already been calibrated.

**To recalibrate a floor plan:**

{% stepper %}
{% step %}
In the navigation pane, click **Venues**.

The **Venues** page displays the summary details of all venues configured in the network.
{% endstep %}

{% step %}
For the venue that you want to recalibrate floor plans for, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **View**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FjLFDAaITYNybZ99l2Jcb%2Fimage.png?alt=media&amp;token=c8d9bef1-83dc-4144-b329-b04e8baa332d" alt="" width="110"><figcaption></figcaption></figure></div>

The ***\<venue name>*** page displays the venue's details.
{% endstep %}

{% step %}
In the **Floors** section, for the floor plan that you want to recalibrate, click the ⋮ (options) icon, then click **Re-Calibrate**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F7Gv05sy102XrosLu4PS1%2Fimage.png?alt=media&amp;token=0f0b687e-343b-4740-a2f3-e3b3a93bff5a" alt="" width="533"><figcaption></figcaption></figure></div>

The **Recalibrate Floor Plan** page displays the floor plan's details.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FYmVGrVxgjDYwcj6byVLu%2Fimage.png?alt=media&amp;token=3f2049f7-fde0-4169-83a7-b74d3e94539f" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To recalibrate the floor plan, adjust the point markers.
{% endstep %}

{% step %}
To save the calibration, in the upper-right corner of the page, click **Save Calibration**.
{% endstep %}
{% endstepper %}

### Delete Floor Plans

{% hint style="info" %}
**NOTE:** You can delete floor plans only if you are a GXC Administrator, Partner Administrator, or a Super Administrator.
{% endhint %}

**To delete a floor plan from a venue:**

{% stepper %}
{% step %}
In the navigation pane, click **Venues**.

The **Venues** page displays the summary details of all venues configured in the network.
{% endstep %}

{% step %}
For the venue that you want to delete the floor plan from, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **View**.

The venue's details are displayed.
{% endstep %}

{% step %}
In the **Floors** section, for the floor plan that you want to delete, click the corresponding ⋮ (options) icon, then click **Delete**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fx1w50PUAGfeuMW9aZUNs%2Fimage.png?alt=media&amp;token=03582b89-6217-44f5-856f-cb9a4cd3d162" alt="" width="563"><figcaption></figcaption></figure></div>

A confirmation dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJLzHyk5XtkaGCFER51ho%2Fimage.png?alt=media&amp;token=fcc31662-cbb7-4f95-896a-ca95db9ac362" alt="" width="374"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To confirm, click **Yes**.
{% endstep %}
{% endstepper %}

## Add Venues

This section describes how to add venues.

{% hint style="info" %}
**NOTE:** You can add venues only if you are a GXC Administrator, Partner Administrator, or a Super Administrator.
{% endhint %}

**To add a venue to a 5G network:**

{% stepper %}
{% step %}
In the navigation pane, click **Venues**.

The **Venues** page displays the summary details of all venues configured in the network.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Add Venue**.

The **Create Venue** page is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FggXCHSc9bEysklCz37WB%2Fimage.png?alt=media&amp;token=03651aa3-51a0-4b51-8149-b21ae9321abb" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

* **Venue Name** — (Required) The venue's name. The venue's name must be an alphanumeric string of 1–32 characters and must be unique within the network.
* **Description** — (Required) The venue's description.
* **Address / Coordinates** — Select the address type.
  * If you select **Address**, enter the venue's address.

    * **Address** — (Required) The venue's address. After you enter the address, the location will be displayed on the map.

    If you select **Coordinates**, enter the venue's GPS latitude and longitude coordinates in Decimal Degrees (DD) format. For example, Latitude: 12.93421, Longitude: 77.62989. After you enter the coordinates, the map displays the location.<br>

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F7fy6mrR99BKvNter5moK%2Fimage.png?alt=media&amp;token=e3f2ba22-a2a8-483a-a1fc-519f8f5cb9e6" alt="" width="563"><figcaption></figcaption></figure></div>

    * **Latitude** — (Required) The venue's GPS latitude coordinate.
    * **Longitude** — (Required) The venue's GPS longitude coordinate.
      {% endstep %}

{% step %}
To save the venue, in the upper-right corner of the page, click **Save Venue**.
{% endstep %}
{% endstepper %}

## Edit Venues

This section describes how to edit venues.

{% hint style="info" %}
**NOTE:** You can edit venues only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

**To edit a venue in a 5G network:**

{% stepper %}
{% step %}
In the navigation pane, click **Venues**.

The **Venues** page displays the summary details of all venues configured in the network.
{% endstep %}

{% step %}
For the venue that you want to edit, in the **Actions** column click the corresponding ⋮ (options) icon, then click **Edit**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FzSGVfw9Q3GFNR18u9eeq%2Fimage.png?alt=media&amp;token=48b545bc-7973-4b14-856b-954f49565b8b" alt="" width="110"><figcaption></figcaption></figure></div>

The **Edit Venue (*****\<venue name>*****)** page displays the venue's details.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FrERGD1dPI2EGBwZSAF6U%2Fimage.png?alt=media&amp;token=84017ace-17ca-4de6-8354-f5a3fcdae298" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Update the venue's details as required.

* **Venue Name** — (Required) The venue's name. The venue's name must be unique within the network and must be an alphanumeric string of 1–32 characters.
* **Description** — (Required) The venue's description.
* **Address / Coordinates** — Select the address type.

  If you select **Address**, enter the venue's address.

  * **Address** — (Required) The venue's address. After you enter the address, the map displays the location.

  If you select **Coordinates**, enter the venue's GPS latitude and longitude coordinates in Decimal Degrees (DD) format. For example, Latitude: 12.93421, Longitude: 77.62989. After you enter the coordinates, the map displays the location.<br>

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fw2DL7g3KQhF4btS4gRrE%2Fimage.png?alt=media&amp;token=1c115b0e-26cd-454a-a0ad-fb37bfa410ba" alt="" width="563"><figcaption></figcaption></figure></div>

  * **Latitude** — (Required) The venue's GPS latitude coordinate.
  * **Longitude** — (Required) The venue's GPS longitude coordinate.
    {% endstep %}

{% step %}
To save your edits, in the upper-right corner of the page, click **Save Venue**.
{% endstep %}
{% endstepper %}

## Delete Venues

{% hint style="info" %}
**NOTE:** You can delete venues only if you are a GXC Administrator, Partner Administrator, or a Super Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** You cannot delete a venue if there are any floors, APs, or Onyx Edge associated with the venue.
{% endhint %}

**To delete a venue from the network:**

{% stepper %}
{% step %}
In the navigation pane, click **Venues**.

The **Venues** page displays the summary details of all venues configured in the network.
{% endstep %}

{% step %}
For the venue that you want to delete, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Delete**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FbdnxcYWnDjcKNa0iK1ii%2Fimage.png?alt=media&amp;token=8e133795-4578-4f87-9bbd-e225817dd6fc" alt="" width="110"><figcaption></figcaption></figure></div>

A confirmation dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmCjMSuBHhd8qI8cmb4Rh%2Fimage.png?alt=media&amp;token=8f51b24b-942f-41e0-8ff2-4d5f9fe7d8db" alt="" width="329"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To confirm deleting the venue, click **Yes**.
{% endstep %}
{% endstepper %}


# Manage Equipment

The Onyx Portal enables you to add, monitor, and manage Onyx Edge, APs, FHM, and Mesh Node equipment in your network.


# 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 %}

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FuPYcLyniULnAMdHSR3kd%2FChatGPT%20Image%20Jun%2012%2C%202026%2C%2012_23_04%20AM.png?alt=media&#x26;token=22c2d9f3-832d-4140-bfd7-577e6c491e8c" alt=""><figcaption></figcaption></figure></div>

* **Onyx Edge (n)** – (n) Indicates the number of Onyx Edge (NR+Core) in the network.
  * Status of services running on the Onyx Edge.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F61927Tox0WKXomDBCyRY%2Fimage.png?alt=media&#x26;token=51a4d198-eba4-4cb4-a96a-9a6980497c92" alt="" data-size="line"> 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.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FkfUxJdcfIUCxNSZwz0vU%2Fimage.png?alt=media&#x26;token=27b91570-3631-4620-9477-c7f38799b3ba" alt="" data-size="line"> 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.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FabTMpcsUQNAfu85BAfT0%2Fimage.png?alt=media&#x26;token=6346a735-f358-45d8-b83e-f6d3346fa5c7" alt="" data-size="line"> 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.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FOhgppxkCQw1mDPjal7OT%2Fimage.png?alt=media&#x26;token=3f938e7a-023c-4e90-b88c-ab715b566b75" alt="" data-size="line"> 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.

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FuenN0T3I89Pz5E9nrv0b%2Fimage.png?alt=media&#x26;token=94236eb6-7127-426b-92d2-5211be244dac" alt=""><figcaption></figcaption></figure></div>
  * **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.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8StsT1yosnAvNiAOCYvd%2Fimage.png?alt=media&#x26;token=c14cec14-2d1e-4017-aac6-b45caa2e155c" alt="" data-size="line"> Green – Indicates the Onyx Edge has checked-in with Onyx Portal in the last five minutes.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FY8ITbeqhGDPgTyoJ2oUG%2Fimage.png?alt=media&#x26;token=56ccee1d-9615-41b4-bcd0-5cc6a77cbd28" alt="" data-size="line"> 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.

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FsOYjdNpdxFPFPZKMlgV1%2Fimage.png?alt=media&#x26;token=a9a825a0-46e9-4494-a337-daf3b51e2c74" alt=""><figcaption></figcaption></figure></div>
  * **Interface Status** – Indicates connection status of N6 and RAN (Fronthaul) interfaces.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fl0LnctTqZdO0C8eQsxGG%2Fimage.png?alt=media&#x26;token=bbf23f4c-11b7-4767-bd2b-57f6773f12e4" alt="" data-size="line"> 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).
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FloHpD7XB1132ND8pE1mm%2Fimage.png?alt=media&#x26;token=2f527bbf-6e25-40db-8b30-201ef769917b" alt="" data-size="line"> 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).
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FY8Oogtd1okxFqolUUyb0%2Fimage.png?alt=media&#x26;token=78d5df32-fcbc-4b64-81c6-d61d6eff29cf" alt="" data-size="line"> 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).
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FxiEvN2FigwEI07qOMEJg%2Fimage.png?alt=media&#x26;token=981801e6-a61a-4d24-ac8c-a78f6801e272" alt="" data-size="line"> Grey – Indicates the Onyx Edge is offline.

    Hover your cursor over the "Interface Status" icon to view the following details.

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fyl68sOEjr5ePf5GWFFKb%2Fimage.png?alt=media&#x26;token=77f14766-490f-43fa-a4bf-a7a310b62503" alt=""><figcaption></figcaption></figure></div>
  * **Sync Status** — Indicates the Onyx Edge's synchronization status with the timing source.

    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FeWq5l7WxliSw8Y8wUKBA%2Ficon-ipsec-status-green.png?alt=media\&token=0d9986b5-0e1d-4216-85fe-c7131e14561e) Green – The Onyx Edge is in sync with the timing source.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fs1QiSGfkgK9wXBq0HhL5%2Ficon-ipsec-status-red.png?alt=media\&token=844819f6-7d8a-4030-93e8-2e791e795f07) Red – The Onyx Edge is out of sync with the timing source.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJixkfvRx1oay39vaBl0x%2Ficon-ipsec-status-grey.png?alt=media\&token=4f8999ff-ffac-4a03-bf44-840cdb7ff81c) 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:

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FCTaXroiMzdlebFcFT4FX%2Fimage.png?alt=media&#x26;token=f279a362-c717-4069-92da-efa60c17754a" alt=""><figcaption></figcaption></figure></div>
  * **Compute Resource** – Indicates utilization of the Onyx Edge's computing resources – CPU, memory, and disk utilization percentage.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5gmvyIBAyrKIG1PdLLuh%2Fimage.png?alt=media&#x26;token=271d4059-bf50-4dbb-bc64-256e38bb67ae" alt="" data-size="line"> Green – Indicates all parameters are below 50%.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FjYnOFlDGGpBvHAOsir7p%2Fimage.png?alt=media&#x26;token=1cc47059-833d-4786-83b4-9fce8d6c4de9" alt="" data-size="line"> Amber – Indicates at least one parameter is above 50% and below 70%.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FrzghdBegGmTttOapSI0L%2Fimage.png?alt=media&#x26;token=8a710971-2a60-4011-970f-e326311ab920" alt="" data-size="line"> Red – Indicates at least one parameter is above 70%.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FtMmANXl9NH1twKXYW8qC%2Fimage.png?alt=media&#x26;token=1e5a9eda-8ad4-48bb-ae58-e0cfc6392aee" alt="" data-size="line"> Grey – Indicates the Onyx Edge is offline.

    Hover your cursor over the Compute Resource icon to view the following details:

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FhUlOzR53by5y5zJl4134%2Fimage.png?alt=media&#x26;token=b81f4010-9554-4a00-a136-f50c2c1679e4" alt=""><figcaption></figcaption></figure></div>

    * **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.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FLQ2D7TvBIwEoRdtTsg4N%2Fimage.png?alt=media&#x26;token=a79527a1-e2bd-4aae-9f35-4ae17dcb37cf" alt=""><figcaption></figcaption></figure></div>

  * **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.

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FNwlSuEp5BflptbsHMsHj%2Fimage.png?alt=media&#x26;token=796bc229-d649-40a6-9dcf-5bef45af235e" alt="" width="563"><figcaption></figcaption></figure></div>
  * **Onyx Edge Connected with Onyx Portal** – Trend chart of the number of Onyx Edge connected with the Onyx Portal in the selected duration.<br>

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F9Vfk03yq2nAtGROThAeB%2Fimage.png?alt=media&#x26;token=6a174865-2ddb-445d-976c-f161bd4f5f14" alt="" width="507"><figcaption></figcaption></figure></div>
  * **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.

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FG8mwzKKX2ZmxqKTmeQdp%2Fimage.png?alt=media&#x26;token=cd448c81-14ae-4be2-ad13-921a92c16968" alt=""><figcaption></figcaption></figure></div>

    You can select the event type from the following:

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FiZB1l8zds98CXVtOOwJR%2F5g-oe-core-only-view-summary-details-perf-graphs-ue-attach-status.png?alt=media&#x26;token=91e210a1-19a1-4b51-9343-faea60181981" alt="" width="348"><figcaption></figcaption></figure></div>

    * **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 ***\<onyx edge name>*** page displays the following details:

* **Overview** tab:
  * **Onyx Edge Details**:

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FOIQwtB1xgeurgOgPiK2n%2FChatGPT%20Image%20Jun%2012%2C%202026%2C%2012_34_43%20AM.png?alt=media&#x26;token=a549c1cd-a41a-4846-92a5-e328effad0fa" alt="" width="375"><figcaption></figcaption></figure></div>

    * **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.

      <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The <strong>Upgrade Status</strong> parameter is displayed only during and for one hour after an upgrade.</p></div>
    * **Core Upgrade Status** – Status of the last Onyx Edge software upgrade.

      <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The <strong>Upgrade Status</strong> parameter is displayed only during and for one hour after an upgrade.</p></div>

      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 <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FFU0iO6AvBkmrzZ3fr7Z0%2Fimage.png?alt=media&#x26;token=17b9a26b-0533-45c1-a961-dfeaaf34a0dc" alt="" data-size="line"> 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 <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FwfcUodghPHqdbC9IDrC4%2Fimage.png?alt=media&#x26;token=15308471-6f08-4406-96eb-bc5906119210" alt="" data-size="line"> copy icon.
  * The Onyx Edge's health status.
    * **Online** – The Onyx Edge's online status indicating its reachability from the Onyx Portal.

      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FR3xrFrrdPEwPHUeLqxMv%2Fimage.png?alt=media&#x26;token=e38ff74e-b7ea-4355-882c-d6c84c3bba14" alt="" data-size="line"> Green – Indicates the Onyx Edge has checked-in with Onyx Portal in the last five minutes.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FF9o8ISYiil1V5yz0bYZI%2Fimage.png?alt=media&#x26;token=a03d4445-1e88-4ef0-aab7-d8f33a8544a3" alt="" data-size="line"> 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.

      <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FsOYjdNpdxFPFPZKMlgV1%2Fimage.png?alt=media&#x26;token=a9a825a0-46e9-4494-a337-daf3b51e2c74" alt=""><figcaption></figcaption></figure></div>
    * **Interface Status** – The Onyx Edge's interface status indicating the connection status of SGi and RAN (S1) interfaces.

      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FPEerPqB0nCKF0EXETL6L%2Fimage.png?alt=media&#x26;token=bfba376b-e9ad-4ad3-85e4-f1cd7804d17b" alt="" data-size="line"> 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).
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FzDshV4ChZbFOhxfg9LXO%2Fimage.png?alt=media&#x26;token=84c97c33-1325-4478-a131-fa241ed7fc9d" alt="" data-size="line"> 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).
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FS9mAMVWkrEvHkuVMb9SO%2Fimage.png?alt=media&#x26;token=adab6565-5ed3-4a62-84d3-a516b73db549" alt="" data-size="line"> 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).
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmEw7Otw6We2U3kdl17A5%2Fimage.png?alt=media&#x26;token=beeab70c-7213-4324-9149-39c600c207f4" alt="" data-size="line"> 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.

      <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fyl68sOEjr5ePf5GWFFKb%2Fimage.png?alt=media&#x26;token=77f14766-490f-43fa-a4bf-a7a310b62503" alt=""><figcaption></figcaption></figure></div>
    * **Compute Resource** – Status of the Onyx Edge's computing resources.

      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FVSwtp5cyu524dBIL2ozo%2Fimage.png?alt=media&#x26;token=efc17fb9-1209-49f8-b54e-7fd20640b5a3" alt="" data-size="line"> Green – Indicates all parameters are below 50%.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FFIe52NhFwGnyn8mOBjoF%2Fimage.png?alt=media&#x26;token=e418e2f3-e776-4270-8122-b01b0d25af3f" alt="" data-size="line"> Amber – Indicates at least one parameter is above 50% and below 70%.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fm6lHZwlN6MMjY1ApdKZr%2Fimage.png?alt=media&#x26;token=8cba3cef-a7e2-49b9-9b57-89918a77fda7" alt="" data-size="line"> Red – Indicates at least one parameter is above 70%.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fv85QMilEwbfFfdL1Itjl%2Fimage.png?alt=media&#x26;token=65e2f365-976b-485a-8f5a-2f7f2d6558ba" alt="" data-size="line"> Grey – Indicates the Onyx Edge is offline.

      Hover your cursor over the Compute Resource Status icon to view the following details:

      <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FhUlOzR53by5y5zJl4134%2Fimage.png?alt=media&#x26;token=b81f4010-9554-4a00-a136-f50c2c1679e4" alt=""><figcaption></figcaption></figure></div>

      * **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.

      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmJoPiFacvXYLtffV4oLJ%2Fimage.png?alt=media&#x26;token=a0de0ff6-d066-43ce-8f4f-be78528c53c9" alt="" data-size="line"> 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.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmLEkvkpkURiakBEZJJa1%2Fimage.png?alt=media&#x26;token=0c7e23d1-d605-4010-811c-c3f9b3bdefac" alt="" data-size="line"> 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.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FIaSa4FSHZ0XAhqZJYZit%2Fimage.png?alt=media&#x26;token=e0e938c5-4f52-4b73-83be-17bd1671fde0" alt="" data-size="line"> 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.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F7XAOwamm2z8X2e23xWOM%2Fimage.png?alt=media&#x26;token=ebeaa754-9ac3-4910-bb1f-bd0c689aa02d" alt="" data-size="line"> 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.

      <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FuenN0T3I89Pz5E9nrv0b%2Fimage.png?alt=media&#x26;token=94236eb6-7127-426b-92d2-5211be244dac" alt=""><figcaption></figcaption></figure></div>
    * **Sync Status** – Indicates the Onyx Edge's synchronization status with the timing source.

      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FeWq5l7WxliSw8Y8wUKBA%2Ficon-ipsec-status-green.png?alt=media\&token=0d9986b5-0e1d-4216-85fe-c7131e14561e) Green – The Onyx Edge is in sync with the timing source.
      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fs1QiSGfkgK9wXBq0HhL5%2Ficon-ipsec-status-red.png?alt=media\&token=844819f6-7d8a-4030-93e8-2e791e795f07) Red – The Onyx Edge is out of sync with the timing source.
      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJixkfvRx1oay39vaBl0x%2Ficon-ipsec-status-grey.png?alt=media\&token=4f8999ff-ffac-4a03-bf44-840cdb7ff81c) 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:

      <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FCTaXroiMzdlebFcFT4FX%2Fimage.png?alt=media&#x26;token=f279a362-c717-4069-92da-efa60c17754a" alt=""><figcaption></figcaption></figure></div>

      * **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.

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fo2LuXkT7l00woIIjRcmM%2Fimage.png?alt=media&#x26;token=0b65cac2-cde4-4105-b9fd-46d56b07805e" alt="" width="422"><figcaption></figcaption></figure></div>

    * **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.

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FN76N4IdjIjdrQnozmzsB%2Fimage.png?alt=media&#x26;token=bb12c3fb-c39b-4dd6-a98b-2eb7c570c0a6" alt="" width="425"><figcaption></figcaption></figure></div>

    * **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.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> For non-GXC Administrator users this list excludes MeshBackhaul subscriber data.</p></div>

    * **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.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fw443ijr7zibYWHQai4NP%2Fimage.png?alt=media&#x26;token=282708ba-40fa-4cc2-ba75-ad735ca71347" alt=""><figcaption></figcaption></figure>

* **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 ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fx1qgmEO25RM7W7eAG314%2Fimage.png?alt=media\&token=4a78557d-d07a-414e-8aa8-825b0d835e0c) fields. The events list automatically updates to display the corresponding logs.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE</strong>: Your selections must fall within a seven-day range.</p></div>
  * **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 <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FiywlnWmDHYOTvXA1Z7RP%2Fimage.png?alt=media&#x26;token=b65d29ec-fa4a-4c0e-9841-ca659929c6b0" alt="" data-size="line"> (view details) icon.
    {% endstep %}

{% step %}
Click the **Logs** tab.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FSD33F9z1MGLt43XKTxyV%2Fimage.png?alt=media&#x26;token=cca6e0e5-7278-4a25-8f8d-87752e533e7f" alt=""><figcaption></figcaption></figure>

* **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 <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F4w8Fy07DnzcNLDkdMQSS%2Fimage.png?alt=media&#x26;token=cb4a9179-768c-4a80-a948-2d3795b87a05" alt="" data-size="line"> field, enter the number of logs to be included in the .csv file, then click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FFuWRaHCtkZOQYxSR9NnW%2Fimage.png?alt=media&#x26;token=e497b562-48a2-4aff-9853-58ed94047d8b" alt="" data-size="line">. Default value: 1000. The downloaded .csv file includes details such as the timestamp, service, tag, type, and log text.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE</strong>: You can download a maximum 5000 logs.</p></div>
* Date and Time Range – To view logs in a specific date and time range, select the required timestamps in the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FsBXYc0Mpc10KwME0epTK%2Fimage.png?alt=media&#x26;token=007e5dde-93fb-4eaf-ad74-a51242da3137" alt="" data-size="line"> fields. The logs list automatically updates to display the corresponding logs.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE</strong>: Your selections must fall within a seven-day range.</p></div>
* Search Logs – To search for a log, in the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FWTRGrtKLDgZbv4r3hJMq%2Fimage.png?alt=media&#x26;token=eabdb9f1-e348-422f-8d04-73a55f77d4f0" alt="" data-size="line"> 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).

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FCTCrNEwhiCXDX9h34ng4%2Fimage.png?alt=media&#x26;token=f679f594-4265-4482-82af-68ab0a0cb1d5" alt="" data-size="line"> 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.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FpT3Vdq4pMreYfEkNBPfW%2Fimage.png?alt=media&#x26;token=ddb607d4-23c9-4284-87da-eaeb74bb1845" alt="" data-size="line"> 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.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FCD8FHUCdDnESrRjQZw4v%2Fimage.png?alt=media&#x26;token=0449ea0e-4559-48bb-b76e-5898063ff81d" alt="" data-size="line"> 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.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FDBeJgef5w60oCcsuUTnH%2Fimage.png?alt=media&#x26;token=5088c512-ffd3-443c-bb4a-afc094c1ddc7" alt="" data-size="line"> 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.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fl4aP84kKB8OxXR1oriGJ%2Fimage.png?alt=media&#x26;token=713c4e06-b3bd-4a17-9412-8490327260a7" alt="" data-size="line"> Green – Indicates the Onyx Edge has checked-in with Onyx Portal in the last five minutes.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FMPCgSTj9vxek8EhqHd7o%2Fimage.png?alt=media&#x26;token=618a5bb1-8819-4496-acf9-4161e6de5a3a" alt="" data-size="line"> 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.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FTDtAPvKVUiuDlmgTaJqo%2Fimage.png?alt=media&#x26;token=680efc64-4076-4037-92be-70eb2eb32937" alt="" data-size="line"> 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).
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FyG2hfPMWBD2KpG4NK5kd%2Fimage.png?alt=media&#x26;token=c3585c06-cbc9-4b62-99f9-77d8ab041a26" alt="" data-size="line"> 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).
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FhIOEvdHqV4POj8jM7VrA%2Fimage.png?alt=media&#x26;token=22d01ed5-5e65-44ff-9306-586f51175b8b" alt="" data-size="line"> 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).
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FnbzQeHlJXev8xRRkegtF%2Fimage.png?alt=media&#x26;token=abd66ad6-4ac9-487e-aa46-0ae48768742b" alt="" data-size="line"> 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.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FrjhDJ5KO0nWN6OTirwj0%2Fimage.png?alt=media&#x26;token=4f96ba71-54a0-4d1e-9199-f0d8506b9b29" alt="" data-size="line"> Green – Indicates all parameters are below 50%.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F57c5JLgHZzLngqbIam0n%2Fimage.png?alt=media&#x26;token=7302b407-843b-493c-b39c-0e90187777ea" alt="" data-size="line"> Amber – Indicates at least one parameter is above 50% and below 70%.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FHpKweHWHbU2k8zoW1yoK%2Fimage.png?alt=media&#x26;token=aa585789-ac37-4f59-8389-529c7328a0d4" alt="" data-size="line"> Red – Indicates at least one parameter is above 70%.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fe4byjJZnjr2Y7XbfKgt2%2Fimage.png?alt=media&#x26;token=1ca92542-87f9-4447-a29f-a02ef1a7e86d" alt="" data-size="line"> 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.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0ColEwAmMLocW8nMbykU%2Fimage.png?alt=media&#x26;token=b84c9b01-ef0c-40fb-9712-1bff22ddd37e" alt="" data-size="line"> Green – One Onyx Edge is functioning as the Primary ACS, and the others as Standby ACS.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FB7eKMlWyiQV9fghtEcKp%2Fimage.png?alt=media&#x26;token=602cfbdb-4b02-4c2d-b023-a6e805b77382" alt="" data-size="line"> Amber – One Onyx Edge is functioning as the Primary ACS, but one or more of the other Onyx Edge are non-functional.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FoxDAt9Yj3mlA8a0ghUah%2Fimage.png?alt=media&#x26;token=15944016-e8c4-4837-baf4-619b55f0f705" alt="" data-size="line"> Red – All Onyx Edge are non-functional, or their status is not available.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fmdzpj3JkPpnN6pZA11Y0%2Fimage.png?alt=media&#x26;token=5b930976-36ed-4db8-bde5-90503d1fca45" alt="" data-size="line"> 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.<br>

  <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FLQ2D7TvBIwEoRdtTsg4N%2Fimage.png?alt=media&#x26;token=a79527a1-e2bd-4aae-9f35-4ae17dcb37cf" alt=""><figcaption></figcaption></figure>

  \
  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.

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FiZB1l8zds98CXVtOOwJR%2F5g-oe-core-only-view-summary-details-perf-graphs-ue-attach-status.png?alt=media&#x26;token=91e210a1-19a1-4b51-9343-faea60181981" alt=""><figcaption></figcaption></figure></div>

    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 ***\<Onyx-Edge-Name>*** 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 ***\<Onyx-Edge-Pool-Name>*** 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.

      <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The <strong>Upgrade Status</strong> parameter is displayed only during and for one hour after an upgrade.</p></div>

      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.

      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FoSTrhnHqKvnM7oKbNSBG%2Fimage.png?alt=media&#x26;token=462c48fc-db4a-4359-adf1-1144326f78dd" alt="" data-size="line"> Green – Indicates the Onyx Edge has checked-in with Onyx Portal in the last five minutes.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8UkiP29T6YRzt5nqVwgK%2Fimage.png?alt=media&#x26;token=7a6e1e00-2e4e-46b4-98ed-a89b58ea2fab" alt="" data-size="line"> 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.

      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKsEgXWX37xZn9WLhmNXf%2Fimage.png?alt=media&#x26;token=ba5d8ea4-ccbf-44e3-ba48-a1a274b0fb5f" alt="" data-size="line"> 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).
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fz7qriAgRIpb5FZrWf34c%2Fimage.png?alt=media&#x26;token=a9bdb872-e6c6-4c5a-8574-6407e2d7515b" alt="" data-size="line"> 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).
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FkImPrpeWgesptgo2PXrj%2Fimage.png?alt=media&#x26;token=ffe9ffd6-2fdc-44a9-b4fb-327b51d510d4" alt="" data-size="line"> 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).
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0VBvVyUrdc87ol4jCKrx%2Fimage.png?alt=media&#x26;token=0fae84e0-160a-43af-acd4-95f8ff7a10cc" alt="" data-size="line"> 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.

      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fb1UDdCFXOBnqrrUGJPQb%2Fimage.png?alt=media&#x26;token=c5095b7a-9867-422a-ab17-c8f36fd62bb3" alt="" data-size="line"> Green – Indicates all parameters are below 50%.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FY0BEjlsQ8bkb0Eyt0EFR%2Fimage.png?alt=media&#x26;token=c46628c1-c783-46b5-8f09-80d749834169" alt="" data-size="line"> Amber – Indicates at least one parameter is above 50% and below 70%.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXsdEqxQWB1TEPf9Th3iR%2Fimage.png?alt=media&#x26;token=1d9b9306-3a62-4674-85d2-04169c6ce5a5" alt="" data-size="line"> Red – Indicates at least one parameter is above 70%.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FkhxM5mOWSNopaloXuJq3%2Fimage.png?alt=media&#x26;token=ef27b898-309c-4691-a0ab-7baaee8d9e5a" alt="" data-size="line"> 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.

      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXvniW2Abkmpl2ZyR0IWw%2Fimage.png?alt=media&#x26;token=1b2a9558-1617-45da-8ddd-74764e57ec29" alt="" data-size="line"> 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.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F4t7cvibfuqY7K7CZ7jS4%2Fimage.png?alt=media&#x26;token=2c0c7156-18f4-4a58-8d93-ace5767b6f63" alt="" data-size="line"> 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.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FnfW9WF3qpXfN3xkPN1lL%2Fimage.png?alt=media&#x26;token=859b2756-b73a-4d63-a326-18b4fee26ea9" alt="" data-size="line"> 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.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FUr5P7vpCTl7tc0QCFWzD%2Fimage.png?alt=media&#x26;token=d07b8546-98d4-4568-9769-3a1c612464c2" alt="" data-size="line"> 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.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> For non-GXC Administrator users this list excludes MeshBackhaul subscriber data.</p></div>

    * **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 <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FogHV542F0ZBYRZWRgC9Q%2Fimage.png?alt=media&#x26;token=2f7d91d7-3a40-4dcb-b65b-f79630ff8773" alt="" data-size="line"> date/time fields. The events list automatically updates to display the corresponding logs.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> Your selections must fall within a seven-day range.</p></div>
  * **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 <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FwqqgCix2PkkM7rG2249n%2Fimage.png?alt=media&#x26;token=21343b59-6741-421b-a940-d081c456bf22" alt="" data-size="line"> (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 <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FioD8wNf4nYeUcI0UXKeT%2Fimage.png?alt=media&#x26;token=dd70e970-1c87-4908-90f4-4a514a40713d" alt="" data-size="line"> field enter the number of logs to be included in the .csv file, then click the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJAoMUAVryUVMrGcApZrU%2Fimage.png?alt=media&#x26;token=5b902c9a-e118-4849-9145-7a1d0d80ffb7" alt="" data-size="line"> icon. Default value: 5000. The downloaded .csv file includes details such as the timestamp, service, tag, type, and log text.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> You can download a maximum 5000 logs.</p></div>
* Date and Time Range – To view logs in a specific date and time range, select the required timestamps in the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FTgcLUaNcjArjGIV25nRO%2Fimage.png?alt=media&#x26;token=7b8222a6-55f6-4939-b6bf-0891f218ba0e" alt="" data-size="line"> date/time fields. The logs list automatically updates to display the corresponding logs.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> Your selections must fall within a seven-day range.</p></div>
* Search Logs – To search for a log, enter your search term in the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FgjUILIcy8ujZCS0dCnoU%2Fimage.png?alt=media&#x26;token=0b36959f-e979-4f38-82bf-93a1f13aec76" alt="" data-size="line"> 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.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Famtd2Fepbooz5AnoxG2f%2F5g-oe-nr-core-add-onyx-edge-tab.png?alt=media&#x26;token=40bc4af0-7b4e-4a3b-b7c0-d0e7c0d9514f" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

* **Type** – (Required) Select the Onyx Edge type **NR+Core**. Default value: **NR+Core**.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> After you add an Onyx Edge, its type cannot be changed.</p></div>
* **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.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FFLlhZaRTrDSlCUugvDrF%2F5g-oe-nr-core-add-core-tab.png?alt=media&#x26;token=4d6492b6-67ec-4211-a800-9aa7e1832198" alt=""><figcaption></figcaption></figure></div>
{% 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.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FAknlOFgL2bQfEUbmYKpC%2F5g-oe-nr-core-add-ran-tab.png?alt=media&#x26;token=79263f03-3c59-4027-a654-8c5506090b95" alt=""><figcaption></figcaption></figure></div>
{% 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.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F4eA9x5CfI3menA0QDs9I%2F5g-oe-nr-core-add-ran-tab-slot-patterns.png?alt=media&#x26;token=ecd7fd64-e286-4bc7-99ad-4b32222bef56" alt="" width="377"><figcaption></figcaption></figure></div>
* **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:

     <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FETvFBMiMMj8UpeKBDVkH%2Fimage.png?alt=media&#x26;token=cbbde537-cec2-4ec1-86b2-a7934264d9bc" alt="" width="563"><figcaption></figcaption></figure></div>

     * **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:

     <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FLdHn7p4Z7IkFlWAxSEhW%2Fimage.png?alt=media&#x26;token=bde39d6f-f4e2-4de7-af7d-8443655533f5" alt="" width="563"><figcaption></figcaption></figure></div>

     * **SAS Enabled** – Enable. Default setting: disabled.
       * **Name** – (Required) The cell's name.
       * **User ID** – (Required) The SAS account's user ID.

         <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> To obtain the SAS user ID, contact GXC Technical Support.</p></div>
       * **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.<br>

             <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> 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.<br>2. Strict Preference is automatically set to True, and it cannot be modified.<br>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.</p></div>
  2. In the **Handover** tab, enter the following details:

     <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5UluWkxaYEutnzFcbQbl%2Fimage.png?alt=media&#x26;token=0d08d0e5-e500-4ee7-8b7c-1f5771d7c1e0" alt="" width="563"><figcaption></figcaption></figure></div>

     * **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.

       <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F74nTbDJWDq9lvLk5rRmW%2Fimage.png?alt=media&#x26;token=aeb98b47-825b-47fe-8b47-9595743aece2" alt="" width="563"><figcaption></figcaption></figure></div>

       * **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.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fk5sZssTIaoCcaYH9dJ2C%2Fimage.png?alt=media&#x26;token=d4e1b773-4e4b-4822-9f81-f3e9ffaa84d9" alt=""><figcaption></figcaption></figure></div>
{% 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.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> 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.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> 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 <strong>Last Reported Time</strong> parameter is blank, displayed as --.</p></div>
* **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.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F2qXFMC743epTUyVHoETO%2F5g-oe-nr-core-add-others-tab-add-backhaul-speedtest-server.png?alt=media&#x26;token=11f49497-1cb1-4a4e-b345-61b4ccf16668" alt="" width="563"><figcaption></figcaption></figure></div>

  * **Add Server** – Add a new speedtest server.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F1E7aJ2pwAqmHDbkB9ivK%2Ficon-drag-handle.png?alt=media\&token=a09fba89-37a5-4a25-b25a-e3948b30551a) (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.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fxk8ehnS409922oS6GtAj%2F5g-vlan-mode-oe-nr-core-add-onyx-edge-tab.png?alt=media&#x26;token=865af989-73a4-43d7-8698-86f48d5c9527" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

* **Type** – (Required) Select the Onyx Edge type **NR+Core**. Default value: **NR+Core**.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> After you add an Onyx Edge, its type cannot be changed.</p></div>
* **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.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FctejVY80k1Fa66WW3vJ7%2F5g-vlan-mode-oe-nr-core-add-core-tab.png?alt=media&#x26;token=533657fc-cd67-49c1-8afc-9585470175e9" alt=""><figcaption></figcaption></figure></div>
{% 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.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Feolfh37nPOiYuT4ZefgZ%2F5g-vlan-mode-oe-nr-core-add-ran-tab.png?alt=media&#x26;token=27722c75-9115-4044-80e6-64def33c7b33" alt=""><figcaption></figcaption></figure></div>
{% 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.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FCizn9p6mKhPuPOusVrEC%2F5g-vlan-mode-oe-nr-core-add-ran-tab-slot-patterns.png?alt=media&#x26;token=799dfc43-82e9-4ee4-a87a-b6a82ed25b06" alt="" width="374"><figcaption></figcaption></figure></div>
* **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:

     <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FdxaHNJwaMGgAT5RpaTLM%2Fimage.png?alt=media&#x26;token=5ef88445-cfc1-4de4-a89f-b68d73013043" alt="" width="563"><figcaption></figcaption></figure></div>

     * **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:

     <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FlxUYW2gknhBrTiZYk1Ai%2Fimage.png?alt=media&#x26;token=c48d42df-e559-472d-b8e5-eb28a910f18f" alt="" width="563"><figcaption></figcaption></figure></div>

     * **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.

         <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> For more information, contact GXC Technical Support.</p></div>
       * **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.<br>

           <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> 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:<br>1. Only one center frequency can be selected.<br>2. Strict Preference is automatically set to True, and it cannot be modified.<br>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.</p></div>
  2. In the **Handover** tab, enter the following details:<br>

     <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fi6uiFtKxqymflBXynVS9%2Fimage.png?alt=media&#x26;token=dfb0255c-68b1-45dd-9dc1-09beef41bb27" alt="" width="563"><figcaption></figcaption></figure></div>

     * **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.<br>

       <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fg6ox12Afh1PMNi2wQXJB%2Fimage.png?alt=media&#x26;token=93548ef9-0bb9-4140-8c14-e3c98fa66ceb" alt="" width="563"><figcaption></figcaption></figure></div>

       * **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.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FLMj7JOo8ed5dCFvwSQpg%2F5g-vlan-mode-oe-nr-core-add-apn-vlan-tab.png?alt=media&#x26;token=2fdb3eb7-d07e-4ecb-bf70-675a6a51eeed" alt=""><figcaption></figcaption></figure></div>
{% 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.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F6cD9BKcTWT1hMRROO8cu%2Fimage.png?alt=media&#x26;token=9ce28b8c-e42e-46e4-b376-e9242e8a0fac" alt=""><figcaption></figcaption></figure></div>
{% 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.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> 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.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> Some commercially available UE have ICMP ping responses disabled. In such cases, CPE monitoring for the UE fails. In the subscriber details, the <strong>Last Reported Time</strong> parameter is displayed as blank --.</p></div>
* **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.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fs5KgNlHUbhIX4mODuc6t%2F5g-vlan-mode-oe-nr-core-add-others-tab-add-backhaul-speedtest-server.png?alt=media&#x26;token=54b6ded4-a0df-4436-98af-6fa8542a837d" alt="" width="563"><figcaption></figcaption></figure></div>

  * **Add Server** – Add a new speedtest server.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Frg6qV2KPjVpXCF368Gyc%2Ficon-drag-handle.png?alt=media\&token=062dc51b-6af5-43ab-939a-71f0c364be6c) (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.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FIh4iQqiiNccI6XIqo1GC%2F5g-oe-core-only-create-onyx-edge-tab.png?alt=media&#x26;token=c8442817-1187-4de1-85e1-4f81f95a94c6" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

* **Type** – (Required) Select Onyx Edge type **Core-Only**. Default value: **NR+Core**.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> After you add an Onyx Edge, its type cannot be changed.</p></div>
* **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/docs/network-configuration-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.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F4Z58qHTHR4zAc2TcWZP6%2F5g-nat-mode-oe-core-only-add-core-tab.png?alt=media&#x26;token=6820dc0c-d970-4a5d-b763-b7a4a7a31533" alt=""><figcaption></figcaption></figure></div>
{% 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.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FNZr8XxFyIIJCqSToVJ7V%2F5g-nat-mode-oe-core-only-add-ran-tab.png?alt=media&#x26;token=c004b5ea-fa35-448c-bb32-7e1e555df4bf" alt=""><figcaption></figcaption></figure></div>
{% 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.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fes1Fgi6GQsZWnvEuiyi1%2F5g-nat-mode-oe-core-only-add-others-tab.png?alt=media&#x26;token=cdb2154c-f236-4e90-ab1c-3021ee34b077" alt=""><figcaption></figcaption></figure></div>
{% 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.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> 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.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> 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 <strong>Last Reported Time</strong> parameter is blank, displayed as --.</p></div>
* **Backhaul Speedtest** – Configures servers used to measure backhaul link performance.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FZtj9SoN31gkRgOWdqCw3%2F5g-nat-mode-oe-core-only-add-others-tab-add-backhaul-speedtest-server.png?alt=media&#x26;token=c7764b25-7893-4cf1-8451-171607a8b478" alt="" width="563"><figcaption></figcaption></figure></div>

  * **Add Server** – Add a new speedtest server.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FqPQpYDCCNy3kUQThSAfb%2Ficon-drag-handle.png?alt=media\&token=bc8dac62-357a-48fa-afe5-fbc58c9c7c6e) (Drag Handle) icon – Drag-and-drop to reorder speedtest server priorit&#x79;**.**
    * **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.

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FIatz1UdlEnVvn2BPDTzX%2F5g-nat-mode-oe-core-only-add-others-tab-add-ssh-key.png?alt=media&#x26;token=5122dd02-aa29-430a-baf1-48b53582ccab" alt="" width="563"><figcaption></figcaption></figure></div>

    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.

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FzZlNqrNFwlE3xY2aiJnO%2F5g-nat-mode-oe-core-only-add-others-tab-agw-user-change-password.png?alt=media&#x26;token=2c4af05d-1161-4afa-9951-664253a0b95f" alt="" width="563"><figcaption></figcaption></figure></div>

    * **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.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKJqGXCHLq42L9fTPg5Iz%2F5g-vlan-mode-oe-core-only-add-onyx-edge-tab.png?alt=media&#x26;token=be696bbf-e34e-4571-8b19-1aa7d7d83102" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

* **Type** – (Required) Click to select the Onyx Edge type, **Core-Only**. Default value: **NR+Core**.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> After you add an Onyx Edge, its type cannot be changed.</p></div>
* **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.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FTRFMFjyDhowaMijELGcT%2F5g-vlan-mode-oe-core-only-add-core-tab.png?alt=media&#x26;token=0a9d75d5-366f-435a-9432-0081f635100b" alt=""><figcaption></figcaption></figure></div>
{% 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.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FdZdLnyg0ZJTfZ1nXPWCO%2F5g-vlan-mode-oe-core-only-add-ran-tab.png?alt=media&#x26;token=cb502131-8544-4f4c-80d2-47284330bef1" alt=""><figcaption></figcaption></figure></div>
{% 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.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FSaHUqBDug7aKrsZsB3hp%2F5g-vlan-mode-oe-core-only-add-apn-vlan-tab.png?alt=media&#x26;token=d1b69b43-818a-40c2-a0a8-3b01419af695" alt=""><figcaption></figcaption></figure></div>
{% 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.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FrHrCBqsETFQyxspJL5Ij%2F5g-vlan-mode-oe-core-only-add-others-tab.png?alt=media&#x26;token=2fc986f0-0c45-43f5-b452-5485f35337ad" alt=""><figcaption></figcaption></figure></div>
{% 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.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> 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.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> Some commercially available UE have ICMP ping responses disabled. In such cases, CPE monitoring for the UE fails. In the subscriber details, the <strong>Last Reported Time</strong> parameter is displayed as blank --.</p></div>
* **Backhaul Speedtest** – Configures servers used to measure backhaul link performance.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F1dPoS5sJEWdkNGcQGcCL%2F5g-vlan-mode-oe-core-only-add-others-tab-add-backhaul-speedtest-server.png?alt=media&#x26;token=aa93648f-4cc9-4709-a98b-d6518b1a6a3b" alt="" width="563"><figcaption></figcaption></figure></div>

  * **Add Server** – Add a new speedtest server.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FEMNUVPmi6bG2oo7Ttje0%2Ficon-drag-handle.png?alt=media\&token=6ca32bb3-3bf9-45c6-a6cd-0dc9bbd8016f) (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.

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Frutg2ioIYx1aUxypsixn%2F5g-vlan-mode-oe-core-only-add-others-tab-add-ssh-key.png?alt=media&#x26;token=156d52bd-fbb3-46e0-bc65-0b7972c32eea" alt="" width="563"><figcaption></figcaption></figure></div>

    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.

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FerUH2S5pzj9WIodPLFtj%2F5g-vlan-mode-oe-core-only-add-others-tab-agw-user-change-password.png?alt=media&#x26;token=0931d700-7cfc-4124-9580-a418c8e365e9" alt="" width="563"><figcaption></figcaption></figure></div>

    * **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&#x20;*****agw\_user*****&#x20;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**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmRShsui8mb64cWhSFedO%2Fimage.png?alt=media&#x26;token=2050fc7d-d61d-4aaf-bc78-135565484992" alt="" width="110"><figcaption></figcaption></figure>

The **Edit Onyx Edge (*****\<onyx edge name>*****)** page is displayed.
{% endstep %}

{% step %}
Click the **Others** tab and move to the **AGW User Configuration** section.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fee1by96l91w6HxYJwTQr%2Fimage.png?alt=media&#x26;token=9f852a43-4bd0-440d-b2ce-6750d15e85cc" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To add an SSH key:

1. Click **Add Keys**.

   The **Add SSH Key** dialog box is displayed.

   <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fd2tu68jgTHggbGNhrIuf%2Fimage.png?alt=media&#x26;token=0040cafe-38d2-4119-91e8-296118ceed13" alt=""><figcaption></figcaption></figure>
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.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FaleCOCTdMgh61FL1nljC%2Fimage.png?alt=media&#x26;token=b481fb2b-72dd-4954-aa36-e88e4ec9c71b" alt=""><figcaption></figcaption></figure>

* **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**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FZXevOaC1T2kp0nJxnFPm%2Fimage.png?alt=media&#x26;token=2e3f5843-d811-4594-896a-ad4e3093a3bd" alt="" width="110"><figcaption></figcaption></figure>

A confirmation dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQidZ0tWhtapSNQTNVTWK%2Fimage.png?alt=media&#x26;token=70123dd1-3548-45d7-9cd7-07250625794c" alt="" width="419"><figcaption></figcaption></figure>
{% 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:

* <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FHtA18K0PCRcr7h8fq7uC%2Fimage.png?alt=media&#x26;token=0a5a236b-9a5f-4c33-981d-4c7028881ee4" alt="" data-size="line"> Green — One Onyx Edge is functioning as the Primary ACS, and the others as Standby ACS.
* <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FIqdQVMiialfl3plzRyy4%2Fimage.png?alt=media&#x26;token=7bf26a30-3029-46d1-894a-e8936b1d39d9" alt="" data-size="line"> Amber — One Onyx Edge is functioning as the Primary ACS, but one or more of the other Onyx Edge are non-functional.
* <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FCMfBpzFmOpgoNOQMTGez%2Fimage.png?alt=media&#x26;token=d83c501f-d20b-4514-9504-3376caa84564" alt="" data-size="line"> Red — All Onyx Edge are non-functional, or their status is not available.
* <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FuHNvWOaSK5xXnknZJ68Z%2Fimage.png?alt=media&#x26;token=b699cfe2-bff4-4967-b64f-bef709030333" alt="" data-size="line"> Grey — All Onyx Edge are offline.
  {% endstep %}

{% step %}
To view a pool's details, click its name.

The ***\<pool name>*** 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:
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FFtQ6k3kVM8mUhzrZPZud%2Fimage.png?alt=media&#x26;token=3a5ab977-2091-4075-81dd-60f9db0a4f9c" alt="" data-size="line"> Green — One Onyx Edge is functioning as the Primary ACS, and the others as Standby ACS.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FCA1gcfK8yZHY60tMOeZ5%2Fimage.png?alt=media&#x26;token=9f385aff-fc56-4b96-9ce5-895f91c5c2b8" alt="" data-size="line"> Amber — One Onyx Edge is functioning as the Primary ACS, but one or more of the other Onyx Edge are non-functional.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FH9lEnFkg9jr00lRepuly%2Fimage.png?alt=media&#x26;token=9ac3dcf7-8e01-429f-a3c0-e7706a5c3b55" alt="" data-size="line"> Red — All Onyx Edge are non-functional, or their status is not available.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FnV3GYTmElmF48h7N8UYh%2Fimage.png?alt=media&#x26;token=f58b9424-80f6-495b-a751-bbe3667ba5cd" alt="" data-size="line"> 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 ***\<pool name>*** 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:

  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FgAXtrPEYZyhpCUoP8zkA%2Fimage.png?alt=media&#x26;token=2664fe89-2860-4b2e-9795-2dc1c4074ee1" alt="" data-size="line"> Green — One Onyx Edge is functioning as the Primary ACS, and the others as Standby ACS.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FWQt7SwKsc6ufjeyPKP9Y%2Fimage.png?alt=media&#x26;token=4d7d23b4-d185-44a6-882b-171691dbb6d1" alt="" data-size="line"> Amber — One Onyx Edge is functioning as the Primary ACS, but one or more of the other Onyx Edge are non-functional.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJQZIwzvWTixeVOlKZxhn%2Fimage.png?alt=media&#x26;token=2845225c-e9f3-49b8-8cb8-7fe10813bcc7" alt="" data-size="line"> Red — All Onyx Edge are non-functional, or their status is not available.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Firfaf3RjzemDjDQsgfqV%2Fimage.png?alt=media&#x26;token=a9bdc975-4e6f-43fb-af70-948d038c4316" alt="" data-size="line"> 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:
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FWesZFN4QBZyd0zkznaBT%2Fimage.png?alt=media&#x26;token=49b75f9b-6be2-4229-8172-d3d3d7dc3b4b" alt="" data-size="line"> Green — The Onyx Edge has checked in with the Onyx Portal in the last five minutes.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FrXp1u95JvFcmhjGjnnJz%2Fimage.png?alt=media&#x26;token=6a9da6b3-99cc-4f6d-9b56-9d267d6d2cbf" alt="" data-size="line"> 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:
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FprgTLhyAv7qwlYM7Q04e%2Fimage.png?alt=media&#x26;token=bc06eb32-83e4-4639-bf27-342e40c39f91" alt="" data-size="line"> Green — The N6 interface is up and has IP, and the N6 link is active (periodic ICMP checks every five minutes).
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FakYK1tF2hQNebQ7Cswiz%2Fimage.png?alt=media&#x26;token=65584a26-ce0b-4676-aacf-759c356039a1" alt="" data-size="line"> Amber — The N6 interface is up and has IP (N6 link is active).
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FtDfQOD6guyIG57ixHxRG%2Fimage.png?alt=media&#x26;token=b34664dd-14ad-40e0-8547-01726d03ecc6" alt="" data-size="line"> Red — The N6 interface is not up or is not active (N6 link activity check through ICMP).
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FVDY5Cg3CxRqaFV0l5Ean%2Fimage.png?alt=media&#x26;token=771a0988-29ec-4d2a-a1db-8b963849ecc2" alt="" data-size="line"> Grey — The Onyx Edge is offline, or data is not available.
      {% endstep %}
      {% endstepper %}

### Create Onyx Edge Pools <a href="#create-onyx-edge-pools" id="create-onyx-edge-pools"></a>

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/docs/application-notes/4g-onyx-edge-ha#associate-or-disassociate-onyx-edge-with-pools) and [*Edit Onyx Edge Pools*](https://docs.gxc.io/docs/application-notes/4g-onyx-edge-ha#edit-onyx-edge-pools).
{% endstep %}
{% endstepper %}

### Edit Onyx Edge Pools <a href="#edit-onyx-edge-pools" id="edit-onyx-edge-pools"></a>

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 <a href="#delete-onyx-edge-pools" id="delete-onyx-edge-pools"></a>

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 <a href="#associate-or-disassociate-onyx-edge-with-pools" id="associate-or-disassociate-onyx-edge-with-pools"></a>

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 (*****\<onyx edge name>*****)**" 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**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FSQJEEjvgyxYdhtyxMDp9%2Fimage.png?alt=media&#x26;token=612d3684-369a-46d7-8af2-943823770a2e" alt="" width="110"><figcaption></figcaption></figure>

The **Edit Onyx Edge (\<onyx edge name>)** 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 %}


# Manage Access Points

The AP (eNodeB in 4G networks and gNodeB function in 5G networks) handles the air interface for the UE. For core services, each AP connects to an Onyx Edge. For SAS-based spectrum access, a CBSD (Citizens Broadband Radio Service Device) resource is created for each AP. The AP represents the radio (gNodeB), while the CBSD represents the same radio in the SAS ecosystem for spectrum coordination. Each CBSD is associated with a single AP. CBSDs do not directly contact the SAS; the Domain Proxy communicates with SAS on behalf of CBSDs, handling registration, spectrum inquiry, grant requests, and heartbeat messages.

**CBSD vs AP**

* **AP (Access Point / gNodeB)**
  * Handles radio transmission and UE connectivity
  * Part of the mobile network (RAN)
* **CBSD**
  * Represents the AP in the SAS ecosystem
  * Handles:
    * Registration
    * Spectrum inquiry
    * Grant management
* **Relationship**
  * One AP ↔ One CBSD
  * CBSD gets spectrum grants from SAS
  * AP uses those grants to transmit
* **Domain Proxy (DP)**
  * Communicates with SAS on behalf of CBSDs

## Carrier Modes

{% hint style="info" %}
**NOTE:** In the current release, Dual Carrier (DC) and Carrier Aggregation (CA) modes are not supported in 5G networks. 5G APs support only Single Carrier (SC) mode.
{% endhint %}

**Single Carrier (SC) Mode** – In SC mode, APs use a single carrier frequency, making it suitable for smaller networks or areas with lower traffic where bandwidth needs can be met with one frequency. SC mode is often used for basic services with lower data rates. While it performs well in environments with limited spectrum, it may become less effective as data demands grow. APs in SC mode operate as a single cell (single carrier) and support up to 96 active UE per AP.

{% hint style="info" %}
**NOTE:** All carrier mode configurations required on the AP equipment Local Configuration Interface (LCI) are managed by GXC. For queries, please contact GXC Technical Support.
{% endhint %}

## Suspended Grant Handling

When a grant is suspended, spectrum inquiry is initiated to seek a new grant. If a new grant is chosen, the suspended grant is relinquished immediately, and a grant request is sent for the chosen new grant.

* In single grant scenarios:
  * If a new grant is available, it is chosen, and the suspended grant is relinquished.
  * If no new grant is available, the suspended grant is maintained.
* In dual grant scenarios:
  * If both grants are suspended:
    * If two new grants are available, they are both chosen, and the suspended grants are relinquished.
    * If only one new grant is available, the new grant is chosen. Depending on the best compatibility with this new grant:
      * The better of the two suspended grants is retained, and the other relinquished. Here, better is the one that is first larger in bandwidth size and then contiguous. Preference order or power of grants is not used here to keep the implementation simple. If both grants are equal with respect to both bandwidth size and contiguity, then the lower frequency is chosen first.
      * If none of the suspended grants is compatible with the new grant, both the suspended grants are relinquished. If no new grants are available, both suspended grants are retained.
  * If only one grant is suspended:
    * If at least two new grants are available:
      * Of the possible choice of grants, the best compatible two are chosen (new grant + the existing authorized grant).
      * The suspended grant is relinquished.
      * If it is not part of the chosen two, the existing authorized grant is also relinquished.
    * If only one new grant is available and it is compatible with the existing authorized grant, it is chosen, and the suspended grant is relinquished.
    * If no such new grant is available, the suspended grant is maintained.

{% hint style="info" %}
**NOTE:** The suspended grant is relinquished immediately, and a grant request is sent for the chosen new grant. However, the SAS may reject the grant request, leaving the CBSD bereft of grants.
{% endhint %}

{% hint style="info" %}
**NOTE:** It is expected that the SAS does not include currently issued grants (be it granted, authorized, or suspended) as part of available channels, especially when it is suspended. If the suspended grant is part of the available channel, then the same suspended channel/grant may be chosen. It is also possible that some other channel will be chosen. There is no guarantee that another channel will be tried instead of the suspended grant.
{% endhint %}

{% hint style="info" %}
**NOTE:** Since Spectrum Inquiry is now initiated as long as there are suspended grants, to avoid continuous Spectrum Inquiry, a Spectrum Inquiry is sent only five minutes after the previous Spectrum Inquiry.
{% endhint %}

## View AP Details

This section describes how to:

* [*View Summary Details of All APs*](#view-summary-details-of-all-aps)
* [*View an AP’s Details*](#view-details-of-an-ap)

### View Summary Details of All APs

**To view the summary details of all APs in the network:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **Access Points** tab.

The **Equipment** page > **Access Points** tab displays the summary details of all APs configured in the network.

* The AP's service status.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FgnHZ20kZBN67hd3Z54sV%2Ficon-service-status-green.png?alt=media\&token=50a395ad-f0cf-4030-bade-4575875d36be) (green) – Indicates the RF Tx status is on.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FnRNgqJyDgoFeWAiPC0dS%2Ficon-service-status-red.png?alt=media\&token=6bb8462d-76b1-43a6-8296-eb9ef10b183c) (red) – Indicates the RF Tx status is off.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJnfDthIUXg81qDYV8es4%2Ficon-service-status-grey.png?alt=media\&token=43890a25-e1bd-4fd1-a0f4-8f5333b2471c) (grey) – Indicates the AP is offline.
* **Name** – The AP's name.

  Hovering your cursor over the AP's name displays the AP equipment's vendor-assigned serial number.
* **Venue** – The name of the venue hosting the AP.
* **B/W (MHz)** – The AP's operating bandwidth in MHz.
* **Center Freq (MHz)** – The AP's operating frequency in MHz.
* **Cell Local ID** – The cell's unique ID within the network.
* **PCI** – The Physical Cell ID. The PCI is used for cell identity during cell selection procedure, and is used by UE to decode physical layer data being transmitted by the AP.
* **Pwr (dBm)** – The AP's current transmit power in dBm. This reflects the actual operating (SAS granted) power and may differ from the configured preferred power.
* **Online** – Indicates the AP's online status, which is determined by its reachability from the Onyx Portal.

  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKCKvev8Mi1akVCKo1AcF%2Ficon-online-status-green.png?alt=media\&token=3ddac865-d3ee-422b-84b0-6e94b3e74eb0) (green) – Indicates the AP has checked-in with the Onyx Portal in the last five minutes.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FA42MBWfpY6Q3iURg9Jl7%2Ficon-online-status-red.png?alt=media\&token=8e3109e0-3e7a-4417-9360-7e27ab32f3d7) (red) – Indicates the AP has not checked-in with the Onyx Portal in the last five minutes. Or, the time reported is older than five minutes.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FSGJPD1eLbnebc64Do3we%2Ficon-online-status-grey.png?alt=media\&token=97e0c889-d953-4a25-914e-aee5460321a6) (grey) – Indicates the associated Onyx Edge is offline.

  Hovering your cursor over the "Online Status" icon displays the last check-in timestamp.
* **Interface Status** – Indicates the AP's fronthaul interface status.

  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKNAqhXWcBdoOeydR49vV%2Ficon-interface-status-green.png?alt=media\&token=ea257bd0-b02f-4a32-845f-de38377e502e) (green) – Indicates the AP fronthaul interface is connected.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmZ88LFP6LVnoswffpEX2%2Ficon-interface-status-red.png?alt=media\&token=dd80462f-ce51-4f4b-83ab-9e70974aba24) (red) – Indicates the AP fronthaul interface is disconnected.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0jlMUgJYQRSbmxeBgbMT%2Ficon-interface-status-grey.png?alt=media\&token=43070a03-6b1c-4bc4-a5c6-683db301084d) (grey) – Indicates the AP is offline or the fronthaul interface status is unavailable.

  Hovering your cursor over the "Interface Status" icon displays the fronthaul status.
* **Sync Status** – Indicates the AP’s time synchronization state with its configured clock source (such as GPS or PTP). Accurate synchronization is critical for proper radio operation, including frame alignment, interference management, and UE connectivity.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8tBKn4zCDpmKEpqGcefc%2Ficon-ipsec-status-green.png?alt=media\&token=af964f1d-78f9-45e2-9d79-92559e4238ac) (green) – Indicates the AP is in sync with the clock source.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQxzZgmYkTIzzcZSZlpYm%2Ficon-ipsec-status-amber.png?alt=media\&token=9a028b82-9377-4935-8b0c-b914855b57e0) (amber) – Indicates the sync is degraded.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FrZsKTHfUSaqL0l2XNDfd%2Ficon-ipsec-status-red.png?alt=media\&token=bc7e550b-0801-417a-9439-aea5404d5b93) (red) – Indicates the AP is not in sync.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FcWG5nTTUSeU4NVDUcfkL%2Ficon-ipsec-status-grey.png?alt=media\&token=a522fa34-0c20-4583-bdcb-7d96011cce7f) (grey) – Indicates the Sync status is not available or the AP is offline.
* **Actions** – Options to view details, edit, and delete APs.

To include or exclude additional details from the list, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FLfgmjsULXyNxyWFd8xyT%2Fimage.png?alt=media&amp;token=e3938601-5780-4b1a-8739-aac8706689da" alt="" data-size="line"> (additional details) and select or clear from the following additional parameters:

* **IP Address** – The AP's IP address.
* **Model** – The AP equipment's model.
* **Software Version** – The AP's software version.
* **Up Time** – The duration for which the AP has been continuously operational without any downtime or interruptions.
* **Subscribers** – The number of active UE sessions connected to each AP.
  {% endstep %}
  {% endstepper %}

### View an AP's Details

**To view an AP's details:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **Access Points** tab.

The **Equipment** page > **Access Points** tab displays the summary details of all APs configured in the network.
{% endstep %}

{% step %}
To view the details of a particular AP, click its name.

The ***\<AP name>*** page displays the AP's details.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fm9BrfIyai3PRzif61NJH%2Fimage.png?alt=media&amp;token=d336dcd9-38a1-49c9-9d14-07805332c55e" alt=""><figcaption></figcaption></figure></div>

* **Overview** tab:
  * **Access Point Details**:
    * **Name** – The AP's name.
    * **Serial Number** – The AP equipment's vendor-assigned serial number.
    * **Description** – The AP's description.
    * **Venue** – The name of the venue hosting the AP.
    * **Hardware Address** – The AP's MAC address.
    * **Upgrade Status** – Status of the previous AP software upgrade.

      <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The <strong>Upgrade Status</strong> parameter is displayed only during an upgrade and for one hour after the upgrade.</p></div>

      To view details, click the status.

      The **Upgrade Status** dialog box displays the following details:

      * **Description** – Description of the last upgrade's status.
      * **Old Version** – The AP software version before the upgrade.
      * **New Version** – The new AP software version.
      * **Updated At** – Timestamp at which the last upgrade completed.
      * **Start Time** – Timestamp at which the last upgrade started.
    * **Online** – Indicates the AP's online status, which is determined by its reachability from the Onyx Portal. To view the last check-in timestamp, hover your cursor over the "Online Status" icon.
      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKCKvev8Mi1akVCKo1AcF%2Ficon-online-status-green.png?alt=media\&token=3ddac865-d3ee-422b-84b0-6e94b3e74eb0) (green) – Indicates the AP has checked-in with the Onyx Portal in the last five minutes.
      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FA42MBWfpY6Q3iURg9Jl7%2Ficon-online-status-red.png?alt=media\&token=8e3109e0-3e7a-4417-9360-7e27ab32f3d7) (red) – Indicates the AP has not checked-in with the Onyx Portal in the last five minutes. Or, the time reported is older than five minutes.
      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FSGJPD1eLbnebc64Do3we%2Ficon-online-status-grey.png?alt=media\&token=97e0c889-d953-4a25-914e-aee5460321a6) (grey) – Indicates the associated Onyx Edge is offline.
    * **Interface Status** – Indicates the AP's fronthaul interface status.

      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FZkOmlHrRmG7GeQVc5OQJ%2Ficon-interface-status-green.png?alt=media\&token=7342ee82-347d-4d89-8d54-ceda27346ab3) (green) – Indicates the AP fronthaul interface is connected.
      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FuSi6OtPTBwt0MOqBw8Qm%2Ficon-interface-status-grey.png?alt=media\&token=7082fa2b-eb14-4f0c-86c2-109abd824939) (grey) – Indicates the interface is not connected or is unavailable.

      Hovering your cursor over the "Interface Status" icon displays the fronthaul status.
    * **Service Status** – Indicates the AP's service status. 5G AP operates as a single cell (Single Carrier mode).

      Cell states per cell:

      <table><thead><tr><th width="115" valign="top">RF Tx Desired</th><th width="114.5" valign="top">RF Tx Actual</th><th width="149.75" valign="top">“Service Status” Icon</th><th valign="top">Cell State</th></tr></thead><tbody><tr><td valign="top">On</td><td valign="top">On</td><td valign="top"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F6z8dFNP4fQLiIsKeNTLg%2Ficon-service-status-green.png?alt=media&amp;token=6fe4d3ca-6e3d-4f44-a82f-e3abe3030e20" alt=""> (green)</td><td valign="top">Healthy</td></tr><tr><td valign="top">Off</td><td valign="top">Off</td><td valign="top"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FtmrnPOHfoZb28Custqxv%2Ficon-service-status-grey.png?alt=media&amp;token=954a13e4-7cca-4e07-a54d-f367c7931ba3" alt=""> (grey)</td><td valign="top">Shutdown, the AP is offline, or the associated Onyx Edge is offline.</td></tr><tr><td valign="top">On</td><td valign="top">Off</td><td valign="top"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJ3NLeam0oB7EyzRaGNf8%2Ficon-service-status-red.png?alt=media&amp;token=cc93dbd6-eabf-4aca-809a-22ef87400c25" alt=""> (red)</td><td valign="top">Service Down</td></tr><tr><td valign="top">Off</td><td valign="top">On</td><td valign="top"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FFlaW0K3p57D7lflhwEGG%2Ficon-service-status-amber.png?alt=media&amp;token=9e519b46-495e-4e86-b7d4-70d5cf75d3ed" alt="">(amber)</td><td valign="top">Unwarranted Transmission</td></tr></tbody></table>

      Hovering your cursor over the "Service Status" icon displays the cell's RF Tx status and cell's desired status.
    * **Sync Status** – Indicates the AP's time reference synchronization status with the primary clock source.
      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJrDiX0mFlDlN7KtJbqWj%2Ficon-ipsec-status-green.png?alt=media\&token=125245a2-137b-438c-8110-1a7b909bffa4) (green) – AP is in sync with the clock source.
      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FTdCLS8DDKaV08RvbwTDA%2Ficon-ipsec-status-amber.png?alt=media\&token=241691cf-ded8-44b3-ba30-11d3ec454e8b) (amber) – AP sync with the clock source is degraded.
      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8ST92c6DsyVtxzwgdBYT%2Ficon-ipsec-status-red.png?alt=media\&token=715d25bd-fb2b-497b-859c-e5a1d1706d60) (red) – AP is not in sync with the clock source.
      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FovBYYyVCuKmRyfW0KkyJ%2Ficon-ipsec-status-grey.png?alt=media\&token=9e36c66f-c820-450d-a1b5-387e8d38659d) (grey) – Any of the following:
        * The AP is offline.
        * The Onyx Edge associated with the AP is offline.
        * The AP's Sync Mode is set to "Free Running".
        * The AP's sync status is not available.
  * **AP Properties**:
    * **Model** – The AP equipment's model.
    * **Software Version** – The AP's software version.
    * **IP Address** – The AP's IP address.
    * **Up Time** – The duration for which the AP has been continuously operational without any downtime or interruptions.
    * **Reported Time** – The timestamp at which the AP's data was last reported.
    * **FSM State** – The AP's Finite State Machine (FSM) state indicating the AP's operational state.
  * **SAS Status** – (Displayed only if SAS is enabled.) Indicates the CBSD's lifecycle state with SAS—Registered, Granted, or Authorized.\
    All green indicates fully operational spectrum usage.

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FVK8aOgyWl75an69PKgu5%2Fsas-status-all-green.png?alt=media&amp;token=73c1038f-f08b-4d16-9d19-9e4afcb62ea1" alt="" width="563"><figcaption></figcaption></figure></div>

    To view the grant state, hover your cursor over the "SAS Status" icons.&#x20;

    In SC mode, displays the grant state of the only cell.

    "SAS Status" icon color coding:

    * Registered icon:
      * Green – All CBSDs are registered.
      * Amber – Some CBSDs are registered, and some are not registered.
      * Red – No CBSDs are registered.
      * Granted icon:
        * Green – Required number of grants are available.
        * Amber – Some grants are available but not the required number.
        * Red – No grants are available.
        * Grey – No CBSDs are registered.
      * Authorized icon:
        * Green – Required number of grants are authorized.
        * Amber – Some grants are authorized but not the required number.
        * Red – No grants are authorized.
        * Grey – No grants are available.
  * **RAN**:
    * **SAS** – Indicates whether SAS-based spectrum coordination is enabled for the AP—**Enabled** or **Disabled**.
    * **Cell Local ID** – The unique identifier for the cell within the local network (used for distinguishing cells in the same network).
    * **Transmit** – The AP's RF transmission status—**Enabled** or **Disabled**.
    * **PCI** – The Physical Cell ID (PCI) of a cell in the physical layer. The PCI is used for cell identity during the cell selection procedure, and is used by UE to decode physical layer data being transmitted by the AP.
    * **DL/UL Distribution (SA)** – Indicates the downlink/uplink slot ratio. “--” indicates system-managed.
    * **SAS Configuration** – (Displayed only if SAS is enabled.)

      <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> These parameters are used for CBSD registration with SAS and are derived from the AP hardware configuration.</p></div>

      * **CBSD Category** – The CBSD's power class under CBRS regulations—Category A (devices that operate at maximum 30 dBm EIRP), Category B (devices that operate at maximum 47 dBm EIRP).
      * **User ID** – The SAS account's user ID for SAS registration and authentication.
      * **No. of Antenna** – The number of physical antennas reported by the CBSD to SAS.
      * **Antenna Gain (dBi)** – The antenna gain reported for CBSD registration, measured in decibels relative to an isotropic antenna (dBi). Higher gain focuses energy more effectively but may have stricter deployment requirements.
      * **Preferred Max Pwr (dBm)** – The preferred maximum transmit power (in dBm), constrained by device class limits.
      * **Preferred BW (MHz)** – The requested bandwidth (in MHz) (supports 10 / 20 / 40 MHz+ depending on device class).
      * **Preferred Freq (MHz)** – The preferred operating frequency in the CBRS band (in MHz); it must comply with device band and bandwidth constraints.
      * **Strict Freq Preference** – If enabled, restricts SAS to preferred frequency; may fallback to lower bandwidth on same frequency.

      <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> Usable frequency range reduces as bandwidth increases due to guard band requirements.</p></div>
* **SAS Status**:

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> These values represent spectrum grants issued by SAS to the CBSD and used by the associated AP for transmission.</p></div>

  * **BW (MHz)** – The actual bandwidth the SAS has granted or is in the process of granting to the CBSD.
  * **Freq (MHz)** – The specific frequency center or range that the SAS has granted to the CBSD or is considering.
  * **Max Tx Pwr (dBm)** – The maximum transmit power level that the SAS allows the CBSD to use on the granted frequency.
  * **Heartbeat Interval** – Interval at which the device must communicate with SAS to maintain its grant.
  * **Grant Expire Time** – Time when the spectrum grant expires if not renewed.
  * **Transmit Expire Time** – Deadline after which transmission must stop if SAS heartbeat/grant conditions are not met.
* **Subscribers (n)** – The count and list of active UE sessions attached to the AP.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> Subscriber connectivity is handled by the AP (gNodeB). The CBSD does not participate in UE connectivity and is only used for spectrum authorization.</p></div>

  Also, in the subscriber details, you can view the specific cells that individual subscribers are attached to (Onyx Portal > **Subscribers** > subscribers list > **Access Point Cell ID** column).

  * **Status** – The subscriber's service state—**Active** or **Inactive**.
  * **Name** – The subscriber account's name.
  * **IMSI** – The subscriber's IMSI number.
  * **Subscriber Group Name** – The subscriber group to which the subscriber belongs.
    {% endstep %}

{% step %}
Click the **Events & Alerts** tab.

* **Alerts** – Details of AP and SAS-related alerts based on the selected severity level. You can select the alert severity level from **All**, **Major**, **Minor**, **Critical**, or **Others**.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FEnXopt8wxuHIkzvrgn6H%2Fimage.png?alt=media&amp;token=adb3227e-cbf1-43ea-b099-97a9e24519f0" alt="" width="413"><figcaption></figcaption></figure></div>

  * **Date** – The alert's creation timestamp.
  * **Status** – The alert's status.
  * **Alert Name** – The alert's name.
  * **Severity** – The alert's severity level.
* **Events** – Details of AP and SAS related events for the selected duration:

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FTkEeRRMIQTCd0ejFrRYK%2Fimage.png?alt=media&amp;token=535ecf70-b1f0-4ba3-95b0-e0cc3b55470a" alt=""><figcaption></figcaption></figure></div>

  * **Timestamp** – The timestamp at which the event occurred.
  * **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.
  * **Event Description** – The event's description.
  * To view the details of a particular event, click the corresponding <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F00GE2xnLckPYvYndwW8z%2Fimage.png?alt=media&amp;token=12417c1e-955f-44ea-a0b7-73868abe2393" alt="" data-size="line"> (view details) icon.
    {% endstep %}

{% step %}
Click the **Logs** tab.

* **Logs** – The total number and list of log events for the AP in the selected duration.

  * **Timestamp** – The timestamp at which the log was generated.
  * **Severity** – The severity of the log message.
  * **Message** – The actual information logged by the system.

  To change the date and time range, select the required timestamps in the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F4mfcJcPEtDPejOIYpH1J%2Fimage.png?alt=media&amp;token=f54d8bbc-135b-4168-be65-12c7a15eb485" alt="" data-size="line"> date/time fields. The logs list automatically updates to display the corresponding logs.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> Your selections must fall within a seven-day range.</p></div>

  To download the logs in .csv format, in the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FfaHCKLXvjj6v7FaNGpyq%2Fimage.png?alt=media&amp;token=026eeb9d-c644-4ffc-9489-5a81f02e2ea1" alt="" data-size="line"> field, enter the number of logs to be included in the .csv file, then click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FEGWiDqtBhdzuCTO7qbhx%2Fimage.png?alt=media&amp;token=63d0969d-7a68-4c8f-bf37-a6f738b41e62" alt="" data-size="line"> (download). Default value: 5000. The downloaded .csv file includes details such as the timestamp, service, tag, type, and log text.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> You can download a maximum 5000 logs.</p></div>
* **DP Logs (n)** – The total number and list of Domain Proxy (DP) log events between the selected entities—**DP**, **ACS**, **CBSD**, and **SAS**.

  To change the selected entities, click the corresponding dropdown.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F9TMz9hkhTOnvIEFumuTu%2Fimage.png?alt=media&amp;token=6fad4a12-76ea-4356-a371-78af04007a7b" alt="" width="190"><figcaption></figcaption></figure></div>

  * **Timestamp** – The timestamp at which the log was generated.
  * **From** – The source or origin of the data.
  * **To** – The destination or target of the data.
  * **Type** – The type of the log entry.
  * **Message** – The actual information logged by the system.
    {% endstep %}

{% step %}
The **Actions** button in the upper-right corner of the page provides the following options:

* **Delete** – (Super Administrator and Administrators only.) To delete the AP, in the upper-right corner of the page, click **Actions** > **Delete**. For more information, see [*Delete APs*](#delete-aps).
* **Reboot** – (Super Administrator and Administrators only.) To reboot the AP, in the upper-right corner of the page, click **Actions** > **Reboot**. For more information, see [*Reboot APs*](#reboot-aps).
* **Upgrade** – (Super Administrator and Administrators only.) To upgrade the AP software running on the APs, in the upper-right corner of the page, click **Actions** > **Upgrade**. For more information, see [*Manage AP Software Upgrades*](#manage-ap-software-upgrades).
  {% endstep %}
  {% endstepper %}

## Add APs

This section describes how to add APs.

{% hint style="info" %}
**NOTE:** You can add APs only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** In this release, IPSec is not supported on APs in 5G networks.
{% endhint %}

{% hint style="info" %}
**NOTE:** In this release, 5G APs support only Single Carrier mode.
{% endhint %}

**To add an AP to a 5G network:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **Access Points** tab.

The **Equipment** page > **Access Points** tab displays the summary details of all APs configured in the network.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Add Node** > **Add Access Point**.

The **Create Access Point** page is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FEEUhsDqrw8pdWqsmJrDI%2Fimage.png?alt=media&amp;token=ea499ed1-90eb-4f40-a0a4-f6826c280ca0" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

* **Name** – (Required) The AP's name.
* **Serial Number** – (Required) The AP equipment's vendor-assigned serial number.
* **MAC Address** – (Required) The AP's MAC address.
* **Device Class** – (Required) Click to select the AP equipment's model from the following. Default value: G105-n48F.

  * **G105-n48F** – Band 48 Indoor AP
  * **G105-n48P** – Band 48 Indoor AP
  * **G105-n77** – Band 77 Indoor AP
  * **G105-n78F** – Band 78 Indoor AP
  * **G105-n78P** – Band 78 Indoor AP
  * **G227** – Indoor AP
  * **G228** – Outdoor AP
  * **G244** – Outdoor AP
  * **G505-n48P** – Band 48 Outdoor AP
  * **G506-n77** – Band 77 Outdoor AP
  * **G506-n78** – Band 78 Medium-power Outdoor AP
  * **G509-n79** – Band 79 Outdoor AP

  For detailed information on these 5G APs, refer to the corresponding Specification Sheets or Hardware Installation Guides.
* **Max Tx Pwr (dBm)** – (Required) The maximum allowed radio transmit power for this AP in dBm.
* **Tx-Enabled** – Click the toggle switch to enable or disable the AP's transmission. Default setting: enabled.
* **Description** – (Required) The AP's description.
  {% endstep %}

{% step %}
To save the AP, in the upper-right corner of the page, click **Save Access Point**.
{% endstep %}
{% endstepper %}

## Edit APs

{% hint style="info" %}
**NOTE:** You can edit AP details only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

**To edit an AP in a 5G network:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **Access Points** tab.

The **Equipment** page > **Access Points** tab displays the summary details of all APs configured in the network.
{% endstep %}

{% step %}
For the node that you want to edit, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FyccydULrsA9KxFxNggVC%2Fimage.png?alt=media&amp;token=55a50765-12a7-4e6b-a609-811a0a622fd1" alt="" width="110"><figcaption></figcaption></figure></div>

The **Edit Access Point** page displays the equipment's details.
{% endstep %}

{% step %}
Edit the AP's details as required.

* **Name** – (Required) The AP's name.
* **Serial Number** – (Read-only) The AP equipment's vendor-assigned serial number. This field cannot be edited.
* **MAC Address** – (Read-only) The AP's MAC address. field cannot be edited.
* **Device Class** – (Read-only) The AP equipment's model. This field cannot be edited.

  For detailed information on 5G APs, refer to the corresponding Specification Sheets or Hardware Installation Guides.
* **Max Tx Pwr (dBm)** – (Required) The maximum allowed radio transmit power for this AP in dBm.
* **Tx-Enabled** – Click the toggle switch to enable or disable the AP's transmission. Default setting: enabled.
* **Description** – (Required) The AP's description.
  {% endstep %}

{% step %}
To save your edits, in the upper-right corner of the page, click **Save Access Point**.
{% endstep %}
{% endstepper %}

## Reboot APs

{% hint style="info" %}
**NOTE:** You can reboot APs only if you are a Super Administrator or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** When you reboot an AP, it will temporarily deactivate any active networks and disconnect any UE that are connected to those networks.
{% endhint %}

**To reboot an AP:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **Access Points** tab.

The **Equipment** page > **Access Points** tab displays the summary details of all APs configured in the network.
{% endstep %}

{% step %}
Click the name of the AP that you want to reboot.

The ***\<AP name>*** page displays the AP's details.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Actions**, then click **Reboot**.

A confirmation dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FjSBq03ggVBsnoui7pbBt%2Fap-reboot.png?alt=media&amp;token=8b51197f-038c-493a-aef9-2f728ca93101" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To confirm rebooting the AP, click **Yes**.
{% endstep %}
{% endstepper %}

## Delete APs

{% hint style="info" %}
**NOTE:** You can delete APs only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

**To delete an AP:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **Access Points** tab.

The **Equipment** page > **Access Points** tab displays the summary details of all APs configured in the network.
{% endstep %}

{% step %}
For the equipment that you want to delete, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Delete**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FCP3VEINpnQJUNNRT0fjJ%2Fimage.png?alt=media&amp;token=0a00038e-082a-406f-85cc-6538149884d2" alt="" width="110"><figcaption></figcaption></figure></div>

A confirmation dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8LX4mfSxzygG58kpEDno%2Fimage.png?alt=media&amp;token=1950deb1-52a8-4952-931d-664f61cebb06" alt="" width="398"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To confirm deleting the AP, click **Yes**.
{% endstep %}
{% endstepper %}


# Manage FHM

The FHM (Fronthaul Manager) is a component in the Onyx 5G architecture that manages the fronthaul connections between the APs and the Onyx Edge (Core). It helps handle data transmission, synchronization, and resource allocation for efficient 5G network operations.

## View FHM Details

This section describes how to view FHM details in a 5G network.

* [*View Summary Details of All FHM*](#view-summary-details-of-all-fhm)
* [*View an FHM's Details*](#view-details-of-an-fhm)

### View Summary Details of All FHM

**To view the summary details of all FHM configured in a 5G network:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **FHM** tab.

The **Equipment** page > **FHM** tab displays the summary details of all FHM configured in the network.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FMouRM2UGqePIunUJCC79%2F5g-fhm-view-summary-details.png?alt=media&amp;token=f7cddf05-4f4d-4aee-8681-15c2e05d2768" alt=""><figcaption></figcaption></figure></div>

* **FHM (n)** – The count of FHMs configured in the network.
  * **Name** – The FHM's name.
  * **Serial Number** – The FHM equipment's vendor-assigned serial number. Click to view the FHM's details.
  * **Device Class** – The FHM equipment's device class.
  * **Access Point** – The number of APs associated with the FHM.
  * **Online Status** – Indicates the FHM's online status, which is determined by its reachability from the Onyx Portal.

    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FESoi85Qmym3xkNwG3gW8%2Ficon-online-status-green.png?alt=media\&token=d5e53151-1372-4139-b84d-6fbecec21785) (green) – Indicates the FHM is management connected, and the last reported time is < 5 mins from current time.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FZbSviJTvZ53somqfIv0Z%2Ficon-online-status-red.png?alt=media\&token=e3e092b0-f21e-47aa-9560-0b0ef584c5ad) (red) – Indicates any of the following conditions:
      * FHM is not management connected
      * Time reported >= 5 mins from current time
      * FHM is not associated with any Onyx Edge
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FEJZjczBlJcqtAvsjgM3f%2Ficon-online-status-grey.png?alt=media\&token=dadf8629-ee7f-4c4b-8156-836b423335c2) (grey) – Indicates the gateway of the associated Onyx Edge is offline.

    Hovering your cursor over the "Online Status" icon displays the FHM's last check-in timestamp.
  * **Interface Status** – Indicates the FHM's interface status—the fronthaul connection state of the FHM and its associated APs.

    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FCN7Tu1nZto10snApAF5S%2Ficon-interface-status-green.png?alt=media\&token=381a1488-74eb-4495-87ba-684dbc921180) (green) – Passthrough is reported as true for all associated APs.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fuiu0K3EHSNwBhjp9XL51%2Ficon-interface-status-red.png?alt=media\&token=9d5db1ef-6b81-41fb-8040-8581c19a475b) (red) – Passthrough is reported as false, or status information is unavailable for all associated APs.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FetpHdCcyoHmSF2mqaT88%2Ficon-interface-status-amber.png?alt=media\&token=3ada08c5-837d-425b-8063-2e93dd944a06) (amber) – Passthrough is reported as false, or status information is unavailable for at least one, but not all, associated APs.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FdiwgPuRyMsS8oIsUBzYd%2Ficon-interface-status-grey.png?alt=media\&token=b32cf09a-8c36-4519-813b-15531b9861cf) (grey) – FHM is not management-connected.

    Hovering your cursor over the "Interface Status" icon displays following details:

    * **Access Point** – Name of individual AP.
    * **Interface** – Ethernet port used for the fronthaul link.
    * **Passthrough** – Indicates whether fronthaul passthrough is active (true or false).
  * **Sync Status** – Indicates the FHM's sync status.
  * **Actions** – Options to view details, edit, and delete an FHM.
    {% endstep %}
    {% endstepper %}

### View an FHM's Details

**To view details of an FHM in a 5G network:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **FHM** tab.

The **Equipment** page > **FHM** tab displays the summary details of all FHMs configured in the network.
{% endstep %}

{% step %}
To view the details of a particular FHM, click its serial number.

The ***\<FHM name>*** page displays the FHM's details.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FrypjK97ez1DJbhDt9dvC%2Ffhm-view-overview-tab.png?alt=media&amp;token=375b2fab-7eb2-41fc-9fc8-7f70b87e9829" alt=""><figcaption></figcaption></figure></div>

* **Name** – The FHM's name.
* **Serial** – The FHM equipment's vendor-assigned serial number.
* **Description** – The FHM's description.
* **IP Address** – The FHM's IP address.
* **MAC Address** – The FHM's MAC address.

The FHM's health status:

* **Online** – Indicates the FHM's online status, determined by its reachability from the Onyx Portal.

  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FPW9kalh6gRq1CDFz8ztW%2Ficon-online-status-green.png?alt=media\&token=3533b7f8-0d5d-439d-ba72-1fd6bc7c907a) (green) – Indicates the FHM is management connected, and the last reported time is < 5 mins from current time.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FG4QfUkBX2CQGQKLB5ZlB%2Ficon-online-status-red.png?alt=media\&token=23cb58ab-9b83-4260-9330-2a212ca3569d) (red) – Indicates any of the following conditions:
    * FHM is not management connected
    * Time reported >= 5 mins from current time
    * FHM is not associated with any Onyx Edge
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FxNpeS6nFP7mlarW9O4Xs%2Fimage.png?alt=media&amp;token=f2b55c76-54f6-4782-8ab0-c980aef2e29c" alt="" data-size="line"> (grey) – Indicates the gateway of the associated Onyx Edge is offline.

  Hovering your cursor over the "Online Status" icon displays the FHM's last check-in timestamp.
* **Interface Status** – Indicates the fronthaul connection status of the AP.

  FHM Interface Status icon indicators:

  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5gXVDcyMvNuttHNcw9D4%2Ficon-interface-status-green.png?alt=media\&token=8aa7cf73-a81a-4541-9ad4-a32d3eb6c7a1) (green) – Passthrough is reported as true for all associated APs.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FnE3PEgYy9t3M9yOo6O8r%2Ficon-interface-status-red.png?alt=media\&token=eba91254-78ba-46ae-9e5e-9f45ba9e59b1) (red) – Passthrough is reported as false, or status information is unavailable for all associated APs.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FSSPwWaroGdd4C97zhktB%2Ficon-interface-status-amber.png?alt=media\&token=5bc77bd0-5fe0-48b3-aee4-bdc54f03c0ac) (amber) – Passthrough is reported as false, or status information is unavailable for at least one, but not all, associated APs.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FEbjEHJc002FJdppQKHIw%2Ficon-interface-status-grey.png?alt=media\&token=cae9992b-b5ed-4e1b-a478-e4250d45ee09) (grey) – FHM is not management-connected.

  Hovering your cursor over the Interface Status icon displays the following details:

  * **Access Point** – Name of individual AP.
  * **Interface** – Ethernet port used for the fronthaul link.
  * **Passthrough** – Indicates whether the fronthaul passthrough is active (true or false).
* **Service Status** – Indicates the FHM's transmission status.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FIayEm0M7pzYJRtQQvbos%2Ficon-service-status-green.png?alt=media\&token=7563b33c-e3f5-40dd-a541-dd2fb708abe9) (green) – RF TX is ON
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F4mKATYuNL8pLMKd3hyWN%2Ficon-service-status-red.png?alt=media\&token=0b7b37cd-93d5-4580-96ae-06756cdd9fb5) (red) – RF TX is OFF
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FACZheDhUzINHnTBxJUlU%2Ficon-service-status-grey.png?alt=media\&token=bbf441d6-9c3c-488c-8d37-f8bce834a63e) (grey) – AP is offline
* **Sync Status** – Indicates the FHM's sync status.

  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Flqi69BnmwPshjUTacq6F%2Ficon-ipsec-status-green.png?alt=media\&token=041dc0f4-371c-4265-9855-a2f251d91ff3) (green) – AP timing status is true
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXGiNKukCewGqq8I59mN5%2Ficon-ipsec-status-red.png?alt=media\&token=40a4520c-2b7a-4839-a3c8-372831969802) (red) – AP timing status is false
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FqTAhLPTgcZY0LMmXxJbQ%2Ficon-ipsec-status-grey.png?alt=media\&token=46fce66e-422f-409c-a26c-a0ef1c7d2544) (grey) – AP is offline

  Hovering your cursor over the "Sync Status" icon displays the following information:

  * Value of the timing status
  * IN\_SYNC if true
  * LATE/EARLY if false
* **Onyx Edge** – The associated Onyx Edge.
* **FHM Properties**
  * **Model** – The FHM equipment's model—GXC-FHM-001.
  * **Software Version** – The FHM's current software version.
  * **Up Time** – The time duration since the FHM was last restarted. For example, 2d 10h 17m 58s.
  * **Reported Time** – Timestamp of the last update received from the FHM.
* **Associated Access Points** – Details of APs connected to the FHM.
  * Service Status – Indicates the AP's service status.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FgnHZ20kZBN67hd3Z54sV%2Ficon-service-status-green.png?alt=media\&token=50a395ad-f0cf-4030-bade-4575875d36be) (green) – Indicates the RF Tx status is on.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FnRNgqJyDgoFeWAiPC0dS%2Ficon-service-status-red.png?alt=media\&token=6bb8462d-76b1-43a6-8296-eb9ef10b183c) (red) – Indicates the RF Tx status is off.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJnfDthIUXg81qDYV8es4%2Ficon-service-status-grey.png?alt=media\&token=43890a25-e1bd-4fd1-a0f4-8f5333b2471c) (grey) – Indicates the AP is offline.
  * **Name** – The AP's name.
  * **Serial No.** – The AP equipment's vendor-assigned serial number.
  * **IP Address** – The AP's IP address.
  * **Online** – Indicates the AP's online status, which is determined by its reachability from the Onyx Portal.

    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKCKvev8Mi1akVCKo1AcF%2Ficon-online-status-green.png?alt=media\&token=3ddac865-d3ee-422b-84b0-6e94b3e74eb0) (green) – Indicates the AP has checked-in with the Onyx Portal in the last five minutes.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FA42MBWfpY6Q3iURg9Jl7%2Ficon-online-status-red.png?alt=media\&token=8e3109e0-3e7a-4417-9360-7e27ab32f3d7) (red) – Indicates the AP has not checked-in with the Onyx Portal in the last five minutes. Or, the time reported is older than five minutes.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FSGJPD1eLbnebc64Do3we%2Ficon-online-status-grey.png?alt=media\&token=97e0c889-d953-4a25-914e-aee5460321a6) (grey) – Indicates the associated Onyx Edge is offline.

    Hovering your cursor over the "Online Status" icon displays the online status.
  * **Interface Status** – Indicates the AP's fronthaul interface status.

    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKNAqhXWcBdoOeydR49vV%2Ficon-interface-status-green.png?alt=media\&token=ea257bd0-b02f-4a32-845f-de38377e502e) (green) – Indicates the AP fronthaul interface is connected.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmZ88LFP6LVnoswffpEX2%2Ficon-interface-status-red.png?alt=media\&token=dd80462f-ce51-4f4b-83ab-9e70974aba24) (red) – Indicates the AP fronthaul interface is disconnected.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0jlMUgJYQRSbmxeBgbMT%2Ficon-interface-status-grey.png?alt=media\&token=43070a03-6b1c-4bc4-a5c6-683db301084d) (grey) – Indicates the AP is offline or the fronthaul interface status is unavailable.

    Hovering your cursor over the "Interface Status" icon displays the fronthaul connection status.
  * **Sync Status** – Indicates the AP’s time synchronization state with its configured clock source (such as GPS or PTP).

    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8tBKn4zCDpmKEpqGcefc%2Ficon-ipsec-status-green.png?alt=media\&token=af964f1d-78f9-45e2-9d79-92559e4238ac) (green) – Indicates the AP is in sync with the clock source.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQxzZgmYkTIzzcZSZlpYm%2Ficon-ipsec-status-amber.png?alt=media\&token=9a028b82-9377-4935-8b0c-b914855b57e0) (amber) – Indicates the sync is degraded.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FrZsKTHfUSaqL0l2XNDfd%2Ficon-ipsec-status-red.png?alt=media\&token=bc7e550b-0801-417a-9439-aea5404d5b93) (red) – Indicates the AP is not in sync.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FcWG5nTTUSeU4NVDUcfkL%2Ficon-ipsec-status-grey.png?alt=media\&token=a522fa34-0c20-4583-bdcb-7d96011cce7f) (grey) – Indicates the Sync status is not available or the AP is offline.

    Hovering over the Sync Status icon displays detailed synchronization states:

    * **PTP** – Precision Time Protocol – Indicates whether time synchronization is locked or unlocked.
    * **SyncE** – Synchronous Ethernet – Indicates whether frequency synchronization is locked or unlocked.
  * **Fiber Length (km)** — Length of fiber cable used to connect this AP to the FHM, in kilometers. The system uses this parameter to automatically calculate and apply RU transmit delay compensation, improving timing alignment across RUs connected via different fiber lengths.
* **Subscribers** — Details of all subscribers connected through every AP associated with the FHM.
  * **Status** — The subscriber's current session state.
  * **Name** — The subscriber account's name.
  * **IMSI** — The subscriber's IMSI — a unique identifier assigned to each subscriber SIM.
  * **Subscriber Group Name** — The subscriber group to which the subscriber belongs.
  * **gNB ID/Cell ID** — The gNB ID/Cell ID top which the subscriber is associated. Click to view the corresponding AP details page.

{% hint style="info" %}
**NOTE:** When an AP is directly associated with an Onyx Edge, details of subscribers connected to that AP are displayed in the AP's Details page. For APs associated with an FHM, subscriber details are displayed only in the FHM details page.
{% endhint %}
{% endstep %}

{% step %}
Click the **Events & Alerts** tab.

The **Events & Alerts** tab displays the following details.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FlfHVp0mZOE6Vi4qVSnr3%2Ffhm-view-events-alerts-tab.png?alt=media&amp;token=3d852ec6-f453-41de-8e77-dd797aed9286" alt=""><figcaption></figcaption></figure>

* **Alerts** panel
  * A filter dropdown allows alerts to be filtered by status. If no alerts are present, the panel displays "No Records Found".
  * **Date** — The date and time the alert was raised.
  * **Status** — The alert's current status.
  * **Alert Name** — The alert's name.
  * **Severity** — The alert's severity level.
* **Events** panel
  * A date and time range selector at the top of the Events panel filters events by time window.
  * The Module and Event Type columns include filter controls, and the Entity column includes a search control.
  * **Timestamp** — The date and time the event occurred.
  * **Module** — The system module that generated the event.
  * **Event Type** — The type of event, such as device\_configuration\_updated, device\_connected, device\_disconnected, etc.
  * **Entity** — The vendor-assigned serial number of the FHM equipment associated with the event.
  * **Event Description** — A plain-language description of the event.
  * To access additional event details, click the corresponding view details icon.
    {% endstep %}
    {% endstepper %}

## Add FHM

{% hint style="info" %}
**NOTE:** You can add FHMs only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

**To add an FHM:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **FHM** tab.

The **Equipment** page > **FHM** tab displays the summary details of all FHM configured in the network.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Add Node** > **Add FHM**.

The **Create FHM** page is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FUaBNYezcfXj0VdyG05lx%2Ffhm-add.png?alt=media&amp;token=be964932-811f-4f96-af74-ad69ad47c2cb" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

* **Name** – (Required) The FHM's name. The name must be unique and must be an alphanumeric string of up to 32 characters.
* **Serial Number** – (Required) The FHM equipment's vendor-assigned serial number. The serial number must be an alphanumeric string of up to 32 characters and may include the "-" (hyphen) character.
* **MAC Address** – (Required) The FHM's MAC address.
* **Device Class** – (Required) Click to select the FHM equipment's model.
* **Selected RU Configuration** – Select the APs to associate with the FHM. You can only associate free unassociated APs.
* **Fiber Length (km)** – The fiber length between each AP and this FHM. The system uses
  \
  these values to automatically calculate and apply AP transmit delay compensation,
  \
  improving timing alignment across APs connected via different fiber lengths. Enter a positive numeric value up to two decimal places (e.g., 0.25, 3.50).
  {% endstep %}

{% step %}
To save the FHM, in the upper-right corner of the page, click **Save FHM**.
{% endstep %}
{% endstepper %}

## Edit FHM

{% hint style="info" %}
**NOTE:** You can edit FHM details only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

**To edit an FHM:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **FHM** tab.

The **Equipment** page > **FHM** tab displays the summary details of all FHMs configured in the network.
{% endstep %}

{% step %}
For the FHM that you want to edit, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FymVW8ZcX1iugA1xpQG5t%2Fimage.png?alt=media&amp;token=d71600da-4afa-4381-9350-f69c37fc891f" alt="" width="110"><figcaption></figcaption></figure></div>

The **Edit FHM** page displays the equipment's details.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FlVZrZpk1F1U77ko05pRp%2Ffhm-edit.png?alt=media&amp;token=aaee6627-0adb-469b-b2f6-6af56d5a6e56" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Edit the following details as required.

* **Name** – (Required) The FHM's name.
* **Serial Number** – (Read-only) The FHM equipment's vendor-assigned serial number. This field cannot be modified after the FHM is created.
* **MAC Address** – (Read-only) The FHM's MAC address. This field cannot be modified after the FHM is created.
* **Device Class** – (Read-only) The FHM equipment's model. This field cannot be modified after the FHM is created.
* **Selected RU Configuration** – Select the APs to associate with the FHM. You can only associate free unassociated APs.
* **Fiber Length (km)** – The fiber length between each AP and this FHM. The system uses
  \
  these values to automatically calculate and apply AP transmit delay compensation,
  \
  improving timing alignment across APs connected via different fiber lengths. Enter a positive numeric value up to two decimal places (e.g.,
  &#x20;0.25, 3.50). Changes to fiber length trigger a configuration update to the Onyx Edge, ensuring compensation is applied immediately.
  {% endstep %}

{% step %}
To save your edits, in the upper-right corner of the page, click **Save FHM**.
{% endstep %}
{% endstepper %}

## Reboot FHM

{% hint style="info" %}
**NOTE:** You can reboot FHMs only if you are a Super Administrator or an Administrator.
{% endhint %}

**To reboot an FHM:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **FHM** tab.

The **Equipment** page > **FHM** tab displays the summary details of all FHMs configured in the network.
{% endstep %}

{% step %}
Click the Serial Number of the FHM that you want to reboot.

The ***\<FHM name>*** page displays the FHM's details.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Actions**, then click **Reboot**.

A confirmation dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FMVksWxrNm9cexpy0Y0Xw%2F5g-fhm-reboot.png?alt=media&amp;token=0a637927-d84a-43d1-becb-3884bd4aca1d" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To confirm rebooting the FHM, click **Yes**.
{% endstep %}
{% endstepper %}

## Delete FHM

{% hint style="info" %}
**NOTE:** You can delete FHMs only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** Before you can delete an FHM, you must disassociate any APs associated with that FHM. For more information, see [*Edit FHM*](#edit-fhm).
{% endhint %}

**To delete an FHM:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **FHM** tab.

The **Equipment** page > **FHM** tab displays the summary details of all FHMs configured in the network.
{% endstep %}

{% step %}
For the equipment that you want to delete, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Delete**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJBjznvKu7x3lPZfZOqLz%2Fimage.png?alt=media&amp;token=2f9c936d-4095-4f18-b6f1-70eeb9c2dbbb" alt="" width="110"><figcaption></figcaption></figure></div>

A confirmation dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fr0XWgzlSDGbwTjumSqpc%2F5g-fhm-delete.png?alt=media&amp;token=11490e52-78bf-49c8-ab82-96d0b25e1d3c" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To confirm deleting the FHM, click **Yes**.
{% endstep %}
{% endstepper %}


# Manage Mesh Nodes

The 5G Mesh Node is a wireless backhaul-capable radio access node for 5G networks. Like an AP, a Mesh Node serves subscribers over the radio access network; unlike a wired AP, it can also relay traffic to another AP or Mesh Node over the air, which lets you extend 5G coverage into areas without a wired backhaul connection.

## View 5G Mesh Node Details

This section describes how to view Mesh Node details.

* [*View Mesh Node Summary Details*](#view-mesh-node-summary-details)
* [*View a Mesh Node's Details*](#view-a-mesh-nodes-details)

### View Mesh Node Summary Details

To view the summary details of all Mesh Node configured in the network:

{% stepper %}
{% step %}
In the navigation pane, click **Equipment > Mesh Node** tab.

The **Equipment** page > **Mesh Node** tab displays the summary details of all Mesh Nodes configured in the network.

* **Mesh Node (n)** — The number of Mesh Nodes configured in the network.
* The list of Mesh Nodes.
  * Mesh Node Service Status.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FN7iOkBO5oSE7SrNUBjst%2Fimage.png?alt=media&amp;token=8597395a-0446-4cbc-b8ba-730e9519fe18" alt="" data-size="line"> Green — Mesh AP cell is in a healthy state.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FIOaQpWLQY1jOmau1DMyM%2Fimage.png?alt=media&amp;token=e5c3d89c-9e1a-4e0a-999d-d26fce22baf5" alt="" data-size="line"> Red — Mesh AP cell is in service down state.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQQ2gYV3bAHI5TrFu9rT7%2Fimage.png?alt=media&amp;token=f34e8ed3-0e0c-4cc6-9293-576e8928b2df" alt="" data-size="line"> Amber — Mesh AP cell is in unwarranted transmission state.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FsXE6duDt2IO6ToFzIL4F%2Fimage.png?alt=media&amp;token=53ec8bbb-ea0a-400a-9aca-312393369840" alt="" data-size="line"> Grey — Mesh AP cell state is shutdown, AP is offline, or Mesh Node is offline.

    To view the Mesh AP Rf Tx status and Mesh AP Last Sync timestamp, hover your cursor over the "Service Status" icon.
* **Name** — The Mesh Node's name.
* **Description** — The Mesh Node's description.
* **Venue** — The name of the venue hosting the Mesh Node.
* **Online** — Indicates the Mesh Node's online status, which is determined by its reachability from the Onyx Portal.

  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F99qGDJljczjeJBLyd4za%2Fimage.png?alt=media&amp;token=acdef267-a172-4c22-8f3e-876d827000e2" alt="" data-size="line"> Green — Indicates the Mesh Node is connected to the Onyx Portal, and it last checked-in with the Onyx Portal within the last two minutes.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5mvjhEfhhozDJgNCDJZU%2Fimage.png?alt=media&amp;token=3c90d639-81df-4dbc-802e-9ccec84da5bb" alt="" data-size="line"> Red — Indicates the Mesh Node is not connected to the Onyx Portal, and it last checked-in with the Onyx Portal more than two minutes ago.

  To view the last synchronized at timestamp, hover your cursor over the "Online Status" icon.
* **Interface Status** — Indicates the Mesh Node's interface status.

  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXIigi4HXPPW1ugkcd5dE%2Fimage.png?alt=media&amp;token=9a3f8927-233b-4637-848f-cd9b833dd113" alt="" data-size="line"> Green — Indicates GRE tunnel status is okay, and Mesh AP is online.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FnEqfpOgCgGMrJGTGBDW3%2Fimage.png?alt=media&amp;token=b151935f-dfe9-4aee-b91f-eb377de4662d" alt="" data-size="line"> Amber — Indicates Mesh Node is online, but Mesh AP is offline, and GRE tunnel Status is okay.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FAWvDOu50JriOUkZlMKMW%2Fimage.png?alt=media&amp;token=0fc36839-8d13-4a62-9d92-69179278a01b" alt="" data-size="line"> Red — Indicates the GRE tunnel status is not okay.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F1EG7Cqeb9WRcbNinCvsd%2Fimage.png?alt=media&amp;token=e786e5f3-39af-4e20-a87a-f082868f9de9" alt="" data-size="line"> Grey — Indicates the Mesh Node is offline.

  To view the Tunnel status and Mesh AP Power Up status, hover your cursor over the "Interface Status" icon.
* **Compute Resource** — Indicates utilization status of the Mesh Node's computing resources—CPU percentage, Memory percentage, and Disk Utilization percentage.

  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fl2axRRXn664zxHDphsg0%2Fimage.png?alt=media&amp;token=9242e8eb-5a34-4f45-ad3c-6595c127f94c" alt="" data-size="line"> Green — Indicates all parameters are less than or equal to 50%.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXbHFYEOW5YQsqBGeDKYq%2Fimage.png?alt=media&amp;token=ae32a73a-007c-46d8-be61-57820fab0841" alt="" data-size="line"> Amber — Indicates all parameters are less than or equal to 70%, and at least one parameter is above 50%.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FSKllqNhHbQp4FC7Gtwt8%2Fimage.png?alt=media&amp;token=26406e9d-0933-4a87-b6e3-82b3f8ed38aa" alt="" data-size="line"> Red — Indicates at least one parameter is above 70%.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F7vwZ95O8s520FWCrLpba%2Fimage.png?alt=media&amp;token=b1ff7e80-2ca5-4a22-b9e8-3b86fe724591" alt="" data-size="line"> Grey — Indicates the Mesh Node is offline.

  To view the Disk Utilization, CPU Utilization, and Memory Utilization percentages, hover your cursor over the "Compute Resource Status" icon.
* **Actions** — Options to view details, edit, and delete a Mesh Node.
  {% endstep %}
  {% endstepper %}

### **View a Mesh Node's Details**

**To view a GM03 Mesh Node's details:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment > Mesh Node** tab.

The **Equipment** page > **Mesh Node** tab displays the summary details of all Mesh Nodes configured in the network.
{% endstep %}

{% step %}
To view a Mesh Node's details, in the list, click its name.

The ***\<Mesh Node name>*** page is displayed.

* **Overview** tab:
  * **Mesh Node Details**:

    * **Name** — The Mesh Node's name.
    * **Serial No.** — The Mesh Node equipment's vendor-assigned serial number.
    * **Venue Name** — The name of the venue hosting the Mesh Node.
    * **Version** — The Mesh Node's software version.
    * **Up Time** — The duration for which the Mesh Node has been continuously operational without any downtime or interruptions.
    * **Mesh AP** — The Mesh AP equipment's vendor-assigned serial number.
    * **Donor AP** — The Mesh Node's donor AP's name.
    * **UUID/Challenge Key** — To view the Mesh Node's Hardware UUID and Challenge Key, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F3FMBfOKtw2zjI4ONERQM%2Fimage.png?alt=media&amp;token=01ddb5e4-04e0-409d-8170-7e4492b0c479" alt="" data-size="line"> (view details).
    * **Hostname** — The Mesh Node's hostname.
    * **Description** — The Mesh Node's description.
    * **Device Class** — The Mesh Node's device class—GM03.
    * **Upgrade Status** — Status of the previous Mesh Node software upgrade.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The <strong>Upgrade Status</strong> parameter is displayed only during an upgrade and for one hour after the upgrade. </p></div>

    * To view the previous upgrade's details, click the status.

      The **Upgrade Status** dialog box displays the following details:

      * **Description** — Description of the last upgrade's status.
      * **Old Version** — The software version before the upgrade.
      * **New Version** — The new software version.
      * **Updated At** — The timestamp at which the last upgrade completed.
      * **Start Time** — The timestamp at which the last upgrade started.
* **SIM Related Info**:
  * **Active SIM** — The active SIM's status—**Disabled**, **Enabled**.
  * **IMSI** — The IMSI number that identifies the SIM within the network.
  * **IMEI** — The IMEI number that uniquely identifies the equipment.
* Status:
  * **Online** — The Mesh Node's online status.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FggNTxqK9UfbLaOFCRhWB%2Fimage.png?alt=media&amp;token=ebd0d85b-f7de-4461-acae-96ffff317171" alt="" data-size="line"> Green — Indicates the Mesh Node is connected to the Onyx Portal, and it last checked-in with the Onyx Portal within the last two minutes.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FADWXl52OhsogM26d7377%2Fimage.png?alt=media&amp;token=52d41512-e74a-447a-919a-d5b3f1ca8e53" alt="" data-size="line"> Red — Indicates the Mesh Node is not connected to the Onyx Portal, and it last checked-in with the Onyx Portal more than two minutes ago.

    To view the last synchronized at timestamp, hover your cursor over the "Online Status" icon.
  * **Interface Status** — The Mesh Node's interface status.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FsqJBRBRO0RZEMu46Ubdp%2Fimage.png?alt=media&amp;token=bbf96426-72e8-4cc5-bd67-4ef4c77b10dd" alt="" data-size="line"> Green — Indicates GRE tunnel status is okay, and Mesh AP is online.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F9AUaDfOXt939KOdtOtwL%2Fimage.png?alt=media&amp;token=f291442d-8817-4d1a-a181-1f72e385e3fa" alt="" data-size="line"> Amber — Indicates the Mesh Node is online, but Mesh AP is offline, and GRE tunnel Status is okay.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fr9oEeikPcpxtSp6zoqzy%2Fimage.png?alt=media&amp;token=366515c0-15f6-41b7-9b91-bf76578fd8cd" alt="" data-size="line"> Red — Indicates the GRE tunnel status is not okay.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FxD9pWBNAyoalqOWWdgKR%2Fimage.png?alt=media&amp;token=58d43ad3-693d-4270-9e96-086aad498e2f" alt="" data-size="line"> Grey — Indicates the Mesh Node is offline.

    To view the Tunnel status and the Mesh AP Power Up status, hover your cursor over the "Interface Status" icon.
  * **Compute Resource** — The Mesh Node's compute resource status.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FZ2Tn8QwFm01QyKobkKAJ%2Fimage.png?alt=media&amp;token=be85be73-0790-4332-9883-32d15840883c" alt="" data-size="line"> Green — Indicates all parameters are below 50%.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FoQbb3wdoXXRWySMC4fEy%2Fimage.png?alt=media&amp;token=fe60ab4e-c24d-4dda-9829-98b1ff3e97ad" alt="" data-size="line"> Amber — Indicates at least one parameter is above 50% and below 75%.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FnHIj0bMckMneLgHMfjHC%2Fimage.png?alt=media&amp;token=a3341da9-683b-4d1b-abdc-0240d6b6048e" alt="" data-size="line"> Red — Indicates at least one parameter is above 75%.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FsVBbumUodxvI2F3hIvVl%2Fimage.png?alt=media&amp;token=8b57e62b-d048-44b8-b812-0c9a6afe8893" alt="" data-size="line"> Grey — Indicates the Mesh Node is offline.

    To view the Disk Utilization, CPU Utilization, and Memory Utilization percentages, hover your cursor over the "Compute Resource Status" icon.
  * **Service Status** — The Mesh Node's service status.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FdNE7uBfyY2dumEbCYGdh%2Fimage.png?alt=media&amp;token=9019d893-ca21-4fa6-af16-952b1fcf7db7" alt="" data-size="line"> Green — Mesh AP cell is in a healthy state.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FDgovl2shO8ocZcX0ImkA%2Fimage.png?alt=media&amp;token=b3ff1951-d470-49fb-aca8-24758fbef3f1" alt="" data-size="line"> Red — Mesh AP cell is in service down state.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FdOOzsKzdILWRMfO9CrJ5%2Fimage.png?alt=media&amp;token=6d11225c-d655-4850-a2f9-d3144191072c" alt="" data-size="line"> Amber — Mesh AP cell is in unwarranted transmission state.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmUHTZ1aMG7XzkdtQAtcE%2Fimage.png?alt=media&amp;token=a6e379ed-e7f7-4edb-852d-80fc08620f1e" alt="" data-size="line"> Grey — Mesh AP is offline, or Mesh Node is offline.

    To view the Mesh AP Rf Tx status and the Mesh AP last synchronized at timestamp, hover your cursor over the "Service Status" icon.
* **Backhaul Status Details** — Indicates how consistent and stable the network connection is.

  * **Backhaul IP** — The backhaul IP address.
  * **Backhaul Filter State** — The backhaul filter state—Low Pass, High Pass.
  * **Mesh AP Filter State** — The Mesh AP filter state—Low Pass, High Pass.

  The following details are displayed in the case of SC mode for Primary cell, and in the case of CA mode for the Primary and Secondary Cells.

  * **Freq** — The cell's frequency in MHz.
  * **BW** — The cell's bandwidth in dBm.
  * **RSRQ** — The cell's RSRQ in dB.
  * **RSRP (dBm)** – The antenna's RSRP in dBm. Displayed for Antenna 0 and Antenna 1.
  * **RSSI (dBm)** — The antenna's RSSI in dBm. Displayed for Antenna 0 and Antenna 1.
* **Alert Thresholds** — Pre-defined limits set in the system to monitor radio signal quality and generate alerts when certain metrics drop below acceptable levels. These thresholds help proactively identify and address connectivity or performance issues with the mesh node.
  * **RSRP Limit** — Reference Signal Received Power (RSRP) indicates the power level of the LTE reference signals received by the antenna. It is a critical measurement for determining coverage quality and cell selection. If the RSRP drops below -90 dB, it implies weak received signal power, which may lead to coverage holes or poor connectivity for the UE.
  * **RSRQ Limit** — Reference Signal Received Quality (RSRQ) is a measure of signal quality, factoring in interference and noise, and is derived from RSRP and Received Signal Strength Indicator (RSSI). When RSRQ falls below -15 dB, it indicates a high level of interference or poor quality of the received signal. This can result in degraded throughput and unreliable connections.
  * **SINR Limit** — Signal-to-Interference-plus-Noise Ratio (SINR) measures the quality of the wireless link by comparing the strength of the desired signal to the level of background interference and noise. SINR below -13 dB suggests severe interference or noise, potentially leading to significant performance degradation, reduced data rates, or dropped connections.
    {% endstep %}

{% step %}
Click the **Analytics** tab.

The Analytics tab displays time-based visualizations of critical radio signal metrics collected from the Mesh Node. It helps monitor signal stability and quality in real time, identify degradations, and take corrective actions.

* **Selected Range** — The time period from which signal metrics are displayed on the analytics plots. Select the time period in the dropdown to the far right.
* **Performance Analytics**
  * **RSRP Signal** — Measures the average power of reference signals received by the Mesh Node from the donor cell. It serves as a primary indicator of coverage strength. Higher RSRP indicates a stronger and more reliable signal. If RSRP falls below certain thresholds, it may signal weak coverage or physical obstructions. This plot displays frequency-based color coding.
    * **Primary/Secondary** — Select the cell's role.
      * **ant0/ant1** — Select the antenna.
  * **RSRQ Signal** — Indicates the quality of the received signal (interference and noise in the signal) by combining information on interference and overall signal strength. It is derived using RSRP and RSSI (total received power). Lower (more negative) RSRQ values signify higher interference or noise in the environment, which can degrade throughput and reliability. This plot displays frequency-based color coding.
    * **Primary/Secondary** — Select the cell's role.
  * **SINR Signal** — Signal-to-Interference-pus Noise ratio. Measures the ratio of the desired signal strength to the sum of interference and noise. It is a key indicator of overall link quality and expected data rates. Higher SINR values correspond to better radio conditions and higher possible throughput. When SINR drops, it can indicate interference from nearby cells, environmental noise, or hardware faults. This plot displays frequency-based color coding.
  * **Check-In Count** — The number of check-in events from the Mesh Node over time, used to monitor node connectivity responsiveness and health.
    {% endstep %}

{% step %}
Click the **Logs** tab.

* **Logs (n)** — The number of logs for the Mesh Node in the selected date and time range.
* To change the date and time range, select the required timestamps in the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQz7fOlIyfrOBx5u8WpeR%2Fimage.png?alt=media&amp;token=9b2b6ecb-e79a-4f01-913f-f111fb34538e" alt="" data-size="line"> fields. The logs list automatically updates to display the corresponding logs.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> Your selections must fall within a seven-day range.</p></div>
* To download the logs in .csv format, in the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQcorBYTM4BFSJEsukhXE%2Fimage.png?alt=media&amp;token=31029dba-9ad0-4579-bca2-79a385b11d42" alt="" data-size="line"> field, enter the number of logs to be included in the .csv file, then click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FA9d0Aek1jV2iPxXuMOWG%2Fimage.png?alt=media&amp;token=edd7a6f0-7ada-421a-857e-c76ec352928d" alt="" data-size="line">. Default value: 5000. The downloaded .csv file includes details such as the timestamp, service, tag, type, and log text.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> You can download a maximum 5000 logs.</p></div>
* To search for a log, in the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FAMro7PwVe8p4zdXFzvqB%2Fimage.png?alt=media&amp;token=e5107389-4ddf-4e70-b698-553e8879afe7" alt="" data-size="line"> field, enter your search term. The logs list automatically updates to display logs containing the term.
* **Timestamp** — The date and time when each log entry was recorded.
* **Service** — The specific service associated with the log.
* **Type** — The log’s type.
* **Output** — The log’s message.&#x20;
  {% endstep %}
  {% endstepper %}

## Add 5G Mesh Node Equipment

{% hint style="info" %}
**NOTE:** You can add a Mesh Node only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** The Mesh Node must check in with the Onyx Portal before it can be registered on the network. It must make an attempt to connect first before you can add its serial number. Once it attempts to connect, you can configure the Mesh Node in the system.
{% endhint %}

**To add a 5G Mesh Node:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **Mesh Node** tab.

The **Equipment** page > **Mesh Node** tab displays the summary details of all Mesh Nodes configured in the network.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Add Node** > **Add Mesh Node**.

The **Create Mesh Node** page > **Mesh Node** tab is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQUd2yCOyvcF2Mu3jrSfZ%2Fimage.png?alt=media&amp;token=238d5d7c-c4df-49ae-904f-077ce9da6e1e" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

* **Venue** — (Required) Select the venue hosting the Mesh Node.
* **Mesh Node Name** — (Required) The Mesh Node's name.
* **Serial No.** — (Required) The Mesh Node equipment's vendor-assigned serial number. The Provisioning Server uses this serial number to generate and provision the keys required for the Mesh Node to operate with the Onyx Portal.
* **Host Name** — (Optional) The Mesh Node's host name.
* **Device Class** — (Required) The Mesh Node's device class—**GM03**. Default value: **GM03**.
* **Description** — (Required) A brief description that will help discern the Mesh Node's role.
  {% endstep %}

{% step %}
Click the **Alert Threshold** tab and enter the following details.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FSDMpmdZOKIzEYaivgjnb%2Fimage.png?alt=media&amp;token=44f8b0a9-25e0-430d-bd78-19c061bcd8ca" alt=""><figcaption></figcaption></figure></div>

You can configure alert thresholds for the following Mesh Node radio signal quality metrics. When real-time metrics fall below the configured thresholds, alerts trigger automatically enabling timely diagnostics and corrective action.

For information on the corresponding alert rules, see *Semi-Custom Alert Rules*.

* **RSRP Limit** — (Required) Enter the minimum acceptable RSRP limit in the range of -140—44. RSRP measures the average received signal power. A value below this limit indicates weak coverage or possible connection issues. When this limit is breached, an alert is triggered. Default value: -100.
* **RSRQ Limit** — (Required) Enter the minimum acceptable RSRQ limit in the range of -20—3. RSRQ reflects signal quality, considering strength and interference. A value below this limit indicates poor quality or high interference, which may affect performance. When this limit is breached, an alert is triggered. Default value: -15.
* **SINR Limit** — (Required) Enter the minimum acceptable SINR limit in the range of -20–30. SINR measures signal quality against interference and noise. A value below this limit can cause slow data rates or dropped connections. When this limit is breached, an alert is triggered. Default value: 13.
  {% endstep %}

{% step %}
To save the Mesh Node, in the upper-right corner of the page, click **Save Mesh Node**.
{% endstep %}
{% endstepper %}

## Mesh Node-AP Affinity Feature

The Mesh Node-AP Affinity feature manages the association between a Mesh Node and a specific cell. By restricting a Mesh Node to attach to a specific cell, this feature optimizes network resource management and enhances the Mesh Node's performance.

In the Onyx Portal subscriber configuration, administrators can designate a specific cell ID as the "Allowed Cell" for a Mesh Node subscriber. The cell IDs are in the format "<*AP name*>-cell-<*cell id*>". For APs with dual cells, two separate entries, one for each cell, are available for association. For more information, see *Manage Subscriber Accounts*.

{% hint style="info" %}
**NOTE:** For this feature to operate effectively, the desired cell should have a signal strength of around -90 RSRP dBm, while undesired cells should have signal strengths of -110 RSRP dBm or lower.
{% endhint %}

{% hint style="info" %}
**NOTE:** You cannot delete an AP or change its carrier mode while its cell ID is configured as a Mesh Node subscriber's "Allowed Cell". The subscriber configuration must first be cleared of the cell ID, after which the AP can be deleted, or its carrier mode can be changed.
{% endhint %}

{% hint style="info" %}
**NOTE:** Users are responsible for associating valid AP cells. Configuring a non-associated AP cell as an "Allowed Cell" for a Mesh Node, or removing the association of an AP whose cell is configured as an "Allowed Cell", will result in a loss of connectivity for that subscriber.
{% endhint %}

{% hint style="info" %}
**NOTE:** The Mesh Node-AP Affinity feature will not work during handovers between two Gateway APs.
{% endhint %}

## Register Mesh Node SIM Card

GXC ships Mesh Nodes with one SIM card preinstalled. The Mesh Node's SIM card/IMSI must be activated in the Onyx Portal before the Mesh Node can join the network. The Mesh Node's SIM card/IMSI can be added in the Onyx Portal even before the Mesh Node equipment is powered up.

{% hint style="info" %}
**NOTE:** The IMSI of the SIM Card and the Serial Number of the Mesh Node can be found on the Mesh Node's LCI > **System** page.
{% endhint %}

**To register a Mesh Node in the Onyx Portal:**

{% stepper %}
{% step %}
In the navigation pane, click **Subscribers**.

The **Subscribers** page > **Subscriber** tab displays the list of subscribers and any Mesh Nodes in the network.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Add Subscriber**.

The **Add Subscriber** page is displayed.
{% endstep %}

{% step %}
Enter the following details:

* **Subscriber Name** — (Required) The Mesh Node's name.
* **IMSI** — (Required) The Mesh Node SIM's IMSI number.
* **Auth Key** — (Required) The authentication key.
* **Auth OPC** — (Required) The authentication OPc. Operator Code used to validate the network.
* **Service** — (Required) Select the SIM card's service state—Active or Inactive.
* **Subscriber Groups** — (Required) Select the "Mesh Nodes" subscriber group. For more information on subscriber groups, see *Manage Subscribers > Manage Subscriber Groups*.
* **Add More Subscriber** — Shortcut option to add additional SIM cards/IMSI.
  {% endstep %}

{% step %}
To save the Mesh Node subscriber account, in the upper-right corner of the page, click **Save Subscriber**.

{% hint style="info" %}
**NOTE:** In the subscriber list and subscriber details, the Mesh Node IMSI's Status will be "Unregistered" until the Mesh Node is powered up and its CPE antenna is pointed correctly to the gateway node.
{% endhint %}
{% endstep %}
{% endstepper %}

## Edit Mesh Nodes

{% hint style="info" %}
**NOTE:** You can edit Mesh Node details only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** When editing a Mesh Node's details, you can either edit its serial number or edit the rest of its editable parameters. If you edit the serial number, the other parameters will be read-only.
{% endhint %}

**To edit a Mesh Node's details:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **Mesh Node** tab.

The **Equipment** page > **Mesh Node** tab displays the summary details of all Mesh Nodes configured in the network.
{% endstep %}

{% step %}
For the Mesh Node that you want to edit, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F2B1Kb2otIgLfYffZVAaT%2Fimage.png?alt=media&amp;token=415d6979-3b1a-4e80-adf8-60c0569ad005" alt="" width="110"><figcaption></figcaption></figure></div>

The **Edit Mesh Node** page displays the node's details.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F873O8rtulzMFTxWVVQ0q%2Fimage.png?alt=media&amp;token=7d82cce2-c70b-475c-a073-8449b5568800" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Edit the following details as required:

* **Venue** — (Read only) The name of the venue hosting the Mesh Node.
* **Mesh Node Name** — (Required) The Mesh Node's name.
* **Serial No.** — (Required) The Mesh Node equipment's vendor-assigned serial number. To edit the serial number, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fk3qQE9wLufBN9iqCJhhX%2Fimage.png?alt=media&amp;token=1e47f66b-4eed-4065-b52e-13b4bcc5dc0f" alt="" data-size="line"> then edit the serial number and save the Mesh Node.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> When editing a Mesh Node's details, you can either edit its serial number or rest of its editable parameters. If you edit the serial number, the other parameters will be view only.</p></div>
* **Host Name** — (Optional) The Mesh Node's host name.
* **Device Class** — (Read only) The Mesh Node's device class.
* **Description** — (Required) The Mesh Node's description.
  {% endstep %}

{% step %}
Click the **Alert Threshold** tab and edit the following details as required.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FrW5PtAjcukFLnweQo7Vc%2Fimage.png?alt=media&amp;token=cd1cd918-09cf-4001-a63f-d1b2301fc9c1" alt=""><figcaption></figcaption></figure></div>

You can configure alert thresholds for the following Mesh Node radio signal quality metrics. When real-time metrics fall below the configured thresholds, alerts trigger automatically enabling timely diagnostics and corrective action.

For information on the corresponding alert rules, see *Semi-Custom Alert Rules*.

* **RSRP Limit** — (Required) Enter the minimum acceptable RSRP limit. RSRP measures the average received signal power. A value below this limit indicates weak coverage or possible connection issues. When this limit is breached, an alert is triggered. Default value: -100.
* **RSRQ Limit** — (Required) Enter the minimum acceptable RSRQ limit. RSRQ reflects signal quality, considering strength and interference. A value below this limit indicates poor quality or high interference, which may affect performance. When this limit is breached, an alert is triggered. Default value: -15.
* **SINR Limit** — (Required) Enter the minimum acceptable SINR limit. SINR measures signal quality against interference and noise. A value below this limit can cause slow data rates or dropped connections. When this limit is breached, an alert is triggered. Default value: 13.
  {% endstep %}

{% step %}
To save your edits, in the upper-right corner of the page, click **Save Mesh Node**.
{% endstep %}
{% endstepper %}

## Reboot Mesh Nodes

**To reboot a Mesh Node:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **Mesh Node** tab.

The **Equipment** page > **Mesh Node** tab displays the summary details of all Mesh Nodes configured in the network.
{% endstep %}

{% step %}
For the Mesh Node that you want to reboot, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **View**.

The ***\<Mesh Node name>*** page is displayed.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Actions > Reboot**.

A confirmation dialog box is displayed.
{% endstep %}

{% step %}
To confirm rebooting the Mesh Node, click **Yes**.
{% endstep %}
{% endstepper %}

## Delete Mesh Nodes

{% hint style="info" %}
**NOTE:** You can delete a Mesh Node only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** Before you delete a Mesh Node, confirm that no active subscribers depend on it for backhaul, since deleting it will disconnect any traffic relayed through it.
{% endhint %}

**To delete a Mesh Node:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **Mesh Node** tab.

The **Equipment** page > **Mesh Node** tab displays the summary details of all Mesh Nodes configured in the network.
{% endstep %}

{% step %}
For the Mesh Node that you want to delete, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Delete**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8a5RvLCx9bqGqQsS1I9I%2Fimage.png?alt=media&amp;token=825b1a9c-967c-4393-a2cd-c361f1ec71e5" alt="" width="110"><figcaption></figcaption></figure></div>

A confirmation dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FEpxJRz3w9l84drVjfS1O%2Fimage.png?alt=media&amp;token=8c2a7363-5601-4c4a-a35c-5a6927819d42" alt="" width="410"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To confirm deleting the Mesh Node, click **Yes.**
{% endstep %}
{% endstepper %}


# Manage Subscribers

This section describes how to:

* [*Manage Subscriber Groups*](#manage-subscriber-groups)
* [*Manage Subscriber Accounts*](#manage-subscriber-accounts)

## Manage Subscriber Groups

{% hint style="info" %}
**NOTE:** You can create and manage subscriber groups only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

Subscriber groups enable organizing subscribers into different groups based on factors such as usage patterns and network policies. Individual subscriber groups can be managed differently to ensure fair allocation of network resources and prioritize critical traffic.

### View Subscriber Groups

{% hint style="info" %}
**NOTE:** By default, the Onyx system creates the "Default" and "Mesh Nodes" subscriber groups in the network. Note that the "Mesh Nodes" subscriber group is visible only to GXC Administrators.
{% endhint %}

This section describes how to:

* [*View Summary Details of All Subscriber Groups*](#view-summary-details-of-all-subscriber-groups)
* [*View a Subscriber Group's Details*](#view-a-subscriber-groups-details)

#### View Summary Details of All Subscriber Groups

**To view summary details of all subscriber groups in the network:**

{% stepper %}
{% step %}
In the navigation pane, click **Subscribers** > **Subscriber Groups** tab.

The **Subscriber (n)** page > **Subscriber Groups** tab displays the list of configured subscriber groups.

* **Name** – The subscriber group's name.
* **APN** – The APN associated with the subscriber group. The APN specifies the default bearer characteristics.
* **Total Subscribers** – The total number of subscribers in the subscriber group.
* **Connected Subscribers** – The number of subscribers with active sessions.
* **Idle Subscribers** – The number of idle subscribers.
* **Actions** – Options to edit and delete a subscriber group.
  {% endstep %}
  {% endstepper %}

#### View a Subscriber Group's Details

**To view a subscriber group's details:**

{% stepper %}
{% step %}
In the navigation pane, click **Subscribers** > **Subscriber Groups** tab.

The **Subscriber (n)** page > **Subscriber Groups** tab displays the list of configured subscriber groups.
{% endstep %}

{% step %}
To view a particular subscriber group's detail, click the group's name.

The ***\<subscriber group name>*** page displays the subscriber group's details.

* **Subscriber Group Details**
  * **Name** – The subscriber group's name.
  * **APN** – The APN associated with the subscriber group.
  * **Aggregate BW (Upload)** – The maximum bandwidth allowed for all non-GBR bearers per UE in the uplink direction in Mbps.
  * **Aggregate BW (Download)** – The maximum bandwidth allowed for all non-GBR bearers per UE in the downlink direction in Mbps.
  * **QoS Category** – The associated APN's QoS category, which specifies the QoS policy for the default bearer.
  * The counts of Connected, Inactive, Idle, Stale, and Unregistered subscriber accounts in the group.
* **Subscribers (n)** – The list of subscribers associated with the subscriber group.
  * **Name** – The subscriber's name.
  * **IMSI** – The subscriber's IMSI. To view a subscriber's details, click the corresponding IMSI. The **\<subscriber name>** details page is displayed.
* **Application Groups** – The list of application groups associated with the subscriber group.
  * **Name** – The application group's name.
  * **Applications** – The applications associated with the application group.
  * **Downlink BW**
    * **Max** – The maximum bandwidth in the downlink direction.
    * **Guaranteed** – The guaranteed bandwidth in the downlink direction.
  * **Uplink BW**
    * **Max** – The maximum bandwidth in the uplink direction.
    * **Guaranteed** – The guaranteed bandwidth in the uplink direction.
  * **QoS Category** – The QoS category associated with the application group. The QoS category specifies the QoS policy for the application group. For more information, see *QoS Categories*.
  * **QCI** – The QoS Class Identifier assigned to the application group.
  * **Pre-emption**
    * **Priority (ARP)** – (Displayed only for custom QoS categories.) The priority level of the bearer associated with this application group relative to other bearers in the network. On a congested cell, it determines the priority of a new bearer setup request—whether to release an established bearer with a lower priority to make way for the new bearer, or to reject the new bearer setup request. Higher priority bearers, indicated by higher ARP values, are less likely to be released in favor of lower priority bearers. Preemption priority ensures that critical services, such as real-time applications, receive preferential treatment, maintaining QoS during periods of network congestion.
    * **Vulnerability** – (Displayed only for custom QoS categories.) Indicates whether, during periods of network congestion, the bearer associated with this application group can be released to make way for a new bearer with a higher priority.
    * **Capability** – (Displayed only for custom QoS categories.) Indicates whether, during periods of network congestion, the establishment of the bearer associated with this application group could lead to the release of an established bearer with a lower priority.
      {% endstep %}
      {% endstepper %}

### Create Subscriber Groups

This section describes how to create subscriber groups.

{% hint style="info" %}
**NOTE:** You can create subscriber groups only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** By default, the system creates the "Default" and "Mesh Nodes" subscriber groups in the network. Note that the "Mesh Nodes" subscriber group is visible only to GXC Administrators. Avoid creating subscriber groups unless there is a specific requirement.
{% endhint %}

**To create a subscriber group in a 5G network:**

{% stepper %}
{% step %}
In the navigation pane, click **Subscribers** > **Subscriber Groups** tab.

The **Subscriber (n)** page > **Subscriber Groups** tab displays the list of configured subscriber groups.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Add Subscriber Group**.

The **Add Subscriber Group** page is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FDI5R989SyCt9lCkZ3o3A%2Fimage.png?alt=media&amp;token=2a608390-0b64-4a3c-9996-92ba45485ada" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

* **Name** – (Required) This subscriber group's name. The name can be an alphabetic, numeric, or alphanumeric string of up to 32 characters.
* **APN** – (Required) Select the APN to associate with this subscriber group. Each subscriber group can be associated with a single APN.
* **Select Application Groups** – Click to select the application groups to associate with this subscriber group and set their priority order.

  The **Select and Order Application Groups** dialog box is displayed.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FZsy0oc3lzTZkO8NGLPIJ%2Fimage.png?alt=media&amp;token=0d50dd94-6e18-47f9-b73f-9f5765c93421" alt=""><figcaption></figcaption></figure></div>

  * To associate an available application group with the subscriber group, in the **Available Application Groups** box, select the applications group(s), then click the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FTwYFGXyaqBUG6gAbmOHV%2Fimage.png?alt=media&amp;token=4b75ebf3-3892-4d0c-86ed-557e8916255c" alt="" data-size="line"> (add) button.
  * To disassociate an application group from the subscriber group, in the **Selected Application Groups** box, select the applications group(s), then click the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FLdfYm1FDuCvJwGzBmfTj%2Fimage.png?alt=media&amp;token=53479032-0ba8-4f35-9abe-cb11cec78b4a" alt="" data-size="line"> (remove) button.
  * To set the priority order of an associated application group, in the **Selected Application Groups** box, drag and drop the corresponding row above or below as required.
    {% endstep %}

{% step %}
To save the subscriber group, in the lower-right corner of the page, click **Save Subscriber Group**.
{% endstep %}
{% endstepper %}

### Edit Subscriber Groups

{% hint style="info" %}
**NOTE:** You can edit subscriber groups only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** By default, the system creates the "Default" and "Mesh Nodes" subscriber groups in the network. The "Mesh Nodes" subscriber group is visible only to GXC Administrators.
{% endhint %}

**To edit a subscriber group:**

{% stepper %}
{% step %}
In the navigation pane, click **Subscribers** > **Subscriber Groups** tab.

The **Subscriber (n)** page > **Subscriber Groups** tab displays the list of configured subscriber groups.
{% endstep %}

{% step %}
For the subscriber group that you want to edit, in the **Actions** column, click the corresponding ⋮ (options) icon then click **Edit**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJ1m0dGMDJcd8xd94e9wD%2Fimage.png?alt=media&amp;token=cd41ace1-3bf8-4b40-82cd-03d0e6ecc7bb" alt="" width="104"><figcaption></figcaption></figure></div>

The **Edit Subscriber Group** page is displayed.
{% endstep %}

{% step %}
Edit the following details as required:

* **Name** – (Required) This subscriber group's name.
* **APN** – (Required) The APN to associate with this subscriber group. Each subscriber group can be associated with a single APN.
* **Select Application Groups** – Click to select the application groups to associate with this subscriber group and set their priority order.

  The **Select and Order Application Groups** dialog box is displayed.

  * To associate application group(s) with the subscriber group, in the **Available Application Groups** box, select the applications group(s), then click the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FMh3RFHtx66jKPLiQiEsQ%2Fimage.png?alt=media&amp;token=aacbd3f8-7a80-4688-bf52-d9cd56e991e4" alt="" data-size="line"> (add) button.
  * To set the priority order of an associated application group, in the **Selected Application Groups** box, drag and drop the corresponding row above or below as required.
  * To disassociate application group(s) from the subscriber group, in the **Selected Application Groups** box, select the applications group(s), then click the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FMI8isYFZhFnnt5ObjQ7z%2Fimage.png?alt=media&amp;token=30bbc1a0-38e2-4870-97bb-3c3402456c28" alt="" data-size="line"> (remove) button.
    {% endstep %}

{% step %}
To save your edits, in the lower-right corner of the page, click **Save Subscriber Group**.
{% endstep %}
{% endstepper %}

### Delete Subscriber Groups

{% hint style="info" %}
**NOTE:** You can delete subscriber groups only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

**To delete a subscriber group:**

{% stepper %}
{% step %}
In the navigation pane, click **Subscribers** > **Subscriber Groups** tab.

The **Subscriber (n)** page > **Subscriber Groups** tab displays the list of configured subscriber groups.
{% endstep %}

{% step %}
For the subscriber group that you want to delete, in the **Actions** column, click the corresponding ⋮ (options) icon then click **Delete**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FEaCw9Jk5V1oukoYWDfJf%2Fimage.png?alt=media&amp;token=567ff573-5ea8-43fa-a477-d658cf799f09" alt="" width="104"><figcaption></figcaption></figure></div>

A confirmation dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FaWSxr7LMCksP3L1leCkG%2Fimage.png?alt=media&amp;token=1495e78e-09d7-4763-98fd-935ead7f0139" alt="" width="258"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To confirm the deletion, click **Yes**.
{% endstep %}
{% endstepper %}

## Manage Subscriber Accounts

{% hint style="info" %}
**NOTE:** You can create and manage subscriber accounts only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

The Onyx Portal enables creating and managing subscriber accounts for your networks.

The subscriber accounts must be created before the UEs can access your network. The UEs must be provisioned with GXC-provided SIM cards or eSIM profiles configured exclusively for your network. For information on the SIM cards/eSIM profiles and supported UE devices, contact your GXC Account representative or GXC Technical Support.

### UE IMEI Verification to Prevent SIM Swapping

To prevent SIM swapping between UE, the IMSI of the SIM assigned to a subscriber account can be associated with a UE's IMEI. If a UE attempts to attach to the network with a different IMSI, the Attach Request is rejected and a "UE IMSI-IMEI Validation Failure" alert is triggered.

To enable UE IMEI verification for an individual subscriber account, see *Create Individual Subscriber Accounts*.

### Subscriber Speed Test Monitoring

The Subscriber Speed Test Monitoring feature provides real-time speed test metrics for individual subscribers/UE, offering enhanced visibility into per-subscriber network performance. This feature reports key real-time measurements, including uplink speed, downlink speed, jitter, and ping.

The feature leverages the free and open-source software provided by OpenSpeedtest. An OpenSpeedtest server runs on the Onyx Edge Core, allowing UE connected to the Onyx Edge to test the health of their 4G/5G network. The speed test operates independently of the backhaul speeds that the Onyx Edge itself is connected to, ensuring accurate measurement of the cellular radio link performance.

To perform a speed test, users open a browser on the UE and navigate to the [*http://uespeedtest.gxc.io*](http://uespeedtest.gxc.io), then click **Start**. The browser executes the speed test and displays the results. For CPE-like UE that lack browser support, an iPerf server is also available on the Onyx Edge. Speed test results are automatically recorded and displayed in the subscriber details page for the respective subscriber.

This feature enables administrators to quickly identify and troubleshoot subscribers/UE experiencing degraded network performance while proactively monitoring QoS compliance. Administrators can validate that upgrades deliver expected results, and connectivity issues can be resolved faster using data-driven insights.

This speed test results are displayed in the subscriber's details page > **Overview** tab > **Speed Test Details** section, and includes the following details:

* **Last Speed Test** – Timestamp of the most recently executed speed test.
* **Uplink Speed** – Measures upload data transfer rate (Mbps).
* **Downlink Speed** – Measures download data transfer rate (Mbps).
* **Jitter** – Tracks latency variation (ms) for connection stability assessment.
* **Ping (RTT)** – Measures round-trip time (ms) for latency evaluation.

Speed test results display as "--" when no data is available.

Speed test functionality requires compatible UE/subscriber device.

### View Subscriber Accounts

This section describes how to:

* [*View Summary Details of Subscriber Accounts*](#view-summary-details-of-all-subscriber-groups)
* [*View a Subscriber Account's Details*](#view-a-subscriber-accounts-details)

#### View Summary Details of Subscriber Accounts

**To view summary details of all subscriber accounts in the network:**

{% stepper %}
{% step %}
In the navigation pane, click **Subscribers**.

The **Subscribers (n)** page > **Subscriber** tab by default displays the list of all subscriber accounts under all subscriber groups.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fl8iUGHgI2xbRPkOP2WJu%2F5g-subscribers-summary-HQ.png?alt=media&amp;token=03ca77f9-a05b-4538-b3a5-9a41d56a6a23" alt=""><figcaption></figcaption></figure></div>

To view the subscriber accounts associated with a specific group, in the groups dropdown, select the group's name. The list of subscriber accounts associated with the selected group is displayed.

The list of subscribers is sorted by their network connection status and their recent network activity, making it easier to identify and manage subscribers based on their current state. The list is automatically sorted using a two-tier approach:

1. Primary Sort – Subscribers are grouped based on their connection status in the following priority order:
   * Connected
   * Idle
   * Detached
   * Not Yet Connected
   * Disabled
2. Secondary Sort – Within each connection status group, subscribers are ordered by their most recent network activity timestamps.

   Any subscribers with missing timestamp values are sorted after those with valid timestamps within the same status group.

   <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> For non-GXC Administrator users this list excludes MeshBackhaul subscriber data.</p></div>

   * **Type** – Indicates whether the subscriber/UE is using a physical SIM or an eSIM, shown with the corresponding icon.
   * **Status** – The subscriber's status—Connected, Idle, Detached, Not Yet Connected, Disabled.
   * **Name** – The subscriber's name.
   * **IMSI** – The IMSI number of the SIM assigned to the subscriber account.

     To view a subscriber's details, click the corresponding IMSI. The ***\<subscriber name>*** page is displayed.
   * **APN** – The APN associated with the subscriber account.
   * **gNB ID/Cell ID** – The gNB ID / Cell ID of the serving 5G cell that the subscriber is attached to.
   * **IP Address** – The subscriber/UE's IP address.
   * **Usage** – The subscriber's data usage in the last 24 hours.
   * **Session Duration** – The duration for which the subscriber's session has remained active.
   * **Actions** – (GXC Administrators, GXC Partner Administrators, Super Administrators, and Administrators only.) Options to edit and delete subscriber accounts.
     {% endstep %}

{% step %}
To search for a specific subscriber, in the **Search** field, enter your search term.
{% endstep %}

{% step %}
**Download CSV** – (Super Administrators and Administrators only.) To download the list of subscribers and their details as a CSV file, in the upper-right corner of the page, click **Download CSV**.
{% endstep %}
{% endstepper %}

#### View a Subscriber Account's Details

**To view a subscriber account's details:**

{% stepper %}
{% step %}
In the navigation pane, click **Subscribers**.

The **Subscribers (n)** page > **Subscriber** tab by default displays the list of all subscriber accounts under all subscriber groups.

To view the subscriber accounts associated with a specific group, in the groups dropdown, select the group's name. The list of subscriber accounts associated with the selected group is displayed.
{% endstep %}

{% step %}
To view the details of a particular subscriber, click the subscriber's IMSI number.

The ***\<subscriber name>*** page > **Overview** tab displays the following details:

* **Subscriber Details**:

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fci9IBjZXyB1KXUeBIgCo%2F5g-subscriber-details-panel.png?alt=media&amp;token=488819a8-e5ab-4e45-ab98-232d6f2dbba4" alt="" width="407"><figcaption></figcaption></figure></div>

  * **IMSI** – The IMSI number of the SIM assigned to this subscriber account.
  * **MAC** – (Displayed only in VLAN mode.) The subscriber's MAC address. Facilitates DHCP reservations in corporate-managed DHCP environments. The MAC address is displayed only when the network and Onyx Edge are in VLAN mode.
  * **Service** – The subscriber's service status—Enabled or Disabled.
  * **Last Reported Time** – The timestamp at which the subscriber's status was last reported.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> Some commercially available UE have ICMP ping responses disabled. In such cases, CPE monitoring for the UE fails and the <strong>Last Reported Time</strong> parameter displays as blank --.</p></div>
  * **IP Address** – The subscriber's IP address.
  * **Active Duration** – The duration for which the subscriber has been active.
  * **Last Uplink Signaling Activity Time** – Last time the subscriber/UE sent uplink signaling to the network.
  * **Last Attach Time** – Last successful network attach time for the subscriber/UE.
  * **Onyx Edge** – The Onyx Edge that the subscriber is associated with.
  * **gNB ID/Cell ID** – The gNB ID and Cell ID of the serving 5G cell that the subscriber is attached to.
  * **Status** – The subscriber's current status—Connected, Idle, Detached, Not Yet Connected, Disabled.
* **Subscriber Group Details**:

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FYfUwVEH4xcwdtX2nO6hI%2F5g-subscriber-view-subscriber-group-details-panel.png?alt=media&amp;token=c684e290-cd58-45fc-bf10-180400a52be7" alt="" width="408"><figcaption></figcaption></figure></div>

  * **Subscriber Group Name** – The name of the subscriber group that the subscriber is associated with. For more information on subscriber groups, see [*Manage Subscriber Groups*](#manage-subscriber-groups).
  * **APN** – The APN associated with the subscriber group.
* **Device Details**:

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F3gsizeMFIqyqyDQPTuWY%2F5g-subscriber-view-device-details-panel.png?alt=media&amp;token=a92c953f-04d0-4183-a5fb-1fb248f1cc7b" alt="" width="407"><figcaption></figcaption></figure></div>

  * **IMEI** – The device's IMEI number.
  * **IMEISV** – The device's IMEISV.
  * **Brand** – The device's manufacturer or vendor name.
  * **Model** – The device's model name or number.
  * **Last IMEI Lookup Time** – Timestamp of the last successful query to the IMEI Cloud database for the device's metadata.
* **Speed Test Details**: real-time network performance measurements for individual subscribers. For more information, see [*Subscriber Speed Test Monitoring*](#subscriber-speed-test-monitoring).

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F7s08ISanI9puJKSbcmt9%2F5g-subscriber-view-speed-test-details-panel.png?alt=media&amp;token=d6f0b8ba-46cf-4471-8bd9-d365ade998bd" alt="" width="406"><figcaption></figcaption></figure></div>

  * **Last Speed Test** – Timestamp of the most recently executed speed test.
  * **Uplink Speed** – Measures upload data transfer rate (Mbps).
  * **Downlink Speed** – Measures download data transfer rate (Mbps).
  * **Jitter** – Tracks latency variation (ms) for connection stability assessment.
  * **Ping (RTT)** – Measures round-trip time (ms) for latency evaluation.
* **Data Consumption** – The subscriber's data usage in the current session.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJBOHGzgXqh4d8KjG1IjF%2F5g-subscriber-view-data-consumption-panel.png?alt=media&amp;token=ac6e3b7c-875c-40b1-9485-c65aba8b08c1" alt="" width="407"><figcaption></figcaption></figure></div>

  * **Download** – The amount of data received by the subscriber from the network during the current session.
  * **Upload** – The amount of data sent by the subscriber to the network during the current session.
    {% endstep %}

{% step %}
Click the **Analytics** tab.

The **Analytics** tab provides real-time and historical data usage and connection performance metrics per subscriber.

* **Selected Range** – The time range for which the subscriber analytics data is displayed. You can change the time range from the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FO4cpTpxrRZuEDpLZ6Dh7%2Fimage.png?alt=media&amp;token=25fa1b9b-3b14-49ae-90e7-09f50f7c2f05" alt="" data-size="line"> dropdown to the far-right.
* **Summary** tab – Displays quick metrics for the selected time range.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FFjMiCh69OTsVBNAeVYzC%2F5g-subscriber-analytics-summary.png?alt=media&amp;token=236938be-c67f-4c21-8717-08a9e56af54d" alt=""><figcaption></figcaption></figure></div>

  * **Throughput Summary** – Subscriber's throughput summary.
    * **Downlink Throughput** – Subscriber's downlink throughput in the core.
    * **Uplink Throughput** – Subscriber's uplink throughput in the core.
  * **Data Usage Summary** – Subscriber's data usage summary.
    * **Downlink Data Usage** – Subscriber's downlink data usage.
    * **Uplink Data Usage** – Subscriber's uplink data usage.
  * **Connection Latency** – Latency for ping from Onyx Edge to UE.
    * **Connection Latency** (If available) – Note that for this to populate, CPE Monitoring must be enabled (**Equipment** > **Onyx Edge** tab > Onyx Edge details > **Dynamic Services** section > **CPE Monitoring** parameter) / (Add/Edit Onyx Edge > **Others** tab > **CPE Monitoring** toggle switch).
* **Plots** tab — Displays time-series plots visualizing usage patterns, spikes and drops, latency gaps, etc. with time granularity for the selected time range.<br>

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5uc01NrFJTtoVdg5uFhq%2F5g-subscriber-analytics-plots2.png?alt=media&amp;token=2c52a381-5ea2-42a7-ab4c-7a0b8e1c3c4f" alt=""><figcaption></figcaption></figure></div>

  \
  To manage the plots displayed, click **Manage Reports**.\
  \
  In the **Manage Report KPIs** dialog box, select the required KPIs.<br>

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FlVfrRJWGQOCfXA9xhA8B%2Fimage.png?alt=media&amp;token=21787b0d-78cf-4a3e-bf0e-07cadd1b78cd" alt=""><figcaption></figcaption></figure></div>

  * **Common KPIs**:
    * **Downlink Throughput** – Subscriber's downlink throughput measured at the core.
    * **Uplink Throughput** – Subscriber's uplink throughput measured at the core.
    * **Downlink Data Usage** – Total downlink data consumed by the subscriber.
    * **Uplink Data Usage** – Total uplink data consumed by the subscriber.
    * **Connection Latency** – Ping latency from Onyx Edge to UE (requires CPE Monitoring enabled). Note that for this to populate, CPE Monitoring must be enabled (**Equipment** > **Onyx Edge** tab > Onyx Edge details page > **Dynamic Services** section > **CPE Monitoring** parameter) / (Add/Edit Onyx Edge > **Others** tab > **CPE Monitoring** toggle switch).
  * **5G Only KPIs**:
    * **DL BLER** – Downlink Block Error Rate, measuring the proportion of erroneously received data blocks on the downlink.
    * **DL CQI** – Channel Quality Indicator reported by the UE to the network for downlink scheduling decisions.
    * **DL MCS** – Modulation and Coding Scheme used for downlink transmissions, indicating channel quality and spectral efficiency.
    * **DL PRB Usage** – The selected subscriber's downlink PRB usage over time as either a percentage (%) of available PRBs or the number (#) of PRBs allocated. PRBs are the units of radio spectrum the serving cell allocates for downlink data transmission. Higher values indicate greater downlink resource utilization, typically due to increased data reception, while sustained high utilization may indicate heavy traffic or increased demand for radio resources.&#x20;
    * **DL Radio Throughput** – Downlink data rate at the radio layer between the base station and the UE.
    * **DL Rank** – Number of spatial layers (MIMO rank) used for downlink transmission.
    * **DL RSRP** – Downlink Reference Signal Received Power, measuring the strength of the downlink signal at the UE.
    * **Serving Cell Transition** – Frequency of UE switching between LTE cells due to mobility or radio conditions. For accurate analysis, use a display duration of four hours or less.
    * **UL BLER** – Uplink Block Error Rate, measuring the proportion of erroneously received data blocks on the uplink.
    * **UL CQI** – Channel Quality Indicator for the uplink, used by the network for uplink scheduling.
    * **UL MCS** – Modulation and Coding Scheme used for uplink transmissions from the UE.
    * **UL PRB Usage** – The selected subscriber's uplink PRB usage over time as either a percentage (%) of available PRBs or the number (#) of PRBs allocated. PRBs are the units of radio spectrum the serving cell allocates for uplink data transmission. Higher values indicate greater uplink resource utilization, typically due to increased data transmission, while consistently high utilization may indicate heavy traffic or radio resource contention.&#x20;
    * **UL Radio Throughput** – Uplink data rate at the radio layer between the UE and the base station.
    * **UL Rank** – Number of spatial layers (MIMO rank) used for uplink transmission from the UE.
      {% endstep %}

{% step %}
Click the **Events** tab.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FYqy7BQJyQVYP7PPxdCsF%2Fimage.png?alt=media&amp;token=7a4273f6-e6b7-4b43-bdf1-c11b777183ef" alt=""><figcaption></figcaption></figure></div>

* **Events (n)** – The number of subscriber-specific events in the selected date and time range.

  To change the date and time range, in <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F9s6pXqU0WftVXmNZaPpJ%2Fimage.png?alt=media&amp;token=d7e8ff85-322f-49c2-a651-4d3cb7c86be5" alt="" data-size="line"> select the required timestamps. The events list automatically updates to display the corresponding events.

  Tabular list of subscriber-specific events displays the following details:

  * **Timestamp** – The timestamp at which the event was generated.
  * **Module** – The specific module or source from which the event originated. To filter the events based on the module, click the 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.
  * **Event Description** – The event's description.
  * **Actions** – To view an event's details, in the **Actions** column, click the corresponding <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FPBnkM5DsvWs1zNeAhj7v%2Fimage.png?alt=media&amp;token=196d3665-aaf9-4fc7-bba0-d3af2608ee85" alt="" data-size="line"> (view details) icon. The **Event Details** frame displays the event's details.
* **Detach Subscriber** – Forcefully disconnect the subscriber/UE.
  {% endstep %}
  {% endstepper %}

### Create Subscriber Accounts

Subscriber addition workflow is integrated into the SIM Provisioning workflow managed by GXC. For more information, contact GXC Technical Support.

### Edit Subscriber Accounts

{% hint style="info" %}
**NOTE:** You can edit subscriber accounts only if you are a GXC Administrator.
{% endhint %}

**To edit a subscriber account:**

{% stepper %}
{% step %}
In the navigation pane, click **Subscribers**.

The **Subscriber (n)** page is displayed.
{% endstep %}

{% step %}
For the subscriber account that you want to edit, in the subscriber groups dropdown, select the corresponding subscriber group.

All the subscriber accounts in the selected subscriber group are listed.
{% endstep %}

{% step %}
For the subscriber account that you want to edit, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

The **Edit Subscriber** page displays the subscriber's details.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FTR5OL81hyVaaLHEhAyPY%2Fimage.png?alt=media&amp;token=f52d9d36-f1bc-4cea-b262-793398bbd9c7" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Update the following details as required:

* **Subscriber Name** – (Required) The subscriber's name.
* **Service State** – (Required) Select the subscriber's SIM card's service state—**Active** or **Inactive**. Default value: Active.
* **Subscriber Groups** – (Required) Select the subscriber group with which this subscriber account must be associated. Each subscriber account can be associated with a single subscriber group. For information on subscriber groups, see *Manage Subscriber Groups*.
* **IMEI Verification** – (Optional) To enable IMEI verification for this subscriber account, select the toggle button.
  * **IMEI** – (Displayed only if IMEI Verification is enabled.) The IMEI of the UE that is assigned to this subscriber account.
    {% endstep %}

{% step %}
To save your edits, in the upper-right corner of the page, click **Save Subscriber**.
{% endstep %}
{% endstepper %}

### Bulk Assign Subscribers to a Subscriber Group

The Onyx Portal lets you move multiple subscriber accounts into a subscriber group in a single action, instead of editing each subscriber individually.

{% hint style="info" %}
**NOTE**: You can bulk-assign subscribers to a subscriber group only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.

**NOTE**: This is a bulk equivalent of changing the Subscriber Groups field on the Edit Subscriber page; it does not change any other subscriber setting (Service State, IMEI Verification, etc.).
{% endhint %}

**To bulk-assign subscribers to a subscriber group:**

{% stepper %}
{% step %}
In the navigation pane, click **Subscribers**.

The **Subscribers (n)** page > **Subscriber** tab displays the list of subscriber accounts.
{% endstep %}

{% step %}
In the first column, select the checkbox for each subscriber account that you want to move, then click **Update Subscriber Group**.

The **Assign to Subscriber Group** dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FezOVBycDYKkyfdhw3fJG%2Fimage.png?alt=media&amp;token=87441564-bae8-430b-b73f-188abf143206" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the **Select Subscriber Group** dropdown, select the target subscriber group.
{% endstep %}

{% step %}
To confirm, click **Assign**.

The selected subscribers are moved into the chosen subscriber group. Each subscriber's **Subscriber Group Details** (visible on that subscriber's **Overview** tab) update to reflect the new group and its associated APN.
{% endstep %}
{% endstepper %}

### Delete Subscriber Accounts

{% hint style="info" %}
**NOTE:** You can delete subscriber accounts only if you are a GXC Administrator.
{% endhint %}

**To delete a subscriber account:**

{% stepper %}
{% step %}
In the navigation pane, click **Subscribers**.

The **Subscriber (n)** page is displayed.
{% endstep %}

{% step %}
For the subscriber account that you want to delete, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Delete**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FaOi60yMO6mMlX2fvttDy%2Fimage.png?alt=media&amp;token=421b430f-ba12-4756-a284-c516d18ab0a9" alt="" width="151"><figcaption></figcaption></figure></div>

A confirmation dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FqpYckMT0uEpidZU7rfpf%2Fimage.png?alt=media&amp;token=649a7de3-cb31-4925-b8c7-e21bde447d6d" alt="" width="359"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To confirm, click **Yes**.
{% endstep %}
{% endstepper %}

### Detach Active Subscribers

Administrators can forcefully disconnect active subscribers/UE directly from the Onyx Portal in any of the following ways:

* From subscriber summary view
* From subscriber details page
* From Onyx Edge details page

#### Detach Subscribers from Subscriber Summary View

{% hint style="info" %}
**NOTE:** You can detach subscribers only if you are a GXC Administrator.
{% endhint %}

**To detach a subscriber from the subscriber summary view:**

{% stepper %}
{% step %}
In the navigation pane, click **Subscribers**.

The **Subscriber (n)** page > **Subscriber** tab is displayed.
{% endstep %}

{% step %}
For the subscriber account that you want to detach, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Detach Subscriber**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FdBODdmfzSyiakejWNrJ5%2Fimage.png?alt=media&amp;token=a863731f-ba56-4cfa-b10d-af315bd52c1b" alt="" width="151"><figcaption></figcaption></figure></div>

A confirmation dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fe6Nyw3mV41LeRREV8cYo%2Fimage.png?alt=media&amp;token=d67ba0e3-2ed9-4d80-b2aa-a2441ad830ac" alt="" width="563"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To confirm, click **Execute**.
{% endstep %}
{% endstepper %}

#### Detach Subscribers from Subscriber Details Page

{% hint style="info" %}
**NOTE:** You can detach subscribers only if you are a GXC Administrator.
{% endhint %}

**To detach a subscriber from the subscriber's details page:**

{% stepper %}
{% step %}
In the navigation pane, click **Subscribers**.

The **Subscribers (n)** page > **Subscriber** tab by default displays the list of all subscriber accounts under all subscriber groups.

To view the subscriber accounts associated with a specific group, in the groups dropdown, select the group's name. The list of subscriber accounts associated with the selected group is displayed.
{% endstep %}

{% step %}
Click the subscriber IMSI number for the subscriber you want to detach.

The ***\<subscriber name>*** page displays the subscriber's details.
{% endstep %}

{% step %}
In the top-right corner of the page, click **Detach Subscriber**.

A confirmation dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKKS6vrqvFgOmBDMrQlCn%2Fimage.png?alt=media&amp;token=70846a71-09f5-4129-b578-52218d278f10" alt="" width="563"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To confirm, click **Execute**.
{% endstep %}
{% endstepper %}

#### Detach Subscribers from Onyx Edge Details Page

{% hint style="info" %}
**NOTE:** You can detach subscribers only if you are a GXC Administrator.
{% endhint %}

**To detach subscribers from the associated Onyx Edge's details page:**

{% 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 **Onyx Edge (n)** panel, click the Onyx Edge's name.

The ***\<Onyx Edge name>*** page displays the Onyx Edge's details.
{% endstep %}

{% step %}
In the top-right corner of the page, click **Actions** > **Detach Subscriber**.

The **Detach Subscriber** dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FBLD1xdpLkGrYc4uYbF1a%2Fimage.png?alt=media&amp;token=0701e431-0ada-4a74-8c3a-dbd9726a507f" alt="" width="563"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the **Subscriber IMSI** dropdown, select the subscriber's IMSI and click **Execute**.

A confirmation dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FcMruwSfrJvgfCkf1Vtg6%2Fimage.png?alt=media&amp;token=d1e6cc22-f89a-48ac-97f2-c97e09b7f31f" alt="" width="563"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To confirm, click **Execute**.
{% endstep %}
{% endstepper %}


# Manage Traffic

Traffic management enables effective prioritization and control of network traffic, ensuring efficient utilization of network resources and enhanced user experience.

## Application-based Policies and Resource Management

This section describes the QoS Management architecture in the Onyx solution.

* **Default Bearer** – A default bearer is the initial logical connection established when a UE initiates a data session. It provides basic connectivity between the UE and the PDN and handles best-effort data traffic with moderate QoS requirements. One default bearer is established per APN.
* **Dedicated Bearer** – A dedicated bearer is a secondary logical connection established for specific types of traffic, such as video streaming or IoT telemetry, with a tailored QoS policy. It ensures optimized performance for these specialized services, running alongside the default bearer. One dedicated bearer is established per application group.
* **APNs** – Access Point Name (APN) specify the PDNs that subscribers/UE should connect to. They are essential for routing data traffic from UE to the appropriate networks, which could be public internet or a private corporate network. One default bearer is established per APN. Each APN is associated with a QoS category, which specifies the QoS policy for the default bearer. For more information on APNs, see [*Manage APNs*](#manage-apns).
* **Applications** – Application definitions specify the traffic classification rules that distinguish between different types of data flows based on their flow characteristics (direction, protocol, peer IP address, and source and destination ports). Multiple flow classification rules can be used to define what constitutes an application. For more information on applications, see [*Manage Applications*](#manage-applications).
* **Application Groups** – Application groups categorize application definitions into different groups based on their similarities such as data rate, latency sensitivity, and reliability requirements. For example, all real-time streaming applications can be grouped into one application group, while all monitoring applications can be in another group. One dedicated bearer is established per application group. The QoS category associated with an application group specifies the QoS policy for the dedicated bearer used for data flows associated with all applications in that group. For more information on application groups, see [*Manage Application Groups*](#manage-application-groups).
* **QoS Categories** – QoS categories are predefined QoS policies that can be applied to APNs and application groups. The predefined QoS categories help simplify the QoS configuration procedure. If required, operators have the option to create their own custom QoS categories.

  For APNs, the system supports the following QoS categories:

  <table><thead><tr><th valign="top">QoS Category</th><th width="99.6666259765625" valign="top">QCI</th><th width="99.666748046875" valign="top">Priority</th><th width="100" valign="top">PDB</th><th width="100" valign="top">PELR</th><th valign="top">Use Cases</th></tr></thead><tbody><tr><td valign="top">NA</td><td valign="top">5</td><td valign="top">1</td><td valign="top">100ms</td><td valign="top">10^-6</td><td valign="top">IMS signaling</td></tr><tr><td valign="top">High Priority Data</td><td valign="top">6</td><td valign="top">6</td><td valign="top">300ms</td><td valign="top">10^-6</td><td valign="top">Buffered video/TCP based</td></tr><tr><td valign="top">NA</td><td valign="top">7</td><td valign="top">7</td><td valign="top">100ms</td><td valign="top">10^-3</td><td valign="top">Live streaming</td></tr><tr><td valign="top">Medium Priority Data</td><td valign="top">8</td><td valign="top">8</td><td valign="top">300ms</td><td valign="top">10^-6</td><td valign="top">Buffered video/TCP based</td></tr><tr><td valign="top">Low Priority Data</td><td valign="top">9</td><td valign="top">9</td><td valign="top">300ms</td><td valign="top">10^-6</td><td valign="top">Buffered video/TCP based</td></tr></tbody></table>

  For application groups, the system supports the following QoS categories.

  * GBR type

    <table><thead><tr><th valign="top">QoS Category</th><th width="99.6666259765625" valign="top">QCI</th><th width="99.666748046875" valign="top">Priority</th><th width="99.6666259765625" valign="top">PDB</th><th width="100.1666259765625" valign="top">PELR</th><th valign="top">Use Cases</th></tr></thead><tbody><tr><td valign="top">Live Audio</td><td valign="top">1</td><td valign="top">2</td><td valign="top">100ms</td><td valign="top">10^-2</td><td valign="top">Conversational voice</td></tr><tr><td valign="top">Live Video</td><td valign="top">2</td><td valign="top">4</td><td valign="top">150ms</td><td valign="top">10^-3</td><td valign="top">Video/live streaming</td></tr><tr><td valign="top">Real-time Applications</td><td valign="top">3</td><td valign="top">3</td><td valign="top">50ms</td><td valign="top">10^-3</td><td valign="top">Real-time gaming</td></tr><tr><td valign="top">High Priority Data</td><td valign="top">4</td><td valign="top">5</td><td valign="top">300ms</td><td valign="top">10^-6</td><td valign="top">Non-conversation video/buffering streaming</td></tr></tbody></table>
  * Non-GBR type

    <table><thead><tr><th valign="top">QoS Category</th><th width="99.666748046875" valign="top">QCI</th><th width="99.6666259765625" valign="top">Priority</th><th width="99.6666259765625" valign="top">PDB</th><th width="100.166748046875" valign="top">PELR</th><th valign="top">Use Cases</th></tr></thead><tbody><tr><td valign="top">NA</td><td valign="top">5</td><td valign="top">1</td><td valign="top">100ms</td><td valign="top">10^-6</td><td valign="top">IMS signaling</td></tr><tr><td valign="top">High Priority Data</td><td valign="top">6</td><td valign="top">6</td><td valign="top">300ms</td><td valign="top">10^-6</td><td valign="top">Buffered video/TCP based</td></tr><tr><td valign="top">NA</td><td valign="top">7</td><td valign="top">7</td><td valign="top">100ms</td><td valign="top">10^-3</td><td valign="top">Live streaming</td></tr><tr><td valign="top">Medium Priority Data</td><td valign="top">8</td><td valign="top">8</td><td valign="top">300ms</td><td valign="top">10^-6</td><td valign="top">Buffered video/TCP based</td></tr><tr><td valign="top">Low Priority Data</td><td valign="top">9</td><td valign="top">9</td><td valign="top">300ms</td><td valign="top">10^-6</td><td valign="top">Buffered video/TCP based</td></tr></tbody></table>
* **Subscriber Groups** – Subscriber groups categorize subscribers/UE into different groups based on their usage patterns and other criteria. Subscribers within the same subscriber group share a common set of application groups. This grouping helps avoid repeating the same configuration for each subscriber/UE that must be treated on par. For example, all camera devices can be grouped into a "Cameras" group, all IoT scanners can be put into an "IoT Scanners" group, and so on. By default, the system creates the "Default" and "Mesh Nodes" subscriber groups in the network.

{% hint style="info" %}
**NOTE:** Each subscriber group is associated with a single APN. All the subscribers/UE associated with a subscriber group connect to the same APN.
{% endhint %}

{% hint style="info" %}
**NOTE:** Each subscriber/UE can be associated only with a single subscriber group.
{% endhint %}

{% hint style="info" %}
**NOTE:** All the subscribers/UE associated with a subscriber group use the same set of application groups.
{% endhint %}

{% hint style="info" %}
**NOTE:** Each subscriber group can contain multiple application groups. Within a subscriber group, the order in which application groups are prioritized determines which application group (QoS policy) is applied when there are overlapping traffic selection rules.
{% endhint %}

{% hint style="info" %}
**NOTE:** The "Mesh Nodes" subscriber group is visible only to GXC Administrators.
{% endhint %}

{% hint style="info" %}
**NOTE:** The QoS Management 2.0.0 feature works only in conjunction with Onyx Edge running software release 2.0.0 or later.
{% endhint %}

For more detailed information, refer to the *QoS Management Application Note*.

### How it Works

{% stepper %}
{% step %}
A subscriber group is associated with an APN and a set of application groups.
{% endstep %}

{% step %}
A subscriber/UE associated with the subscriber group uses the APN and application groups associated with that specific subscriber group.
{% endstep %}

{% step %}
An application group is associated with applications that classify different types of traffic based on their flow characteristics.
{% endstep %}

{% step %}
The QoS category associated with the application group decides the QoS treatment for those applications.
{% endstep %}

{% step %}
While registering with the network, the UE sends an Attach Request to the AP, which contains the APN identifying the PDN that the UE wants to connect to. The network verifies the UE's identity and checks if the UE is authorized to access the requested APN. The network establishes the default bearer and applies the QoS policy defined in the APN to the default bearer.
{% endstep %}

{% step %}
After the default bearer is established, for each application group associated with the subscriber group that the subscriber/UE is associated with, the network establishes a dedicated bearer and applies the QoS policy defined in the application group to it.
{% endstep %}

{% step %}
After the default and dedicated bearers are established, data packets are transmitted over these bearers facilitating communication between the UE and the network. While the default bearer handles general data traffic, the dedicated bearers cater to their respective application groups with defined QoS requirements.
{% endstep %}

{% step %}
At the UE and the Onyx Edge, the downlink and uplink packets are routed to the respective bearers based on the application definitions associated with the corresponding application group.

* Uplink data packets (originating from the UE) are processed and routed to the appropriate bearer based on the application definitions associated with the applications running on the UE.
* At the Onyx Edge, downlink data packets are inspected and routed to the appropriate bearers based on the application definitions associated with the corresponding application group.
  {% endstep %}

{% step %}
The default and dedicated bearers are released when:

* The UE detaches from the network.
* The user session is terminated.
* Network/operator policies trigger bearer release under specific conditions.
  {% endstep %}
  {% endstepper %}

### Limitations

This section outlines the limitations of the QoS Management feature in this release.

1. The QoS functionality works end-to-end only with UE connected to APs that are directly connected with an Onyx Edge.
2. When application definitions are modified, changes will not affect current sessions. The modifications will only come into effect when the UE establishes a new session.
3. Downlink-only application groups are not supported. To ensure the creation of a dedicated bearer, at least one uplink rule (even if it is a dummy rule) must be included in any of its member applications.
4. A maximum of four simultaneous dedicated bearers are supported per UE.
5. It is possible that not all dedicated bearers (one per application group) will always be established. For example, due to radio resource constraints.
6. The Onyx Edge can only create up to 15 TFTs in a bearer. This is further restricted by how many TFTs can be encoded within 255 octets in the "Create Bearer Request" message. Consequently, this restricts the number of flows across all applications within an application group.
7. The Preemption Vulnerability and Preemption Capability functionality are available only for trials in this release.

### QoS Configuration

This section describes the QoS configuration workflow and the procedure.

#### QoS Configuration Workflow

<p align="center"><strong>QoS Configuration Workflow</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FvGunJcxfwh0K8eCOQt31%2Fimage.png?alt=media&amp;token=4b186f4d-e163-4fc0-8141-7fb8d3760b5c" alt="" width="449"><figcaption></figcaption></figure>

QoS Configuration Workflow:

{% stepper %}
{% step %}
Create APNs.

* Specify the default bearer characteristics (associate with a predefined QoS category or define custom a QoS category).

See [*Manage APNs*](#manage-apns) *>* [*Create APNs*](#create-apns).
{% endstep %}

{% step %}
Create application definitions.

* Specify the flow classification rules.

See [*Manage Applications*](#manage-applications) *>* [*Create Applications*](#create-applications).

{% hint style="info" %}
**NOTE:** Avoid creating application definitions unless there is a specific requirement to prioritize certain types of traffic over others.
{% endhint %}
{% endstep %}

{% step %}
Create application groups.

* Specify the application group's QoS characteristics (associate with a predefined QoS category or define a custom QoS category).
* Associate the application group with application definitions.

See [*Manage Application Groups*](#manage-application-groups) *>* [*Create Application Groups*](#create-application-groups).
{% endstep %}

{% step %}
Create subscriber groups.

* Associate the subscriber group with an APN.
* Associate the subscriber group with application groups.

See *Manage Subscriber Groups > Create Subscriber Groups*.

{% hint style="info" %}
**NOTE:** By default, the system creates the "Default" and "Mesh Nodes" subscriber groups in the network. Note that the "Mesh Nodes" subscriber group is visible only to GXC Administrators.
{% endhint %}

{% hint style="info" %}
**NOTE:** Avoid creating subscriber groups unless there is a specific requirement.
{% endhint %}
{% endstep %}

{% step %}
Create subscriber accounts.

* Associate subscriber accounts with subscriber groups.

See *Manage Subscriber Accounts > Create Subscriber Accounts*.

<p align="center"><strong>QoS Configuration Associations</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FhlhnokrAsvd4oYzogVfl%2Fimage.png?alt=media&amp;token=875453b3-8924-4cb1-9c1b-7142f54b9b92" alt=""><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}

## Manage APNs

{% hint style="info" %}
**NOTE:** You can create and manage APNs only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

APNs serve as network identifiers to route UE traffic to a specific PDN. When a UE establishes a data connection, it must specify the APN it wants to use. The APN also specifies the QoS policy for the default bearer established between the UE and the PDN.

By default, Onyx Portal supports the following APNs:

* "internet": Used for various data services, including web browsing, email, and other Internet-related activities.
  * QCI – 9
  * ARP Priority Level – 15
  * Aggregate Bandwidth Downlink – 100 Mbps
  * Aggregate Bandwidth Uplink – 100 Mbps
* "MeshBackhaul": For use by Mesh devices in the network.
  * QCI – 6
  * ARP Priority Level – 15
  * Aggregate Bandwidth Downlink – 200 Mbps
  * Aggregate Bandwidth Uplink – 50 Mbps

{% hint style="info" %}
**NOTE:** The "MeshBackhaul" APN is visible only to GXC Administrators.
{% endhint %}

{% hint style="info" %}
**NOTE:** The default APNs cannot be deleted.
{% endhint %}

{% hint style="info" %}
**NOTE:** The default APNs cannot be renamed. APN names are case-insensitive, that is "internet" and "Internet" are treated as identical by the system.
{% endhint %}

### View APNs

**To view APNs configured in the network:**

{% stepper %}
{% step %}
In the navigation pane, click **Traffic**.

The **Traffic** page > **APNs** tab displays the list of configured APNs.

* **APN ID** – The APN's ID.
* **Aggregate BW**
  * **Download** – The maximum bandwidth allowed for all non-GBR bearers per UE in the downlink direction.
  * **Upload** – The maximum bandwidth allowed for all non-GBR bearers per UE in the uplink direction.
* **QoS Category** – The QoS category associated with the APN, which specifies the QoS policy for the default bearer associated with the APN—High Priority Data, Medium Priority Data, Low Priority Data, Custom.
* **QCI** – (Displayed only for custom QoS categories.) The QoS Class ID.
* **Pre-emption**
  * **Priority (ARP)** – (Displayed only for custom QoS categories.) The priority level of the bearer associated with this APN relative to other bearers in the network. On a congested cell, it determines the priority of a new bearer setup request—whether to release an established bearer with a lower priority to make way for the new bearer, or to reject the new bearer setup request. Higher priority bearers, indicated by higher ARP values, are less likely to be released in favor of lower priority bearers. Preemption priority ensures that critical services, such as real-time applications, receive preferential treatment, maintaining QoS during periods of network congestion.
  * **Vulnerability** – (Displayed only for custom QoS categories.) Indicates whether, during periods of network congestion, the bearer associated with this APN can be released to make way for a new bearer with a higher priority.
  * **Capability** – (Displayed only for custom QoS categories.) Indicates whether, during periods of network congestion, establishment of the bearer associated with this APN could lead to the release of an established bearer with a lower priority.
* **Actions** – (GXC Administrators, GXC Partner Administrators, Super Administrators, and Administrators only.) Options to edit and delete APNs.
  {% endstep %}

{% step %}
To search for a particular APN, in the Search field, enter your search term.
{% endstep %}
{% endstepper %}

### Create APNs

This section describes how to create APNs.

{% hint style="info" %}
**NOTE:** You can create APNs only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

**To create an APN in a 5G network:**

{% stepper %}
{% step %}
In the navigation pane, click **Traffic**.

The **Traffic** page > **APNs** tab displays the list of APNs configured in the network.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Add APN**.

The **Add APN** page > **Add APN** tab is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FcNyqOX2h3xW2yy5sd8t1%2Fimage.png?alt=media&amp;token=f9dd746d-b0ea-476a-8985-0ff81cb30168" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
In the **Add APN** tab, enter the following details:

* **ID** – (Required) The APN's ID.

{% hint style="info" %}
**NOTE:** APN names are case-insensitive, that is "internet" and "Internet" are identical in the system.
{% endhint %}

* **Aggregate BW (Upload)** – (Required) The maximum bandwidth allowed for all non-GBR bearers per UE in uplink direction in Mbps. The value must be in the range of range: 1 Mbps to 1000 Mbps. Default value: 100 Mbps.
* **Aggregate BW (Download)** – (Required) The maximum bandwidth allowed for all non-GBR bearers per UE in downlink direction in Mbps. The value must be in the range of range: 1 Mbps to 1000 Mbps. Default value: 250 Mbps.
* **QoS Category** – (Required) Click to select the APN's QoS category, which specifies the QoS policy for the default bearer associated with the APN. Default value: Low Priority Data. For more information including the QoS parameters per each category, see *QoS Categories*.<br>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> In this release, "Low Priority Data" is the only supported QoS category.</p></div>

  * **Low Priority Data** – This category is suitable for non-urgent or background traffic that can tolerate delays or occasional packet loss. Examples include software updates, non-critical file transfers, and bulk data backups.
    {% endstep %}

{% step %}
To save the APN, in the upper-right corner of the page, click **Save APN**.
{% endstep %}
{% endstepper %}

### Edit APNs

{% hint style="info" %}
**NOTE:** You can edit APNs only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

**To edit an APN in a 5G network:**

{% stepper %}
{% step %}
In the navigation pane, click **Traffic**.

The **Traffic** page > **APNs** tab displays the list of APNs configured in the network.
{% endstep %}

{% step %}
For the APN that you want to edit, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FbfISGTdUilRtrcbHHCBs%2Fimage.png?alt=media&amp;token=0761a042-8804-4670-b62b-4830edfc9c61" alt="" width="104"><figcaption></figcaption></figure>

The **Edit APN** page is displayed.
{% endstep %}

{% step %}
Edit the APN's details as required:

* **APN ID** – (Required) The APN's ID.
* **Aggregate BW (Upload)** – (Required) The maximum bandwidth allowed for all non-GBR bearers per UE in the uplink direction in Mbps.
* **Aggregate BW (Download)** – (Required) The maximum bandwidth allowed for all non-GBR bearers per UE in downlink direction in Mbps.
* **QoS Category** – (Required) Click to select the APN's QoS category. The QoS category specifies the QoS policy for the bearer associated with this APN. For more information including the QoS parameters per each category, see *QoS Categories*.
  * **High Priority Data** – This category is suitable for critical data traffic that requires high-priority treatment and reliable transmission with low latency and minimal packet loss. Examples include control signals for industrial automation systems, emergency communications, and real-time transactions.
  * **Medium Priority Data** – This category is suitable for important but less time-sensitive data traffic that requires reliable transmission with moderate priority and latency. Examples include email services and non-real-time communications that can tolerate some latency while still requiring reliable delivery.
  * **Low Priority Data** – This category is suitable for non-urgent or background traffic that can tolerate delays or occasional packet loss. Examples include software updates, non-critical file transfers, and bulk data backups.
  * **Custom** – The custom category allows for the creation of a tailored QoS policy that will be applied to all traffic associated with the APN.

    * **QCI** – (Displayed only if the **QoS Category** is **Custom**. Required.) The QoS Class ID from QCI 5 to QCI 9. Default value: QCI=9.
      * QCI=5 (PDB=100, PER=10^-6)
      * QCI=6 (PDB=300, PER=10^-6)
      * QCI=7 (PDB=100, PER=10^-3)
      * QCI=8 (PDB=300, PER=10^-6)
      * QCI=9 (PDB=300, PER=10^-6)
    * **Pre-emption Priority** – (Displayed only if the **QoS Category** is **Custom**. Required.) The priority level of the bearer associated with this APN relative to other bearers in the network. On a congested cell, it determines the priority of a new bearer setup request—whether to release an established bearer with a lower priority to make way for the new bearer, or to reject the new bearer setup request. Higher priority bearers, indicated by higher ARP values, are less likely to be released in favor of lower priority bearers. Preemption priority ensures that critical services, such as real-time applications, receive preferential treatment, maintaining QoS during periods of network congestion.
    * **Pre-emption Vulnerability** – (Displayed only if the **QoS Category** is **Custom**.) Enable or disable ARP preemption vulnerability. Specifies whether, during periods of network congestion, the bearer associated with this APN can be released to make way for a new bearer with a higher priority. To enable preemption vulnerability, turn on the toggle button. Default setting: disabled.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The Pre-emption Vulnerability configuration is available only for trials in this release. Keep it disabled. For more information, contact GXC Technical Support.</p></div>

    * **Pre-emption Capability** – (Displayed only if the **QoS Category** is **Custom**.) Enable or disable ARP preemption capability. Specifies whether, during periods of network congestion, establishment of the bearer associated with this APN can lead to the release of an established bearer with a lower priority. To enable preemption capability, turn on the toggle button. Default setting: disabled.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The Pre-emption Capability configuration is available only for trials in this release. Keep it disabled. For more information, contact GXC Technical Support.</p></div>

{% endstep %}

{% step %}
To save your edits, in the upper-right corner of the page, click **Save APN**.
{% endstep %}
{% endstepper %}

### Delete APNs

{% hint style="info" %}
**NOTE:** You can delete APNs only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** You can only delete APNs that are not associated with any subscriber groups.
{% endhint %}

{% hint style="info" %}
**NOTE:** You cannot delete the two default APNs available out of the box—Internet and MeshBackhaul.
{% endhint %}

**To delete an APN:**

{% stepper %}
{% step %}
In the navigation pane, click **Traffic**.

The **Traffic** page > **APNs** tab displays the list of APNs configured in the network.
{% endstep %}

{% step %}
For the APN that you want to delete, in the **Actions** column click the corresponding ⋮ (options) icon, then click **Delete**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmgFDZnVPWUPWGRu4LS5z%2Fimage.png?alt=media&amp;token=11401528-d6fb-4647-a4d0-65d4acc92cb3" alt="" width="104"><figcaption></figcaption></figure>

A confirmation dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FvmTVNoGnO1kgvlCQMWDe%2Fimage.png?alt=media&amp;token=02b9112d-6b8a-4d70-ac76-213198463e1f" alt="" width="372"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To delete the APN, click **Yes**.
{% endstep %}
{% endstepper %}

## Manage Applications

{% hint style="info" %}
**NOTE:** You can create and manage applications only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

Application definitions specify the traffic classification rules that distinguish between different types of data flows based on their flow characteristics (direction, protocol, peer IP address, and source and destination ports).

{% hint style="info" %}
**NOTE:** You can create a maximum of 15 flow classification rules per application.
{% endhint %}

The application group's order in the list of associations within a subscriber group determines which application/rule will be matched against a given flow. A flow will only ever be assigned to one application.

For example, a video streaming application deployed in cameras can have a rule like:

```
TCP traffic from local port 45000 to {Streaming server IP} port 50000 and vice versa
```

A resource-constrained monitoring application that sends status reports periodically may have rules like:

```
TCP traffic any local port to {Monitoring Server IP} port 80 and vice versa
```

```
UDP traffic from local port 46000 to {Monitoring Server IP} port 50100
```

### View Applications

**To view applications configured in the network:**

{% stepper %}
{% step %}
In the navigation pane, click **Traffic** > **Applications** tab.

The **Traffic** page > **Applications** tab displays the list of configured applications.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FaZhD4x3gVKrSEJ6AEqD4%2Fimage.png?alt=media&amp;token=cb6bb99e-c1ab-42da-8f60-9dceb2fd6ba6" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To view an application's details, click the corresponding row.

Any flow classification rules associated with the application are listed.

* **Description** – The application's description.
* **Direction** – The flow's direction—Downlink, Uplink.
* **Protocol** – The flow's communication protocol—ICMP, IP, TCP, UDP.
* **Peer IP/Subnet** – The peer IP address.
* **Peer Port** – The flow's source port number.
* **Destination Port** – The flow's destination port number.
* **Bidirectional** – Indicates if an additional rule has been created internally to match all packets (not just responses) in the reverse direction (based on the selected **Direction**)—No, Yes.
* **Actions** – (GXC Administrators, GXC Partner Administrators, Super Administrators, and Administrators only.) Click the ⋮ (options) icon to view the options to edit and delete applications.
  {% endstep %}
  {% endstepper %}

### Create Applications

{% hint style="info" %}
**NOTE:** You can create applications only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** Avoid creating applications unless there is a specific need to prioritize certain types of traffic over others. Otherwise, unnecessary applications may increase complexity and overhead in managing the network.
{% endhint %}

**To create an application:**

{% stepper %}
{% step %}
In the navigation pane, click **Traffic** > **Applications** tab.

The **Traffic** page > **Applications** tab displays the list of configured applications.
{% endstep %}

{% step %}
In the upper-right area of the page, click **Add Application**.

The **Add Application** page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQ7PaAT2RgNqXfRjXhf3B%2Fimage.png?alt=media&amp;token=38356cbd-d03c-4e34-a907-b8fb196ca09c" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details:

* **Application**
  * **Name** – (Required) The application's name. The application name can be an alphabetic, numeric, or alphanumeric string of up to 32 characters.
    {% endstep %}

{% step %}
Add the flow classification rules to route traffic based on the flow characteristics. For example, to block IP traffic in the uplink direction.

{% hint style="info" %}
**NOTE:** You can create a maximum of 15 flow classification rules per application.
{% endhint %}

1. To add a flow classification rule, click **Add Flows**, and enter the following details:
   * **Description** – (Optional) The rule's description.
   * **Direction** – (Required) Select the flow's direction between **Uplink** (outgoing), **Downlink** (incoming), and **Bidirectional** (outgoing and incoming, the Onyx system internally creates an additional rule to match all packets (not just responses)). Default value: Bidirectional.
   * **Protocol** – (Required) Select the flow's communication protocol between **ICMP**, **IP**, **TCP**, and **UDP**. Default value: IP.
   * **Peer IP/Subnet** – (Optional) Enter the flow's peer IP address.
   * **Peer Port** – (Optional) Enter the flow's destination port number.
   * **UE Port** – (Optional) Enter the flow's source port number.
2. To save the flow classification rule, under **Actions**, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FuAPAyKpRC3SYGy3gyjRW%2Fimage.png?alt=media&amp;token=ce6418fc-dad3-491b-b7da-882b42e28e52" alt="" data-size="line"> (save).
3. To discard the flow classification rule without saving it, under **Actions**, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F7o7KafaVYI32iz6q5msV%2Fimage.png?alt=media&amp;token=d2b85854-664a-43d2-8fcd-778a9679a261" alt="" data-size="line"> (delete).
   {% endstep %}

{% step %}
To save the application, click **Save Application**.

{% hint style="info" %}
**NOTE:** You will not be able save an application until you create and save at least one flow classification rule under it.
{% endhint %}
{% endstep %}
{% endstepper %}

### Edit Applications

{% hint style="info" %}
**NOTE:** You can edit applications only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** In case application definitions are modified, the changes will not affect the current sessions. The changes will only take effect when the UE establishes a new session.
{% endhint %}

**To edit an application definition:**

{% stepper %}
{% step %}
In the navigation pane, click **Traffic** > **Applications** tab.

The **Traffic** page > **Applications** tab displays the list of configured applications.
{% endstep %}

{% step %}
For the application that you want to edit, click the corresponding ⋮ (options) icon, then click **Edit**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Ftp6YSTeGCqMSZNyshY5g%2Fimage.png?alt=media&amp;token=4f6316aa-4ef7-472e-9e70-f7402f4365ec" alt="" width="98"><figcaption></figcaption></figure>

The **Edit Application** page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FslSIltXTJ1XfIcVKnrcp%2Fimage.png?alt=media&amp;token=d0bb65d9-110d-4347-84a7-fae25f91c6ca" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Edit the following details as required:

* **Application**
  * **Application Name** – (Required) The application's name.
* **Flows**
  * Add Flows:

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> You can create a maximum of 15 flow classification rules per application.</p></div>

    1. To add a flow classification rule, click **Add Flows**, and enter the following details:
       * **Description** – (Optional) The rule's description.
       * **Direction** – (Required) Select the flow's direction between **Uplink** (outgoing), **Downlink** (incoming), and **Bidirectional** (outgoing and incoming, the Onyx system internally creates an additional rule to match all packets (not just responses)). Default value: Bidirectional.
       * **Protocol** – (Required) Select the flow's communication protocol between **ICMP**, **IP**, **TCP**, and **UDP**. Default value: IP.
       * **Peer IP/Subnet** – (Optional) Enter the flow's peer IP address.
       * **Peer Port** – (Optional) Enter the flow's destination port number.
       * **UE Port** – (Optional) Enter the flow's source port number.
    2. To save the rule, under **Actions**, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FLXOBsip4mvAnsEaZlg6K%2Fimage.png?alt=media&amp;token=ef3ee7dd-7e4f-4260-a0b1-8097bdf33469" alt="" data-size="line"> (save).
    3. To discard the rule without saving it, under **Actions**, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FZz1TT8Opfv1rtEjbF25r%2Fimage.png?alt=media&amp;token=045b9af7-a94f-43fd-a2f7-13831272e012" alt="" data-size="line"> (delete).
  * Edit Flows:

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> You can create a maximum of 15 flow classification rules per application.</p></div>

    1. To edit a flow classification rule, click the corresponding ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FqAWCTpB64mFvixmXTaqm%2Fimage.png?alt=media\&token=750e8978-b41a-41fb-914c-dd67edf6c141) (edit) and edit the following details as required.
       * **Description** – (Optional) The rule's description.
       * **Direction** – (Required) Select the flow's direction between **Uplink** and **Downlink**. Default value: Uplink.
       * **Protocol** – (Required) Select the flow's communication protocol between **ICMP**, **IP**, **TCP**, and **UDP**. Default value: IP.
       * **Peer IP** – (Optional) Enter the flow's peer IP address.
       * **Source Port** – (Optional) Enter the flow's source port number.
       * **Destination Port** – (Optional) Enter the flow's destination port number.
       * **Bidirectional** – (Required) If the Onyx system should internally create an additional rule to match all packets (not just responses) in the reverse direction (based on the selected **Direction**), select the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fq4iSIZ3tvyFhwQvIpaVY%2Fimage.png?alt=media&amp;token=20ecb039-602b-4313-bb28-5414e04b4d2e" alt="" data-size="line">/<img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FrhuRjXyr197guz0saxFD%2Fimage.png?alt=media&amp;token=2d4bbd0f-71a6-4697-be4a-dd69f0987d5a" alt="" data-size="line"> check box.
    2. To save your edits, under **Actions**, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5ZymzAkoLUa3LTQX0r8Z%2Fimage.png?alt=media&amp;token=1c32a4a8-cb7a-48e6-95bf-bde8c39e7127" alt="" data-size="line"> (save).
  * Delete Flows:

    To delete a flow classification rule, click the corresponding <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FvixPwFaNBh1W2GtdxAyh%2Fimage.png?alt=media&amp;token=769a6712-61ba-4a98-bea5-84b9ac3a2574" alt="" data-size="line"> (delete) icon.
    {% endstep %}

{% step %}
To save your edits, in the lower-right area of the page, click **Save Application**.
{% endstep %}
{% endstepper %}

### Delete Applications

{% hint style="info" %}
**NOTE:** You can delete applications only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** You cannot delete applications that are associated with application groups.
{% endhint %}

**To delete an application definition:**

{% stepper %}
{% step %}
In the navigation pane, click **Traffic** > **Applications** tab.

The **Traffic** page > **Applications** tab displays the list of configured applications.
{% endstep %}

{% step %}
For the application that you want to delete, click the corresponding ⋮ (options) icon, then click **Delete**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FLJzvmuuHWOfwoiZCWSJ2%2Fimage.png?alt=media&amp;token=889a2751-8fb6-49c7-ad46-6d7a77507bb0" alt="" width="98"><figcaption></figcaption></figure>

A confirmation dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FIFDiRhAvnMvyWvbob7wV%2Fimage.png?alt=media&amp;token=6199c0db-a7db-4c18-b49d-40ed7e0beb33" alt="" width="378"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To confirm deleting the application, click **Yes**.
{% endstep %}
{% endstepper %}

## Manage Application Groups

{% hint style="info" %}
**NOTE:** In this release, Application Groups are supported only in 4G networks.
{% endhint %}

{% hint style="info" %}
**NOTE:** You can create and manage application groups only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

Application groups allow you to group applications together based on their common characteristics, such as similar resource usage patterns. These groups can be used as match criteria to optimize the allocation of network resources to different application groups. For instance, you could create a "Monitoring Application Group" that contains multiple monitoring applications.

### View Application Groups

**To view application groups configured in the network:**

{% stepper %}
{% step %}
In the navigation pane, click **Traffic** > **Application Groups** tab.

The **Traffic** page > **Application Groups** tab displays the list of configured application groups.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FnnxTqPgSUiuPCrJ2AoFF%2Fimage.png?alt=media&amp;token=a1932119-ff67-4053-8210-df339fca6902" alt=""><figcaption></figcaption></figure>

* **Name** – The application group's name.
* **Application** – The applications associated with the application group.
* **Downlink BW (Mbps)**
  * **Max** – The maximum bandwidth allocated to traffic flows originating from the network or internet and traveling towards a UE. Any packets arriving at the bearer after this limit is exceeded will be discarded.
  * **Guaranteed** – The minimum bandwidth allocated to traffic flows originating from the network or internet and traveling towards a UE.
* **Uplink BW (Mbps)**
  * **Max** – The maximum bandwidth allocated to traffic flows originating from a UE and traveling towards the network or internet. Any packets arriving at the bearer after this limit is exceeded will be discarded.
  * **Guaranteed** – The guaranteed/minimum bandwidth that will be allocated to traffic flows originating from a UE and traveling towards the network or internet.
* **QoS Category** – The application group's QoS category, which specifies the QoS policy for the bearer associated with this application group—Live Audio, Live Video, Real-time Applications, High Priority Data, or Custom. For more information see *QoS Categories*.
* **QCI** – (Displayed only for custom QoS categories.) The QoS Class Identifier assigned to the application group.
* **Pre-emption**
  * **Priority (ARP)** – (Displayed only for custom QoS categories.) The priority level of the bearer associated with this application group relative to other bearers in the network. On a congested cell, it determines the priority of a new bearer setup request—whether to release an established bearer with a lower priority to make way for the new bearer, or to reject the new bearer setup request. Higher priority bearers, indicated by higher ARP values, are less likely to be released in favor of lower priority bearers. Preemption priority ensures that critical services, such as real-time applications, receive preferential treatment, maintaining QoS during periods of network congestion.
  * **Vulnerability** – (Displayed only for custom QoS categories.) Indicates whether, during periods of network congestion, the bearer associated with this application group can be released to make way for a new bearer with a higher priority.
  * **Capability** – (Displayed only for custom QoS categories.) Indicates whether, during periods of network congestion, establishment of the bearer associated with this application group could lead to the release of an established bearer with a lower priority.
* **Actions** – (GXC Administrators, GXC Partner Administrators, Super Administrators, and Administrators only.) Options to edit and delete application groups.
  {% endstep %}
  {% endstepper %}

### Create Application Groups

{% hint style="info" %}
**NOTE:** You can create application groups only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

**To create an application group:**

{% stepper %}
{% step %}
In the navigation pane, click **Traffic** > **Application Groups** tab.

The **Traffic** page > **Application Groups** tab displays the list of configured application groups.
{% endstep %}

{% step %}
In the upper-right area of the page, click **Add Application Group**.

The **Add Application Group** page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fd5lrPnCLtdEi8mZN8HTc%2Fimage.png?alt=media&amp;token=df65cf9f-79fa-40ba-84c0-4ff725822547" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details:

* **Application Group Name** – (Required) The application group's ID. It can be an alphabetic, numeric, or alphanumeric string of up to 32 characters.
* **Applications** – (Required) Click to select the applications to add to the group.

{% hint style="info" %}
**NOTE:** You can associate a maximum of 15 applications with an application group.
{% endhint %}

* **Downlink Max BW (Mbps)** – (Required) The maximum bandwidth that will be allocated to traffic flows originating from the network or internet and traveling towards a UE. Any packets arriving at the bearer after this limit is exceeded will be discarded. Default value: 100 Mbps.
* **Uplink Max BW (Mbps)** – (Required) The maximum bandwidth that will be allocated to traffic flows originating from a UE and traveling towards the network or internet. Any packets arriving at the bearer after this limit is exceeded will be discarded. Default value: 100 Mbps.
* **Guaranteed BW** – To reserve bandwidth for the bearer associated with this application group, select the **Guaranteed BW** check box. This parameter decides if the bearer is a GBR bearer or a non-GBR bearer. Default setting: Selected (GBR bearer).

  * **Downlink Guaranteed BW (Mbps)** – (Displayed only if the **Guaranteed BW** check box is selected.) The guaranteed/minimum bandwidth that will be allocated to traffic flows originating from the network or internet and traveling towards a UE. Default value: 10 Mbps.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> <strong>Downlink Guaranteed BW</strong> must always be less than or equal to <strong>Downlink Max BW</strong>.</p></div>

  * **Uplink Guaranteed BW (Mbps)** – (Displayed only if the **Guaranteed BW** check box is selected.) The guaranteed/minimum bandwidth that will be allocated to traffic flows originating from a UE and traveling towards the network or internet. Default value: 10 Mbps.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> <strong>Uplink Guaranteed BW</strong> must always be less than or equal to <strong>Uplink Max BW</strong>.</p></div>

  Note the maximum possible GBR values for downlink and uplink based on the Subframe Assignment and Primary Cell Channel Bandwidth.

  <table><thead><tr><th valign="top">Bandwidth of the Primary Carrier</th><th valign="top">Subframe Assignment</th><th valign="top">GBR Downlink (Mbps)</th><th valign="top">GBR Uplink (Mbps)</th></tr></thead><tbody><tr><td valign="top">20 MHz +</td><td valign="top">2</td><td valign="top">28</td><td valign="top">3</td></tr><tr><td valign="top">10 MHz</td><td valign="top">2</td><td valign="top">14</td><td valign="top">1.5</td></tr><tr><td valign="top">20 MHz +</td><td valign="top">6</td><td valign="top">16</td><td valign="top">8</td></tr><tr><td valign="top">10 MHz</td><td valign="top">6</td><td valign="top">8</td><td valign="top">4</td></tr></tbody></table>
* **QoS Category** – (Required) Click to select the application group's QoS category. The QoS category specifies the QoS policy for the application group. For more information including the QoS parameters configured per category, see *QoS Categories*.
  * **Live Audio** – This category is suitable for applications and services that require real-time transmission of audio data. It ensures low latency and minimal jitter to maintain the real-time nature of the audio stream.
  * **Live Video** – This category is suitable for applications and services that involve real-time transmission of video data, such as video conferencing, live streaming, or remote surveillance. It prioritizes low latency and stable throughput to support smooth video playback and minimize buffering.
  * **Real-time Applications** – This category is suitable for applications and services (other than audio and video) that require real-time responsiveness and low latency, such as remote desktop applications. It provides a balance between low latency and efficient resource utilization.
  * **High Priority Data** – This category is suitable for applications and services that require high-priority treatment with moderate latency, while still maintaining a high level of reliability to support time-sensitive operations. Examples include control signals for industrial automation systems and telemetry data in IoT deployments.
  * **Custom** – The custom category allows for the creation of tailored QoS policies based on the needs of specific applications, services, or subscriber groups.

    <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FV7vRfjgmeIcERBKkfC06%2Fimage.png?alt=media&amp;token=6252d195-c086-4875-890b-ef0d8a798ac0" alt=""><figcaption></figcaption></figure>
* **QCI** – (Displayed only if the **QoS Category** is **Custom**. Required.) Select the QoS Class Identifier.

  (If the **Guaranteed BW** check box is selected.) For GBR bearer configuration, select from QCI 1 to QCI 4. Each QCI is assigned a standard Packet Delay Budget and Packet Error Rate. Default value: QCI=1.

  * QCI=1 (PDB=100, PER=10^-2)
  * QCI=2 (PDB=150, PER=10^-3)
  * QCI=3 (PDB=50, PER=10^-3)
  * QCI=4 (PDB=300, PER=10^-6)

  (If the **Guaranteed BW** check box is cleared.) For non-GBR bearer configuration, select from QCI 5 to QCI 9. Default value: QCI=5.

  * QCI=5 (PDB=100, PER=10^-6)
  * QCI=6 (PDB=300, PER=10^-6)
  * QCI=7 (PDB=100, PER=10^-3)
  * QCI=8 (PDB=300, PER=10^-6)
  * QCI=9 (PDB=300, PER=10^-6)
* **Pre-emption Priority (ARP)** – (Displayed only if the **QoS Category** is **Custom**. Required.) The priority level of the bearer associated with this application group relative to other bearers in the network. On a congested cell, it determines the priority of a new bearer setup request—whether to release an established bearer with a lower priority to make way for the new bearer, or to reject the new bearer setup request. Higher priority bearers, indicated by higher ARP values, are less likely to be released in favor of lower priority bearers. Preemption priority ensures that critical services, such as real-time applications, receive preferential treatment, maintaining QoS during periods of network congestion. Default value: 2.
* **Pre-emption Vulnerability** – (Displayed only if the **QoS Category** is **Custom**.) Enable or disable ARP preemption vulnerability. Specifies whether, during periods of network congestion, the bearer associated with this application group can be released to make way for a new bearer with a higher priority. To enable preemption vulnerability, turn on the toggle button. Default setting: disabled.

{% hint style="info" %}
**NOTE:** The Pre-emption Vulnerability configuration is available only for trials in this release. Keep it disabled. For more information, contact GXC Technical Support.
{% endhint %}

* **Pre-emption Capability** – (Displayed only if the **QoS Category** is **Custom**.) Enable or disable ARP preemption capability. Specifies whether, during periods of network congestion, establishment of the bearer associated with this application group can lead to the release of an established bearer with a lower priority. To enable preemption capability, turn on the toggle button. Default setting: disabled.

{% hint style="info" %}
**NOTE:** The Pre-emption Capability configuration is available only for trials in this release. Keep it disabled. For more information, contact GXC Technical Support.
{% endhint %}
{% endstep %}

{% step %}
To save the application group, in the lower-right corner of the page, click **Save Application Group**.

{% endstep %}
{% endstepper %}

### Edit Application Groups

{% hint style="info" %}
**NOTE:** You can edit application groups only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

**To edit an application group:**

{% stepper %}
{% step %}
In the navigation pane, click **Traffic** > **Application Groups** tab.

The **Traffic** page > **Application Groups** tab displays the list of configured application groups.
{% endstep %}

{% step %}
For the application group that you want to edit, in the **Actions** column click the corresponding ⋮ (options) icon, then click **Edit**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FlCYgcrIfOVR4oOyyXe2V%2Fimage.png?alt=media&amp;token=09acd576-4070-4252-a34c-db6ae1b8246f" alt="" width="104"><figcaption></figcaption></figure>

The **Edit Application Group** page displays the application group's details.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FvFrYDZ7GJ2DS2ee2cj9w%2Fimage.png?alt=media&amp;token=fe0fcffa-e8bc-44b6-b5c0-ab2ae6644f8a" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Edit the following details as required:

* **Name** – (Required) The application group's name.
* **Applications** – (Required) Click to add or remove applications from the group— select or clear the corresponding check boxes.

{% hint style="info" %}
**NOTE:** You can associate a maximum of 15 applications with an application group.
{% endhint %}

* **Downlink Max BW (Mbps)** – (Required) The maximum bandwidth that will be allocated to traffic flows originating from the network or internet and traveling towards a UE. Any packets arriving at the bearer after this limit is exceeded will be discarded. Default value: 100 Mbps.
* **Uplink Max BW (Mbps)** – (Required) The maximum bandwidth that will be allocated to traffic flows originating from a UE and traveling towards the network or internet. Any packets arriving at the bearer after this limit is exceeded will be discarded. Default value: 100 Mbps.
* **Guaranteed BW** – To reserve bandwidth for the application group, select the **Guaranteed BW** check box. This parameter decides if the bearer is a GBR bearer or a non-GBR bearer. Default setting: selected (GBR bearer).

  * **Downlink Guaranteed BW (Mbps)** – (Displayed only if the **Guaranteed BW** check box is selected.) The guaranteed/minimum bandwidth that will be allocated to traffic flows originating from the network or internet and traveling towards a UE. Default value: 10 Mbps.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> <strong>Downlink Guaranteed BW</strong> must always be less than or equal to <strong>Downlink Max BW</strong>.</p></div>

  * **Uplink Guaranteed BW (Mbps)** – (Displayed only if the **Guaranteed BW** check box is selected.) The guaranteed/minimum bandwidth that will be allocated to traffic flows originating from a UE and traveling towards the network or internet. Default value: 10 Mbps.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> <strong>Uplink Guaranteed BW</strong> must always be less than or equal to <strong>Uplink Max BW</strong>.</p></div>

  Note the maximum possible GBR values for downlink and uplink based on the Subframe Assignment and Primary Cell Channel Bandwidth.

  <table><thead><tr><th valign="top">Bandwidth of the Primary Carrier</th><th valign="top">Subframe Assignment</th><th valign="top">GBR Downlink (Mbps)</th><th valign="top">GBR Uplink (Mbps)</th></tr></thead><tbody><tr><td valign="top">20 MHz +</td><td valign="top">2</td><td valign="top">28</td><td valign="top">3</td></tr><tr><td valign="top">10 MHz</td><td valign="top">2</td><td valign="top">14</td><td valign="top">1.5</td></tr><tr><td valign="top">20 MHz +</td><td valign="top">6</td><td valign="top">16</td><td valign="top">8</td></tr><tr><td valign="top">10 MHz</td><td valign="top">6</td><td valign="top">8</td><td valign="top">4</td></tr></tbody></table>
* **QoS Category** – (Required) Click to select the application group's QoS category. The QoS category specifies the QoS policy for the application group. For more information including the QoS parameters configured per category, see *QoS Categories*.
  * **Live Audio** – This category is suitable for applications and services that require real-time transmission of audio data. It ensures low latency and minimal jitter to maintain the real-time nature of the audio stream.
  * **Live Video** – This category is suitable for applications and services that involve real-time transmission of video data, such as video conferencing, live streaming, or remote surveillance. It prioritizes low latency and stable throughput to support smooth video playback and minimize buffering.
  * **Real-time Applications** – This category is suitable for applications and services (other than audio and video) that require real-time responsiveness and low latency, such as remote desktop applications. It provides a balance between low latency and efficient resource utilization.
  * **High Priority Data** – This category is suitable for applications and services that require high-priority treatment with moderate latency, while still maintaining a high level of reliability to support time-sensitive operations. Examples include control signals for industrial automation systems and telemetry data in IoT deployments.
  * **Custom** – The custom category allows for the creation of tailored QoS policies based on the needs of specific applications, services, or subscriber groups.

    <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0fHg4AjRghCN0dFUEexT%2Fimage.png?alt=media&amp;token=03413c3d-5f8d-47a5-95be-2b3724077695" alt=""><figcaption></figcaption></figure>
* **QCI** – (Displayed only when the **Custom** QoS category is selected. Required.) Select the QoS Class Identifier.

  (If the **Guaranteed BW** check box is selected.) For GBR bearer configuration, select from QCI 1 to QCI 4. Each QCI is assigned a standard Packet Delay Budget and Packet Error Rate. Default value: QCI=1.

  * QCI=1 (PDB=100, PER=10^-2)
  * QCI=2 (PDB=150, PER=10^-3)
  * QCI=3 (PDB=50, PER=10^-3)
  * QCI=4 (PDB=300, PER=10^-6)

  (If the **Guaranteed BW** check box is cleared.) For non-GBR bearer configuration, select from QCI 5 to QCI 9. Default value: QCI=5.

  * QCI=5 (PDB=100, PER=10^-6)
  * QCI=6 (PDB=300, PER=10^-6)
  * QCI=7 (PDB=100, PER=10^-3)
  * QCI=8 (PDB=300, PER=10^-6)
  * QCI=9 (PDB=300, PER=10^-6)
* **Pre-emption Priority (ARP)** – (Displayed only if the **QoS Category** is **Custom**. Required.) The priority level of the bearer associated with this application group relative to the other bearers in the network. On a congested cell, it determines the priority of a new bearer setup request—whether to release an established bearer with a lower priority to make way for the new bearer, or to reject the new bearer setup request. Higher priority bearers, indicated by higher ARP values, are less likely to be released in favor of lower priority bearers. Preemption priority ensures that critical services, such as real-time applications, receive preferential treatment, maintaining QoS during periods of network congestion. Default value: 2.
* **Pre-emption Vulnerability** – (Displayed only if the **QoS Category** is **Custom**.) Enable or disable ARP preemption vulnerability. Specifies whether, during periods of network congestion, the bearer associated with this application group can be released to make way for a new bearer with a higher priority. To enable preemption vulnerability, turn on the toggle button. Default setting: disabled.

{% hint style="info" %}
**NOTE:** The Pre-emption Vulnerability configuration is available only for trials in this release. Keep it disabled. For more information, contact GXC Technical Support.
{% endhint %}

* **Pre-emption Capability** – (Displayed only if the **QoS Category** is **Custom**.) Enable or disable ARP preemption capability. Specifies whether, during periods of network congestion, establishment of the bearer associated with this application group can lead to the release of an established bearer with a lower priority. To enable preemption capability, turn on the toggle button. Default setting: disabled.

{% hint style="info" %}
**NOTE:** The Pre-emption Capability configuration is available only for trials in this release. Keep it disabled. For more information, contact GXC Technical Support.
{% endhint %}
{% endstep %}

{% step %}
To save your edits, click **Save Application Group**.
{% endstep %}
{% endstepper %}

### Delete Application Groups

{% hint style="info" %}
**NOTE:** You can delete application groups only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

**To delete an application group:**

{% stepper %}
{% step %}
In the navigation pane, click **Traffic** > **Application Groups** tab.

The **Traffic** page > **Application Groups** tab displays the list of configured application groups.
{% endstep %}

{% step %}
For the application group that you want to delete, in the **Actions** column click the corresponding ⋮ (options) icon, then click **Delete**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FGmpMHy5PsqrqbyJxhdCw%2Fimage.png?alt=media&amp;token=369e2993-8e62-414d-a4aa-9e78d50361d8" alt="" width="104"><figcaption></figcaption></figure>

A confirmation dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FunWBJghIXxAXKcIqil3f%2Fimage.png?alt=media&amp;token=250fd4bf-0676-44fb-a82e-91bba26a7efb" alt="" width="445"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To confirm deleting the application group, click **Yes**.
{% endstep %}
{% endstepper %}


# Manage Alerts

Alerts provide notifications about significant events within the network and are key to monitoring and debugging potential issues in your network in a timely fashion.

For example, you can configure an alert rule to notify when the CPU percentage on the gateway is running > 75% in the last five minutes. Or, for example, when more than three Onyx Edge services restarted in the last one hour.

## Alert Notifications

The Onyx Portal provides alert notifications via the Active Alerts Counters panel and email notifications.

### Active Alert Counters Panel

The Active Alert Counters panel in the header area displays the count of active Critical, Major, Minor, and Other alerts. The "Other" category accounts for alerts of Warning, Info, and Notice severities.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8TYbfB5jW69sdJ0xdVUK%2Fimage.png?alt=media&amp;token=9c8ba49e-af4c-4e8a-98b2-f9960fccb42b" alt="" width="179"><figcaption></figcaption></figure>

To view the active alerts, click the panel.

The **Active Alerts** page displays summary details of active alerts.

For more information, see [*View Active Alerts*](#view-active-alerts).

### Alert Email Notifications

The Onyx Portal sends alert notification emails when an alert is triggered, every one hour until the alert gets cleared, and when the alert finally gets cleared.

{% hint style="info" %}
**NOTE:** The alert notification emails are only sent to receivers configured to receive alert notifications for specified alert severity levels. For more information, see *Manage Alert Receiver Accounts*.
{% endhint %}

The alert notification emails use the following format for their subject lines:

"Alert Notifications | *\<alert severity level>* | *\<customer name>*"

The body of the alert notification emails include the following details:

* **Time Zone** – The timestamp at which the alert was generated or cleared, and the time zone of the venue where the alert was generated or cleared.
* **Alert Duration** – The duration for which the alert has remained active.
* **Network Name** – The network's name.
* **Alert Name** – The alert's name.
* **Equipment Name** – The alert's source (AP, Mesh Node, or Onyx Edge equipment's name) linking to the Onyx Portal equipment details page.
* Link to the Onyx Portal Alerts page—<https://portal.gxc.io/#/alert/alerts.>

## View Active Alerts

Active alerts are alerts that have been triggered but not yet cleared and still require attention. The Active Alerts view displays all currently active instances of all alerts.

The Active Alerts view is auto-refreshed every one minute.

**To view active alerts' details:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts**.

The **Alerts** page > **Active Alerts** tab displays the list of active alert instances.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fnnnk7WMf3ZF6DNyc9Dvy%2Fimage.png?alt=media&amp;token=6d9365fa-4803-48f7-83eb-3d45d9db956c" alt=""><figcaption></figcaption></figure>

* **Start Time** – The timestamp at which the alert was triggered.\
  To sort the list by start time, click the column header.
* **Duration** – The duration for which the alert is active.
* **Severity** – The alert's severity level—Critical, Major, Minor, Warning, Info, Notice.\
  To sort the list by severity, click the column header.
* **ID** – The alert's ID used to identify the alert. This is a fixed ID that third-party tooling can use to identify the alerts. The alert ID is comprised of *\<alert type>* *\<module ID>*.
* **Type** – The alert's type used to identify the problem source or type—Access Point, Mesh Node, Onyx Edge, Orchestrator, Provisioning Server.
* **Module** – The associated module.
  * Management Plane – Relating to equipment configuration and communicating the configuration to the device. Module ID: 01.
  * Control Plane – Relating to protocol operations of the equipment for control plane. Module ID: 02.
  * User Plane – Relating to protocol operations of the equipment for user plane. Module ID: 03.
  * Platform – Relating to functioning of the equipment. Module ID: 04.
  * CU Plane – Relating to either or both control and user plane. Module ID: 05.
  * MCU Plane – Relating to either or all of Management, Control, User Plane. Module ID: 06.
  * Domain Proxy – Relating to Domain Proxy. Module ID: 07.
* **Name** – The alert's name.\
  To view an alert's details, click the alert's name.\
  To sort the list by alert names, click the column header.
* **Device ID** – The associated device's ID.
* **Description** – The alert's description.
* **Instance ID** – The alert's instance ID, which differentiates between multiple instances of the same alert.
* **Mute Alert** – While investigating an active alert, mute or unmute an active alert instance to suppress or enable the hourly alert email notifications for that specific alert instance.

  To mute an alert instance to stop alert email notifications, turn on the toggle button. To resume the alert email notifications, unmute the alert instance by turning off the toggle button.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> This mute/unmute configuration is alert instance specific. If necessary, any new or other instances of an alert must be explicitly muted/unmuted.</p></div>

{% endstep %}

{% step %}
To view an alert's details, in the alerts list, click the alert's name.

The ***\<alert name>*** dialog box displays the alert's details.
{% endstep %}

{% step %}
To sort the list by alert creation timestamp, click the **Start Time** column header.
{% endstep %}

{% step %}
To sort the list by alert severity level, click the **Severity** column header.
{% endstep %}
{% endstepper %}

## View Cleared Alerts

Cleared alerts are alerts that were previously active but have subsequently been cleared either by user intervention or automatically by the system.

{% hint style="info" %}
**NOTE:** The cleared alerts history is available only for alerts cleared in the last seven days and lists only the most recent 1000 cleared alerts.
{% endhint %}

{% hint style="info" %}
**NOTE:** The Cleared Alerts view auto-refreshes every one minute.
{% endhint %}

**To view cleared alerts' details:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Cleared Alerts** tab.

The **Alerts** page > **Cleared Alerts** tab displays the list of alerts cleared in the selected time duration.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FRzFJ4sXHKIUhqW4lZYQG%2Fimage.png?alt=media&amp;token=7895025f-84ac-4e1a-9b26-e622ed3a9c9e" alt=""><figcaption></figcaption></figure>

* **Start Time** – The timestamp at which the alert was triggered.\
  To sort the list by start time, click the column header.
* **Duration** – The duration for which the alert was active.\
  To sort the list by duration, click the column header.
* **Severity** – The alert's severity level—Critical, Major, Minor, Warning, Info, Notice.\
  To sort the list by severity, click the column header.
* **ID** – The alert's ID used to reference the alert.

  To search for cleared alerts by alert ID, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Ft1D9DKtZfgY8EreLktwR%2Fimage.png?alt=media&amp;token=91bfd85f-025c-4b9c-85f0-936692a56429" alt="" data-size="line"> (filter), then in the Search box, enter the alert ID.
* **Type** – The alert's type—Onyx Edge, Access Point, Provisioning Server, etc.

  To search for cleared alerts by alert type, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Ft1D9DKtZfgY8EreLktwR%2Fimage.png?alt=media&amp;token=91bfd85f-025c-4b9c-85f0-936692a56429" alt="" data-size="line"> (filter), then in the Search box, enter the alert type.
* **Module** – The associated module—Platform, Management Plane, MCU Plane, etc.

  To search for cleared alerts by associated module, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Ft1D9DKtZfgY8EreLktwR%2Fimage.png?alt=media&amp;token=91bfd85f-025c-4b9c-85f0-936692a56429" alt="" data-size="line"> (filter), then in the Search box, enter the module name.
* **Name** – The alert's name.

  To search for cleared alerts by alert name, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Ft1D9DKtZfgY8EreLktwR%2Fimage.png?alt=media&amp;token=91bfd85f-025c-4b9c-85f0-936692a56429" alt="" data-size="line"> (filter), then in the Search box, enter the alert name.\
  To sort the list by alert names, click the column header.
* **Device ID** – The associated device ID.

  To search for cleared alerts by device ID, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Ft1D9DKtZfgY8EreLktwR%2Fimage.png?alt=media&amp;token=91bfd85f-025c-4b9c-85f0-936692a56429" alt="" data-size="line"> (filter), then in the Search box, enter the device ID.
* **Description** – The alert's description.
* **Instance ID** – The alert's instance ID, which differentiates between multiple instances of the same alert.

  To search for cleared alerts by instance ID, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Ft1D9DKtZfgY8EreLktwR%2Fimage.png?alt=media&amp;token=91bfd85f-025c-4b9c-85f0-936692a56429" alt="" data-size="line"> (filter), then in the Search box, enter the instance ID.
  {% endstep %}

{% step %}
To change the duration for which the cleared alerts are displayed, change the selected from and to timestamps <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FxWALuDcEi4YmeOnNgAWR%2Fimage.png?alt=media&amp;token=5719b02d-4073-41ad-98cb-6abaed30b751" alt="" data-size="line">.
{% endstep %}

{% step %}
To sort the alerts list by alert creation timestamp, click the **Start Time** column header.
{% endstep %}
{% endstepper %}

## Manage Muting Alerts

Muting alerts involves suspending the alert email notifications sent by the Onyx system. Typically, alerts are muted to prevent unnecessary alert email notifications during planned maintenance and other situations where the alerts may not require immediate attention.

Alerts can be muted at the following levels:

* **Active Alert Instance Level** – Muting and unmuting active alert instances allows you to suppress and enable alert email notifications for specific active instances of an alert. For more information, see [*Mute/Unmute Specific Instances of Active Alerts*](#mute-unmute-specific-instances-of-active-alerts).
* **Alert Rule Level** – Muting and unmuting alerts per alert rule allows to suppress and enable alert email notifications for all alerts generated by individual alert rules. For more information, see [*Mute/Unmute Alerts per Alert Rule*](#mute-unmute-alerts-per-alert-rule).

### View Muted Alerts

**To view muted alerts:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Muted Alerts** tab.

The **Alerts** page > **Muted Alerts** tab displays the list of muted alerts.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FEnxeGVsfl8A4yUh72Su4%2Fimage.png?alt=media&amp;token=8ff4c4e3-d1f2-4f29-aa3d-fcddcf48f0e9" alt=""><figcaption></figcaption></figure>

* <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fw6h0VtWN6bWm46Y2szpp%2Fimage.png?alt=media&amp;token=43926875-f7ae-46fe-bafc-e557b542a130" alt="" data-size="line"> (checkbox) – Select/clear all or specific alerts.
* **Type** – The alert's type—Access Point, Mesh Node, Onyx Edge, Orchestrator.
* **Name** – The alert's name.
* **Devices** – The device names for which an alert is muted.
* **Actions** – Options to edit and delete a muted alert rule.
  {% endstep %}
  {% endstepper %}

### Mute/Unmute Active Alert Instances

Muting and unmuting active alert instances allows you to suppress or enable alert email notifications for specific active instances of an alert.

You can mute alert email notifications for a specific alert either for all equipment or only for specific equipment. For example, you can mute alert notifications for the "Offline" and "Cell Service Down" alerts for a specific AP or for all APs in the network.

#### Mute Active Alerts

{% hint style="info" %}
**NOTE:** You can mute active alert notifications only if you are a GXC Administrator.
{% endhint %}

You can either mute:

* All alert notifications for a specific alert.
* Alert notifications for a specific alert either for all equipment or only for specific equipment. For example, you can mute alert notifications for the "Offline" and "Cell Service Down" alerts for a specific AP or for all APs in the network.

#### Create Alert Mute Rules

**To create an alert mute rule:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Muted Alerts** tab.

The **Alerts** page > **Muted Alerts** tab displays the list of muted alerts.
{% endstep %}

{% step %}
Click **Mute New Alerts**.

The **Add Mute Rule** dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FB809K7TzdV2t4p4QLrqj%2Fimage.png?alt=media&amp;token=9dd1aba0-d47f-4969-a35f-c4cfa9bbcad5" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
In the **Select Alert Type** dropdown, select the alert type from **Onyx Edge**, **Access Point**, **Orchestrator**, **Mesh Node**.

The list of alerts related to the selected alert type is displayed.
{% endstep %}

{% step %}
In the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FDytyerSSVtss94qVFcdq%2Fimage.png?alt=media&amp;token=eaebcc33-afd8-41dc-9c4b-28a51084d266" alt="" data-size="line"> (select/clear) column, select the alert that you want to mute.
{% endstep %}

{% step %}
(Applicable only to Onyx Edge, Access Point, and Mesh Node alert types.) To mute the selected alert for specific equipment, in the **Device List** column, click the corresponding **Select Devices** dropdown, and select the specific equipment.

To mute alert notifications for all equipment, select **Select All**.
{% endstep %}

{% step %}
Select any other alerts to mute and select the required equipment.
{% endstep %}

{% step %}
To save your edits, click **Submit**.
{% endstep %}
{% endstepper %}

#### Edit Alert Mute Rules

{% hint style="info" %}
**NOTE:** You can edit alert mute rules only if you are a GXC Administrator.
{% endhint %}

**To edit alert mute rules:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Muted Alerts** tab.

The **Alerts** page > **Muted Alerts** tab displays the list of muted alerts.
{% endstep %}

{% step %}
For the alert mute rule that you want to edit, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FDTBoeE53BsB08N84Ne86%2Fimage.png?alt=media&amp;token=f7f807ed-4e12-4eef-ba79-4775e05ad1a9" alt="" width="104"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
In the **Devices** column, select or clear the devices for which the alert is muted.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FZt6CBt8ztxejZmxxyXOO%2Fimage.png?alt=media&amp;token=e3dd3f4f-4fd9-41c8-b57a-b2a8eeb8adbf" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To save your edits, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FpkTDXoJfs12jJTBGkzRX%2Fimage.png?alt=media&amp;token=388269cc-c17b-418b-ad6e-13a6083b114a" alt="" data-size="line">.
{% endstep %}
{% endstepper %}

#### Delete Alert Mute Rules

{% hint style="info" %}
**NOTE:** You can delete alert mute rules only if you are a GXC Administrator.
{% endhint %}

**To delete alert mute rules:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Muted Alerts** tab.

The **Alerts** page > **Muted Alerts** tab displays the list of muted alerts.
{% endstep %}

{% step %}
For the alert mute rule(s) that you want to delete, in the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FutRumAKVILeEsprdlzEm%2Fimage.png?alt=media&amp;token=658728c2-4dbc-4a7c-82aa-7ef22dcdc665" alt="" data-size="line"> (select/clear) column, select the rule(s), then click **Delete**.

Alternately, to delete a particular alert mute rule, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Delete**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FcBWZVzdhTIzZSdzCabLB%2Fimage.png?alt=media&amp;token=01cd8e6e-2c83-4d10-80f9-30de790f8a4f" alt="" width="104"><figcaption></figcaption></figure>

A confirmation dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FlgxXP0LSgk35yZUgj3lf%2Fimage.png?alt=media&amp;token=ecaca735-9e68-4b91-af1a-01afbbd5ddf5" alt="" width="511"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To confirm the deletion, click **Yes**.
{% endstep %}
{% endstepper %}

### Mute/Unmute Specific Instances of Active Alerts

Muting and unmuting alert instances allows you to suppress or enable alert email notifications for specific instances of an active alert. This allows to silence an alert's individual instance instead of silencing the entire alert providing more granular control over the alerting process.

{% hint style="info" %}
**NOTE:** This mute/unmute configuration is alert instance specific. If necessary, any new or other instances of an alert must be explicitly muted/unmuted.
{% endhint %}

#### Mute Specific Instance of an Active Alert

**To mute an alert's instance:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Active Alerts** tab.

The **Alerts** page > **Active Alerts** tab displays the list of active alert instances.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fui88bUNXFcUiMEepzw5H%2Fimage.png?alt=media&amp;token=f5e051b4-a846-49e4-99d5-97a6df2a56e0" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
For the alert instance that you want to mute, in the **Mute Alert** column, turn on the corresponding toggle switch.

The **Mute&#x20;*****\<alert type> \<alert name>*****&#x20;Alert** dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FxvV7QXzFvtJFf6ndfUWq%2Fimage.png?alt=media&amp;token=d05eecf4-0621-4c7e-9f24-7bff6b6f0de5" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
In the **Select a Time Duration** dropdown, select the duration for which the alert instance must remain muted from **Twenty Four Hours**, **One Week**, **Forever**.
{% endstep %}

{% step %}
To save your changes, click **Submit**.
{% endstep %}
{% endstepper %}

#### Unmute Specific Instance of an Active Alert

**To unmute an alert's instance:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Active Alerts** tab.

The **Alerts** page > **Active Alerts** tab displays the list of active alert instances.
{% endstep %}

{% step %}
For the alert instance that you want to unmute, in the **Mute Alert** column, turn off the corresponding toggle switch.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F9AKRYsFHugW3ymzv5L4Y%2Fimage.png?alt=media&amp;token=63d07558-e287-4c66-9b31-68922de528fa" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To save your change, click **Submit**.
{% endstep %}
{% endstepper %}

### Mute/Unmute Alerts per Alert Rule

Muting and unmuting alerts per alert rule allows you to suppress or enable alert email notifications for any alerts generated by individual alert rules. Muting or unmuting alerts per alert rule enables you to receive notifications only for the most relevant alerts, offering more granular control over the alerting process.

#### Mute Alert Notifications per Custom Alert Rule

{% hint style="info" %}
**NOTE:** You can disable or enable alert notifications for custom alert rules only if you are a GXC Administrator.
{% endhint %}

**To disable or enable alert notifications for a custom alert rule:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Alert Rules** tab.

The **Alerts** page > **Alert Rules** tab is displayed.

The **Custom Alerts** section lists the custom alert rules.

{% hint style="info" %}
**NOTE:** The **Custom Alerts** section is displayed only if at least one custom alert rule exists.
{% endhint %}
{% endstep %}

{% step %}
For the custom alert rule that you want to disable or enable alert notifications for, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.
{% endstep %}

{% step %}
Under **Notifications**:

* To disable alert notifications, clear the **Enable Email Notification** checkbox.
* To enable alert notifications, select the **Enable Email Notification** checkbox.
  {% endstep %}

{% step %}
To save your edit, in the upper-right corner of the page, click **Save Rule**.
{% endstep %}
{% endstepper %}

#### Mute Alert Notifications per Predefined Alert Rule

{% hint style="info" %}
**NOTE:** You can disable or enable alert notifications for predefined alert rules only if you are a GXC Administrator.
{% endhint %}

**To disable or enable alert notifications for a predefined alert rule:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Alert Rules** tab.

The **Alerts** page > **Alert Rules** tab is displayed. The **Predefined Alerts** section lists the predefined alert rules.
{% endstep %}

{% step %}
In the **Predefined Alerts** section, for the predefined alert rule that you want to disable or enable alert notifications for, in the **Notifications** column, click the toggle button to enable or disable notifications.

A confirmation dialog box is displayed.
{% endstep %}

{% step %}
To confirm your change, click **Yes**.
{% endstep %}
{% endstepper %}

## Manage Alert Rules

An alert rule specifies the criteria of a condition based on Prometheus Query Language expressions. When the condition becomes true, an alert is triggered, which changes the state of the alert to active, and initiates an alert notification. As long as an alert is active, an alert notification is sent every one hour until the alert gets cleared. When the condition becomes false, the state of the alert changes to resolved, which clears the alert and initiates an alert notification.

The Onyx Portal supports alert rules of two types—predefined and custom.

Predefined alert rules are provided pre-configured with the Onyx Solution, and can be created, edited, and deleted only by GXC.

Custom alert rules are specific to each network. You can create and manage custom alert rules only if you are a GXC Administrator.

### View Alert Rules

**To view available predefined and custom alert rules:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Alert Rules** tab.

The **Alerts** page > **Alert Rules** tab displays predefined and custom alert rule lists.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FWNKsdEAf7rnUrpyj3Y54%2Fimage.png?alt=media&amp;token=236c1cde-3880-4857-baf1-42a98e02fab5" alt=""><figcaption></figcaption></figure>

* **Predefined Alerts**
  * **ID** – The alert rule's ID.
  * **Type** – The alert rule's type—Access Point, Mesh Node, Onyx Edge, Orchestrator, and Provisioning Server.
  * **Module** – The alert rule's module—Control Plane, CU Plane, Domain Proxy, Platform, Management Plane, MCU Plane.
  * **Name** – The alert rule's name.\
    To sort the list by alert name, click the column header.
  * **Severity** – The alert rule's severity classification—Critical, Major, Minor, Warning, Info, Notice.\
    To sort the list by severity, click the column header.
  * **Description** – The alert rule's description.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FzIs7uEpewqbdjiQAqviw%2Fimage.png?alt=media&amp;token=6c7b8e30-d800-466e-82e4-cad791d29e6b" alt="" data-size="line"> (view details) – Click to view the alert rule's details, including its PromQL expression and labels.
* **Custom Alerts**

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The <strong>Custom Alerts</strong> section is displayed only if at least one custom alert rule has been created.</p></div>
* **Name** – The alert rule's name.
* **Severity** – The alert rule's severity classification—Critical, Major, Minor, Warning, Info, Notice.
* **Description** – The alert rule's description.
* **Notifications** – Indicates whether email notification receivers are notified when the alert is triggered. For more information, see *Manage Alert Receiver Accounts*.
* **Actions** – Options to:
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FPeC7GQxKDCZJ8SFzAfaI%2Fimage.png?alt=media&amp;token=2c4ec244-080a-4c91-9d55-87b5ce32f672" alt="" data-size="line"> (view details) – Click to view the alert rule's details, including its PromQL expression and labels.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FWfhv71KNNoiCHga85xEe%2Fimage.png?alt=media&amp;token=1996b924-a6b7-43c3-8583-189e64e09ddc" alt="" data-size="line"> (edit) – (GXC Administrators only) Edit the alert rule.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FG1ohLQcgvCPPjhr0Pcsw%2Fimage.png?alt=media&amp;token=34d8a43d-7efd-4c79-88ad-63a9c1129a50" alt="" data-size="line"> (delete) – (GXC Administrators only) Delete the alert rule.
    {% endstep %}
    {% endstepper %}

### Predefined Alert Rules

{% hint style="info" %}
**NOTE:** The Onyx Portal includes predefined alert rules out of the box.
{% endhint %}

{% hint style="info" %}
**NOTE:** Only GXC can create, modify, and delete predefined alert rules.
{% endhint %}

{% hint style="info" %}
**NOTE:** Whenever a new network is created, the predefined alert rules are auto synchronized, and do not have to be synchronized manually.
{% endhint %}

{% hint style="info" %}
**NOTE:** For detailed information on predefined alert rules, refer to the *Onyx Portal 5G Alerts Reference*.
{% endhint %}

The following tables list the predefined alert rules supported in 5G networks.

**Access Point > Control Plane Alerts**

<table><thead><tr><th width="249.833251953125" valign="top">Alert</th><th width="109.833251953125" valign="top">Severity</th><th valign="top">Trigger and Clear Conditions</th></tr></thead><tbody><tr><td valign="top">Neighbor Tables Incomplete</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: Not all eligible neighbor gNBs could be populated in the Access Point's neighbor table, and this condition persists for at least 15 minutes while the Access Point remains connected for management.</p><p>Clear Condition: All eligible neighbor gNBs are successfully populated in the neighbor table.</p></td></tr></tbody></table>

**Access Point > CU-Plane Alerts**

<table><thead><tr><th width="249.833251953125" valign="top">Alert</th><th width="109.833251953125" valign="top">Severity</th><th valign="top">Trigger and Clear Conditions</th></tr></thead><tbody><tr><td valign="top">Cell Service Down</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: Cell is not transmitting for at least five minutes.</p><p>Clear Condition: Grant is either unavailable or unauthorized for the AP to transmit.</p></td></tr><tr><td valign="top">Insufficient SAS Power</td><td valign="top">Major</td><td valign="top">Trigger Condition: SAS has granted the CBSD(s) associated with this Access Point a maximum transmit power that is below the Access Point's configured hardware minimum power, and the AP has force-disabled transmission as a result.<br>Clear Condition: SAS grants a maximum transmit power at or above the AP's configured hardware minimum power.</td></tr><tr><td valign="top">Multiport Cell Service Down</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: Cell with Multiport Attach enabled is not transmitting for at least five minutes.</p><p>Clear Condition: Cell is transmitting again.</p></td></tr></tbody></table>

**Access Point > Domain Proxy Alerts**

<table data-header-hidden><thead><tr><th width="249.8333740234375" valign="top"></th><th width="109.833251953125" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">CBSD Lesser BW Granted</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: CBSD has been granted less bandwidth than is desired, and it continues to be in this state for at least five minutes.</p><p>Clear Condition: Any of the following:</p><p>- CBSD gets the desired bandwidth in a grant</p><p>- CBSD loses the grant</p></td></tr><tr><td valign="top">CBSD New Grant</td><td valign="top">Warning</td><td valign="top"><p>Trigger Condition: New grants have been received in the last one hour.</p><p>Clear Condition: No new grants for at least one hour.</p></td></tr><tr><td valign="top">CBSD Preferred Frequency Unavailable</td><td valign="top">Warning</td><td valign="top"><p>Trigger Condition: For SC/DC mode, none of the frequencies in the preferred list are available with SAS.</p><p>For CA mode, no non-overlapping frequency pair from the preferred list is available with SAS.</p><p>Clear Condition: Any of the following:</p><p>- Preferred frequencies are available again</p><p>- CBSD is deregistered</p></td></tr><tr><td valign="top">CBSD Registration Failure</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: CBSD registrations have failed within the past hour.</p><p>Clear Condition: No CBSD registrations have failed for at least an hour.</p></td></tr></tbody></table>

**Access Point > Management Plane Alerts**

<table data-header-hidden><thead><tr><th width="249.833251953125" valign="top"></th><th width="109.833251953125" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Offline</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: No M-Plane messages have been received for the past 10 minutes (5 minutes in alert condition + 5 minutes for changing the metric). This can happen for example due to AP being powered off.</p><p>Clear Condition: M-Plane connection with the AP is reestablished.</p></td></tr></tbody></table>

**Access Point > MCU-Plane Alerts**

<table data-header-hidden><thead><tr><th width="249.8333740234375" valign="top"></th><th width="109.833251953125" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Cell Unwarranted Transmission</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: When even though transmission is disabled, an AP cell transmits for at least five minutes.</p><p>Clear Condition: When the cell stops transmission.</p></td></tr><tr><td valign="top">Mesh Filter-Frequency Mismatch</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: The Mesh Node's filter configuration and the attached AP's frequency are mismatched, and this condition persists for at least five minutes.</p><p>Clear Condition: The Mesh Node's filter configuration and the AP's frequency are aligned again.</p></td></tr></tbody></table>

**Access Point > S-Plane Alerts**

<table data-header-hidden><thead><tr><th width="249.8333740234375" valign="top"></th><th width="109.8333740234375" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Timing Out of Sync</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: The PTP lock is not obtained by the 5G AP.</p><p>Clear Condition: The AP receives PTP signal and syncs up with it.</p></td></tr></tbody></table>

**FHM > Management Plane Alerts**

<table data-header-hidden><thead><tr><th width="249.833251953125" valign="top"></th><th width="109.833251953125" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Offline</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: No M-Plane messages have been received for the past 15 minutes. This can happen for example due to FHM being powered off.</p><p>Clear Condition: M-Plane connection is established again with the AP.</p></td></tr></tbody></table>

**FHM > Control Plane Alerts**

<table data-header-hidden><thead><tr><th width="249.8333740234375" valign="top"></th><th width="109.8333740234375" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Packet Loss Detected</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: Radio Unit Loss of Signal Detection (RU-loss-detect) is triggered on FHM RU ports due to early/late packets at least three times in five minutes.</p><p>Clear Condition: RU-loss-detect is not triggered more than two times in last five minutes. No early/late packets between FHM and RU.</p></td></tr></tbody></table>

**Mesh Node > Domain Proxy Alerts**

<table data-header-hidden><thead><tr><th width="250" valign="top"></th><th width="110.3333740234375" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">CPE CBSD New Grant</td><td valign="top">Warning</td><td valign="top"><p>Trigger Condition: New grants were received within the last one hour.</p><p>Clear Condition: No new grants were received in the last one hour.</p></td></tr><tr><td valign="top">CPE CBSD Preferred Frequency or Bandwidth Unavailable</td><td valign="top">Warning</td><td valign="top"><p>Trigger Condition: The backhaul frequency or bandwidth to which the Mesh Node is connected is unavailable.</p><p>Clear Condition: When the preferred frequencies or bandwidth are available again.</p></td></tr><tr><td valign="top">CPE CBSD Registration Failure</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: CPE CBSD registrations have encountered failures within the last hour.</p><p>Clear Condition: No CPE CBSD registrations have failed for at least one hour.</p></td></tr></tbody></table>

**Mesh Node > Management Plane Alerts**

<table data-header-hidden><thead><tr><th width="250" valign="top"></th><th width="109.66668701171875" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Offline</td><td valign="top">Critical</td><td valign="top"><p>Trigger Condition: When a Mesh Node has remained offline for at least 10 minutes.</p><p>Clear Condition: When the Mesh Node comes online.</p></td></tr></tbody></table>

**Mesh Node > MCU-Plane Alerts**

<table data-header-hidden><thead><tr><th width="250" valign="top"></th><th width="109.6666259765625" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Tunnel Down</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: When the mesh tunnel between a Mesh Node and Onyx Edge is down for at least five minutes.</p><p>Clear Condition: When the mesh tunnel between the Mesh Node and Onyx Edge comes up.</p></td></tr><tr><td valign="top">Watchdog Powercycle</td><td valign="top">Minor</td><td valign="top"><p>Trigger Condition: A Mesh Node power cycle is triggered by the watchdog within the last 10 minutes.</p><p>Clear Condition: No watchdog-triggered power cycles occur within a subsequent 10-minute window.</p></td></tr></tbody></table>

**Mesh Node > Platform Alerts**

<table data-header-hidden><thead><tr><th width="251" valign="top"></th><th width="109.66668701171875" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">CPU Usage Alert</td><td valign="top">Minor</td><td valign="top"><p>Trigger Condition: When a Mesh Node’s CPU utilization in the last five minutes exceeds 70% of capacity.</p><p>Clear Condition: When the CPU utilization falls below 70% of capacity.</p></td></tr><tr><td valign="top">Memory Usage Alert</td><td valign="top">Minor</td><td valign="top"><p>Trigger Condition: When a Mesh Node’s RAM utilization exceeds 70% of capacity.</p><p>Clear Condition: When the RAM utilization falls below 70% of capacity.</p></td></tr><tr><td valign="top">Disk Usage Alert</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: When a Mesh Node’s disk utilization in the last five minutes exceeds 70% of capacity.</p><p>Clear Condition: When the disk usage falls below 70% of capacity.</p></td></tr></tbody></table>

**Mesh Node > Provisioning Server Alerts**

<table data-header-hidden><thead><tr><th width="250" valign="top"></th><th width="110.33331298828125" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Provisioning Server Connection Failure</td><td valign="top">Warning</td><td valign="top"><p>Trigger Condition: When a Mesh Node has not successfully checked in with the Provisioning Server within the past 35 minutes.</p><p>Clear Condition: When the Mesh Node successfully checks in with the Provisioning Server.</p></td></tr></tbody></table>

**Onyx Edge (Core) > Control Plane Alerts**

<table data-header-hidden><thead><tr><th width="249.8333740234375" valign="top"></th><th width="109.8333740234375" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">DHCP Server Failed</td><td valign="top">Major</td><td valign="top">Trigger Condition: When the DHCP server responsible for assigning IP addresses to UE is unavailable for five minutes.<br>Clear Condition: When the DHCP server becomes available.</td></tr><tr><td valign="top">NG Setup Failure</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: When there is an NG Setup Request failure in the last five-minute window.</p><p>Clear Condition: When there are no NG Setup Request failures in the last five-minute window.</p></td></tr><tr><td valign="top">SCTP Outbound Stalled</td><td valign="top">Major</td><td valign="top">Trigger Condition: SCTP inbound ordered chunks have been increasing over the last 15 minutes while SCTP outbound ordered chunks have remained flat.<br>Clear Condition: Outbound SCTP chunks resume normal flow, indicating the core is processing and responding to signaling messages again.</td></tr><tr><td valign="top">UE IMSI-IMEI Validation Failure</td><td valign="top">Warning</td><td valign="top"><p>Trigger Condition: IMSI-IMEI validation checks failed for at least one UE within the last 30 minutes.</p><p>Clear Condition: No IMSI-IMEI validation failures for 30 minutes.</p></td></tr><tr><td valign="top">UE Registration Failure</td><td valign="top">Warning</td><td valign="top"><p>Trigger Condition: More than 25% of UE registrations in the last 15-minute window failed to complete, and this state persisted for at least the past three minutes.</p><p>Clear Condition: More than 75% of UE registrations in the last 15-minute window completed successfully.</p></td></tr></tbody></table>

**Onyx Edge (Core) > CU-Plane Alerts**

<table data-header-hidden><thead><tr><th width="249.8333740234375" valign="top"></th><th width="109.8333740234375" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">HA Peer Down</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: When, in an Onyx Edge pool, the Primary Onyx Edge detects a peer Onyx Edge is down. The Primary Onyx Edge detects a peer is down within 10 minutes of it going down.</p><p>Clear Condition: When the Primary Onyx Edge detects that the peer Onyx Edge is operational.</p></td></tr></tbody></table>

**Onyx Edge (Core) > Management Plane Alerts**

<table data-header-hidden><thead><tr><th width="249.8333740234375" valign="top"></th><th width="109.8333740234375" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Offline</td><td valign="top">Critical</td><td valign="top"><p>Trigger Condition: When an Onyx Edge (Core) has remained offline for at least 10 minutes.</p><p>Clear Condition: When the Onyx Edge (Core) comes back online.</p></td></tr></tbody></table>

**Onyx Edge (Core) > MCU-Plane Alerts**

<table data-header-hidden><thead><tr><th width="249.8333740234375" valign="top"></th><th width="109.833251953125" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Service Down</td><td valign="top">Critical</td><td valign="top"><p>Trigger Condition: When any of the following is true:</p><p>- All APs are offline for five minutes.</p><p>- All APs are S1-disconnected for five minutes.</p><p>- If any critical services have restarted more than three times in the last five minutes.</p><p>- If any critical services are down for five minutes.</p><p>Clear Condition: When the trigger condition is resolved.</p></td></tr></tbody></table>

**Onyx Edge (Core) > Platform Alerts**

<table data-header-hidden><thead><tr><th width="249.833251953125" valign="top"></th><th width="109.8333740234375" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">CPU Usage Alert</td><td valign="top">Minor</td><td valign="top"><p>Trigger Condition: CPU Utilization in the last five minutes has increased above 70% of capacity.</p><p>Clear Condition: CPU Utilization in the last five minutes has dropped below 70% of capacity.</p></td></tr><tr><td valign="top">Disk Usage Alert</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: Disk Utilization in the last five minutes has increased above 70% of capacity.</p><p>Clear Condition: Disk Utilization in the last five minutes has dropped below 70% of capacity.</p></td></tr><tr><td valign="top">Memory Usage Alert</td><td valign="top">Minor</td><td valign="top"><p>Trigger Condition: Memory consumption has increased above 70% of capacity.</p><p>Clear Condition: Memory consumption has dropped below 70% of capacity.</p></td></tr></tbody></table>

**Onyx Edge (Core) > Provisioning Server Alerts**

<table data-header-hidden><thead><tr><th width="249.8333740234375" valign="top"></th><th width="109.833251953125" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Provisioning Server Connection Failure</td><td valign="top">Warning</td><td valign="top"><p>Trigger Condition: When an Onyx Edge (Core) has not successfully checked in with the Provisioning Server within the past 35 minutes.</p><p>Clear Condition: When the Onyx Edge successfully checks in with the Provisioning Server.</p></td></tr></tbody></table>

**Onyx Edge (NR) > Control Plane Alerts**

<table data-header-hidden><thead><tr><th width="249.833251953125" valign="top"></th><th width="109.8333740234375" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">F1 Setup Failure</td><td valign="top">Critical</td><td valign="top"><p>Trigger Condition: When there is an F1 Setup Request failure in the last five-minute window.</p><p>Clear Condition: When there are no F1 Setup Request failures in the last five-minute window.</p></td></tr><tr><td valign="top">RRC Security Mode Failure</td><td valign="top">Warning</td><td valign="top"><p>Trigger Condition: When there is at least one RRC Security Mode failure in the last five-minute window.</p><p>Clear Condition: When there are no RRC Security Mode failures in the last five-minute window.</p></td></tr><tr><td valign="top">RRC Setup Failure</td><td valign="top">Warning</td><td valign="top"><p>Trigger Condition: More than 25% of RRC Connection Setup in the last 15-minute window failed to complete and this persisted at least for the last three minutes.</p><p>Clear Condition: More than 75% of RRC Connection Setup in the last 15-minute window completed successfully.</p></td></tr></tbody></table>

**Onyx Edge (NR) > Management Plane Alerts**

<table data-header-hidden><thead><tr><th width="249.8333740234375" valign="top"></th><th width="109.833251953125" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Offline</td><td valign="top">Critical</td><td valign="top"><p>Trigger Condition: Onyx Edge (NR) has remained offline for at least 10 minutes.</p><p>Clear Condition: Onyx Edge (NR) comes back online.</p></td></tr></tbody></table>

**Onyx Edge (NR) > MCU-Plane Alerts**

<table data-header-hidden><thead><tr><th width="249.8333740234375" valign="top"></th><th width="109.8333740234375" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Service Down</td><td valign="top">Critical</td><td valign="top"><p>Trigger Condition: When any of the following is true:</p><p>- F1c Connection is down for five minutes.</p><p>- NGc Connection is down for five minutes.</p><p>- If any critical core services have restarted unexpectedly more than three times in the last five minutes.</p><p>- If any critical core services are down for five minutes.</p><p>- If gNB services have restarted due to failures in the last five minutes.</p><p>Clear Condition: Trigger condition should be resolved.</p></td></tr></tbody></table>

**Onyx Edge (NR) > Platform Alerts**

<table data-header-hidden><thead><tr><th width="249.8333740234375" valign="top"></th><th width="109.8333740234375" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">CPU Usage Alert</td><td valign="top">Minor</td><td valign="top"><p>Trigger Condition: CPU Utilization in the last five minutes has increased above 80% of capacity.</p><p>Clear Condition: CPU Utilization in the last five minutes has dropped below 80% of capacity.</p></td></tr><tr><td valign="top">Disk Usage Alert</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: Disk Utilization in the last five minutes has increased above 70% of capacity.</p><p>Clear Condition: Disk Utilization in the last five minutes has dropped below 70% of capacity.</p></td></tr><tr><td valign="top">Memory Usage Alert</td><td valign="top">Minor</td><td valign="top"><p>Trigger Condition: Memory consumption has increased above 80% of capacity.</p><p>Clear Condition: Memory consumption has dropped below 80% of capacity.</p></td></tr></tbody></table>

**Onyx Edge (NR) > Provisioning Server Alerts**

<table data-header-hidden><thead><tr><th width="249.833251953125" valign="top"></th><th width="109.8333740234375" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Provisioning Server Connection Failure</td><td valign="top">Warning</td><td valign="top"><p>Trigger Condition: When an Onyx Edge (NR) has not successfully checked in with the Provisioning Server within the past 35 minutes.</p><p>Clear Condition: When the Onyx Edge successfully checks in with the Provisioning Server.</p></td></tr></tbody></table>

**Onyx Edge (NR) > User Plane Alerts**

<table><thead><tr><th width="250">Alert</th><th width="110">Severity</th><th>Trigger and Clear Conditions</th></tr></thead><tbody><tr><td>Cell High DL BLER</td><td>Warning</td><td>Trigger Condition: Downlink BLER (Block Error Rate) for the cell exceeds 50% for at least 15 minutes.<br>Clear Condition: Downlink BLER for the cell falls to or below 50%.</td></tr><tr><td>Cell High UL BLER</td><td>Warning</td><td>Trigger Condition: Uplink BLER for the cell exceeds 50% for at least 15 minutes.<br>Clear Condition: Uplink BLER for the cell falls to or below 50%.</td></tr><tr><td>Early eCPRI Packets</td><td>Warning</td><td>Trigger Condition: More than 50% of eCPRI packets received for the cell in the last 15 minutes are classified as early.<br>Clear Condition: The proportion of early eCPRI packets falls to or below 50%.</td></tr><tr><td>Late eCPRI Packets</td><td>Warning</td><td>Trigger Condition: More than 50% of eCPRI packets received for the cell in the last 15 minutes are classified as late.<br>Clear Condition: The proportion of late eCPRI packets falls to or below 50%.</td></tr><tr><td>eCPRI Rx Down</td><td>Warning</td><td>Trigger Condition: No eCPRI Rx packets are received for the cell for at least 10 minutes, even though the RU's RF Tx is enabled/desired.<br>Clear Condition: eCPRI Rx packets resume being received while Tx remains enabled.</td></tr></tbody></table>

**Onyx Edge (NR) > S Plane Alerts**

<table data-header-hidden><thead><tr><th width="249.8333740234375" valign="top"></th><th width="109.833251953125" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">GPS Signal Not Available</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: GPS signal is not detected or available at the Onyx Edge. The timing service cannot acquire external time stamp signals from GPS, preventing synchronization of the PTP hardware clock to GPS timing.</p><p>Clear Condition: When the trigger condition is resolved.</p></td></tr><tr><td valign="top">PHC2SYS Offset is Too High</td><td valign="top">Warning</td><td valign="top"><p>Trigger Condition: The time difference (offset) between the system clock and PTP hardware clock exceeds acceptable thresholds. The PHC2SYS service is unable to sync system clock to hardware clock.</p><p>Clear Condition: When the trigger condition is resolved.</p></td></tr><tr><td valign="top">TS2PHC Offset is Too High</td><td valign="top">Warning</td><td valign="top"><p>Trigger Condition: The time difference (offset) between external GPS time stamp signals and the PTP hardware clock exceeds acceptable thresholds. The TS2PHC service is unable to sync hardware clock to GPS timing.</p><p>Clear Condition: When the trigger condition is resolved.</p></td></tr></tbody></table>

**Orchestrator > Domain Proxy Alerts**

<table data-header-hidden><thead><tr><th width="249.8333740234375" valign="top"></th><th width="109.8333740234375" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">SAS Connection Failure</td><td valign="top">Critical</td><td valign="top"><p>Trigger Condition: When any of the following is true:</p><p>- Could not connect to SAS at least three times in the past 15 minutes.</p><p>- At least one HTTP error from SAS in the past 15 minutes.</p><p>Clear Condition: No SAS connection errors, and HTTP errors occur for at least 15 minutes.</p></td></tr></tbody></table>

### Custom Alert Rules

{% hint style="info" %}
**NOTE:** Custom alert rules are specific to each network.
{% endhint %}

{% hint style="info" %}
**NOTE:** You can create and manage custom alert rules only if you are a GXC Administrator.
{% endhint %}

#### View a Custom Alert Rule's Details

**To view a custom alert rule's details:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Alert Rules** tab.

The **Alerts** page > **Alert Rules** tab is displayed.

The **Custom Alerts** section lists the existing custom alert rules.

{% hint style="info" %}
**NOTE:** The **Custom Alerts** section is displayed only if at least one custom alert rule exists.
{% endhint %}
{% endstep %}

{% step %}
For the custom alert rule that you want to view details for, click the corresponding <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FLsRj4Tge6SfeX7xzFyb4%2Fimage.png?alt=media&amp;token=3690fb3e-4fa7-46ea-b487-a9b0838e9ca2" alt="" data-size="line"> (view details) icon.
{% endstep %}

{% step %}
The **View Alert Rule** dialog box displays the rule's details.

* **Alert** – The custom alert's name.
* **Description** – Description of what the alert monitors or the condition it checks for.
* **Expression** – The expression or condition that triggers the alert.
* **Duration** – The duration for which the expression must continuously remain in effect before the alert is triggered.
* **Severity** – The alert's severity classification—Notice, Info, Warning, Minor, Major, or Critical.
* **Labels** – Metadata associated with the alert in key-value pairs.
  {% endstep %}
  {% endstepper %}

#### Create Custom Alert Rules

{% hint style="info" %}
**NOTE:** You can create custom alert rules only if you are a GXC Administrator.
{% endhint %}

You can create custom alert rules to define conditions for which alerts must be triggered. Before you create a new alert rule, check if an existing alert rule already serves the purpose or can be modified for your requirements.

**To create a custom alert rule:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Alert Rules** tab.

The **Alerts** page > **Alert Rules** tab is displayed.

The **Custom Alerts** section lists the custom alert rules.

{% hint style="info" %}
**NOTE:** The **Custom Alerts** section is displayed only if at least one custom alert rule has already been created.
{% endhint %}
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Add New**.

The **Add Alert Rule** page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FEGvRkLQpXY3th0tszes2%2Fimage.png?alt=media&amp;token=20354d08-18df-407e-a191-d56801392281" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details:

* **Summary**:
  * **Rule Name** – (Required) The alert rule's name. Alert rule names can be a maximum of 64 characters and can contain alphanumeric and \_ (underscore) and - (hyphen) characters.
  * **Description** – (Optional) A brief explanation of what the alert monitors or the condition it checks for.
* **Conditions**:
  * **Expression** – (Required) The Prometheus expression. Contact GXC Engineering for the expression to use.
  * **Duration** – (Optional) Select the duration for which the condition must continuously remain in effect before the alert is triggered. To trigger an alert immediately when a condition becomes true, enter 0.
  * **Unit** – (Optional) Select the units for the value specified in **Duration** from **Seconds**, **Minutes**, or **Hours**.
  * **Severity** – (Optional) Select the severity classification for the alert from:
    * **Notice** – A normal but important condition, not related to any error situation.
    * **Info** – General information about a specific condition.
    * **Warning** – A potential or impending condition requiring analysis and/or corrective action to prevent it from becoming a Major or a Minor condition.
    * **Minor** – A condition requiring corrective action to prevent it from becoming a Major condition.
    * **Major** – A condition requiring urgent corrective action to prevent it from becoming a Critical condition.
    * **Critical** – A significant condition requiring urgent corrective action.
* **Notifications** – Manage alert rule notifications.
  * **Enable e-mail notification** – Select to notify alert receivers when this rule triggers an alert. For information on alert receivers, see *Manage Alert Receiver Accounts*.
* **Labels** – Add labels to provide more information about the alerts.
  * **Add New Label** – (Optional) Click to create additional labels to provide more information about the alerts.
    * **Name** – The label's name. The label name must be an alphanumeric string. It cannot contain white spaces or special characters.
    * **Value** – The label's value.
    * **Action** – To delete the label, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F08vNR809rOAWxDPTPYwD%2Fimage.png?alt=media&amp;token=bfab1d54-45e5-4182-9954-09549421087a" alt="" data-size="line"> (delete).
      {% endstep %}
      {% endstepper %}

#### Edit Custom Alert Rules

{% hint style="info" %}
**NOTE:** You can edit custom alert rules only if you are a GXC Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** You cannot edit predefined alert rules, except to enable or disable per alert rule email notifications. For more information, see *Mute Alert Notifications per Predefined Alert Rule*.
{% endhint %}

**To edit a custom alert rule:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Alert Rules** tab.

The **Alerts** page > **Alert Rules** tab is displayed.

The **Custom Alerts** section lists the custom alert rules.

{% hint style="info" %}
**NOTE:** The **Custom Alerts** section is displayed only if at least one custom alert rule exists.
{% endhint %}
{% endstep %}

{% step %}
For the custom alert rule that you want to edit, click the corresponding <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8N0uXu0yRrAkZ3FCtNLm%2Fimage.png?alt=media&amp;token=a45bea05-993c-4487-a39b-e9a84942f4a2" alt="" data-size="line"> (edit) icon.
{% endstep %}

{% step %}
Update the custom alert rule as required.

For parameter descriptions, see [*Create Custom Alert Rules*](#create-custom-alert-rules).
{% endstep %}

{% step %}
To save your edits, in the upper-right corner of the page, click **Save Rule**.
{% endstep %}
{% endstepper %}

#### Delete Custom Alert Rules

{% hint style="info" %}
**NOTE:** You can delete custom alert rules only if you are a GXC Administrator. Predefined alert rules cannot be deleted.
{% endhint %}

{% hint style="warning" %}
**CAUTION:** Custom alert rules when deleted are lost for good. Before you delete a custom alert rule, review the rule to ensure it is no longer required before you delete it.
{% endhint %}

**To delete a custom alert rule:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Alert Rules** tab.

The **Alerts** page > **Alert Rules** tab is displayed.

The **Custom Alerts** section lists the custom alert rules.

{% hint style="info" %}
**NOTE:** The **Custom Alerts** section is displayed only if at least one custom alert rule exists.
{% endhint %}
{% endstep %}

{% step %}
For the custom alert rule that you want to delete, click the corresponding <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FwBRsDmWckibJMekPH5V4%2Fimage.png?alt=media&amp;token=0c585b5c-9699-4f3d-81c8-a3e23f80b050" alt="" data-size="line"> (delete) icon.

A confirmation dialog box is displayed.
{% endstep %}

{% step %}
To confirm, click **Yes**.
{% endstep %}
{% endstepper %}

## Manage Alert Receiver Accounts

You can configure the receivers to be notified when alerts are triggered. The receivers are notified by email in real-time to review the alerts and take action. As per the configuration, a receiver can be notified about all alerts or only alerts of specific severities.

{% hint style="info" %}
**NOTE:** Alert receiver configurations are specific to the selected network.
{% endhint %}

### View Summary Details of All Alert Receiver Accounts

**To view the summary details of all alert receiver accounts:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Receivers** tab.

The **Alerts** page > **Receivers** tab displays the list of alert receiver accounts configured in the selected network.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F4sWdlK1u4bA66UkMvviZ%2Fimage.png?alt=media&amp;token=4225a536-1799-43ba-89a8-d81e665a4c68" alt=""><figcaption></figcaption></figure>

* **E-mail** – The alert receiver's email ID.
* **Severity of Alert** – The alert severity levels for which the receiver is notified.
* **Actions** – Options to view, edit, and delete alert receiver accounts.
  {% endstep %}
  {% endstepper %}

### Create Alert Receiver Accounts

{% hint style="info" %}
**NOTE:** You can add alert receiver accounts only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

**To create an alert receiver account:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Receivers** tab.

The **Alerts** page > **Receivers** tab displays the list of alert receiver accounts configured in the selected network.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Add Receivers**.

The **Create Receiver** page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FMPwifynnS33CC247RC3T%2Fimage.png?alt=media&amp;token=bcb98707-70aa-4c33-86d8-d78c660205ee" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details:

* **E-mail** – (Required) The alert receiver's e-mail ID to send alert notifications.
* **Severity Level** – (Required) The alert severity levels for which notifications should be sent to this receiver. Select from **Critical**, **Major**, **Minor**, or **All**.
  {% endstep %}

{% step %}
To save the alert receiver account, in the upper-right corner of the page, click **Save Receiver**.

The alert receiver account is saved and added to the list of receivers.
{% endstep %}
{% endstepper %}

### Edit Alert Receiver Accounts

{% hint style="info" %}
**NOTE:** You can edit alert receiver accounts only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

**To edit an alert receiver account:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Receivers** tab.

The **Alerts** page > **Receivers** tab displays the list of alert receiver accounts configured in the selected network.
{% endstep %}

{% step %}
For the alert receiver account that you want to edit, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FvKrUYUuS1IbJgcd0epCK%2Fimage.png?alt=media&amp;token=f1140fde-05b6-4a0c-84b9-94454e3d07e7" alt="" width="110"><figcaption></figcaption></figure>

The **Edit Receiver** page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FwGoh043jwBLZhZRZjk1q%2Fimage.png?alt=media&amp;token=c19e6093-cb66-4a43-825e-7da0e9f7aaca" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Edit the following details as required:

* **E-mail** – (Read only) The alert receiver's email ID.
* **Severity Level** – (Required) The alert severity levels for which notifications should be sent for this receiver. Select from **Critical**, **Major**, **Minor**, or **All**.
  {% endstep %}

{% step %}
To save your edit, in the upper-right corner of the page, click **Save Receiver**.
{% endstep %}
{% endstepper %}

### Delete Alert Receiver Accounts

{% hint style="info" %}
**NOTE:** You can delete alert receiver accounts only if you are a GXC Administrator, Partner Administrator, or a Super Administrator.
{% endhint %}

**To delete an alert receiver account:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Receivers** tab.

The **Alerts** page > **Receivers** tab displays the list of alert receiver accounts configured in the selected network.
{% endstep %}

{% step %}
For the alert receiver account that you want to delete, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Delete**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXeGxwfScUYzRspnbCJEo%2Fimage.png?alt=media&amp;token=1e11233f-4516-488a-91ba-9663d49fb892" alt="" width="110"><figcaption></figcaption></figure>

A confirmation dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FZ0ZXofrZmmFVaiHJgNuC%2Fimage.png?alt=media&amp;token=99b27f37-d165-452f-a1ab-b9ff0631bd58" alt="" width="506"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To confirm, click **Yes**.
{% endstep %}
{% endstepper %}


# Administration

This section describes how to create and manage partner, customer, and user accounts, and cloud resources.

## Manage Onyx Portal Accounts

The Onyx Portal supports the following account types:

* **GXC Root Account** – The root account comprising of all GXC partner (and associated customer accounts) and GXC-direct customer accounts. You can switch to and manage the GXC Root account only if you are a GXC Administrator.
* **GXC Partner Accounts** – System Integrator (SI) or Value-added Reseller (VAR) accounts comprising associated customer accounts. If you are a Partner Administrator, you can switch to and manage your own GXC partner account. If you are a GXC Administrator, you can switch to and manage any GXC partner account.
* **Customer Accounts** – Individual customer accounts. If you are a Partner Administrator, you can switch to and manage your own customer accounts. If you are a GXC Administrator, you can switch to and manage any customer account.

### Support Plans

Support plans are assigned to each GXC partner and customer account outline the level of assistance and services available, including technical support hours, response times, resolution times, and access to resources such as support documentation and training materials.

* **Basic** – GXC provides business hours support for Tier 3 issues.
* **Basic Plus** – (Additional subscription) GXC provides NOC monitoring, and Tier 1 / 2 / 3 Support 24 x 7 x 365 with standard response times for a cost-effective solution.
* **Platinum** – (Additional subscription) Includes "Basic Plus" features with accelerated SLA response and resolution times.
* **Partner Managed** – GXC Partner / Customer integrates GXC Onyx to their own NOC to directly manage Tier 1 / 2 issues.

For more information regarding the entitlements associated with each of these support plans, please contact your GXC Account representative or GXC Technical Support.

### Manage GXC Partner Accounts

{% hint style="info" %}
**NOTE:** You can create and manage GXC partner accounts only if you are a GXC Administrator.
{% endhint %}

#### View GXC Partner Accounts

This section describes how to:

* View Summary Details of All GXC Partner Accounts
* View a GXC Partner Account's Details

**View Summary Details of All GXC Partner Accounts**

{% hint style="info" %}
**NOTE:** You can view GXC partner account details only if you are a GXC Administrator.
{% endhint %}

**To view the summary details of all GXC partner accounts:**

{% stepper %}
{% step %}
Switch to the GXC Root account.

To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click **Other Accounts** > **Select GXC Root**.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Partners** tab.

The **Administration** page > **Partners** tab displays the summary details of all GXC partner accounts.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FsZJvk8WpMExwJPZ40kJ0%2Fimage.png?alt=media&amp;token=a84f73a9-3899-424a-a095-20f15a77e07b" alt=""><figcaption></figcaption></figure></div>

* **Name** – The GXC partner account's name.
* **Email** – The GXC partner account's email address.
* **Support Plan** – The support plan assigned to the GXC partner account—Basic, Basic Plus, Platinum, and Partner Managed. For more information, see [Support Plans](#support-plans).
* **Actions** – (Super Administrator only) Options to view, edit, and delete the GXC partner account.
  {% endstep %}

{% step %}
To download a CSV file listing the partner accounts' details including partner name, GXC support plan, contact email ID, and address, click **Download**. The CSV file is downloaded to your computer.
{% endstep %}

{% step %}
To search for a particular GXC partner account, in the **Search** box, enter your search term.
{% endstep %}
{% endstepper %}

**View a GXC Partner Account's Details**

{% hint style="info" %}
**NOTE:** You can view GXC partner account details only if you are a GXC Administrator.
{% endhint %}

**To view a GXC partner account's details:**

{% stepper %}
{% step %}
Switch to the GXC Root account.

To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click **Other Accounts** > **Select GXC Root**.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Partners** tab.

The **Administration** page > **Partners** tab displays the summary details of all GXC partner accounts.
{% endstep %}

{% step %}
To view the details of a particular GXC partner account, click the account's name.

The ***\<partner name>*** page displays the GXC partner account's details:

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F4DVrJjMOrNeamGRipmnF%2Fimage.png?alt=media&amp;token=d102f440-28da-46dd-98a9-9f0e9b659589" alt=""><figcaption></figcaption></figure></div>

* **Partner Details**:
  * **E-mail** – The Account Manager's email address.
  * **Type** – The account's type—GXC Partner.
  * **Parent** – The GXC partner account's parent—GXC Root.
  * **Name** – The GXC partner account's name.
  * **Address** – The GXC partner account's registered address.
  * **Session Timeout** – The Onyx Portal user session timeout duration for users in this GXC partner account. If a user's session is idle for this duration, the user is automatically logged out.
  * **Support Plan** – The support plan assigned to the GXC partner account—Basic, Basic Plus, Platinum, and Partner Managed. For more information, see [Support Plans](#support-plans).
* **Customers** – List of customer accounts under this GXC partner account.
  * **Name** – The customer account's name.
  * **E-mail** – The customer's email address.
  * **Type** – The customer account type—Customer.
  * **Customer ID** – The customer account's ID.
  * **Actions** – Options to view and delete the customer account.
* **Own Users** – List of the GXC partner account's own users.
  * **Name** – The user's name.
  * **E-mail** – The user's email address.
  * **Role** – The user's role.
  * **User ID** – The user's ID.
  * **Actions** – Options to edit and delete the user account.
* **Account Managers** – List of the GXC partner account's Account Managers.
  * **Name** – The user's name.
  * **E-mail** – The user's email address.
  * **Role** – The user's role.
  * **User ID** – The user's ID.
    {% endstep %}
    {% endstepper %}

#### Add Super Admin User Account under a GXC Partner Account

**To add a Super Admin user account under a GXC partner account:**

{% stepper %}
{% step %}
Switch to the GXC Root account.

To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click **Other Accounts** > **Select GXC Root**.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Partners** tab.

The **Administration** page > **Partners** tab displays the summary details of all GXC partner accounts.
{% endstep %}

{% step %}
For the GXC partner account that you want to edit, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **View**.

The ***\<partner name>*** page displays the GXC partner account's details.
{% endstep %}

{% step %}
To add a Super Admin user account to the GXC partner account, in the **Own Users** section, click **Add User**.

The **Create User** page is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F6Asd2wX6YZ38lVmCMtCe%2Fimage.png?alt=media&amp;token=85cb9a39-8ff7-4b4e-b28d-ea698d57fc4d" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

* **Upstream IdP User** – If a customer's IdP cannot release user attributes such as "onyxPortalTenantId", "onyxPortalRole", etc. required for SSO user authentication to the Onyx IdP, user accounts for Onyx Portal users in the customer's organization are created in the Onyx Portal. To enable SSO authentication for such users, this toggle button must be enabled to fetch the required attributes from the user's Onyx Portal account settings. Default setting: disabled.
* **User Email** – (Required) The user's email address.
* **User Name** – (Required) The user account's user name.
* **Role** – (View-only field) The user's role—Super Admin.
  {% endstep %}

{% step %}
To save the user account, in the upper-right corner of the page, click **Save User**.
{% endstep %}
{% endstepper %}

### Manage Customer Accounts

{% hint style="info" %}
**NOTE:** You can create and manage customer accounts only if you are a GXC Administrator.
{% endhint %}

#### View Customer Accounts

{% hint style="info" %}
**NOTE:** You can view customer accounts only if you are a GXC Administrator.
{% endhint %}

This section describes how to:

* View Summary Details of All Customer Accounts
* View a Customer Account's Details

**View Summary Details of All Customer Accounts**

{% hint style="info" %}
**NOTE:** You can view customer account details only if you are a GXC Administrator.
{% endhint %}

**To view the summary details of all customer accounts:**

{% stepper %}
{% step %}
Switch to the GXC Root account.

To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click **Other Accounts** > **Select GXC Root**.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Customers** tab.

The **Administration** page > **Customers** tab displays the summary details of all Onyx Portal customer accounts. All customer accounts irrespective of their partner hierarchy are listed in the **Customers** tab.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FF7Vn0vUmfv2eJK4hv6dx%2Fimage.png?alt=media&amp;token=1722f546-4055-4dcf-990d-df4c9c940d74" alt=""><figcaption></figcaption></figure></div>

* **Customer Name** – The customer account's name.
* **GXC Partner** – If the customer account is associated with a GXC partner, the GXC partner's name.
* **Email** – The Account Manager's email address.
* **Support Plan** – The support plan assigned to the customer account—Basic, Basic Plus, Platinum, or Partner Managed. For more information, see [Support Plans](#support-plans).
* **Actions** – Options to view details, edit and delete a GXC partner account.
  {% endstep %}

{% step %}
To download a CSV file listing the associated customer accounts with details including customer name, partner, GXC support plan, contact email ID, and address, click **Download**. The CSV file is downloaded to your computer.
{% endstep %}

{% step %}
To search for a customer account, in the **Search** box, enter your search term.
{% endstep %}
{% endstepper %}

**View a Customer Account's Details**

**To view a customer account's details:**

{% stepper %}
{% step %}
Switch to the GXC Root account.

To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click **Other Accounts** > **Select GXC Root**.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Customers** tab.

The **Administration** page > **Customers** tab displays the summary details of all Onyx Portal customer accounts. All customer accounts irrespective of their partner hierarchy are listed in the **Customers** tab.
{% endstep %}

{% step %}
To view the details of a particular customer account, click the customer account's name.

The ***\<customer name>*** page displays the following details:

* **Customer Details**:
  * **E-mail** – The Account Manager's email address. The email address of the customer account's first Super Administrator user. This Super Administrator user will have the privilege to create other user accounts within the customer account.
  * **Type** – The account type—Customer.
  * **GXC Partner** – If the customer account is associated with a GXC partner, the GXC partner's name.
  * **Name** – The customer account's name.
  * **Address** – The customer's registered address.
  * **Session Timeout** – The Onyx Portal user session timeout duration for users in this customer account. If a user's session is idle for this duration, the user is automatically logged out.
  * **Support Plan** – The support plan assigned to the customer account—Basic, Basic Plus, Platinum, and Partner Managed. For more information, see *Support Plans*.
  * **Add SSO Config** – (Displayed only if SSO is not configured.) Click to add SSO configuration for the customer account. For more information, see *Add SSO with IdP Configuration*.
  * **Edit SSO Config** – (Displayed only if SSO is already configured.) Click to edit SSO configuration for the customer account. For more information, see *Edit SSO with IdP Configuration*.
* **Account ID** – The Onyx Portal cloud account ID.
  * **Resource Group ID** – The resource group's ID.
  * **Resource Group Name** – The resource group's name.
  * **Region** – The region associated with the resource group.
  * **Availability Zone** – The availability zone associated with the resource group.
  * **Status** – The resource group's status—Create Complete, etc.
  * **Host Key** – Options to view and download the host key.
  * Click the expand icon to view EC2 instances, if provisioned.
    * **Instance ID** – The instance's ID.
    * **Instance Name** – The instance's name.
    * **Connected Onyx Edge** – The connected Onyx Edge's name.
    * **Network Name** – The network's name.
    * **Private IP** – The instance's private IP address.
    * **Public IP** – The instance's public IP address.
    * **Status** – The instance's provisioning status.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8UHMDykRo2ZdGMLKmYHJ%2Fimage.png?alt=media&amp;token=de28e1df-0e33-4196-a8c3-5cab4fa0744d" alt="" data-size="line"> Green – Create Complete
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FRPGrPdIfFb8rFKV5rqhD%2Fimage.png?alt=media&amp;token=4303d444-d2f0-42ff-a262-5b039d3f49e4" alt="" data-size="line"> Red – Rollback Complete
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FP9nviL2QrZrqmafa53Zk%2Fimage.png?alt=media&amp;token=d74708f7-c8a4-4668-a11a-1815375dc1cc" alt="" data-size="line"> – Click to delete the instance.
* **Add Resource Group** – Click to create a cloud resource group. For more information, see *Create Cloud Resource Groups*.
* **Own Users**:
  * **Name** – The user's name.
  * **E-mail** – The user's email address.
  * **Role** – The user's role.
  * **User ID** – The user's user ID.
  * **Actions** – Options to edit and delete the user account.
* **Account Managers**: This section is not applicable in this release.
  * **Add User** – Click to add a user account under the customer account. For more information, see *Create User Accounts under a Customer Account*.
    {% endstep %}
    {% endstepper %}

#### Create User Accounts under a Customer Account

{% hint style="info" %}
**NOTE:** You can add users to customer accounts only if you are a GXC Administrator.
{% endhint %}

**To add a user to a customer account:**

{% stepper %}
{% step %}
Switch to the GXC Root account.

To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click **Other Accounts** > **Select GXC Root**.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Customers** tab.

The **Administration** page > **Customers** tab displays the summary details of all Onyx Portal customer accounts.
{% endstep %}

{% step %}
For the customer account that you want to add the user to, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **View**.

The ***\<customer name>*** page displays the customer account's details.
{% endstep %}

{% step %}
In the **Account Managers** section, click **Add User**.

The **Create User** page is displayed.
{% endstep %}

{% step %}
Enter the following details:

* **User Email** – (Required) The user's email address.
* **User Type** – (View-only field) The user's account type—Own User.
* **User Name** – (Required) The user's account name.
* **Role** – (Required) The user's role. Select from **Super Admin**, **Admin**, **Viewer**.
* **Upstream IdP User** – (Optional) If a customer's IdP cannot release user attributes such as "onyxPortalTenantId", "onyxPortalRole", etc. required for SSO user authentication to the Onyx IdP, user accounts for Onyx Portal users in the customer's organization are created in the Onyx Portal. To enable SSO authentication for such users, this toggle button must be enabled to fetch the required attributes from the user's Onyx Portal account settings. Default setting: disabled.
  {% endstep %}

{% step %}
To save the user account, in the upper-right corner of the page, click **Save User**.
{% endstep %}
{% endstepper %}

#### Configure SSO Authentication with IdP Configuration

The Onyx Portal can integrate with a customer organization's existing IdP for SSO user authentication. The customer must provide their IdP details to GXC for integration with the Onyx Portal.

All IdP-related configurations such as entity ID, IdP metadata, Single Sign-On/Single Logout URLs and certificates are configured in the Onyx IdP. The Single Sign-On and Single Logout requests are redirected from the Onyx Portal to the Onyx IdP. The Onyx IdP does the target IdP discovery based on the RequestedAuthnContext in the SAML Authentication Request and redirects the Single Sign-On/Logout request to the customer IdP.

{% hint style="info" %}
**NOTE:** Before enabling SSO for an Onyx Portal customer account, the SAML or OIDC application must be configured with the customer's IdP.
{% endhint %}

**Add SSO with IdP Configuration**

**To add SSO configuration for an existing Onyx Portal customer account:**

{% stepper %}
{% step %}
Switch to the GXC Root account.

To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click **Other Accounts** > **Select GXC Root**.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Customers** tab.

The **Administration** page > **Customers** tab displays the summary details of all Onyx Portal customer accounts.
{% endstep %}

{% step %}
In the upper-right corner of the **Customer Details** panel, click **Add SSO Config**.

The **Add SSO Config** dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FM7o7tJY6GHRhxybUOBkK%2Fimage.png?alt=media&amp;token=3b85ac83-c964-42a3-850b-fed76d04c4d5" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

* **Enable SSO** – Toggle to enable or disable SSO for the customer account.
* **Organization Name** – (Required) The organization's name.
* **IdP Entity ID** – (Required) The IdP's entity ID, a unique ID for the IdP within the SSO ecosystem. It is used by service providers to recognize and trust the IdP.
* **IdP Destination URL** – (Required) The endpoint where the IdP receives authentication requests from the service provider. This URL is used during the SSO process to authenticate users.
* **SSO Vendor** – (Required) Select the SSO solution vendor's name—**Google**, **Shibboleth**, **Okta**.
* **IDP SLO URL** – (Optional) The IDP's single logout (SLO) URL. The endpoint where the IdP handles logout requests. This URL ensures that when a user logs out from one service, the session is terminated across all connected services in the SSO environment.
* **IdP Metadata URL** – (Required) The metadata file location for the IdP. This file contains configuration information, such as entity ID, SSO URLs, SLO URLs, and certificates, which the service provider uses to establish trust and integrate with the IdP.
* **+ Upload Metadata** – Click to add a metadata file. In XML format, this metadata contains the necessary configurations and certificates required to establish trust between the IdP and service providers within the SSO environment.
* **Additional Config**:
  * **IDP Certificate** – A digital certificate issued to the IdP that is used to sign authentication assertions and encrypt communications. This certificate ensures the integrity and security of the data exchanged between the IdP and the service provider. It typically contains the public key used in the cryptographic processes.
  * **InCommon Metadata Filter** – A configuration tool or setting used within the "InCommon Federation", a trusted framework for U.S. education and research institutions. This filter allows administrators to selectively include or exclude metadata from the federation's metadata aggregate based on specific criteria. This helps manage which entities are trusted and ensures that only relevant and up-to-date metadata is processed for authentication and authorization purposes.
    {% endstep %}

{% step %}
To save the SSO config, click **Save**.
{% endstep %}
{% endstepper %}

**Edit SSO with IdP Configuration**

**To edit the SSO configuration for an Onyx Portal customer account:**

{% stepper %}
{% step %}
Switch to the GXC Root account.

To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click **Other Accounts** > **Select GXC Root**.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Customers** tab.

The **Administration** page > **Customers** tab displays the summary details of all Onyx Portal customer accounts.
{% endstep %}

{% step %}
In the upper-right corner of the **Customer Details** panel, click **Edit SSO Config**.

The **Edit SSO Config** dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FCEUnRSvsWsQQ1PfsCQkx%2Fimage.png?alt=media&amp;token=0946595a-7f89-4c6c-852c-b99a076ae5ea" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Update the following details as required:

* **Enable SSO** – Toggle to enable or disable SSO for the customer account.
* **Organization Name** – (Required) The organization's name.
* **IdP Entity ID** – (Required) The IdP's entity ID, a unique ID for the IdP within the SSO ecosystem. It is used by service providers to recognize and trust the IdP.
* **IdP Destination URL** – (Required) The endpoint where the IdP receives authentication requests from the service provider. This URL is used during the SSO process to authenticate users.
* **SSO Vendor** – (Required) Select the SSO solution vendor's name—**Google**, **Shibboleth**, **Okta**.
* **IDP SLO URL** – (Optional) The IDP's single logout (SLO) URL. The endpoint where the IdP handles logout requests. This URL ensures that when a user logs out from one service, the session is terminated across all connected services in the SSO environment.
* **IdP Metadata URL** – (Required) The metadata file location for the IdP. This file contains configuration information, such as entity ID, SSO URLs, SLO URLs, and certificates, which the service provider uses to establish trust and integrate with the IdP.
* **+ Upload Metadata** – Click to add a metadata file. In XML format, this metadata contains the necessary configurations and certificates required to establish trust between the IdP and service providers within the SSO environment.
* **Additional Config**:
  * **IDP Certificate** – A digital certificate issued to the IdP that is used to sign authentication assertions and encrypt communications. This certificate ensures the integrity and security of the data exchanged between the IdP and the service provider. It typically contains the public key used in the cryptographic processes.
  * **InCommon Metadata Filter** – A configuration tool or setting used within the "InCommon Federation", a trusted framework for U.S. education and research institutions. This filter allows administrators to selectively include or exclude metadata from the federation's metadata aggregate based on specific criteria. This helps manage which entities are trusted and ensures that only relevant and up-to-date metadata is processed for authentication and authorization purposes.
    {% endstep %}

{% step %}
To save your edits, click **Save**.
{% endstep %}
{% endstepper %}

## Manage Onyx Portal User Accounts

The Onyx Portal supports creating and managing user accounts for users to monitor and manage their enterprise/private networks.

User privileges are strictly regulated by Role-based Access Control (RBAC). Users, such as Support Engineers, can be granted access to only view specific data while restricting their ability to create, modify, or delete configurations.

The Onyx Portal supports the following user roles:

* **GXC Administrator** – The highest level in the Onyx Portal user hierarchy. Can create and manage partner and customer accounts.
* **GXC Partner Administrator** – System Integrators (SI) or Value-added Resellers (VAR). Can perform all configuration and management tasks for associated customer accounts.
* **Super Administrator** – Can perform all configuration and management tasks within the managed network.
* **Administrator** – Can perform equipment-level operations and management within the managed network.
* **Viewer** – Can only monitor the managed network.

The following table summarizes user administration privileges across user roles.

The privileges indicated in the following tables follows the CRUD convention:

* C – Create or add new entries.
* R – Read, retrieve, search, or view existing entries.
* U – Update or edit existing entries.
* D – Delete, deactivate, or remove existing entries.

<p align="center"><strong>User Administration Privileges</strong></p>

<table><thead><tr><th valign="top">User Role</th><th valign="top">Account</th><th valign="top">GXC Partner</th><th width="138.8333740234375" valign="top">Super Administrator</th><th width="139.666748046875" valign="top">Administrator</th><th width="97.166748046875" valign="top">Viewer</th></tr></thead><tbody><tr><td valign="top">GXC Administrator</td><td valign="top">Super CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td></tr><tr><td valign="top">GXC Partner</td><td valign="top">R for associated accounts</td><td valign="top">R</td><td valign="top">CR</td><td valign="top">CRUD</td><td valign="top">CRUD</td></tr><tr><td valign="top">Super Administrator</td><td valign="top">R for self account</td><td valign="top">CRUD for self account</td><td valign="top">R</td><td valign="top">CRUD</td><td valign="top">CRUD</td></tr><tr><td valign="top">Administrator</td><td valign="top">No</td><td valign="top">R</td><td valign="top">R</td><td valign="top">R</td><td valign="top">RUD</td></tr><tr><td valign="top">Viewer</td><td valign="top">No</td><td valign="top">R</td><td valign="top">R</td><td valign="top">R</td><td valign="top">R</td></tr></tbody></table>

The following table summarizes Onyx Portal RBAC across user roles.

<p align="center"><strong>Onyx Portal Administration Privileges</strong></p>

**Venues**

<table><thead><tr><th width="99.6666259765625">Module</th><th width="139.833251953125">GXC Administrator</th><th>GXC Partner</th><th width="138">Super Administrator</th><th width="137.1666259765625">Administrator</th><th>Viewer</th></tr></thead><tbody><tr><td>Venue</td><td>CRUD</td><td>CRUD</td><td>CRUD</td><td>RU</td><td>R</td></tr><tr><td>Floors</td><td>CRUD</td><td>CRUD</td><td>CRUD</td><td>RU</td><td>R</td></tr></tbody></table>

**Equipment**

<table data-header-hidden><thead><tr><th valign="top"></th><th valign="top"></th><th valign="top"></th><th valign="top"></th><th valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Onyx Edge</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">R</td></tr><tr><td valign="top">Onyx Edge Upgrade Groups</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">R</td><td valign="top">R</td></tr><tr><td valign="top">Access Point</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">R</td></tr><tr><td valign="top">Access Point Upgrade Groups</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">R</td><td valign="top">R</td></tr><tr><td valign="top">Mesh Node</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">R</td></tr><tr><td valign="top">Mesh Node Upgrade Groups</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">R</td><td valign="top">R</td></tr><tr><td valign="top">FHM</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">R</td></tr><tr><td valign="top">FHM Upgrade Groups</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">R</td><td valign="top">R</td></tr></tbody></table>

**Subscribers**

| Subscriber Secrets                                | CRUD | Unauthorized | Unauthorized | Unauthorized | Unauthorized |
| ------------------------------------------------- | ---- | ------------ | ------------ | ------------ | ------------ |
| Subscriber Info / Traffic Policy, APN Association | RU   | RU           | RU           | RU           | R            |
| Subscriber Info - IMEI Association                | RU   | RU           | RU           | RU           | R            |
| Bulk Export / Import                              | CRUD | Unauthorized | Unauthorized | Unauthorized | Unauthorized |
| Session Monitoring                                | R    | R            | R            | R            | R            |

**Network**

| Network      | CRUD | CRUD | CRUD | R | R |
| ------------ | ---- | ---- | ---- | - | - |
| Network List | CRUD | CRUD | CRUD | R | R |

**Traffic**

| Policies | CRUD | CRUD | CRUD | CRUD | R |
| -------- | ---- | ---- | ---- | ---- | - |
| Profiles | CRUD | CRUD | CRUD | CRUD | R |

**Alerts**

| Alerts Visibility | R    | R    | R    | R   | R |
| ----------------- | ---- | ---- | ---- | --- | - |
| Rules             | CRUD | R    | R    | R   | R |
| Receivers         | CRUD | CRUD | CRUD | CRU | R |

**Analytics**

| Generate Reports | R | R | R | R | R |
| ---------------- | - | - | - | - | - |

**Audit Logs**

| Audit Logs Visibility | R | R | R | Unauthorized | Unauthorized |
| --------------------- | - | - | - | ------------ | ------------ |

### Onyx Portal User Idle Session Timeout

While users inherit partner or customer account timeout settings by default, administrators can configure custom timeouts for individual users based on their roles, operational needs, or security policies.

The custom timeout setting can be configured when adding or editing a user account.

The custom timeout setting can be configured in one of the following ranges:

* 5–59 minutes
* 1–23 hours
* 1–7 days

For SSO user accounts, idle session timeout in Onyx Portal is independent of the SSO/SAML IdP configuration. If the Onyx Portal timeout is shorter than the IdP's, users are logged out but silently reauthenticated if the IdP session is still valid. If the Onyx Portal timeout is longer, users must fully reauthenticate once the IdP session expires.

For multi-tenant user accounts, the idle session timeout is determined by the base tenant's setting.

### View User Accounts

{% hint style="info" %}
**NOTE:** If you are a GXC Administrator, when you are in the GXC Root account, you can view all Onyx Portal users irrespective of their account hierarchy.
{% endhint %}

{% hint style="info" %}
**NOTE:** If you are a GXC Partner Administrator, when you are in your own partner account, you can view all users within your own partner account and those in your direct customer accounts.
{% endhint %}

{% hint style="info" %}
**NOTE:** If you are a Super Administrator or an Administrator, you can view all users within your own customer account.
{% endhint %}

{% hint style="info" %}
**NOTE:** To view, create, and manage users in a particular Onyx Portal account, you must switch to that account.
{% endhint %}

* View User Accounts under Non-GXC Root Accounts
* View User Accounts under the GXC Root Account

#### View User Accounts under Non-GXC Root Accounts

{% hint style="info" %}
**NOTE:** You can view user accounts under non-GXC Root accounts only if you are a GXC Administrator or Partner Administrator.
{% endhint %}

**To view user accounts under non-GXC Root accounts:**

{% stepper %}
{% step %}
Switch to the required Onyx Portal account.

To switch between Onyx Portal accounts, in the upper-right corner of the page, click the current Onyx Portal account's name, then select the required account.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Users** tab.

The **Administration** page > **Users** tab displays the list of active user accounts from across all Onyx Portal accounts.

* **Users (n)** – The count and list of user accounts in the selected Onyx Portal account.
  * **User Email** – The user's email address.
  * **User Name** – The user's name.
  * **User Role** – The user's role—Super Admin, Admin, Viewer.
  * **Network** – The networks under the selected Onyx Portal customer account that the user has permission to manage.
  * **Actions** – Shortcut options to edit and delete the user account.
    {% endstep %}

{% step %}
To search for a particular user account, in the **Search** field, enter your search term.
{% endstep %}
{% endstepper %}

#### View User Accounts under the GXC Root Account

{% hint style="info" %}
**NOTE:** You can view user accounts under the GXC Root account only if you are a GXC Administrator.
{% endhint %}

**To view user accounts under the GXC Root account:**

{% stepper %}
{% step %}
Switch to the GXC Root account.

To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click **Other Accounts** > **Select GXC Root**.
{% endstep %}

{% step %}
To view all existing user accounts under the GXC Root account:

1. Click **Administration** > **Users** tab.

   The **Administration** page > **Users** tab displays the list of active user accounts from across all Onyx Portal accounts.

   * **Name** – The user's name.
   * **Role** – The user's role—GXC Admin, Super Admin, Admin, Viewer.
   * **Email** – The user's email address.
   * **Status** – The user account's status—Verified, Verification Pending, Forgot Password.
   * **Account Name** – The Onyx Portal account that the user is associated with.
   * **Parent Account Name** – The parent account of the Onyx Portal account that the user is associated with.
   * **Actions** – Shortcut options to edit, delete, and suspend the user account.

   To search for a particular user account, in the upper-right corner of the page, in the **Search** field, enter your search term.
   {% endstep %}

{% step %}
To view user accounts under a particular GXC partner account:

1. Click **Administration** > **Partners** tab.\
   The summary details of all GXC partner accounts are displayed.
2. Click the GXC partner account's name.\
   The ***\<partner name>*** page is displayed.\
   The **Own Users** section lists the user accounts under the GXC selected partner account.
   {% endstep %}

{% step %}
To view the user accounts under a particular customer account:

1. Click **Administration** > **Customers** tab.\
   The list of customer accounts is displayed.
2. Click the customer account's name.\
   The ***\<customer name>*** page is displayed.\
   The **Own Users** section lists the user accounts under the selected customer account.
   {% endstep %}
   {% endstepper %}

### Create User Accounts

This section describes creating the following types of user accounts:

* Create direct user accounts:
  * Create Direct Super Administrator, Administrator, or Viewer User Accounts
  * Create GXC Administrator User Account
* Create upstream IdP user accounts

#### Create Direct Super Administrator, Administrator, or Viewer User Accounts

{% hint style="info" %}
**NOTE:** If you are a GXC Administrator or a GXC Partner Administrator, you can add Super Administrator, Administrator, and Viewer user accounts. If you are a Super Administrator, you can add Administrator and Viewer user accounts.
{% endhint %}

**To create a direct Super Administrator, Administrator, or Viewer user account under non-GXC Root accounts:**

{% stepper %}
{% step %}
Switch to the required GXC partner or customer account.

To switch between Onyx Portal accounts, in the upper-right corner of the page, click the current Onyx Portal account's name.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Users** tab.

The **Administration** page > **Users** tab displays the list of active user accounts.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Add User**.

The **Create User** page is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fx59igEIhcuzuFDkhRQGf%2Fimage.png?alt=media&amp;token=19b81f15-dbd6-46c0-8fd5-fbb25862b427" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

* **User Email** – (Required) The user's email address.

{% hint style="info" %}
**NOTE:** If the email ID that you enter is already associated with a user account in another Onyx Portal customer account, the user can be invited to manage the current Onyx Portal customer account with any role.
{% endhint %}

* **Invite user to manage the current Onyx Portal customer account** – (Displayed only if the email ID is already associated with an existing user account in any other Onyx Portal customer account.) To invite the user to manage the current Onyx Portal customer account, select the check box.
* **User Name** – (Required) The user's full name.
* **Role** – (Required) The user's role. Select from **Super Admin**, **Admin**, **Viewer**.
* **Network** – Click to select from the list of networks in the customer account, all or specific networks that the user must have access to manage. To remove access to a particular network, clear the corresponding checkbox. Default value: **All Networks**.
* **Use account-level idle session timeout setting** – To inherit the GXC partner/customer account level user idle timeout setting, select the checkbox. To configure a custom value, clear the checkbox and enter a value from one of the following ranges.
  * 5–59 minutes
  * 1–23 hours
  * 1–7 days
    {% endstep %}

{% step %}
To save the user account, in the upper-right corner of the page, click **Save User**.
{% endstep %}
{% endstepper %}

#### Create Upstream IdP Super Admin, Admin, and Viewer User Accounts

Upstream IdP users are users who authenticate and are managed via a customer's IdP service rather than being managed directly by the Onyx Portal. If a customer's IdP cannot release the user attributes required for SSO user authentication (onyxPortalTenantId and onyxPortalRole) to the Onyx IdP, user accounts for Onyx Portal users in the customer's organization are created in the Onyx Portal.

{% hint style="info" %}
**NOTE:** If you are a GXC Administrator or a GXC Partner Administrator, you can add Super Administrator, Administrator, and Viewer user accounts. If you are a Super Administrator, you can add Administrator and Viewer user accounts.
{% endhint %}

**To create an upstream IdP Super Admin, Admin, or Viewer user account:**

{% stepper %}
{% step %}
Switch to the required GXC partner or customer account.

To switch between Onyx Portal accounts, in the upper-right corner of the page, click the current Onyx Portal account's name.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Users** tab.

The **Administration** page > **Users** tab displays the list of active user accounts.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Add Upstream IdP User**.

The **Create User** page is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FvsUCrNaksVjoTmOo99ue%2Fimage.png?alt=media&amp;token=fa61b571-7481-4531-b89c-4defc14f05ff" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

* **User Email** – (Required) The user's email address.

{% hint style="info" %}
**NOTE:** If the email ID that you enter is already associated with a user account in another Onyx Portal customer account, the user can be invited to manage the current Onyx Portal customer account with any role.
{% endhint %}

* **Invite user to manage the current Onyx Portal customer account** – (Displayed only if the email ID is already associated with an existing user account in any other Onyx Portal customer account.) To invite the user to manage the current Onyx Portal customer account, select the check box.
* **User Name** – (Required) The user's full name.
* **Role** – (Required) The user's role. Select from **Super Admin**, **Admin**, **Viewer**.
* **Network** – Click to select from the list of networks in the customer account, all or specific networks that the user must have access to manage. To remove access to a particular network, clear the corresponding checkbox. Default value: **All Networks**.
  {% endstep %}

{% step %}
To save the user account, in the upper-right corner of the page, click **Save User**.
{% endstep %}
{% endstepper %}

### Edit User Accounts

{% hint style="info" %}
**NOTE:** If you are a GXC Administrator, you can edit Super Administrator, Administrator, and Viewer user accounts. If you are a GXC Partner or a Super Administrator, you can only edit Administrator and Viewer user accounts.
{% endhint %}

This section applies to editing both direct and upstream IdP user accounts under non-GXC Root accounts.

{% hint style="info" %}
**NOTE:** You can edit a user account only to change the user's name. Details such as the user's email address and role are not editable.
{% endhint %}

**To edit a user account under non-GXC Root accounts:**

{% stepper %}
{% step %}
Switch to the required GXC partner or customer account.

To switch between Onyx Portal accounts, in the upper-right corner of the page, click the current Onyx Portal account's name.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Users** tab.

The **Administration** page > **Users** tab > **Users** section displays the list of active user accounts.
{% endstep %}

{% step %}
For the user account that you want to edit, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FxdxwTyBfpPBnx6seqVcE%2Fimage.png?alt=media&amp;token=25a7f022-be19-4c0c-a887-0c7bc66b0d98" alt="" width="162"><figcaption></figcaption></figure></div>

The **Edit User Access** page is displayed.
{% endstep %}

{% step %}
Edit the user's name or allowed networks as required.

* **User Email** – (View-only field) The user's email address.
* **User Name** – (Required) The user's name.
* **Role** – (View-only field) The user's role.
* **Network** – Click to select from the list of networks in the customer account, all or specific networks that the user must have access to manage. To remove access to a particular network, clear the corresponding checkbox. Default value: **All Networks**.
* **Use account-level idle session timeout setting** – To inherit the GXC partner/customer account level user idle timeout setting, select the checkbox. To configure a custom value, clear the checkbox and enter a value from one of the following ranges.
  * 5–59 minutes
  * 1–23 hours
  * 1–7 days
    {% endstep %}

{% step %}
To save your edits, in the upper-right corner of the page, click **Save User**.
{% endstep %}
{% endstepper %}

{% hint style="info" %}
**NOTE:** You can edit user accounts under the GXC Root account only if you are a GXC Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** You can edit a user account only to change the user's name. Details such as the user's email address and role cannot be edited.
{% endhint %}

**To edit user accounts under the GXC Root account:**

{% stepper %}
{% step %}
Switch to the GXC Root account.

To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click **Other Accounts** > **Select GXC Root**.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Users** tab.

The **Administration** page > **Users** tab displays the list of active user accounts.
{% endstep %}

{% step %}
For the user account that you want to edit, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

The **Edit User Access** page is displayed.
{% endstep %}

{% step %}
Edit the user's name as required.

* **User Email** – (View-only field) The user's email address.
* **User Name** – (Required) The user's name.
* **Role** – (View-only field) The user's role.
* **Use account-level idle session timeout setting** – To inherit the GXC partner/customer account level user idle timeout setting, select the checkbox. To configure a custom value, clear the checkbox and enter a value from one of the following ranges.
  * 5–59 minutes
  * 1–23 hours
  * 1–7 days
    {% endstep %}

{% step %}
To save your edit, in the upper-right corner of the page, click **Save User**.
{% endstep %}
{% endstepper %}

### Reset User MFA Secrets

If a user's mobile phone is compromised or lost, and the user's MFA backup codes are unavailable or exhausted, you can reset the user's MFA secrets. Resetting a user's MFA secrets is equivalent to deleting the user's MFA registration, allowing the user to set up MFA again as if for a new user.

{% hint style="info" %}
**NOTE:** If a user does not have access to his/her phone temporarily, the user can use the backup codes to log in. For more information, see *Reset Your MFA Secrets*.
{% endhint %}

**To reset a user's MFA secrets:**

{% stepper %}
{% step %}
Switch to the required GXC partner or customer account.

To switch between Onyx Portal accounts, in the upper-right corner of the page, click the current Onyx Portal account's name.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Users** tab.

The **Administration** page > **Users** tab displays the list of active user accounts.
{% endstep %}

{% step %}
For the user account that you want to reset MFA secrets, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Reset MFA Secrets**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5k6Mk5pyVSuKjWU3HFaV%2Fimage.png?alt=media&amp;token=74c5889f-4908-49ef-a117-640761cb4eb4" alt="" width="162"><figcaption></figcaption></figure></div>

A confirmation dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FG4Oq0AgeYqtUWDrlMZhH%2Fimage.png?alt=media&amp;token=ead4acda-4b4d-431d-9c16-85445e203c09" alt="" width="430"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To confirm resetting the user's MFA secrets, click **Yes**.
{% endstep %}
{% endstepper %}

### Suspend User Accounts

**To suspend a user account:**

{% stepper %}
{% step %}
Switch to the required Onyx Portal account.

To switch between Onyx Portal accounts, in the upper-right corner of the page, click the current Onyx Portal account's name, then select the required account.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Users** tab.

The **Administration** page > **Users** tab displays the list of active user accounts.
{% endstep %}

{% step %}
For the user account that you want to suspend, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Suspend Account**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJcBW0HWGYUFUV8iDNpdi%2Fimage.png?alt=media&amp;token=e8fa45b2-2513-48c3-9dd6-75d8e0f71e23" alt="" width="162"><figcaption></figcaption></figure></div>

A confirmation dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F012dHyVYUbq6mzd7oqOv%2Fimage.png?alt=media&amp;token=a7e988d9-e339-40e4-9d4d-41f80adbf2bf" alt="" width="315"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To confirm, click **Yes**.

The user account is suspended.
{% endstep %}
{% endstepper %}

### Activate Suspended User Accounts

**To activate a suspended user account:**

{% stepper %}
{% step %}
Switch to the required Onyx Portal account.

To switch between Onyx Portal accounts, in the upper-right corner of the page, click the current Onyx Portal account's name, then select the required account.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Users** tab.

The **Administration** page > **Users** tab displays the list of active user accounts.
{% endstep %}

{% step %}
For the suspended user account that you want to activate, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Activate Account**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fy0spDsYbCHKGvG12Y4Hy%2Fimage.png?alt=media&amp;token=4d5281a8-8e40-4f78-9a2a-96bcb1208c9b" alt="" width="164"><figcaption></figcaption></figure></div>

A confirmation dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FAhKNyjbB0VDa7tVboYdt%2Fimage.png?alt=media&amp;token=48d75b32-0f2e-4b46-a98e-8cd20f101981" alt="" width="311"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To confirm, click **Yes**.

The user account is activated.
{% endstep %}
{% endstepper %}

### Delete User Accounts

{% hint style="info" %}
**NOTE:** If you are a GXC Administrator, you can delete Super Administrator, Administrator, and Viewer user accounts. If you are a GXC Partner Administrator or a Super Administrator, you can delete Administrator and Viewer user accounts. If you are an Administrator, you can delete Viewer user accounts.
{% endhint %}

**To delete a user account from an Onyx Portal account:**

{% stepper %}
{% step %}
Switch to the required Onyx Portal account.

To switch between Onyx Portal accounts, in the upper-right corner of the page, click the current Onyx Portal account's name, then select the required account.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Users** tab.

The **Administration** page > **Users** tab displays the list of active user accounts.
{% endstep %}

{% step %}
For the user account that you want to delete, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Delete**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FAW9vpf39UkcED4UjgdaH%2Fimage.png?alt=media&amp;token=dc5914ae-1a57-4c24-b65d-924ca933ea48" alt="" width="162"><figcaption></figcaption></figure></div>

A confirmation dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fev8R9tu7KNDrI08hL5fQ%2Fimage.png?alt=media&amp;token=a05e7c40-16bd-4761-875e-5e8c8cac4ef9" alt="" width="323"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To confirm, click **Yes**.

The user account is deleted.
{% endstep %}
{% endstepper %}

## View Onyx Portal Operations Audit Logs

{% hint style="info" %}
**NOTE:** You can view the Onyx Portal Operations Audit Logs only if you are a GXC Administrator, GXC Partner Administrator, or a Customer Super Administrator.
{% endhint %}

The Onyx Portal supports audit logging of important Onyx Portal user operations, such as user log on and log out, all create, update, and delete operations, software upgrades, equipment restarts, log and cert file downloads, etc.

The audit logs are retained for a period of 60 days and can be downloaded as a .csv file.

The audit logs record details include the operation, the timestamp at which the operation occurred, the responsible user, client IP address, operation's category and sub-category, operation's status, and so on.

**To view the Onyx Portal Operations Audit Logs:**

{% stepper %}
{% step %}
Switch to the GXC Root account.

To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click **Other Accounts** > **Select GXC Root**.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Operations Audit Logs** tab.

The **Administration** page > **Operations Audit Logs** tab displays the list of Onyx Portal Operations Audit Logs for the selected duration and customer account.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fo9FDbsyb69jUNhq5Eo4W%2Fimage.png?alt=media&amp;token=099fda6c-e77c-4bdf-9a44-4cd6f3537dd1" alt=""><figcaption></figcaption></figure></div>

* **Audit Logs (n)** – The total number of audit logs.
* **Timestamp** – The timestamp at which the operation occurred.
* **Email** – The email address of the user responsible for the operation. To filter logs for a particular user, in the **Search Email** box, enter the user's email address.
* **Operation Name** – The operation's name—Post, Put, Delete. To filter logs based on operation name, in the dropdown select the required operation name.
* **Operation Category** – The operation's category. To filter logs based on operation category, in the dropdown select the required operation category.
* **Operation Sub-Category** – The operation's subcategory. To filter logs based on operation sub-category, in the dropdown select the required operation sub-category.
* **Operation Status** – The operation's status—Success, Failure, Blank. To filter logs based on operation status, in the dropdown select the required operation status.
* **Client IP** – The client IP address from which the operation occurred.
* **Request Details** – Click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fe9sbWyjTaTv7H9Uxf1aX%2Fimage.png?alt=media&amp;token=7dcb1613-80c5-455a-a3b3-9d6a80171763" alt="" data-size="line"> (view details) to view the object's details. The **Details** dialog box displays the object's details.
* **Request Object** – If available, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fm8UzH0qwmGi2Q11yURsZ%2Fimage.png?alt=media&amp;token=4d61a6a8-b41f-43a1-a059-9a4a85e62393" alt="" data-size="line"> (view details) to view the request details. The **Details** dialog box displays the object's request details.
* **Additional Details** – If available, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQTNk3Zb3t3kTfEWbk1AJ%2Fimage.png?alt=media&amp;token=c2fac062-515d-4284-9552-6f0b1f80ebd3" alt="" data-size="line"> (view details) to view additional object details, such as Onyx Edge or AP configuration, etc. The **Details** dialog box displays additional details.
  {% endstep %}

{% step %}
By default, logs are displayed for all customer accounts. To view logs for a specific customer account, in the **Tenant** dropdown, select the customer account's name.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FWZjeGLeK6OoqzFLm1TDY%2Fimage.png?alt=media&amp;token=b2a5ab5d-4293-4165-afcd-7e5530a1dcdb" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To change the selected duration for which logs are displayed, select the required from and to timestamps.
{% endstep %}

{% step %}
To search for logs using keywords, enter your search term in the **Search keyword** box.
{% endstep %}

{% step %}
To download the logs as a .csv file, click **Download**, and specify where to save the file.
{% endstep %}
{% endstepper %}


# Analytics

The Analytics feature generates Key Performance Indicator (KPI) reports that provide insight into the performance and status of your networks. You can generate analytics reports for specific functions and time durations to troubleshoot and optimize your networks.

## Analytics Reports

The Analytics feature provides three report types, each providing a different view of network performance data:

* [*Performance Summary Report*](#performance-summary-report)
* [*Performance Analytics Report*](#performance-analytics-report)

### Performance Summary Report&#x20;

The Performance Summary Report presents KPIs as single numerical values, each representing an aggregate over the selected duration and equipment scope. For instructions on generating this report, see [*Generate Analytics Reports*](#generate-analytics-reports).

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FOb66S3kVR4XF2nzdpIwz%2F5g-performance-summary.png?alt=media&amp;token=1ed82693-eb98-4d7e-ac9d-22331fbb077e" alt=""><figcaption></figcaption></figure></div>

The Performance Summary Report includes the following KPIs.

<table><thead><tr><th valign="top">Metric</th><th width="100" valign="top">4G / 5G</th><th valign="top">Description</th></tr></thead><tbody><tr><td valign="top">Average Uplink Throughput</td><td valign="top">4G, 5G</td><td valign="top">Average data transmission rate in the uplink direction (UE to AP) across the selected duration.</td></tr><tr><td valign="top">Peak Uplink Throughput</td><td valign="top">4G, 5G</td><td valign="top">Peak data transmission rate in the uplink direction (UE to AP) during the selected duration.</td></tr><tr><td valign="top">Uplink Traffic Volume</td><td valign="top">4G, 5G</td><td valign="top">Total data transmitted in the uplink direction (UE to AP) over the selected duration. Excludes MeshBackhaul traffic.</td></tr><tr><td valign="top">Average Downlink Throughput</td><td valign="top">4G, 5G</td><td valign="top">Average data transmission rate in the downlink direction (AP to UE) across the selected duration.</td></tr><tr><td valign="top">Peak Downlink Throughput</td><td valign="top">4G, 5G</td><td valign="top">Peak data transmission rate in the downlink direction (AP to UE) during the selected duration.</td></tr><tr><td valign="top">Downlink Traffic Volume</td><td valign="top">4G, 5G</td><td valign="top">Total data transmitted in the downlink direction (AP to UE) over the selected duration. Excludes MeshBackhaul traffic.</td></tr><tr><td valign="top">GPS Signal Availability</td><td valign="top">4G</td><td valign="top"><p>Average percentage of time the selected AP was GPS-connected during the selected duration.</p><p>Loss of GPS timing signal can cause drift, increased interference, and reduced cell capacity.</p></td></tr><tr><td valign="top">PRB Utilization Uplink</td><td valign="top">4G, 5G</td><td valign="top"><p>Average Physical Resource Block (PRB) utilization percentage on uplink shared channels, aggregated over five-minute intervals.</p><p>Includes Mesh UE traffic. All other KPIs exclude Mesh UE traffic.</p><p>See <a href="#prb-utilization-analytics"><em>PRB Utilization Analytics</em></a>.</p></td></tr><tr><td valign="top">PRB Utilization Downlink</td><td valign="top">4G, 5G</td><td valign="top"><p>Average PRB utilization percentage on downlink shared channels, aggregated over five-minute intervals.</p><p>Includes Mesh UE traffic. All other KPIs exclude Mesh UE traffic.</p><p>See <a href="#prb-utilization-analytics"><em>PRB Utilization Analytics</em></a>.</p></td></tr><tr><td valign="top">Access Point Uptime</td><td valign="top">4G, 5G</td><td valign="top"><p>Average percentage of time the AP was in service during the selected duration.</p><p>For CA-enabled APs, only the primary cell is accounted for — 100% does not confirm secondary cells were functioning.</p><p>For DC-enabled APs, both Cell 1 and Cell 2 are accounted for.</p></td></tr><tr><td valign="top">Downlink Cell BLER</td><td valign="top">5G</td><td valign="top"><p>Average downlink Block Error Rate (BLER) as a percentage, measuring error rate after decoding.</p><p>Elevated BLER indicates retransmissions are consuming capacity, reducing effective downlink throughput.</p></td></tr><tr><td valign="top">Uplink Cell BLER</td><td valign="top">5G</td><td valign="top"><p>Average uplink BLER as a percentage, measuring error rate after decoding.</p><p>High uplink BLER indicates poor UE transmit conditions — distance, obstruction, or interference.</p></td></tr><tr><td valign="top">Cell SRS SNR</td><td valign="top">5G</td><td valign="top"><p>Average Signal-to-Noise Ratio of Sounding Reference Signals (SRS), used for uplink channel quality estimation and scheduling decisions.</p><p>Low SNR correlates with higher BLER and lower modulation order selection. Measured in decibels (dB).</p></td></tr><tr><td valign="top">RRC Success Percentage</td><td valign="top">5G</td><td valign="top"><p>Average number of RRC connection establishments for the cell, expressed as a ratio of successful to attempted setups.</p><p>Failures at this layer prevent devices reaching the core network.</p></td></tr><tr><td valign="top">RACH Attempts</td><td valign="top">5G</td><td valign="top"><p>Number of Random Access Channel attempts during the selected duration.</p><p>High RACH load with a simultaneous fall in RRC Success Percentage indicates access congestion.</p></td></tr><tr><td valign="top">UE Connection Requests</td><td valign="top">4G, 5G</td><td valign="top"><p>4G: Number of UE attach requests (NAS layer Connection Requests) for the selected equipment and duration.</p><p>5G: Number of UE registration requests (NAS layer Connection Requests) for the selected equipment and duration.</p></td></tr><tr><td valign="top">UE Connection Success</td><td valign="top">4G, 5G</td><td valign="top"><p>4G: Percentage or count of successful UE attach accepts (NAS layer Connection Responses sent to UE).</p><p>5G: Percentage or count of successful UE registration accepts (NAS layer Connection Responses sent to UE).</p><p>Toggle between % and # display modes using the icon control.</p></td></tr><tr><td valign="top">Number of Dropped Calls</td><td valign="top">4G</td><td valign="top"><p>Number of implicit UE detaches — sessions terminated because the UE went out of coverage and did not refresh its registration periodically.</p><p>Distinct from attach failures; the device was previously connected. Also, see <a href="#performance-analytics-report"><em>Performance Analytics Report</em></a> > Dropped Call Rate.</p></td></tr><tr><td valign="top">Average Number of Active UE</td><td valign="top">4G, 5G</td><td valign="top"><p>Average number of active (connected) UE for the selected equipment and duration.</p><p>Measured at the Onyx Edge level. Not available when a specific AP is selected.</p></td></tr><tr><td valign="top">Average Number of Registered UE</td><td valign="top">4G, 5G</td><td valign="top"><p>Average number of registered UE (idle and connected) for the selected equipment and duration. Always >= active UE.</p><p>Measured at the Onyx Edge level. Not available when a specific AP is selected.</p></td></tr><tr><td valign="top">Paging Success</td><td valign="top">4G, 5G</td><td valign="top"><p>Percentage or count of successful paging attempts. Used by the network to wake idle registered UE.</p><p>Toggle between % and # display modes using the icon control.</p></td></tr><tr><td valign="top">NGAP Dropped Connections</td><td valign="top">5G</td><td valign="top"><p>Percentage or count of N2 interface connections dropped due to errors between the RAN and 5G core. Excludes drops caused by user inactivity or core-initiated releases.</p><p>Indicates instability in the control-plane path between the access network and the AMF.<br>Toggle between % and # display modes using the icon control.</p></td></tr><tr><td valign="top">SAS Availability</td><td valign="top">4G, 5G</td><td valign="top"><p>Average percentage of time SAS was available for the selected equipment and duration.</p><p>Applies only to CBRS-band deployments.</p><p>If SAS becomes unavailable, the network loses its spectrum grant and must suspend transmissions — causing a complete service outage regardless of radio or core health.</p></td></tr></tbody></table>

### Performance Analytics Report

The Performance Analytics Report presents KPIs as time-series line charts over the selected duration, enabling identification of trends, anomalies, and patterns not visible in point-in-time summary values. Not all charts are displayed by default — use the Manage Reports feature to add or remove charts from the report. For instructions on generating this report, see [*Generate Analytics Reports*](#generate-analytics-reports). For known sampling behavior affecting these charts, see [*Analytics Limitations*](#analytics-limitations).&#x20;

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FaxoLEZZT0up1cZ4gy1Tn%2F5g-performance-analytics.png?alt=media&amp;token=4ad2b404-d8af-4317-b804-7678e857a91e" alt=""><figcaption></figcaption></figure></div>

The Performance Analytics Report includes the following KPIs.

<table><thead><tr><th width="310.39990234375" valign="top">Chart</th><th width="100" valign="top">4G / 5G</th><th valign="top">Description</th></tr></thead><tbody><tr><td valign="top">Average Downlink Throughput</td><td valign="top">4G, 5G</td><td valign="top">Average downlink throughput across all or selected equipment at each time point.</td></tr><tr><td valign="top">Average Uplink Throughput</td><td valign="top">4G, 5G</td><td valign="top">Average uplink throughput across all or selected equipment at each time point.</td></tr><tr><td valign="top">Peak Downlink Throughput</td><td valign="top">4G, 5G</td><td valign="top">Maximum downlink throughput achieved across all or selected equipment at each time point.</td></tr><tr><td valign="top">Peak Uplink Throughput</td><td valign="top">4G, 5G</td><td valign="top">Maximum uplink throughput achieved across all or selected equipment at each time point.</td></tr><tr><td valign="top">Downlink Traffic Volume</td><td valign="top">4G, 5G</td><td valign="top">Total data sent in the downlink direction (AP to UE) for selected equipment at each time point. Excludes MeshBackhaul traffic.</td></tr><tr><td valign="top">Uplink Traffic Volume</td><td valign="top">4G, 5G</td><td valign="top">Total data sent in the uplink direction (UE to AP) for selected equipment at each time point. Excludes MeshBackhaul traffic.</td></tr><tr><td valign="top">Access Point Uptime</td><td valign="top">4G, 5G</td><td valign="top"><p>Average percentage of time the AP was in service at each time point.</p><p>Subject to the same CA/DC primary-cell accounting as the Performance Summary.</p></td></tr><tr><td valign="top">Cell Uptime</td><td valign="top">4G, 5G</td><td valign="top">Average percentage of time the cell was in service at each time point.</td></tr><tr><td valign="top">SAS Availability</td><td valign="top">4G, 5G</td><td valign="top"><p>Average percentage of time SAS was available for selected equipment at each time point.</p><p>Applies only to CBRS-band deployments.</p></td></tr><tr><td valign="top">UE Connection Requests</td><td valign="top">4G, 5G</td><td valign="top"><p>4G: Number of UE attach requests (NAS layer) for all or selected equipment at each time point.</p><p>5G: Number of UE registration requests (NAS layer) for all or selected equipment at each time point.</p></td></tr><tr><td valign="top">UE Connection Success</td><td valign="top">4G, 5G</td><td valign="top"><p>4G: Percentage or count of successful UE attach accepts at each time point.</p><p>5G: Percentage or count of successful UE registration accepts at each time point.</p><p>Toggle between % and # display modes using the icon control.</p></td></tr><tr><td valign="top">Average Number of Active UEs</td><td valign="top">4G, 5G</td><td valign="top"><p>Average number of active (connected) UE at each time point.</p><p>Not available when a specific AP is selected.</p></td></tr><tr><td valign="top">Average Number of Registered UEs</td><td valign="top">4G, 5G</td><td valign="top"><p>Average number of registered UE (idle and connected) at each time point. Always >= active UE.</p><p>Not available when a specific AP is selected.</p></td></tr><tr><td valign="top">PRB Utilization Downlink</td><td valign="top">4G, 5G</td><td valign="top"><p>Average downlink PRB utilization on shared channels aggregated over five-minute intervals at each time point.</p><p>Includes Mesh UE traffic. All other KPIs exclude Mesh UE traffic.<br>See <a href="#prb-utilization-analytics"><em>PRB Utilization Analytics</em></a>.</p></td></tr><tr><td valign="top">PRB Utilization Uplink</td><td valign="top">4G, 5G</td><td valign="top"><p>Average uplink PRB utilization on shared channels aggregated over five-minute intervals at each time point.</p><p>Includes Mesh UE traffic. All other KPIs exclude Mesh UE traffic.<br>See <a href="#prb-utilization-analytics"><em>PRB Utilization Analytics</em></a>.</p></td></tr><tr><td valign="top">Paging Success</td><td valign="top">4G, 5G</td><td valign="top"><p>Percentage or count of successful paging responses at each time point.</p><p>Toggle between % and # display modes using the icon control.</p></td></tr><tr><td valign="top">GPS Signal Availability</td><td valign="top">4G</td><td valign="top">Average percentage of time the selected AP was GPS-connected at each time point.</td></tr><tr><td valign="top">Dropped Call Rate</td><td valign="top">4G</td><td valign="top">Number of implicit UE detaches at each time point — sessions lost because the UE went out of coverage and did not refresh periodically. Also, see <a href="#performance-summary-report"><em>Performance Summary Report</em></a> > <em>Number of Dropped Calls</em>.</td></tr><tr><td valign="top">NGAP Dropped Connections</td><td valign="top">5G</td><td valign="top">Percentage or count of N2 interface connections dropped due to errors at each time point. Excludes drops caused by user inactivity or core-initiated releases. A spike indicates N2/AMF interface instability.<br>Toggle between % and # display modes using the icon control.</td></tr><tr><td valign="top">Downlink Cell BLER</td><td valign="top">5G</td><td valign="top">Percentage of downlink data blocks failing decoding after error correction at each time point.</td></tr><tr><td valign="top">Uplink Cell BLER</td><td valign="top">5G</td><td valign="top">Percentage of uplink data blocks failing decoding after error correction at each time point.</td></tr><tr><td valign="top">Cell SRS SNR</td><td valign="top">5G</td><td valign="top">SNR of Sounding Reference Signals at each time point, used for uplink channel quality estimation and scheduling decisions. Measured in decibels (dB).</td></tr><tr><td valign="top">RRC Connection Establishments</td><td valign="top">5G</td><td valign="top"><p>The RRC Connection Establishments chart provides per-cell visibility into RRC connection activity over time. It displays two data series — Successful (green) and Attempted (blue) — as a grouped bar chart, with raw connection counts on the y-axis and time on the x-axis.</p><p>Use this chart to assess both connection volume and success rate simultaneously. A significant gap between the Attempted and Successful series indicates RRC establishment failures, which may point to radio coverage issues, interference, or capacity constraints.</p></td></tr><tr><td valign="top">RACH Attempts</td><td valign="top">5G</td><td valign="top"><p>Number of Random Access Channel access attempts at each time point.</p><p>A spike coinciding with falling RRC Success Percentage confirms RACH congestion.</p></td></tr></tbody></table>

## Generate Analytics Reports

{% hint style="info" %}
**NOTE:** Analytics reports may include data for equipment that no longer exist (deleted and decommissioned equipment) but were operational during the sampling period.
{% endhint %}

{% hint style="info" %}
**NOTE:** The "PRB Utilization Downlink" and "PRB Utilization Uplink" KPIs include Mesh UE traffic. All other KPIs exclude Mesh UE traffic.
{% endhint %}

**To generate Analytics Reports:**

{% stepper %}
{% step %}
If you are a GXC Partner Administrator, switch to your own partner account.

If you are a Super Administrator, Administrator, or a Viewer, start with Step 2.
{% endstep %}

{% step %}
In the navigation pane, click **Analytics**.

The **Analytics** page is displayed.
{% endstep %}

{% step %}
Select from the following filter criteria.

As you select each criterion, the options available in the next criterion dropdown updates automatically.

If only one option exists at a given hierarchy level — such as a single network, venue, or Onyx Edge — the Onyx Portal automatically selects it and advances to the next criterion, reducing the number of steps required to reach a target cell or AP. Where multiple options exist at a level, manual selection is required as usual.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FliF8j2DzT5LazGMTAeuM%2Fimage.png?alt=media&amp;token=405b343f-e96b-4453-8e35-8a204602ef47" alt=""><figcaption></figcaption></figure></div>

* **Customer** – Select the Onyx Portal customer account.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> GXC Administrators, when in the GXC Root account, can select from all existing customer accounts.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> GXC Partner Administrators, when in their own partner account, can select from their own customer accounts.</p></div>
* **Network** – Select the network—**All 4G Networks**, **All 5G Networks**, or a specific network. Default value: **All 4G Networks**.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The options available in the <strong>Network</strong> drop-down correspond to the customer account selected in the <strong>Customer</strong> drop-down.</p></div>
* **Venue** – Select the venue—**All Venues** or a specific venue in the selected network. Default value: **All Venues**.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The options available in the <strong>Venue</strong> drop-down correspond to the network selected in the <strong>Network</strong> drop-down.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> In the <strong>Network</strong> drop-down, if you select <strong>All 4G Networks</strong> or <strong>All 5G Networks</strong>, the <strong>Venue</strong> drop-down displays <strong>All Venues</strong> and is disabled. To select a specific venue, in the <strong>Network</strong> drop-down, you must select a specific network.</p></div>
* **Onyx Edge** – Select the Onyx Edge—**All Onyx Edges** or a specific Onyx Edge in the selected venue. Default value: **All Onyx Edges**.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The options available in the <strong>Onyx Edge</strong> drop-down correspond to the venue selected in the <strong>Venue</strong> drop-down.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> If, in the <strong>Venue</strong> drop-down, you select <strong>All Venues</strong>, the <strong>Onyx Edge</strong> drop-down displays <strong>All Onyx Edge</strong> and is disabled. To select a specific Onyx Edge, in the <strong>Venue</strong> drop-down, you must select a specific venue.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The analytics reports may include data for Onyx Edge that do not exist (deleted and decommissioned Onyx Edge) but were operational in the selected duration.</p></div>
* **Cell** – Select the cell—**All Cells** or a specific cell. Default value: **All Cells**.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE</strong>: This filter is only available when a 5G network is selected.</p></div>
* **Access Point** – Select the AP—**All APs** or a specific AP associated with the selected cell. Default value: **All APs**.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The options available in the <strong>Access Point</strong> drop-down correspond to the Onyx Edge selected in the <strong>Onyx Edge</strong> drop-down.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> If, in the <strong>Onyx Edge</strong> drop-down, you select <strong>All Onyx Edges</strong>, the <strong>Access Point</strong> drop-down displays <strong>All APs</strong> and is disabled. To select a specific AP, in the <strong>Onyx Edge</strong> drop-down, you must select a specific Onyx Edge.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The analytics reports may include data for APs that do not exist (deleted and decommissioned APs) but were operational in the selected duration.</p></div>
* **Duration** – Select the duration for which the summary report must be generated—**Last 15 minutes**, **Last 30 minutes**, **Last 1 hour**, **Last 3 hours**, **Last 24 hours**, **Last 1 week**, **Last 15 days**, **Last 30 days**, **Last 60 days**, **Last 90 days**, or **Custom**. Default value: **Last 3 hours**.\
  The **Custom** option is limited to a maximum range of 90 days, as only 90 days of historical data is retained.

As you select each filter criterion, the analytics reports update automatically.
{% endstep %}

{% step %}
The **Performance Summary** tab, open by default, displays the performance summary report for the selected criteria.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FsFlX0caXqOJwRGk4QJAU%2F5g-performance-summary.png?alt=media&amp;token=15864ad8-1c45-44c8-8e60-6f52bad3a007" alt=""><figcaption></figcaption></figure></div>

* For KPI descriptions, see [*Performance Summary Report*](#analytics-reports).
* To download the summary report as a CSV file, click **Download Summary**.
* To view per-subscriber KPI report, click **Per Subscriber Report**. \
  The **Per Subscriber KPIs** dialog box is displayed.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FDGANEHKvznuUZISCDU2s%2Fimage.png?alt=media&amp;token=0607782b-a273-4d33-8832-3e61a5b84ef5" alt=""><figcaption></figcaption></figure></div>

  * **IMSI** – The subscriber's IMSI.
  * **Average DL Throughput** – The subscriber's average download data rate.
  * **Average UL Throughput** – The subscriber's average upload data rate.
  * **Peak DL Throughput** – The subscriber's maximum observed download speed.
  * **Peak UL Throughput** – The subscriber's maximum observed upload speed.
  * **DL Traffic Volume** – The subscriber's total downloaded data volume.
  * **UL Traffic Volume** – The subscriber's total uploaded data volume.
* To download the Per Subscriber Report, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FEwNftH4ullby3q9bpwOJ%2Fimage.png?alt=media&amp;token=7f6600f1-7346-4362-aaf4-59470f27f6cb" alt="" data-size="line"> (download).
  {% endstep %}

{% step %}
To view the Performance Analytics Report, click the **Performance Analytics** tab.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FUKm0qKQvXYprzyNqjcoc%2F5g-performance-analytics.png?alt=media&amp;token=776b8813-5014-478d-984b-792f46b128db" alt=""><figcaption></figcaption></figure></div>

* For chart descriptions, see [*Performance Analytics Report*](#analytics-reports).
* By default, not all available charts are displayed in the Performance Analytics Report. To view or hide a specific chart in the report:
  1. Click **Manage Reports**.\
     The **Manage Report KPIs** dialog box displays available KPIs, categorized into Common and 5G groups.

     <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FFibpVye4KJkVWBbGx7t6%2Fimage.png?alt=media&amp;token=93819f5e-66a1-49f6-889c-0fd80911afa2" alt="" width="563"><figcaption></figcaption></figure></div>
  2. To view a specific trend chart, move it to the **Selected KPIs** list.
  3. To hide a specific trend chart, move it to the **Choose KPIs** list.
  4. To save your changes, click **Save**.
* To download the report as a PDF file, click **Download All Charts**.
  {% endstep %}
  {% endstepper %}

## Analytics Limitations

This section describes the limitations of the Analytics feature in this release.

### Last Data Point on Plots Sometimes Drops to Zero

The last data point on Performance Analytics plots may sometimes drop to zero for one of the following reasons:

* The last data point may factually be zero.
* The data point for the last minute may be delayed. Very likely since the graph's right edge is close to the current time, and there may be a delay in collecting the metric from the corresponding equipment.
* The last data point may be missing due to the equipment going offline.

It is recommended to ignore the last data point on the plots.

### PRB Utilization Analytics

This limitation applies to the PRB Utilization Uplink and PRB Utilization Downlink KPIs in both the [*Performance Summary Report*](#performance-summary-report) and [*Performance Analytics Report*](#performance-analytics-report).

The Onyx Edge collects five-minute averaged statistics from the APs every five minutes. Since the data is backfilled for the last five minutes, any queries including the sampling time will give different values before and after that time. After the five-minute sampling time, refresh the report to view the correct data.

For example:

> An AP provides data at 10:00:29 with the value x.
>
> This covers five minutes average, from 09:55:29 to 10:00:29.
>
> The Onyx Edge generates the following five samples: 09:56:00 x, 09:57:00 x, 09:58:00 x, 09:59:00 x, 10:00:00 x.
>
> Say, the Onyx Edge pushed these at 10:00:50 into the Orchestrator/Prometheus.
>
> Any query done including this 09:55:00 to 10:00:00 interval until 10:00:50 is void (as these five data points do not exist), and any query done post 10:00:50 will give the correct value (as these data points now exist). Post 10:00:50, these values will never change for that duration.

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# 4G Onyx Portal 4.x Operations


# Overview

GXC's 4G Onyx Solution is a fully integrated enterprise-grade private LTE platform designed to deliver secure, high-performance wireless connectivity. Tailored for industrial, campus, and large commercial deployments, the architecture combines CBRS-based radio infrastructure with an on-premises core and centralized orchestration tools.

The Onyx architecture consists of several key components that work together to provide secure connectivity, centralized management, and scalable private LTE deployment.

<p align="center"><strong>GXC 4G Private Network Architecture</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKlZZgwWMwG00ndfmSwR2%2F4g-onyx-architecture.svg?alt=media&amp;token=9be4e36d-4aca-421a-a625-4505c73255a4" alt=""><figcaption></figcaption></figure>

## Onyx Edge

The Onyx Edge serves as the integrated LTE core and acts as the central processing unit of the private network. It combines the core LTE functions—Mobility Management Entity (MME), Home Subscriber Server (HSS), Serving Gateway (SGW), and Packet Data Network Gateway (PGW)—into a single platform. Together, these components provide secure device authentication, mobility management, and efficient routing of user data between the private LTE network, the enterprise LAN, and external networks such as the public internet.

The Onyx Edge is deployed on-premises on ONYX-ES hardware.

For information on Onyx Edge On-Premises, see *4G Onyx Edge On-Premises Installation and Operations Guide*.

## Access Points

The GXC Access Points (APs) are LTE radios purpose-built to operate on CBRS Band 48. These APs provide enterprise-grade LTE radio access with low latency and high throughput, supporting a wide range of connected devices.

Designed for rugged and demanding environments such as warehouses, manufacturing plants, and large campuses, they ensure continuous and reliable wireless access across both indoor and outdoor spaces.

GXC's 4G AP lineup includes indoor APs with a compact form factor, ideal for smart factories and large indoor spaces, and ruggedized outdoor APs for industrial yards, campuses, and extended-range needs.

## Mesh Nodes

Mesh Nodes enable wireless backhaul for APs where wired connectivity is unavailable. Each Mesh Node integrates a G101 or G501 AP with a mesh-capable radio to wirelessly connect back to the Onyx Edge. Using self-interference mitigation techniques, Mesh Nodes support simultaneous access and wireless backhaul traffic over the same CBRS band. This architecture supports flexible and rapid deployment of network infrastructure, making it ideal for temporary setups or complex physical environments.

GXC's Mesh Node lineup includes:

* GM01 — A compact, general-purpose mesh node designed for rapid extension of network coverage.
* GM02 — A hardened mesh node providing higher power output and improved backhaul performance for demanding outdoor or industrial environments.

For more information, see the *GM01 Mesh Node Hardware Installation and Configuration Guide* and/or *GM02 Mesh Node Hardware Installation and Configuration Guide*.

## Spectrum Access and SAS Integration

To operate in CBRS Band 48, GXC's solution integrates with certified Spectrum Access Systems (SAS) for dynamic spectrum allocation and interference management. This integration enables automated real-time spectrum coordination, ensuring reliable operation while maintaining compliance with FCC regulations. SAS registration and spectrum coordination are managed through the Onyx Platform, simplifying deployment and ongoing operation.

## SIM and Subscriber Management

The GXC solution supports both physical SIMs and eSIMs for subscriber authentication and UE access control. Subscriber profiles are managed by the HSS function within the Onyx Edge, while provisioning and policy enforcement are performed through the Onyx Portal. This ensures secure and granular control over which user equipment (UE) can access the network and under what conditions, supporting enterprise security and access management requirements.

## Onyx Orchestrator

The Onyx Orchestrator is GXC's cloud-hosted backend service responsible for network configuration and orchestration. It maintains configuration data, synchronizes settings across network components, and ensures policy enforcement. Onyx Edge and APs periodically communicate with the orchestrator to report operational status and receive configuration updates. This orchestration layer ensures consistent configuration, policy enforcement, and centralized monitoring of network performance.

## Onyx Portal

The Onyx Portal provides a centralized, web-based interface for monitoring and managing Onyx networks. It delivers intuitive control and operational visibility across all network components, enabling simplified management of complex enterprise private LTE deployments.


# Onyx Portal Login and Navigation

This section provides information for Onyx Portal users to get started using the Onyx Portal, including initial login procedures, portal navigation, and basic configurations to help users to familiarize themselves with the Onyx Portal's features and functions.

## Multi-factor Authentication

Multi-factor Authentication (MFA), also referred to as Two-Factor Authentication (2FA), is a layered approach to securing your Onyx Portal user account. A combination of two authenticators verifies your identity before you can log on to the Onyx Portal. Your Onyx Portal user ID/password is the first factor of authentication. A Time-based One-time Password (TOTP) generated by an authenticator app installed on your mobile phone is the second factor of authentication.

{% hint style="info" %}
**NOTE:** MFA is enabled system-wide for all Onyx Portal users and cannot be disabled.
{% endhint %}

{% hint style="info" %}
**NOTE:** If you log on to Onyx Portal using your customer organization's SSO credentials, you must follow your organization's MFA requirements.
{% endhint %}

**MFA workflow:**

{% stepper %}
{% step %}
Install an authenticator app on your mobile phone.

See [Install the Authenticator App](#install-the-authenticator-app).
{% endstep %}

{% step %}
Log on to the Onyx Portal and activate your MFA.

See [Activate Your MFA](#activate-your-mfa).
{% endstep %}

{% step %}
Whenever you log on to the Onyx Portal, use the current MFA OTP displayed in your authenticator app as your second factor of authentication.

See [Log On to the Onyx Portal](#log-on-to-the-onyx-portal).
{% endstep %}

{% step %}
If your mobile phone is compromised or lost, or your MFA backup codes are unavailable or exhausted, reset your MFA secrets.

See [Reset Your MFA Secrets](#reset-your-mfa-secrets).
{% endstep %}
{% endstepper %}

## Single Sign-On Authentication with IdP Support

Single Sign-On (SSO) and Identity Provider (IdP) are authentication mechanisms that work together to provide a seamless and secure user authentication experience across the Onyx Portal and other applications in the user's SSO ecosystem.

SSO is an authentication mechanism that allows users to access multiple applications and services with a single set of login credentials. Instead of requiring users to remember separate usernames and passwords for each application, SSO allows them to log in once and access all integrated applications or services without additional login steps. SSO simplifies the user experience, enhances security, and reduces the burden of managing multiple sets of user credentials.

An IdP is a trusted service that manages and authenticates user identities. It acts as the central authentication authority for user authentication within an ecosystem of applications. When a user tries to access an application that relies on the IdP for authentication, the IdP verifies the user's identity and grants or denies access accordingly. It also provides the user's identity information, such as username or email address, to the other applications or services.

The Onyx Portal can be integrated with a customer organization's existing IdP for user authentication. In which case, the user accounts exist in the customer's IdP. When a user attempts to access the Onyx Portal, the user is redirected to the customer's IdP login page. The IdP verifies the user's identity and issues a token or assertion that can be used to authenticate the user's access to the Onyx Portal and other applications or services within the customer's SSO ecosystem. This eliminates the need for the user to repeatedly provide login credentials.

If a customer's IdP cannot release the user attributes required for SSO user authentication (onyxPortalTenantId and onyxPortalRole) to the Onyx IdP, to enable SSO authentication for Onyx Portal users in the customer's organization, the user accounts are created in the Onyx Portal. To enable SSO authentication for such users, an "Upstream IdP User" parameter must be enabled at the user account level.

**Single Sign-On with IdP Support workflow:**

{% stepper %}
{% step %}
(GXC Administrators) Configure SSO authentication with IdP configuration in the customer's Onyx Portal account.

For more information, see Configure SSO Authentication with IdP Configuration.
{% endstep %}

{% step %}
(All SSO users) When you log on to the Onyx Portal, in the Login page, click the **Sign in to an organization** link, then enter your organization's name. You are redirected to your organization's IdP page. Complete the authentication requirements as directed.

For more information, see [Log On to the Onyx Portal](#log-on-to-the-onyx-portal).
{% endstep %}
{% endstepper %}

## Activate Your Onyx Portal User Account

When your Onyx Portal user account is created you will receive an email from <onyx.accounts@gxc.io> with a link to verify your email ID (Onyx Portal user ID) and set your password. To activate your Onyx Portal user account, you must verify your email ID and set your password.

{% hint style="info" %}
**NOTE:** If you have issues with activating your Onyx Portal user account, contact your Onyx Portal Administrator.
{% endhint %}

**To verify your email ID and set your password:**

{% stepper %}
{% step %}
In the email from <onyx.accounts@gxc.io> with the subject line "Email Verification and Password Creation Link", click the link to verify your email ID and set your password.

The **GXC Set Password** page is displayed.
{% endstep %}

{% step %}
Enter the following details, then click **Continue**.

* **New Password** – (Required) Your new password.
* **Confirm Password** – (Required) Renter your new password.

Your Onyx Portal password must conform to the following requirements:

* Contain at least eight characters
* Contain at least one integer
* Contain at least one uppercase character
* Contain at least one lowercase character
* Contain at least one special character from the following: !@#$%^&\*
  {% endstep %}
  {% endstepper %}

## Set Up MFA

To set up your MFA, you must have an authenticator app installed on your mobile phone. If you don't already have it, you must install an authenticator app to activate and use your MFA. For more information, see [Install the Authenticator App](#install-the-authenticator-app).

### Install the Authenticator App

To activate and use MFA, you must install an authenticator app on your mobile phone. Any authenticator app that generates TOTPs using the standard 'HMAC-based One-time Password' (HOTP) algorithms—such as Google Authenticator, Microsoft Authenticator, or DUO Mobile—can be used. The authenticator app generates the TOTPs used as the second factor of authentication.

This document describes how to use the Google Authenticator app, which is available for Android on the Google Play Store and for iPhone on the App Store.

### Activate Your MFA

{% hint style="info" %}
**NOTE:** Activating your MFA is a one-time procedure.
{% endhint %}

**To activate your MFA:**

{% stepper %}
{% step %}
Using a supported web browser visit [https://portal.gxc.io](https://portal.gxc.io/).

The Onyx Portal Login page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FYauDsvTOeOOv6OMSFDOv%2Fop-logon-page.png?alt=media&amp;token=fe5c26b1-491b-4757-874f-0a2556e96ac5" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details, then click **Login**:

* **Email** – (Required) Your Onyx Portal logon ID (email address).

The GXC IdP Login page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fzeyux7ZOdJ0772oKxip8%2Fop-logon-idp-page.png?alt=media&amp;token=33edfc47-6912-4ef0-955f-afb740185c5c" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details, then click **Login**:

* **Username** – (Required) Your Onyx Portal username (email address).
* **Password** – (Required) Your Onyx Portal password.
* **I'm not a robot** – (Displayed only if you fail a login attempt. Required.) Select to validate reCAPTCHA—a seamless fraud detection service that stops bots and other automated attacks by rate-limiting log on attempts while allowing valid users.

{% hint style="info" %}
**NOTE:** The I’m not a robot checkbox for reCAPTCHA validation is displayed only if you fail an Onyx Portal login attempt. For example, when you enter an incorrect username or password.
{% endhint %}

The **Activate Multi-Factor Authentication** dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fv7AMzVXnsKNuNooguZjC%2Fmfa-activate-auth.png?alt=media&amp;token=5b246ea3-d33a-406a-b28a-b4a267893e5b" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
On your mobile phone, open the authenticator app and scan the QR code displayed in the **Activate Multi-Factor Authentication** dialog box > **QR Code** section.

For example, if you are using the Google Authenticator app:

* If it is your first time setting up an MFA in the app, click **Scan a QR code**.
* If you have previously set up other MFA in the app, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Ff5xQCJKKDHIjeubQTWr4%2Fimage.png?alt=media&amp;token=218fc9b2-023a-435e-9329-16a8b0801730" alt="" data-size="line"> > **Scan a QR code**.
* If you are unable to scan the QR code, click **Enter a setup key**, then manually enter the alphanumeric key displayed in the **Activate Multi-Factor Authentication** dialog box > **Setup Key** section.

To copy the setup key to your clipboard, click ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FhKi93UAmFSDqvZbzANtG%2Fimage.png?alt=media\&token=1c599775-6a79-4372-8164-f29be4cf6d81) (copy).

The authenticator app displays a six-digit OTP.

You have activated your MFA successfully.

Hereon, every time you log in to the Onyx Portal, you must use the current OTP displayed in your authenticator app as your second factor of authentication.
{% endstep %}

{% step %}
Save your MFA backup codes to a safe location.

After activating your MFA, whenever you log on to the Onyx Portal, if you are unable to obtain an OTP from the authenticator app, instead of an OTP, you can use one of these backup codes as your second factor of authentication. For more information, see [MFA Backup Codes](#mfa-backup-codes).

To save your MFA backup codes as a text file, in the **Activate Multi-Factor Authentication** dialog box > **Backup Codes** section > click ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FAnrB6LHGSShgWhzKm0cO%2Fimage.png?alt=media\&token=0a584445-3e84-447d-a590-ba4af8661e98) (download).

{% hint style="info" %}
NOTE: If you do not download your backup codes before you confirm your MFA activation (Step 6), a text file containing your MFA backup codes is automatically downloaded to your computer. In your Downloads folder, look for the most recent text file with the name format “OnyxPortal\_BackupCodes\_*\<portal>*\_*\<date\_timestamp>*.txt”.
{% endhint %}
{% endstep %}

{% step %}
Confirm your MFA is activated.

You can log on to the Onyx Portal up to five times without activating your MFA. To skip activating your MFA, click **Skip**. After you exhaust your five grace logins, to access the Onyx Portal you must activate your MFA.

To confirm your MFA is activated, click **Confirm MFA OTP**. The **Confirm MFA OTP** dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FnMvYsAurLOXTQcpFgT9G%2Fmfa-confirm-otp.png?alt=media&amp;token=7253126e-f41c-4da5-8044-c47b65dc5bee" alt=""><figcaption></figcaption></figure>

Enter the MFA OTP displayed in the authenticator app on your mobile phone and click **Submit**.

The Onyx Portal Dashboard is displayed.
{% endstep %}
{% endstepper %}

### MFA Backup Codes

After activating your MFA, if your mobile phone is unavailable or you are unable to obtain an OTP from the authenticator app, instead of an OTP, you can pro tem use a backup code as your second factor of authentication.

You must make sure to save your backup codes that are displayed when you activate your MFA and whenever you reset your MFA secrets. For more information, see [Activate Your MFA](#activate-your-mfa) and [Reset Your MFA Secrets](#reset-your-mfa-secrets) respectively.

{% hint style="info" %}
**NOTE:** Only if you have saved the backup codes that were generated when you activated your MFA or last reset your MFA secrets, whichever is recent, can you use the backup codes.
{% endhint %}

{% hint style="info" %}
**NOTE:** The MFA backup codes are single use only and cannot be reused.
{% endhint %}

{% hint style="info" %}
**NOTE:** If you have not saved your backup codes, or if you have exhausted all your backup codes, you can reset your MFA secrets to generate a new set of backup codes. For more information, see [Reset Your MFA Secrets](#reset-your-mfa-secrets).
{% endhint %}

{% hint style="info" %}
**NOTE:** When you reset your MFA secrets, any previous backup codes will become invalid.
{% endhint %}

{% hint style="info" %}
**NOTE:** If you are unable to obtain MFA OTPs to log in to the Onyx Portal and have exhausted your MFA backup codes, you will have to create a support ticket to contact GXC Technical Support for assistance. When the message *"You have exhausted your MFA backup codes. Please contact GXC Technical Support for assistance.*" is displayed, click the "*Technical Support*" link to enter the "Onyx Support Portal" and create the support ticket.
{% endhint %}

## Access the Onyx Portal

You can use any of the following web browsers to access the Onyx Portal:

* Google Chrome (latest version)
* Mozilla Firefox (latest version)

## Log On to the Onyx Portal

You can log on to the Onyx Portal only if you have an Onyx Portal user account, or if SSO authentication is supported for your customer organization (your organization's IdP is integrated with the Onyx Portal/Onyx IdP).

* For information to log on with your Onyx Portal credentials, see [Log On Using Your Onyx Portal Credentials](#log-on-using-your-onyx-portal-credentials).
* For information to log on with your customer organization SSO credentials, see [Log On Using Your SSO Credentials](#log-on-using-your-organizations-sso-credentials).

### Log On Using Your Onyx Portal Credentials

{% hint style="info" %}
**NOTE:** Before you can log on to the Onyx Portal for the first time, you must activate your Onyx Portal user account. For more information, see [Activate Your Onyx Portal User Account](#activate-your-onyx-portal-user-account).
{% endhint %}

**To log on to the Onyx Portal using your Onyx Portal credentials:**

{% stepper %}
{% step %}
Using a supported web browser visit [https://portal.gxc.io](https://portal.gxc.io/).

The Onyx Portal Login page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FYauDsvTOeOOv6OMSFDOv%2Fop-logon-page.png?alt=media&amp;token=fe5c26b1-491b-4757-874f-0a2556e96ac5" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details, then click **Login**:

* **Email** – (Required) Your Onyx Portal logon ID (email address).

The IdP Login page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fzeyux7ZOdJ0772oKxip8%2Fop-logon-idp-page.png?alt=media&amp;token=33edfc47-6912-4ef0-955f-afb740185c5c" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details, then click **Login**:

* **Email** – (Required) Your Onyx Portal username (email address).
* **Password** – (Required) Your Onyx Portal password.
* **I'm not a robot** – (Displayed only if you fail a login attempt. Required.) Select to validate reCAPTCHA—a seamless fraud detection service that stops bots and other automated attacks by rate-limiting log on attempts while allowing valid users.

{% hint style="info" %}
NOTE: The I’m not a robot checkbox for reCAPTCHA validation is displayed only if you fail an Onyx Portal login attempt. For example, when you enter an incorrect username or password.
{% endhint %}

The 2FA page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FSZxAr8GF7mO7m3XAc9qZ%2Fop-logon-2fa-page.png?alt=media&amp;token=3953d6e4-5b02-4405-b433-578b25830d48" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the six-digit MFA OTP displayed in the authenticator app on your mobile phone, then click **Login**.

You are logged on to the Onyx Portal, and the Dashboard page is displayed.
{% endstep %}
{% endstepper %}

{% hint style="info" %}
**NOTE:** The six-digit OTP refreshes every 30 seconds and is valid only for one minute.
{% endhint %}

{% hint style="info" %}
**NOTE:** If your mobile phone is not accessible or you are unable to obtain an MFA OTP, instead of an MFA OTP you can pro tem use an MFA backup code to authenticate your Onyx Portal logon. For more information, see [MFA Backup Codes](#mfa-backup-codes).
{% endhint %}

{% hint style="info" %}
**NOTE:** If you are unable to obtain MFA OTPs to log in to the Onyx Portal and you have exhausted your MFA backup codes, you will have to create a support ticket to contact GXC Technical Support for assistance. When the message "*You have exhausted your MFA backup codes. Please contact GXC Technical Support for assistance.*" is displayed, click the "*Technical Support*" link to enter the "Onyx Support Portal" and create the support ticket.
{% endhint %}

### Log On Using Your Organization's SSO Credentials

{% hint style="info" %}
**NOTE:** If you log on to the Onyx Portal using your customer organization's SSO credentials, you must follow your organization's MFA requirements.
{% endhint %}

{% hint style="info" %}
**NOTE:** To use SSO authentication, your organization's IdP must be integrated with the Onyx IdP. In this case, the user accounts exist in the customer IdP and are authenticated by the customer IdP.
{% endhint %}

**To log on to the Onyx Portal using your organizational SSO credentials:**

{% stepper %}
{% step %}
Using a supported web browser visit [https://portal.gxc.io](https://portal.gxc.io/).

The Onyx Portal Login page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FYauDsvTOeOOv6OMSFDOv%2Fop-logon-page.png?alt=media&amp;token=fe5c26b1-491b-4757-874f-0a2556e96ac5" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Click the **Sign in to an Organization** link.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FVK5f9BYDetWLXvnf54N6%2Fop-logon-to-org-page.png?alt=media&amp;token=8ec57a16-265b-4b87-9dd9-258a231865db" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details, then click **Login**.

* **Organization Name** – (Required) Your organization's name.

Contact your Onyx Portal administrator for the organization name to use.

{% hint style="info" %}
**NOTE:** The Organization Name field is case-sensitive.
{% endhint %}

Your organization's IdP login page is displayed.
{% endstep %}

{% step %}
Enter the authentication information required by your organization's IdP and continue as instructed.

You are logged on to the Onyx Portal, and the Dashboard page is displayed.
{% endstep %}
{% endstepper %}

## Log Off from the Onyx Portal

**To log off from the Onyx Portal:**

{% stepper %}
{% step %}
In the upper-right corner of the page, click the current Onyx Portal account's name, then click **Logout**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fvc7A2j2WdRXsOUQkoexc%2Fop-account-menu.png?alt=media&amp;token=20b03610-43d3-484d-96c3-ac45cc5a36df" alt=""><figcaption></figcaption></figure>

You are logged out of the Onyx Portal.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmKfISlqEsQ70yDpimN0D%2Fop-logout.png?alt=media&amp;token=c6135855-394f-4a60-96f8-cec84fed4cad" alt=""><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}

### Single Log Off

If you logged on to the Onyx Portal using SSO with IdP authentication, on logging out, you will also be logged out from all other active applications and services supported within your SSO ecosystem.

### Automatic Termination of Idle User Sessions

The Onyx Portal automatically terminates idle user sessions after a configurable timeout period. Session timeout is configurable at the GXC partner and customer account levels, and at individual user level, with the user-level configuration taking precedence over the GXC partner/customer level configuration.

For more information, see [Create GXC Partner Accounts](#create-gxc-partner-accounts) or [Edit GXC Partner Accounts](#edit-gxc-partner-accounts) and [Create Customer Accounts](#create-customer-accounts) or [Edit Customer Accounts](#edit-customer-accounts) respectively.

## Reset Your Forgotten Onyx Portal Password

If you have forgotten your Onyx Portal password, you can reset it from the Onyx Portal Login page. Your new password must conform to the following requirements:

* Contain at least eight characters
* Contain at least one integer
* Contain at least one uppercase character
* Contain at least one lowercase character
* Contain at least one special character from the following: !@#$%^&\*

**To reset your forgotten Onyx Portal password:**

{% stepper %}
{% step %}
On the Onyx Portal Login page, click the **Reset/Forgot Password?** link.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FYauDsvTOeOOv6OMSFDOv%2Fop-logon-page.png?alt=media&amp;token=fe5c26b1-491b-4757-874f-0a2556e96ac5" alt=""><figcaption></figcaption></figure>

The Reset Password page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F3Agewdd5gFuNOtyni7G8%2Fop-reset-password.png?alt=media&amp;token=5f4f680c-159e-4fb0-9a5e-1f62dc3d69bd" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details, then click **Continue**.

1. **Email** – Enter your logon ID (email address).
2. Solve the CAPTCHA and enter the answer in the field provided below the CAPTCHA image.

An email is sent to your registered email address with a link to reset your password.

Note that the reset password link is valid for 24 hours and will expire afterward.
{% endstep %}

{% step %}
In the email, click the reset password link.

The Reset Password page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F4L6DmC4X0k1mvG308mCz%2Fop-reset-password-page.png?alt=media&amp;token=aaf62b65-1697-4388-8c11-e8847f0216d4" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details, then click **Continue**.

* **New Password** – (Required) Enter your new password.
* **Confirm Password** – (Required) Renter your new password to confirm.

The Onyx Portal Login page is displayed.
{% endstep %}
{% endstepper %}

## Change Your Onyx Portal Password

You can choose to change your active Onyx Portal password anytime you are logged on to the Onyx Portal.

Your Onyx Portal password must conform to the following requirements:

* Contain at least eight characters
* Contain at least one integer
* Contain at least one uppercase character
* Contain at least one lowercase character
* Contain at least one special character from the following: !@#$%^&\*

**To change your Onyx Portal password while you are logged on to the Onyx Portal:**

{% stepper %}
{% step %}
In the upper-right corner of the page, click the current Onyx Portal account's name, then click **Reset Password**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fvc7A2j2WdRXsOUQkoexc%2Fop-account-menu.png?alt=media&amp;token=20b03610-43d3-484d-96c3-ac45cc5a36df" alt=""><figcaption></figcaption></figure>

The **Reset Password** page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FdKtabYoXNoWbPKnkQzT8%2Fop-reset-password-page-change.png?alt=media&amp;token=ae9444dd-778d-425b-9d1a-ee4d611e9643" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details:

* **Old Password** – (Required) Your current password.
* **New Password** – (Required) Your new password.
* **Confirm Password** – (Required) Renter your new password.
* **Logout from all devices** – Turn on to log out of your Onyx Portal account on all devices.
  {% endstep %}

{% step %}
In the upper-right corner of the page, click **Reset Password**.
{% endstep %}
{% endstepper %}

## Reset Your MFA Secrets

If your mobile phone is compromised or lost, or your MFA backup codes are unavailable or exhausted, you must reset your MFA secrets. Resetting your MFA secrets is equivalent to deleting your MFA registration, allowing you to set up your MFA again as if you are a new user.

{% hint style="info" %}
**NOTE:** If you do not have access to your phone temporarily, you can use the backup codes to log in. If you do not have the backup codes, you must reset your MFA secrets.
{% endhint %}

**To reset your MFA secrets:**

{% stepper %}
{% step %}
In the upper-right corner of the page, click the current Onyx Portal account's name, then click **Reset MFA Secrets**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fvc7A2j2WdRXsOUQkoexc%2Fop-account-menu.png?alt=media&amp;token=20b03610-43d3-484d-96c3-ac45cc5a36df" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
NOTE: The Reset MFA Secrets option is enabled only if you have already activated your MFA. For more information, see *Activate Your MFA*.
{% endhint %}

A confirmation dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8JNXl9o7nscbIA4xTrKR%2Fmfa-reset-mfa-secrets-confirmation.png?alt=media&amp;token=3cc0a443-4d05-408b-b8b5-04fd2f7bbadc" alt="" width="309"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To reset your MFA secrets, click **Yes**.

The **Reset MFA Secrets** dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FBBBaHn1L2px3AOOoiyAN%2Fmfa-reset-mfa-secrets.png?alt=media&amp;token=54595451-1f18-4ed7-8e46-74db1b564057" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
On your mobile phone, open the authenticator app and scan the QR code displayed in the **Reset MFA Secrets** dialog box > **QR Code** section.

For example, if you are using the Google Authenticator app:

* If it is your first time setting up MFA in the app, click **Scan a QR code**.
* If you have previously set up other MFA in the app, click ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Ff5xQCJKKDHIjeubQTWr4%2Fimage.png?alt=media\&token=218fc9b2-023a-435e-9329-16a8b0801730) > **Scan a QR code**.
* If you are unable to scan the QR code, click **Enter a setup key**, then enter the alphanumeric key displayed in the **Reset MFA Secrets** dialog box > **Setup Key** section.&#x20;

  To copy the setup key to your clipboard, click ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FhKi93UAmFSDqvZbzANtG%2Fimage.png?alt=media\&token=1c599775-6a79-4372-8164-f29be4cf6d81) (copy).

The authenticator app displays a six-digit OTP.

You have reset your MFA secrets successfully.

Hereon, every time you log in to the Onyx Portal, you must use the current OTP displayed in your authenticator app as your second factor of authentication.
{% endstep %}

{% step %}
Save your MFA backup codes to a safe location.

Whenever you log on to the Onyx Portal, if you are unable to obtain an OTP from the authenticator app, instead of an OTP, you can use one of these backup codes as your second factor of authentication. For more information, see [MFA Backup Codes](#mfa-backup-codes).

To save your MFA backup codes as a text file, in the **Reset MFA Secrets** dialog box > **Backup Codes** section > click ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FAnrB6LHGSShgWhzKm0cO%2Fimage.png?alt=media\&token=0a584445-3e84-447d-a590-ba4af8661e98) (download).

{% hint style="info" %}
**NOTE:** When you reset your MFA secrets, any previous backup codes will become invalid.
{% endhint %}

{% hint style="info" %}
**NOTE:** If you do not download your backup codes before you close the **Reset MFA Secrets** dialog box, a text file containing your MFA backup codes is automatically downloaded to your computer. In your Downloads folder, look for the most recent file with the name format "OnyxPortal\_BackupCodes\_\_*\<date\_timestamp>*.txt".
{% endhint %}
{% endstep %}

{% step %}
To confirm your MFA secrets are reset, click **Confirm MFA OTP**. The **Confirm MFA OTP** dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fn9GADfwwXnY38g5f5qJQ%2Fmfa-confirm-otp.png?alt=media&amp;token=83317573-ff1d-4ef7-bbf4-b97f3600b5bb" alt="" width="308"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the MFA OTP displayed in the authenticator app on your mobile phone and click **Submit**.
{% endstep %}

{% step %}
The next time you try to log on to the Onyx Portal, after your user ID/password is authenticated, the **2-Factor Authentication OTP** dialog box is displayed. Enter the OTP displayed in your authenticator app and click **Login**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FSZxAr8GF7mO7m3XAc9qZ%2Fop-logon-2fa-page.png?alt=media&amp;token=3953d6e4-5b02-4405-b433-578b25830d48" alt=""><figcaption></figcaption></figure>

After the OTP is authenticated, you are logged in to the Onyx Portal, and the Dashboard page is displayed.
{% endstep %}
{% endstepper %}

## User Interface and Navigation

The Onyx Portal's user interface is organized into three primary areas, the header area at the top of the window, the navigation menu to the left, and the content area. The header and the navigation menu are always visible in the Onyx Portal interface allowing for intuitive and quick navigation and operations.

### Header Area

The Onyx Portal interface's header area.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fhvphait7kcJFGSoqjas7%2Fheader-area.png?alt=media&amp;token=d6a990cb-d957-4a17-bc9b-d568743f9e0b" alt=""><figcaption></figcaption></figure>

The Onyx Portal interface's header area displays the following:

* Default Network – The network for which data is currently displayed in the Onyx Portal. For more information on networks, see [Manage Networks](#manage-networks).
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FvFhfjNNljZH83H6y3GC8%2Fimage.png?alt=media\&token=5e6dc906-fc15-4acc-9a41-92264a3640f1) indicates the default network has not been selected.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXDGXdBPHuPtAPh1aXD9R%2Fimage.png?alt=media\&token=65cc3a88-7a1d-48c3-8605-8f8e84afa4e4) indicates the default network is a 4G network.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F9XpHpcJ9g9kll9RLsXFA%2Fimage.png?alt=media\&token=fb78e89c-d5a7-44c9-960d-e58c04f5c546) indicates the default network is a 5G network.
* <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FqD2jzY9FHHSKyVkr8OtL%2Fimage.png?alt=media&amp;token=1fe0918b-23c7-4db9-8416-fbeaffe98e11" alt="" data-size="line">(Active Alerts Counter) – The number of active Critical, Major, Minor, and Other alerts. The Other category accounts for alerts of Warning, Info, and Notice severities. To view alert details, click the panel. For more information on alerts, see [Manage Alerts](#manage-alerts).
* ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FLbdGcZbuR6AbIZIYlZc9%2Fimage.png?alt=media\&token=2d2233ad-552b-4d77-a9f2-1f8b5e38be2f)(Notifications) – Indicates any active Onyx Portal user notifications. For example, about a planned downtime for a software upgrade.

  * To view a summary list of active notifications, click the (Notifications) icon.

  <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fp4HJZ34ZetZkFjzrfaTn%2Fimage.png?alt=media&amp;token=854bf52e-f0dd-4ff6-9982-c66d574879d6" alt="" width="468"><figcaption></figcaption></figure>

  * To view a notification's details, click its title.
* GXC\_V\*..\* – The Onyx Portal's software version.
* *\<current Onyx Portal account's name>* – The currently selected Onyx Portal account's name. Click to access a shortcut menu to switch accounts, change your password, enable MFA, or log off from the Onyx Portal.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fvc7A2j2WdRXsOUQkoexc%2Fop-account-menu.png?alt=media&amp;token=20b03610-43d3-484d-96c3-ac45cc5a36df" alt="" width="185"><figcaption></figcaption></figure>

* **Current Account**
  * *\<current Onyx Portal account's name>*
    * *\<current user's email ID>*
* **Other Accounts**

  * **(R) Select GXC Root** – Click to switch to the GXC Root account.
  * **(C) Select Customer** – Click to switch to a customer account. The **Switch Customer** dialog box is displayed. Click the customer account's name.
  * **(P) Select Partner** – Click to switch to a GXC partner account. The **Switch Partner** dialog box is displayed. Click the GXC partner account's name.

  For information on Onyx Portal accounts, see [Manage Onyx Portal Accounts](#manage-onyx-portal-accounts).
* **Reset Password** – Click to change your Onyx Portal password. For more information, see [Change Your Onyx Portal Password](#change-your-onyx-portal-password).
* **Reset MFA Secrets** – Click to reset your MFA secrets.
* **Logout** – Click to log off from the Onyx Portal. For more information, see [Log Off from the Onyx Portal](#log-off-from-the-onyx-portal).

### Navigation Pane

You can use the navigation pane to quickly access the various Onyx Portal features. The navigation pane includes a collapse/expand toggle, allowing you to minimize the menu to icons only or expand it to display full labels. This provides additional screen space and helps you optimize your workspace layout based on your preferences and screen size.

* Collapsed State

  * Displays icon-only navigation
  * Maximizes screen real estate for viewing
  * Maintains quick access to menu items via recognizable icons

  <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FxR48fbQoFU8DrQWVLtD8%2Fimage8.png?alt=media&amp;token=4c1d9106-d32e-4206-ba9c-54a8103aaf70" alt=""><figcaption></figcaption></figure>
* Expanded State
  * Displays the full menu with icons and labels
  * Provides traditional navigation experience
  * Shows complete menu item names

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F9NJ0QNcPYWyu4h8LsiCd%2Fimage9.png?alt=media&amp;token=9821d563-c922-4766-b9c4-8f9ab205bade" alt=""><figcaption></figcaption></figure>

* **Dashboard** – View an overview of the network's key metrics at a glance. For more information, see [Administrator Dashboard](#administrator-dashboard) and [Onyx Portal Dashboard](#onyx-portal-dashboard).
* **Network** – View details and manage networks under the selected Onyx Portal account. For more information, see [Manage Networks](#manage-networks).
* **Venues** – View details and manage venues in the selected network. For more information, see [Manage Venues](#manage-networks).
* **Equipment** – View details and manage Onyx Edge, Mesh Node, and AP equipment in the selected network. For more information, see [Manage Equipment](#manage-equipment).
* **Subscribers** – View details and manage subscriber groups and subscriber accounts in the selected network. For more information, see [Manage Subscriber Groups and Accounts](#manage-subscriber-groups-and-accounts).
* **Traffic** – View details and manage APNs, Applications, and Application Groups in the selected network. For more information, see [Manage Traffic](#manage-traffic).
* **Analytics** – Generate Key Performance Indicator (KPI) reports that provide insight into the performance and status of your networks. For more information, see [Analytics](#analytics).
* **Alerts** – View details and manage alerts, alert rules, and alert receivers in the selected network. For more information, see [Manage Alerts](#manage-alerts).
* **Administration** – View details and manage administrative functionality including Onyx Portal accounts, user accounts, cloud configurations, etc. For more information, see [Administration](#administration).
* **Documentation** – View product release notes and user documentation.
* **Contact Us** – View the Onyx Technical Support Portal. Displays the Onyx Technical Support Portal to submit tickets and access the GXC Help Center.

### Administrator Dashboard

{% hint style="info" %}
**NOTE:** The Administrator Dashboard is exclusively available to GXC Administrators and GXC Partner Administrators.
{% endhint %}

GXC Administrators can use the Administrator Dashboard to monitor and to manage administration activities across all Onyx Portal accounts. If you are a GXC Administrator, to view the Administrator Dashboard, you must select the "GXC Root" account. To exit the Administrator Dashboard, select any other Onyx Portal account.

GXC Partner Administrators can use the Administrator Dashboard to monitor and manage administration activities within their direct customer accounts. If you are a GXC Partner Administrator, to view the Administrator Dashboard, you must select your own GXC partner account. To exit the Administrator Dashboard, select any of your customer accounts.

To switch between Onyx Portal accounts, in the upper-right corner of the page, click the current Onyx Portal account's name.

You can use the navigation pane to quickly access the various Onyx Portal features. The navigation pane includes a collapse/expand toggle, allowing you to minimize the menu to icons only or expand it to display full labels. This provides additional screen space and helps you optimize your workspace layout based on your preferences and screen size.

* Collapsed State

  * Displays icon-only navigation
  * Maximizes screen real estate for viewing
  * Maintains quick access to menu items via recognizable icons

  <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FHX5qNFFJFoTl38n9FL3Q%2Fimage10.png?alt=media&amp;token=c88f69e1-b8b5-4aeb-97a2-fe128f89a7c2" alt="" width="66"><figcaption></figcaption></figure>
* Expanded State

  * Displays the full menu with icons and labels
  * Provides traditional navigation experience
  * Shows complete menu item names

  <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FPbbpQNnoDXQfvbPNfqoA%2Fimage11.png?alt=media&amp;token=da53bf8d-eb36-40b5-9d5d-9874edc6a15a" alt="" width="162"><figcaption></figcaption></figure>

When in the Administrator mode, the navigation pane displays the following options:

* **Dashboard**: Displays the Administrator Dashboard.
  * **Subscriber** – Doughnut pie chart representation of the number of subscribers grouped by customers. The chart shows the top five customers, with the remaining customers grouped under the Others category.
  * **Customer** – Doughnut pie chart representation of the number of customers grouped by partners. For GXC Administrators, the chart shows the top five partners, with the remaining partners grouped under the Others category.
  * **Access Point** – Doughnut pie chart representation of the number of access points grouped by customers. The chart shows the top five customers, with the remaining customers grouped under the Others category.
  * **Access Point by Model** – Pie chart representation of the number of access points by model across all networks.
  * **Data Volume** – Aggregated data usage across all networks for all customers, or all networks for the selected customer since the last one year. This graph excludes Mesh UE traffic.
    * **Total** – The data volume transmitted in uplink and downlink directions.
    * **Upload** – The data volume transmitted in uplink direction.
    * **Download** – The data volume transmitted in downlink direction.
    * Doughnut pie chart representation of the total data volume transmission per customer. The chart shows the top five customers, with the remaining customers grouped under the Others category.
    * **Inventory** – (GXC Administrators) View the inventory list of all online and offline Onyx Edge, APs, and Mesh Nodes across all partners, customers, and networks.\
      (GXC Partners Administrators) The inventory list of all online and offline Onyx Edge, APs, and Mesh Nodes across the partner's direct customers and networks.
      * **Onyx Edge**&#x20;

        The Onyx Edge Inventory table is sorted by customer and grouped by Onyx Edge pools. Each pool can be expanded and collapsed to view or hide all the Onyx Edge in that pool. Onyx Edge that are not part of any pool are displayed as individual rows in the table.

        * **Name** – The Onyx Edge's name.
        * **Hardware ID** – The Onyx Edge equipment's vendor-assigned serial number.
        * **Partner** – The associated GXC partner account, if applicable.
        * **Customer** – The associated customer account.
        * **Venue** – The name of the venue hosting the Onyx Edge.
        * **Network** – The name of the network hosting the Onyx Edge.
        * **Support Plan** – The support plan assigned to the GXC partner / customer owning the equipment—Basic, Basic Plus, Platinum, and Partner Managed. For more information, see [Support Plans](#support-plans).
        * To search for a particular Onyx Edge, in the Search box, enter your search term (partner name, customer name, Onyx Edge name, hardware ID, venue, network, etc.).
        * **Download** – Click to download the Onyx Edge inventory list as a CSV format file.
      * **Access Point**
        * **Name** – The AP's name.
        * **Serial Number** – The AP equipment's vendor-assigned serial number.
        * **Model** – The AP's model.
        * **S/W Version** – The AP's software version.
        * **Partner** – The associated GXC partner account, if applicable.
        * **Customer** – The associated customer account.
        * **Venue** – The name of the venue hosting the AP.
        * **Network** – The name of the network hosting the AP.
        * **Support Plan** – The support plan assigned to the GXC partner / customer owning the equipment—Basic, Basic Plus, Platinum, and Partner Managed. For more information, see [Support Plans](#support-plans).
        * To search for a particular AP, in the Search box, enter your search term (partner name, customer name, AP name, serial number, model, etc.).
        * **Download Access Points** – Click to download the inventory list as a CSV format file.
      * **Mesh Node** – (4G equipment.)
        * **Name** – The Mesh Node's name.
        * **Serial Number** – The Mesh Node equipment's vendor-assigned serial number.
        * **Model** – The Mesh Node's model.
        * **Partner** – The associated GXC partner account, if applicable.
        * **Customer** – The associated customer account.
        * **Venue** – The name of the venue hosting the Mesh Node.
        * **Network** – The name of the network hosting the Mesh Node.
        * **Support Plan** – The support plan assigned to the GXC partner / customer owning the equipment—Basic, Basic Plus, Platinum, and Partner Managed. For more information, see [Support Plans](#support-plans).
        * To search for a particular Mesh Node, in the Search box, enter your search term (partner name, customer name, Mesh Node name, serial number, model, version, etc.).
        * **Download Access Points** – Click to download the inventory list as a CSV format file.
      * **FHM** – 5G equipment
        * **Name** – The FHM equipment's name.
        * **Serial Number** – The FHM equipment's vendor-assigned serial number.
        * **Model** – The FHM equipment's model.
        * **Partner** – The associated GXC partner account, if applicable.
        * **Customer** – The associated customer account.
        * **Venue** – The name of the venue hosting the FHM equipment.
        * **Network** – The name of the network hosting the FHM equipment.
        * **Support Plan** – The support plan assigned to the GXC partner / customer owning the equipment—Basic, Basic Plus, Platinum, and Partner Managed. For more information, see [Support Plans](#support-plans).
        * To search for a particular FHM, in the Search box, enter your search term (partner name, customer name, FHM name, serial number, model, version, etc.).
        * **Download** – Click to download the inventory list as a CSV format file.
    * **Analytics** – Generate Key Performance Indicator (KPI) reports that provide insight into the performance and status of networks. For more information, see [Analytics](#analytics).
    * **SIM Provisioning** – View GXC SIM card and eSIM inventory and add, edit, and delete SIM and eSIM entries. For more information, see [Manage SIM Provisioning](#manage-sim-provisioning).
    * **Administration** – View and manage partner, customer, and user accounts, and cloud resources.
      * **Partners** – (GXC Administrators only) View, edit, and delete individual GXC partner accounts.
        * **Add Partner** – Click to add a GXC partner account.\
          For information on creating and managing GXC partner accounts, see [Manage GXC Partner Accounts](#manage-gxc-partner-accounts).
      * **Customers** – (GXC Administrators) View, edit, and delete customer accounts across GXC's partners and GXC's direct customers.\
        (GXC Partner Administrators) View, edit, and delete customer accounts across the partner's direct customers.
        * **Add Customer** – Click to add a customer account.\
          For information on creating and managing customer accounts, see [Manage Customer Accounts](#manage-customer-accounts).
      * **Users** – (GXC Administrators) View, edit, delete, and suspend individual Onyx Portal user accounts across GXC's partners and GXC's direct customers.\
        (GXC Partner Administrators) View, edit, delete, and suspend individual Onyx Portal user accounts across the GXC partner's direct customers.
        * **Add User** – Click to add a user account.
        * **Download Users** – Click to download the list of users as a CSV file. \
          For information on creating and managing user accounts, see [Manage Onyx Portal User Accounts](#manage-onyx-portal-user-accounts).
      * **Cloud Resources** – View and manage cloud resource groups.
        * **Account ID** – The cloud account ID.
        * **Actions** – Options to update and delete the cloud account.
        * **Add Resource Group** – Click to add a cloud resource group.\
          For information on creating and managing cloud resource groups, see [Manage Cloud Resource Groups](#manage-cloud-resource-groups).
      * **Notifications** – (GXC Administrators only) View, activate, deactivate, edit, and delete user notifications for all Onyx Portal users.
        * **Add Notification** – Click to add a notification.\
          For information on creating and managing notifications, see Manage Notifications.
      * **Documentation** – View product release notes and user documentation.
      * **Contact Us** – View the Onyx Technical Support Portal. Displays the Onyx Technical Support Portal to submit tickets and access the GXC Help Center.

### Onyx Portal Dashboard

The Onyx Portal Dashboard simplifies portal operations providing a quick view of the selected network's infrastructure details and its overall health including venues, subscribers and their status, traffic throughput, CBRS SAS status, and Backhaul (SGi) health status. The Onyx Portal Dashboard is available to all users of the Onyx Portal.

**To view the Onyx Portal Dashboard:**

{% hint style="info" %}
**NOTE:** Verify the selected Onyx Portal account and network in the header area. For more information, see [Header Area](#header-area).
{% endhint %}

{% stepper %}
{% step %}
In the navigation pane, click **Dashboard**.

The Dashboard displays the following details for the selected network:

* **Onyx Edge** – The total number of Onyx Edge in the network.
  * **Online** – The consolidated online status of all Onyx Edge in the network. The "Online Status" icon's color indicates the Onyx Edge's reachability from the Onyx Portal.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FFKa8EXrkAtWT09iicYPv%2Fimage.png?alt=media&amp;token=db1ff966-c6cf-46b7-a7ff-113937167cff" alt="" data-size="line"> Green – Indicates all Onyx Edge are online.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FLG9dZ7OkQW6ND3u8AeWW%2Fimage.png?alt=media&amp;token=bc6bd7cf-80a1-4674-9c54-c1a113a862a6" alt="" data-size="line"> Amber – Indicates some Onyx Edge are online and others offline.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FBGOnQqUjF75ay4t2oiJk%2Fimage.png?alt=media&amp;token=63bb7324-fc0a-4644-bc82-b73f59c3edda" alt="" data-size="line"> Red – Indicates all Onyx Edge are offline.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FS27lqjvVrp6Le1z1dObB%2Fimage.png?alt=media&amp;token=44409a5f-dc6a-4664-ada0-555e214c2651" alt="" data-size="line"> Grey – Indicates data is loading or is not available.

    Hovering your cursor over the "Online Status" icon displays per Onyx Edge status.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKbHyxl0Iv7hDGgvhJ4Zh%2Fimage.png?alt=media&amp;token=f2aebb49-31f6-4210-8e67-aff7a3365b7e" alt="" data-size="line"> – Indicates the Onyx Edge is online.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F14iCDTHKofwnLTL071Av%2Fimage.png?alt=media\&token=18030363-fc98-4fd7-8c50-042818aad088) – Indicates the Onyx Edge is offline.
  * **Service Status** – The consolidated service status of all Onyx Edge in the network. The "Service Status" icon's color indicates the status of services running on the Onyx Edge.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FjobmcnnNm7M27nOnx4Wa%2Fimage.png?alt=media&amp;token=8fa7d79b-d63e-4f4e-9a9c-c6fe74bbdc8a" alt="" data-size="line"> Green – Indicates services on all Onyx Edge are up and running.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F4lhbBs23yXJKEW8YCDPm%2Fimage.png?alt=media&amp;token=1aff791e-b00c-4876-a3cd-6c5ba60129d4" alt="" data-size="line"> Amber – Indicates services on some Onyx Edge are facing manual or unexpected restarts.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FqHqzxW2uTTI9qsLDUVf7%2Fimage.png?alt=media&amp;token=5c7efd18-193d-45c2-879f-6b1a1ebbed03" alt="" data-size="line"> Red – Indicates services on all Onyx Edge are facing manual or unexpected restarts.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F4RPFksLnOmIIZkYugqYm%2Fimage.png?alt=media&amp;token=ea134740-81b9-4629-8260-8ef5710c3272" alt="" data-size="line"> Grey – Indicates all Onyx Edge are offline, or data is loading or is not available.

    Hovering your cursor over the "Service Status" icon displays per Onyx Edge status.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FxWb7OVJmAa74CW8yDkvH%2Fimage.png?alt=media&amp;token=143dc543-7749-45f9-9d87-31e778df48d7" alt="" data-size="line"> – Indicates all services are up and running.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FB0d0xgJyD1Ku7ILssxe3%2Fimage.png?alt=media&amp;token=7bc94d60-87e2-4de5-9b2c-ab0ff687c645" alt="" data-size="line"> – Indicates unexpected or manual restart of critical services.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fw8VWy8qX0Vh2LU25Omjh%2Fimage.png?alt=media&amp;token=c052e391-aa2b-47d0-b963-26b675548ba3" alt="" data-size="line"> – Indicates data is not available.
* **Access Point** – The total number of APs in the network.
  * **Online** – The consolidated online status of all APs in the network. The "Online Status" icon's color indicates reachability of APs from the Onyx Portal.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FlRrYGHBD09dN3Yn099HL%2Fimage.png?alt=media&amp;token=d7e024b6-ba8a-40d0-a1fe-dc675d71e7a4" alt="" data-size="line"> Green – Indicates all APs are online.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fb4l7zDuKymQszIYMLiaG%2Fimage.png?alt=media&amp;token=d50b2d3d-6d22-4eea-84a9-6f8d0c1eddc2" alt="" data-size="line"> Amber – Indicates some APs are online and others offline.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FYYnnJyxnzYnGqhh2cA0y%2Fimage.png?alt=media&amp;token=c823c4d3-f8bf-47a7-bcac-4543111dc278" alt="" data-size="line"> Red – Indicates all APs are offline.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F6Ff7Ih1wFwPex3B5BrE8%2Fimage.png?alt=media&amp;token=72bec2eb-7413-4a49-8691-9de0cb032c59" alt="" data-size="line"> Grey – Indicates data is loading or is not available.

    Hovering your cursor over the "Online Status" icon displays per AP status.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F6thZeWLcVg0ofS5TUGeh%2Fimage.png?alt=media&amp;token=16e8dd6e-94f9-4bab-82a6-d739d5cf0646" alt="" data-size="line"> – Indicates the AP is online.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FBL5N9zSKvzUSivPCqWRr%2Fimage.png?alt=media&amp;token=e15cd6ec-69fc-49b2-b398-22585951a626" alt="" data-size="line"> – Indicates the AP is offline.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FvMIoKDB5S6M1nC4CYpUI%2Fimage.png?alt=media&amp;token=98ca1e52-f307-46d6-a369-f1dc266baf69" alt="" data-size="line"> – Indicates any of the following:
      * The AP is offline.
      * The AP's cell state is shutdown.
      * The Onyx Edge associated with the AP is offline.
      * Data is not available.
  * **Service Status** – The consolidated service status of all APs in the network. The "Service Status" icon's color indicates the status of services running on the AP.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FUcjIaUD7nXphaKV73tuY%2Fimage.png?alt=media&amp;token=10082fd7-640c-4d96-ae9e-de96acff98fc" alt="" data-size="line"> Green – Indicates services on all APs are up and running.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQayhmzFjkqFZ1t1ezxFe%2Fimage.png?alt=media&amp;token=eca7e06c-e899-439b-ae2a-0d4b6361b0fb" alt="" data-size="line"> Amber – Indicates services on some APs are facing manual or unexpected restarts.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FWKALdMazNy5JwovuDJlP%2Fimage.png?alt=media&amp;token=625f5251-8c72-45d1-a8b5-4fc2d08f8cd1" alt="" data-size="line"> Red – Indicates services on all APs are facing manual or unexpected restarts.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FnMziRheQoJMeeAjTh3cj%2Fimage.png?alt=media&amp;token=5645e0ec-64ac-4b06-9df8-eded1bdb8687" alt="" data-size="line"> Grey – Indicates all APs are offline, or data is not available.

    Hovering your cursor over the "Service Status" icon displays per AP service status.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FZgY2fHz8aNUNmaR7UTOD%2Fimage.png?alt=media&amp;token=d087f498-66d8-48b4-989a-cb843cdb8ea7" alt="" data-size="line"> – Indicates all services are up and running.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FZeNS30l9z09In3Y2Wvk5%2Fimage.png?alt=media\&token=2a350006-342a-474f-974b-8320f1fe0607) – Indicates unexpected or manual restart of critical services.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FB2gJwXvulcJTaKmDJcLw%2Fimage.png?alt=media&amp;token=52c80746-8249-4138-b359-ea9e828b49bd" alt="" data-size="line"> – Indicates any of the following:
      * The AP is offline.
      * The AP's cell state is shutdown.
      * The Onyx Edge associated with the AP is offline.
      * Data is not available.
* **MME-AP Connections** – The number of MME-connected APs of the total APs in the network.
* **Mesh Node** – The total number of Mesh Node in the network.
  * **Online** – The consolidated online status of all Mesh Node in the network. The "Online Status" icon's color indicates reachability of the Mesh Node from the Onyx Portal.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fhx71DPgOhD7ccFpJpto4%2Fimage.png?alt=media&amp;token=c3073098-ffa8-4fc7-b245-3d15a39ee5e4" alt="" data-size="line"> Green – Indicates all Mesh Nodes are online.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FdknwsPsSYlV4HVmLroCf%2Fimage.png?alt=media&amp;token=5363e834-0fce-4322-9316-8f02e4e7ddb8" alt="" data-size="line"> Amber – Indicates some Mesh Nodes are online and some offline.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FrX6dPMLVCfFdRh2f2Qsp%2Fimage.png?alt=media&amp;token=2a78f93e-38c3-4d2c-95e6-58f153146a1f" alt="" data-size="line"> Red – Indicates all Mesh Nodes are offline.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F9KdhiAx8eAhJaBP1QpDH%2Fimage.png?alt=media&amp;token=62042a35-f1df-4027-85de-2a53d82dd003" alt="" data-size="line"> Grey – Indicates data is loading or is not available.

    Hovering your cursor over the "Online Status" icon displays the per Mesh Node status.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FiYKwIULI8GlxmEgte59y%2Fimage.png?alt=media&amp;token=3fccce76-3c47-488c-8b2b-cd31387c9c9f" alt="" data-size="line"> – Indicates the Mesh Node is online.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FBYKHf7znE0GlvA9laKd5%2Fimage.png?alt=media&amp;token=2209c88a-b070-476a-ba4b-80e329481874" alt="" data-size="line"> – Indicates the Mesh Node is offline.
  * **Service Status** – The consolidated service status of all Mesh Node in the network. The "Service Status" icon's color indicates the status of services running on the Mesh Node.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F2bBUUc2BmITzB4GZRFQr%2Fimage.png?alt=media&amp;token=91e80d9d-61d1-406a-ad20-3f90a4163bae" alt="" data-size="line"> Green – Indicates services on all Mesh Nodes are up and running.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FF4WhauZO3x3Z0YXaJPnE%2Fimage.png?alt=media&amp;token=36cd6ab9-38cf-46c3-b3a3-4b825c8ac8b9" alt="" data-size="line"> Amber – Indicates services on some Mesh Nodes are facing manual or unexpected restarts.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FrAsdLi63FR6R9XB7v47V%2Fimage.png?alt=media&amp;token=ff66f7e9-1b64-4cc8-9751-38eb054d4b6f" alt="" data-size="line"> Red – Indicates services on all Mesh Nodes are facing manual or unexpected restarts.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FP4D1n6EN0seeZRcOrr31%2Fimage.png?alt=media&amp;token=37525d90-4ab4-401f-a53c-4323aa44127f" alt="" data-size="line"> Grey – Indicates any of the following:
      * APs associated with the Mesh Nodes are offline.
      * APs associated with the Mesh Nodes are shut down.
      * All Mesh Nodes are offline.
      * Data is not available.

    Hovering your cursor over the "Service Status" icon displays the per Mesh Node service status.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FaEK06TWElFNSK00Ip9pH%2Fimage.png?alt=media&amp;token=9d5bf554-a081-4eb3-aa13-3bcb6c0eb91c" alt="" data-size="line"> – Indicates all services are up and running.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F9ouFSETNt7WixJICMnko%2Fimage.png?alt=media&amp;token=2087d7c9-6364-46f5-831d-744dc55106d8" alt="" data-size="line"> – Indicates unexpected or manual restart of critical services.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0Mg1X6tyaQqDBprap3po%2Fimage.png?alt=media&amp;token=b65a76c8-328d-4d52-881f-16b40f1a0588" alt="" data-size="line"> – Indicates any of the following:
      * The AP associated with the Mesh Node is offline.
      * The AP associated with the Mesh Node is shutdown.
      * The Mesh Node is offline.
      * Data is not available.
* **Onyx Edge Pool** – The number of Onyx Edge pools in the network, the pool names, and their HA connectivity status.<br>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The <strong>Onyx Edge Pool</strong> panel is displayed only if at least one Onyx Edge pool exists in the network. For more information on Onyx Edge pools, see <a href="#manage-onyx-edge-high-availability">Manage Onyx Edge High Availability</a>.</p></div>

  * Onyx Edge pool's HA connectivity status:

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FPGfQPwRRhmXNebBNjl5p%2Fimage.png?alt=media&amp;token=8c34b65a-07c3-40fd-8e9c-51a3c911c9e0" alt="" data-size="line"> Green – One Onyx Edge is functioning as the Primary ACS, and the others as Standby ACS.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FOJn9bIGuXDqh9RdelOqI%2Fimage.png?alt=media&amp;token=b3be7485-a168-4ff6-87df-378534ead13c" alt="" data-size="line"> Amber – One Onyx Edge is functioning as the Primary ACS, but one or more of the other Onyx Edge are non-functional.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FjZLkGnbxbzeUk4lcwjcd%2Fimage.png?alt=media&amp;token=e6a9ad33-3b33-4678-8751-95b725fde800" alt="" data-size="line"> Red – All Onyx Edge are non-functional, or their status is not available.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FPfDgGKmD7E1z4UEc9czw%2Fimage.png?alt=media&amp;token=95d2ba74-24aa-4f92-bc65-4e2024a88f29" alt="" data-size="line"> 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.

    To view a pool's details, click its name. The page displays the Onyx Edge pool's details.
* **Venue** – The total number of venues in the network.
  * The list of venues with their names and addresses. To view a venue's details, click the venue's name.
* **Subscribers**:
  * **Total Subscribers** – The total number of subscribers in the network.
    * **Connected** – The number of subscribers currently connected to the network.
    * **Idle** – The number of subscribers currently in idle state.
    * **Not Connected** – The number of subscribers currently not connected to the network.
    * **Unknown** – The number of subscribers currently with unknown connection status.
    * **Disabled** – The number of subscribers that have been disabled.
  * **Subscribers by APNs** – The number of subscribers per APN against the total subscriber count.
* **Downlink/Uplink Traffic** – Trend chart of the throughput of all UE for the selected APN, downlink or uplink direction, and duration. This graph excludes Mesh UE traffic.

{% hint style="info" %}
**NOTE:** In the APN dropdown, MeshBackhaul is available only to GXC Administrators.
{% endhint %}

* **Access Point/DAS SAS Status** – The AP's SAS status.
  * **Total** – The total number of APs.
  * **Unregistered** – The number of APs whose Citizens Broadband Radio Service Device (CBSD) are not registered with SAS yet or have deregistered.
  * **Registered** – The number of APs whose CBSD are registered with SAS but do not have grants.
  * **Granted** – The number of APs whose CBSD have received at least one grant but are not heart-beating on any grants.
  * **Authorized** – The number of APs whose CBSD are authorized to transmit on at least one grant.
  * **Suspended** – The number of APs whose CBSD cannot transmit on any of its grants. All grants are temporarily suspended by the SAS.
* **Data Usage** – Total data usage across all Onyx Edge in the network in the selected duration. Note that this graph excludes Mesh UE traffic.
* **Backhaul (SGi) Health** – Per Onyx Edge, the latency and packet loss data.
  * **Onyx Edge** – The Onyx Edge's name.
  * **Latency** – The Round-Trip Time (RTT) measured between the SGi interface and the destination IP address 8.8.8.8.
  * **Packet Loss %** – The ICMP packet loss percentage between SGi and 8.8.8.8.
  * **DL/UL** – Downlink and uplink TCP throughput between SGi and public iPerf server.

In the upper-right corner, the panel indicates when the view was last updated. To refresh the view, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FCIMaNma2phWUkOKDOhQY%2Fimage.png?alt=media&amp;token=5f00b7ff-cf04-4ade-83c4-7405f9272ea8" alt="" data-size="line"> (refresh).
{% endstep %}
{% endstepper %}


# Manage Networks

The Onyx Portal enables you to add, configure, and manage your networks and network parameters such as throughput and bandwidth, and the usage policies around what the equipment can access.

The Onyx Portal supports the creation of 4G and 5G specific networks. For more information, refer to [*Create Networks*](#create-networks).

## Networking Modes

The Onyx Platform supports multiple networking modes that determine how the Onyx Edge integrates with enterprise networks and how it manages UE and AP/FHM traffic. Each mode varies in its balance of security, visibility, operational complexity, and integration requirements. Selecting the correct mode allows enterprises to meet their architectural, security, scalability, and management objectives.

The Onyx 4G Platform supports the following networking modes:

* 4G NAT Modes
  * 4G NAT Classic Mode
  * 4G NAT Flat Mode
* 4G Bridge (APN-on-VLAN) Modes
  * 4G Bridge (APN-on-VLAN) Classic Mode
  * 4G Bridge (APN-on-VLAN) Flat Mode

For comprehensive information on each networking mode see the *4G & 5G Networking Modes Application Note*.

## Throughput Comparisons

The following table presents a comparison of the approximate throughputs for different DL/UL Distribution (SA) and Radio Range (SSF) configurations in a Band 48 TDD system operating at 3600 MHz with a bandwidth of 20 MHz. Note that the actual throughput may vary depending on specific network conditions, radio conditions, and system configurations.

| DL/UL Distribution (SA) | Radio Range (SSF) | DL Throughput | UL Throughput |
| ----------------------- | ----------------- | ------------: | ------------: |
| 85% DL, 15% UL (SA2)    | Normal (SSF7)     |   112.32 Mbps |    11.52 Mbps |
|                         | 6miles (SSF5)     |     97.2 Mbps |    11.52 Mbps |
| 70% DL, 30% UL (SA1)    | Normal (SSF7)     |    82.08 Mbps |     21.6 Mbps |
|                         | 6miles (SSF5)     |    66.96 Mbps |     21.6 Mbps |
| 60% DL, 40% UL (SA6)    | Normal (SSF7)     |    66.96 Mbps |    26.64 Mbps |
|                         | 6miles (SSF5)     |    51.84 Mbps |    26.64 Mbps |

## Switch Default Network

When you log on to Onyx Portal, from the list of networks available under the selected Onyx Portal account, you must select the default network for your session. When you select a particular network, the Onyx Portal screens display data for that network.

**To switch the default network:**

{% stepper %}
{% step %}
After you log on to the Onyx Portal, in the header area of the page, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fo4wJtdMIsD7GabMU5tTw%2Fimage.png?alt=media&amp;token=07bc6fc2-da1a-4043-8c98-cd484425840f" alt="" data-size="line"> (switch default network).

The **Networks** page displays the list of networks configured under the selected Onyx Portal account.
{% endstep %}

{% step %}
Click the name of the network that you want to switch to.

A confirmation dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F7yxwHsrgURJWFbbHPBV3%2Fimage.png?alt=media&amp;token=d7245eef-f51d-454d-9922-739178078278" alt="" width="327"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To confirm the switch, click **Yes**. The default network switches, and the selected network's name is displayed in the header area.

<img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F4iB9X39VBZsN5ttwWVL3%2Fimage.png?alt=media&amp;token=5091edfc-38c7-4b77-bfd6-dccda6497074" alt="" data-size="line"> indicates the default network is a 4G network.

<img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FtRG8eyQWbloDJH5oepwh%2Fimage.png?alt=media&amp;token=682e107e-51b6-4d39-9850-7e45ace68d94" alt="" data-size="line"> indicates the default network is a 5G network.
{% endstep %}
{% endstepper %}

## View Default Network's Details

To view details of the default network:

{% stepper %}
{% step %}
In the navigation pane, click **Network**.

The ***\<network name>*** page displays the default network's details.

* **Network**:

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Ft9GVCwyl3rimGqxCmjHG%2Fimage.png?alt=media&amp;token=a8ce1ac9-4de7-4161-8124-e2bd0824b276" alt="" width="420"><figcaption></figcaption></figure></div>

  * **Name** – The network's name.
  * **UE Display Short Name** – The network's short name that is displayed in UE screens.
  * **Description** – The network's description.
  * The number of Onyx Edge, APs, Mesh Nodes, subscribers, and APNs associated with the network.
* **Core**:

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmjV4ne1tARYKfMR3JZa4%2Fimage.png?alt=media&amp;token=26e99b39-7576-4f49-aa34-422dc9cf616b" alt="" width="419"><figcaption></figcaption></figure></div>

  * **IP Allocation Mode** – The UE IP allocation mode—NAT, DHCP Broadcast.
  * **Primary PLMN ID** – The primary PLMN ID.
* **RAN**:

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmPHhCkroOfCQf3ZFkFEf%2Fimage.png?alt=media&amp;token=fcf41ba4-1ff4-4d87-b824-48267268c798" alt="" width="419"><figcaption></figcaption></figure></div>

  * **Radio Range (SSF)** – The Radio Range parameter, also referred to as Signal Strength Floor (SSF), for all APs in the network. SSF determines the signal strength thresholds for different coverage areas within a network, ensuring optimal connectivity and handover performance across varying distances and terrain conditions.
    * **Normal (SSF7)** – This SSF category represents the typical signal strength threshold for cell selection and handover within a network. It is used for areas where the network coverage is considered standard, and the signal strength is within the normal operating range.
    * **> 6miles (SSF5)** – This SSF category represents an extended coverage area where the signal strength may be weaker compared to the normal operating range. It is used for areas where the distance between the cell site and the UE exceeds six miles, requiring a lower signal strength threshold for cell selection and handover.
  * **DL/UL Distribution (SA)** – The DL/UL Subframe Assignment (SA), which determines the percentage of transmission resources in downlink and uplink—"85%DL, 15%UL (SA2)", "70%DL, 30%UL (SA1)", "60%DL, 40%UL (SA6)".

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> If, at the venue level the optional <strong>DL/UL Distribution (SA)</strong> and <strong>Radio Range (SSF)</strong> parameters are not configured, and the <strong>Use network-level configuration</strong> check box is selected, the network-level SA and SSF configurations are applied to all APs in that venue.</p></div>
  * **AP Reboot on Neighbor Update** – Controls whether APs automatically reboot when neighbor configuration changes are applied.

    * **Enabled** – APs reboot automatically when neighbor configuration changes are saved. For frequency changes, the AP and its neighboring APs also reboot automatically.
    * **Disabled** – APs do not reboot automatically. Changes take effect only after the AP is manually rebooted, either immediately or at a scheduled time.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> In existing networks, this parameter is enabled by default to maintain pre-4.0.1 behavior. In networks created in release 4.0.1 or later, it is disabled by default.</p></div>
* **Physical Cell ID (PCI)** – The range used to assign a PCI value to AP cells in the network.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FjPqNcUMXW5WY8lfDbyAs%2Fimage.png?alt=media&amp;token=2554ccb9-328d-4dd4-97b4-c7ba3afa0d7c" alt="" width="421"><figcaption></figcaption></figure></div>

  * **Min PCI** – The minimum PCI value.
  * **Max PCI** – The maximum PCI value.

  For example, if the range is set to 0–2, and you have two APs and one Onyx Edge, they will be allocated values 0, 1, and 2. That is, for a range of 0–2, only three nodes (Onyx Edge + AP), and for 0–1, only two nodes (Onyx Edge + AP) can be added to the network.
* **SAS** – Spectrum Access System (SAS) related information.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJ34mGCR8ebh9oNDOGfvW%2Fimage.png?alt=media&amp;token=bbcb5fb7-9cc0-4b6b-a1af-6526a6deacaf" alt="" width="419"><figcaption></figcaption></figure></div>

  * **SAS Provider** – The SAS provider's name.
* **Venues** – The list of venues associated with the network.
  {% endstep %}
  {% endstepper %}

## View Available Networks

This section describes how to:

* [View Summary Details of All Networks](#view-summary-details-of-all-networks)
* [View a Network's Details](#view-a-networks-details)

### View Summary Details of All Networks

**To view the summary details of all networks under the selected Onyx Portal account:**

{% stepper %}
{% step %}
In the header area, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fg4VlQ7SJHbDVfTy2mnv0%2Fimage.png?alt=media&amp;token=5ea9cab0-a03a-4e9d-9481-47e8b1eac089" alt="" data-size="line"> (switch network).&#x20;

The **Networks** page displays the summary details of all networks configured under the selected Onyx Portal account.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Froq6pNlkrbGLxwsuC2FA%2Fimage.png?alt=media&amp;token=e5a082b2-53bb-4201-b2ab-69e23d3c43ef" alt=""><figcaption></figcaption></figure></div>

* **Name** – The network's name.
* **Venues** – The number of venues configured in the network.
* **4G/5G** – The network's type—4G or 5G. To sort the table by network type, click the column header.
* **Onyx Edge Appliances** – The number of Onyx Edge configured in the network.
* **Access Point** – The number of APs configured in the network.
* **Mesh Node** – The number of Mesh Nodes configured in the network. In the current release, Mesh Node is specific to 4G networks.
* **FHM** – The number of FHMs configured in the network. In the current release FHM is specific to 4G networks.
* **Actions** – Options to view details, edit and delete a network.
  {% endstep %}
  {% endstepper %}

### View a Network's Details

**To view a network's details:**

{% stepper %}
{% step %}
In the header area, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FD3b1UAn81fv9CGfvRbym%2Fimage.png?alt=media&amp;token=9e91c8ee-64fe-4aca-884b-c5cce0942226" alt="" data-size="line"> (switch network).&#x20;

The **Networks** page displays the summary details of all networks configured under the current Onyx Portal account.
{% endstep %}

{% step %}
To view the details of a specific network, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **View**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FivaKQgPVamxh4c6YNMou%2Fimage.png?alt=media&amp;token=269fe68a-f5b5-4bdc-bc9f-a3c586d0e580" alt="" width="110"><figcaption></figcaption></figure>

The **\<network name>** page displays the selected network's details.

* **Network**:

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FjUAfZfaHq1mCLEx6gV2A%2Fimage.png?alt=media&amp;token=e311beec-18b5-4cd0-bb52-753e1dda82af" alt="" width="420"><figcaption></figcaption></figure></div>

  * **Name** – The network's name.
  * **UE Display Short Name** – The network's short name that is displayed in UE screens.
  * **Description** – The network's description.
  * The number of Onyx Edge, APs, Mesh Node, subscribers, and APNs associated with the network.
* **Core**:

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmjV4ne1tARYKfMR3JZa4%2Fimage.png?alt=media&amp;token=26e99b39-7576-4f49-aa34-422dc9cf616b" alt="" width="419"><figcaption></figcaption></figure></div>

  * **IP Allocation Mode** – The IP allocation mode—NAT, DHCP Broadcast.
  * **Primary PLMN ID** – The primary PLMN ID.
* **RAN**:

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmPHhCkroOfCQf3ZFkFEf%2Fimage.png?alt=media&amp;token=fcf41ba4-1ff4-4d87-b824-48267268c798" alt="" width="419"><figcaption></figcaption></figure></div>

  * **Radio Range (SSF)** – The Radio Range parameter, also referred to as Signal Strength Floor (SSF), for all APs in the network. SSF determines the signal strength thresholds for different coverage areas within a network, ensuring optimal connectivity and handover performance across varying distances and terrain conditions.
    * **Normal (SSF7)** – This SSF category represents the typical signal strength threshold for cell selection and handover within a network. It is used for areas where the network coverage is considered standard, and the signal strength is within the normal operating range.
    * **> 6miles (SSF5)** – This SSF category represents an extended coverage area where the signal strength may be weaker compared to the normal operating range. It is used for areas where the distance between the cell site and the UE exceeds six miles, requiring a lower signal strength threshold for cell selection and handover.
  * **DL/UL Distribution (SA)** – The DL/UL Subframe Assignment (SA), which determines the percentage of transmission resources in downlink and uplink—"85%DL, 15%UL (SA2)", "70%DL, 30%UL (SA1)", "60%DL, 40%UL (SA6)".

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> If, at the venue level the optional <strong>DL/UL Distribution (SA)</strong> and <strong>Radio Range (SSF)</strong> parameters are not configured, and the <strong>Use network-level configuration</strong> check box is selected, the network-level SA and SSF configurations are applied to all APs in that venue.</p></div>
  * **AP Reboot on Neighbor Update** – Controls whether APs automatically reboot when neighbor configuration changes are applied.

    * **Enabled** – APs reboot automatically when neighbor configuration changes are saved. For frequency changes, the AP and its neighboring APs also reboot automatically.
    * **Disabled** – APs do not reboot automatically. Changes take effect only after the AP is manually rebooted, either immediately or at a scheduled time.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> In existing networks, this parameter is enabled by default to maintain pre-4.0.1 behavior. In networks created in release 4.0.1 or later, it is disabled by default.</p></div>
* **Physical Cell ID (PCI)** – The range used to assign a PCI value.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FjPqNcUMXW5WY8lfDbyAs%2Fimage.png?alt=media&amp;token=2554ccb9-328d-4dd4-97b4-c7ba3afa0d7c" alt="" width="421"><figcaption></figcaption></figure></div>

  * **Min PCI** – The minimum PCI value.
  * **Max PCI** – The maximum PCI value.

  For example, if the range is set to 0–2, and you have two APs and one Onyx Edge, they will be allocated the values 0, 1, and 2. That is, for a range of 0–2, only three nodes can be configured, and for 0–1, only two nodes can be configured.
* **SAS** – Spectrum Access System (SAS) related details.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJ34mGCR8ebh9oNDOGfvW%2Fimage.png?alt=media&amp;token=bbcb5fb7-9cc0-4b6b-a1af-6526a6deacaf" alt="" width="419"><figcaption></figcaption></figure></div>

  * **SAS Provider** – The SAS provider's name.
* **Venues** – The list of venues associated with the network.
* **Download Root CA Certificate** – To download the network's Root CA certificate file, in the upper-right corner of the page, click **Download Root CA Certificate**. The .pem file is downloaded.

{% hint style="info" %}
**NOTE:** On enabling IPSec for an AP, this Root CA Certificate file, the AP Certificate and AP Private Key must be uploaded to the AP equipment's configuration interface. For more information see [Enable and Configure IPSec on AP Equipment](#enable-and-configure-ipsec-on-ap-equipment).
{% endhint %}
{% endstep %}
{% endstepper %}

## Create Networks

This section describes how to create 4G networks.

{% hint style="info" %}
**NOTE:** You can create networks only if you are a GXC Administrator, Partner Administrator, or a Super Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** You can create networks only under customer accounts. Before you create a network, make sure you have selected the appropriate customer account.
{% endhint %}

**To create a 4G network:**

{% stepper %}
{% step %}
In the header area, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8u9FBBPM4t8kEEsLE1rJ%2Fimage.png?alt=media&amp;token=b0fef442-b62d-4d18-88cb-8c7046acb77c" alt="" data-size="line"> (switch network).

The **Networks** page displays the summary details of all networks configured under the selected Onyx Portal account.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Add Network**.

The **Create Network** page > **Network** tab is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FkavhbVkoDWgGyDA2JXYa%2Fimage.png?alt=media&amp;token=a63666d0-e2d6-47e4-8d3e-7c094ffac4ae" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details on the **Network** tab:

* **Network Name** – (Required) The network's name. The network name must be unique within the customer account and must be an alphanumeric string of 1–32 characters.
* **UE Display Short Network Name** – (Required) The network's short name that is displayed in UE screens.
* **Description** – (Required) The network's description.
  {% endstep %}

{% step %}
At the bottom of the page, click **Configure Core/RAN**.

The **Create Network** page > **Core/RAN** tab is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmsvvY3u8rheUXB6qdewU%2Fimage.png?alt=media&amp;token=4a82aeb0-a38e-487c-874d-b8b6b8f8038b" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the **Core/RAN** tab, enter the following details:

* **4G / 5G** – Click the toggle button to select the 4G network type. Default setting: 4G.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> After you create a network, its type cannot be changed.</p></div>
* **APN on a VLAN** – To enable the Bridge (Multi-APN-VLAN) networking mode, turn on the toggle button. To enable the NAT mode, turn off the toggle button. Default setting: disabled (NAT mode). For more information, see [Networking Modes](#networking-modes).
* **DL/UL Distribution (SA)** – (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. Default value: 85%DL, 15%UL (SA2).

  * **85%DL, 15%UL (SA2)** – Subframe Assignment 2. Allocates approximately 85% subframes within each radio frame for downlink transmission and the remaining 15% for uplink transmission.
  * **70%DL, 30%UL (SA1)** – Subframe Assignment 1. Allocates approximately 70% subframes within each radio frame for downlink transmission and the remaining 30% for uplink transmission.
  * **60%DL, 40%UL (SA6)** – Subframe Assignment 6. Allocates approximately 60% subframes within each radio frame for downlink transmission and the remaining 40% for uplink transmission.

  For a comparison of the approximate throughput for the different DL/UL Distribution (SA) and Radio Range (SSF) configurations, see [Throughput Comparisons](#throughput-comparisons).
* **Radio Range (SSF)** – (Required) Select the Radio Range Special Subframe (SSF). The Radio Range (SSF) is a configuration of subframes within the radio frame structure, optimized for communication efficiency over varying distances. It adjusts the allocation of time slots to match specific propagation characteristics, ensuring reliable communication between the AP and UE across different coverage areas. Default value: Normal (SSF7).
  * **Normal (SSF7)** – For areas where the distance between the AP and UE is within standard operating range. SSF7 ensures optimal network performance and reliability by evenly allocating time for downlink and uplink transmissions.
  * **> 6miles (SSF5)** – For areas where the distance between the AP and UE exceeds six miles. SSF5 ensures effective communication over extended ranges by optimizing time slot allocation to match the propagation characteristics of longer distances.

{% hint style="info" %}
**NOTE:** If, at the venue level, the optional **DL/UL Distribution (SA)** and **Radio Range (SSF)** parameters are not configured and the **Use network-level configuration** check box is selected, the network-level SA and SSF configurations are applied to all the APs in that venue.
{% endhint %}

* **MCC** – (Required) The Mobile Country Code. A three-digit code that uniquely identifies the country or geographical area within the IMSI. Default value: 315.
* **MNC** – (Required) The Mobile Network Code. A three-digit code when combined with the MCC, uniquely identifies a mobile network operator within a country. Default value: 010.
* **AP Reboot on Neighbor Update** – Click to control whether APs automatically reboot when neighbor configuration changes are applied. Default: Off.
  * **On** – APs reboot automatically when neighbor configuration changes are saved.
  * **Off** – APs do not reboot automatically. Changes take effect only after the AP is manually rebooted, either immediately or at a scheduled time.
    {% endstep %}

{% step %}
At the bottom of the page, click **Configure Users**.

The **Create Network** page > **Users** tab is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FBVpw3LrCtllS9cRoZoh1%2Fimage.png?alt=media&amp;token=708ec595-cef3-4288-b906-bcd7038d99e3" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the **Users** tab, enter the following details:

* **Users** – Click to select one or more users from the customer account who should have permission to manage this network. To remove access for a particular user, clear the corresponding checkbox. Default value: **All Users**.
  {% endstep %}

{% step %}
To save the network, in the upper-right corner of the page, click **Save Network**.
{% endstep %}
{% endstepper %}

## Edit Networks

This section describes how to edit networks.

{% hint style="info" %}
**NOTE:** You can edit networks only if you are a GXC Administrator, Partner Administrator, or a Super Administrator.
{% endhint %}

**To edit a 4G network's settings:**

{% stepper %}
{% step %}
In the header area, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FDGdegGN60qIBK64bKCCI%2Fimage.png?alt=media&amp;token=52c35ecb-c706-45fd-9fa3-86f9878be776" alt="" data-size="line"> (switch network).

The **Networks** page displays the summary details of all networks configured under the selected Onyx Portal account.
{% endstep %}

{% step %}
For the network that you want to edit, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKnUeUCRvLFzj7GokBiBF%2Fimage.png?alt=media&amp;token=8b82bd16-2096-4e2a-99aa-91e32c77a25c" alt="" width="110"><figcaption></figcaption></figure>

The **Edit Network** page > **Network** tab is displayed.
{% endstep %}

{% step %}
In the **Network** tab, edit the following details as required:

* **Network Name** – (Required) The network's name. The name must be unique within the customer account and must be an alphanumeric string of 1–32 characters.
* **UE Display Short Network Name** – (Required) The network's short name that is displayed in UE screens.
* **Description** – (Required) The network's description.
  {% endstep %}

{% step %}
In the lower-left bottom of the page, click **Configure Core/RAN**.

In the **Core/RAN** tab, edit the following details as required:

* **4G / 5G** – (Read only) Indicates the network type is 4G.
* **APN on a VLAN** – To enable the Multi-APN-VLAN (non-NAT) mode, turn on the toggle button. To enable the NAT mode, turn off the toggle button. Default setting: disabled (NAT mode). For more information, see [Networking Modes](#networking-modes).
* **DL/UL Distribution (SA)** – (Required.) Select the DL/UL Subframe Assignment (SA). Default value: 85%DL, 15%UL (SA2).

  * **85%DL, 15%UL (SA2)** – Subframe Assignment 2.
  * **70%DL, 30%UL (SA1)** – Subframe Assignment 1.
  * **60%DL, 40%UL (SA6)** – Subframe Assignment 6.

  For a comparison of the approximate throughput for the different DL/UL Distribution (SA) and Radio Range (SSF) configurations, see [Throughput Comparisons](#throughput-comparisons).
* **Radio Range (SSF)** – (Required) Select the Radio Range Special Subframe (SSF). The Radio Range (SSF) is a configuration of subframes within the radio frame structure, optimized for communication efficiency over varying distances. It adjusts the allocation of time slots to match specific propagation characteristics, ensuring reliable communication between the AP and UE across different coverage areas. Default value: Normal (SSF7).
  * **Normal (SSF7)** – For areas where the distance between the AP and UE is within standard operating range. SSF7 ensures optimal network performance and reliability by evenly allocating time for downlink and uplink transmissions.
  * **> 6miles (SSF5)** – For areas where the distance between the AP and UE exceeds six miles. SSF5 ensures effective communication over extended ranges by optimizing time slot allocation to match the propagation characteristics of longer distances

{% hint style="info" %}
**NOTE:** If, at the venue level, the optional **DL/UL Distribution (SA)** and **Radio Range (SSF)** parameters are not configured and the **Use network-level configuration** check box is selected, the network-level SA and SSF configurations are applied to all the APs in that venue.
{% endhint %}

* **MCC** – (Required) The Mobile Country Code. A three-digit code that uniquely identifies the country or geographical area within the IMSI. Default value: 315.
* **MNC** – (Required) The Mobile Network Code. Default value: 010.
* **AP Reboot on Neighbor Update** – Click to control whether APs automatically reboot when neighbor configuration changes are applied. Default: Off.
  * **On** – APs reboot automatically when neighbor configuration changes are saved.
  * **Off** – APs do not reboot automatically. Changes take effect only after the AP is manually rebooted, either immediately or at a scheduled time.
    {% endstep %}

{% step %}
In the lower-right bottom of the page, click **Configure Users**.

In the **Users** tab, edit the following details as required:

* **Users** – Click to select one or more users from the customer account who should have permission to manage this network. To remove access for a particular user, clear the corresponding checkbox. Default value: **All Users**.
  {% endstep %}

{% step %}
To save your edits, in the upper-right corner of the page, click **Save Network**.
{% endstep %}
{% endstepper %}

## Delete Networks

{% hint style="info" %}
**NOTE:** You can delete networks only if you are a GXC Administrator, Partner Administrator, or a Super Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** You cannot delete a network if there are any venues, Onyx Edge, or APs associated with it.
{% endhint %}

**To delete a network:**

{% stepper %}
{% step %}
In the header area, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FimbfT66kcQQqB8qSZMM8%2Fimage.png?alt=media&amp;token=a777ba35-e349-4d05-bebe-98751b1643ad" alt="" data-size="line"> (switch network).

The **Networks** page displays the summary details of all networks configured under the selected Onyx Portal account.
{% endstep %}

{% step %}
To delete a particular network, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Delete**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FE322KtMZRVCs4ELScjIQ%2Fimage.png?alt=media&amp;token=c6b14060-6c32-458e-9173-59162afb501e" alt="" width="110"><figcaption></figcaption></figure>

A confirmation dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FB1AFbSfCBsLN5ObMBY4g%2Fimage.png?alt=media&amp;token=ebeb3efb-6d85-458f-92c9-6820a35d4b07" alt="" width="355"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To confirm, click **Yes**.
{% endstep %}
{% endstepper %}


# Manage Venues

A venue represents a physical location in a private mobile network, such as a factory or a warehouse, hosting the AP(s). A venue can be a small facility or a multi-floor facility hosting multiple APs on each floor.

## View Venues

This section describes how to:

* [*View Summary Details of All Venues*](#view-summary-details-of-all-venues)
* [*View a Venue's Details*](#view-a-venues-details)

### View Summary Details of All Venues

To view the summary details of all venues in the network:

{% stepper %}
{% step %}
In the navigation pane, click **Venues**.

The **Venues** page displays the summary details of all venues configured in the network.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FX3dBvdR1mGxjxVOJqaXF%2Fimage.png?alt=media&amp;token=a370fdb3-10ee-49d7-b89c-e75939f50a2e" alt=""><figcaption></figcaption></figure></div>

* **Name** — The venue's name.
* **Description** — The venue's description.
* **Address** — The venue's postal address.
* **Actions** — Options to view details, edit, and delete venues.
  {% endstep %}
  {% endstepper %}

### View a Venue's Details

**To view a venue's details:**

{% stepper %}
{% step %}
In the navigation pane, click **Venues**.
{% endstep %}

{% step %}
To view a particular venue's details, click the venue's name.

Alternatively, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **View**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FcKRnzMZ4NcDtl5dwVmPA%2Fimage.png?alt=media&amp;token=9e93b403-ee1b-4b23-befd-6aa1f21456c4" alt="" width="110"><figcaption></figcaption></figure></div>

The ***\<venue name>*** page > **Overview** tab displays the venue's details, and summary details of its associated network infrastructure components.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FrVy5MmGhUeA0T0wmbkgh%2Fimage.png?alt=media&amp;token=54495bfd-c8ee-4da4-90ca-73b34602acfd" alt=""><figcaption></figcaption></figure></div>

* **Name** — The venue's name.
* **Network** — The associated network's name.
* **Address** — The venue's address.
* **Description** — The venue's description.
* **Radio Range (SSF)** — (Displayed only if configured at the venue level or inherited from the network level.) The Radio Range parameter, also referred to as Signal Strength Floor (SSF), for all APs in the venue. SSF determines the signal strength thresholds for different coverage areas within a network. This ensures optimal connectivity and handover performance across varying distances and terrain conditions.
  * **Normal (SSF7)** — This SSF category represents the typical signal strength threshold for cell selection and handover within a network. It is used for areas where the network coverage is considered standard, and the signal strength is within the normal operating range.
  * **> 6 miles (SSF5)** — This SSF category represents an extended coverage area where the signal strength may be weaker compared to the normal operating range. It is used for areas where the distance between the cell site and the UE exceeds six miles, requiring a lower signal strength threshold for cell selection and handover.
* **DL/UL Distribution (SA)** — (Displayed only if configured at the venue level or inherited from the network level.) The DL/UL Subframe Assignment (SA) for all APs in the venue. SA allocates transmission resources — specific subframes within the radio frame — for downlink (DL) and uplink (UL) data transmissions, to support efficient data exchange between the AP and UE.

  * **85%DL, 15%UL (SA2)** — Subframe Assignment 2. Allocates approximately 85% of subframes within each radio frame for downlink transmission and the remaining 15% for uplink transmission.
  * **70%DL, 30%UL (SA1)** — Subframe Assignment 1. Allocates approximately 70% of subframes within each radio frame for downlink transmission and the remaining 30% for uplink transmission.
  * **60%DL, 40%UL (SA6)** — Subframe Assignment 6. Allocates approximately 60% of subframes within each radio frame for downlink transmission and the remaining 40% for uplink transmission.

  For a comparison of the approximate throughputs for different DL/UL Distribution (SA) and Radio Range (SSF) configurations, see [Throughput Comparisons](#networking-modes).
* Satellite map visualization of the venue's location.
* **Floors** — The venue's floor plans.\
  To add a floor plan, click **Add Floor**. For information on adding floor plans, see [Add Floor Plans](#add-floor-plans).
* **Onyx Edge** — The list of Onyx Edge deployed at the venue and their online status (reachability from the Onyx Portal). To view an Onyx Edge's details, click its name. To add an Onyx Edge to the venue, click **Add Onyx Edge**. For information on adding Onyx Edge, see [Add Onyx Edge](#add-onyx-edge).
* **Access Point** — The list of APs deployed at the venue and their online status (reachability from the Onyx Portal). To view an AP's details, click its name. To add an AP to the venue, click **Add Access Point**. For information on adding APs, see [Add APs](#add-aps).
* **DAS** — The list of DAS units deployed at the venue and their online status (reachability from the Onyx Portal). To view a DAS's details, click its name. To add a DAS to the venue, click **Add DAS**. For information on adding DAS to the venue, see Add DAS.
* **Mesh Node** — The list of Mesh Nodes deployed at the venue and their online status (reachability from the Onyx Portal). To view a Mesh Node's details, click its name. To add a Mesh Node to the venue, click **Add Mesh Node**. For information on adding Mesh Node, see [Add Mesh Nodes](#add-mesh-nodes).
  {% endstep %}

{% step %}
Click the **CBSD Scanner** tab.

The CBSD Scanner tab provides Venue CBSD Scanner functionality for venue-level CBSD planning and channel analysis. This tool helps with RF planning by identifying available CBSD channels, detecting potential interference, and optimizing spectrum allocation for network deployment.

The following screenshot displays the interface before performing a scan.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F7beX7NGYWnOwnRp7BWyX%2Fimage.png?alt=media&amp;token=f17a08ca-0ad3-411d-9f56-e3de82e91cda" alt=""><figcaption></figcaption></figure></div>

The following screenshot displays the results after performing a scan with a selected radius of 2 miles, resulting in 13 discovered POIs.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJqxOOVdPQ6tVYd3c0DH7%2Fimage.png?alt=media&amp;token=406fa54e-cd95-47a7-bdba-92fe80189ac6" alt=""><figcaption></figcaption></figure></div>

* **Venue CBSD Scanner**
  * **Venue Location** — The venue's geographic coordinates (latitude and longitude) that define the center point for spectrum analysis queries and serve as the reference location for all SAS database queries.
  * Interactive Map Display — Provides standard map and satellite imagery views of the area surrounding the venue's coordinates. This gives spatial context for terrain characteristics and potential RF interference sources. The map displays a circular overlay representing the search radius around the venue location, with the venue marked at the center.
  * **Selected Radius** — User-configured parameter that defines the geographic search distance from the venue's center point, determining how far the system queries the federated SAS database to discover neighboring CBRS deployments. The system performs a box search that extends the specified distance in all directions from the venue coordinates.
  * **New Scan** — Initiates a fresh query to the SAS database using the current venue location and Selected Radius. Use this to refresh analysis with current SAS data, since devices frequently register and deregister in dynamic RF environments.
  * **POIs** — Points of Interest (POIs). Displays a list of specific CBSD deployments discovered within the search radius. Each entry shows precise coordinates in decimal degrees. Checkboxes next to each POI enable administrators to select specific points for focused analysis. The **Select All** and **Clear All** buttons provide quick controls for managing selections, allowing to toggle between viewing specific or all discovered deployments.

    The following screenshot displays the POI detail popup.<br>

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FULj9NweOUUdudUqWBI8B%2Fimage.png?alt=media&amp;token=91622222-1480-49b0-8467-3c042843fbc5" alt=""><figcaption></figcaption></figure></div>

    For each discovered deployment, the POI detail popup displays the geographic coordinates (latitude and longitude), CBSD category counts, and channels in use. The category counts show the number of Category A devices and Category B devices. Category A devices are lower-power systems, up to 24 dBm EIRP per 10 MHz, typically used for indoor deployments. Category B devices are higher-power systems, up to 47 dBm EIRP per 10 MHz, typically used for outdoor infrastructure with larger coverage areas. The channels in use section lists each channel with the number of CBSDs operating on that frequency. Administrators can filter the Channel Usage and EIRP Distribution visualizations by selecting specific channels from the popup. This supports focused analysis to prioritize interference mitigation and select optimal channels.
  * **Channel Usage** — Displays spectrum utilization across the CBRS frequency band. The horizontal axis represents channel numbers. The vertical axis indicates the number of CBSDs detected on each frequency block, based on current SAS registrations and incumbent activity. Taller bars indicate significant existing activity; shorter bars suggest minimal utilization. The visualization responds dynamically to POI selections, updating to display only the channel usage associated with selected deployments.
  * **EIRP Distribution over CBRS Spectrum** — Displays the effective radiated power distribution for detected CBRS devices within the search radius. The horizontal axis represents assigned EIRP values in dBm/MHz. The vertical axis indicates the number of CBSDs operating at each power level. Category A devices are shown in light green; Category B devices are shown in dark green. This lets administrators assess the power profile of nearby deployments. Higher EIRP values indicate stronger potential interference sources. The distribution pattern also shows whether neighboring networks operate primarily as low-power or high-power systems. Like the **Channel Usage** graph, this visualization responds dynamically to POI selections for focused analysis.

Administrators use scan results to make informed channel selection decisions. The map shows geographic distribution. The **Channel Usage** graph shows frequency utilization. The **EIRP Distribution over CBRS Spectrum** chart shows power characteristics. Look for lower bars or gaps in the Channel Usage graph to identify frequencies with minimal nearby activity. Use the EIRP Distribution chart to understand interference potential based on both proximity and transmission strength. Correlate this with POI geographic distribution to understand directional interference potential.

Clicking on POI markers reveals detailed deployment information. POI selection filters both the Channel Usage and EIRP Distribution visualizations to isolate individual deployment patterns. This supports detailed investigation and helps prioritize mitigation strategies based on deployment power levels, frequency utilization, and proximity.

Administrators can modify the search radius or run scans at different times to understand how the RF environment evolves. Use this iterative analysis to develop spectrum strategies that minimize interference, avoid congested portions of the spectrum, and ensure reliable network performance as the deployment landscape changes.
{% endstep %}

{% step %}
Click the **Survey** tab.

The Survey tab provides survey log management and coverage overlay comparison for RF coverage assessment workflows.

* **Generate Access Token** — Generates an authentication token for mobile app survey collection. Use the token to securely link a field data collection device to the Onyx Portal.
* **Upload Local File** — Uploads a survey log file from your local device. Uploaded files are listed with their file name, label, uploader, upload date, and size.
* **Coverage Overlays (KMZ from EINO)** — Use this section to compare predicted coverage against actual survey results:
  * **Upload KMZ** — Uploads a KMZ coverage file exported from EINO. Uploaded overlays are listed with their file name, label, uploader, and upload date.
    {% endstep %}

{% step %}
Click the **AP Markers** tab.

The **AP Markers** tab lets you record the physical location of APs at a venue, independent of a survey scan.

**To add an AP marker:**

1. On the venue's page, click the **AP Markers** tab.
2. Click **Add AP Marker**, or right-click the location on the survey map.
3. Enter the marker's name, serial number, device class, latitude, and longitude.
4. Save the marker.

The **AP Markers** tab lists each marker's name, serial number, device class, latitude, longitude, creator, creation date, and available actions.

{% hint style="info" %}
**NOTE:** For detailed information on the Survey solution, including detailed procedures for generating survey logs with the GXC Survey mobile application, loading and analyzing survey data in the Onyx Portal, and interpreting RF metrics, refer to the *4G & 5G Onyx Survey Solution Application Note*.
{% endhint %}
{% endstep %}
{% endstepper %}

## Manage Floor Plans

Floor plans enable you to visualize the layout of floors and the physical location of equipment on the floors on a map.

### Add Floor Plans

{% hint style="info" %}
**NOTE:** You can add floor plans only if you are a GXC Administrator, GXC Partner Administrator, or a Super Administrator.
{% endhint %}

**To add a floor plan to a venue:**

{% stepper %}
{% step %}
In the navigation pane, click **Venues**.
{% endstep %}

{% step %}
For the venue that you want to add floor plans to, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **View**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F9YYV04PiSJzyvA5argSl%2Fimage.png?alt=media&amp;token=55bf4aa8-5c61-4c8a-ba6b-cf33c34f9a11" alt="" width="110"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the **Floors** section, click **Add Floor**.

The **Create Floor** page is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FhozmvvhrjeA285mUCFPe%2Fimage.png?alt=media&amp;token=e2439bbb-be45-43e5-bcbd-17e5b951f0c2" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

* **Name** — (Required) Assign a name to the floor.
* **Floor No.** — (Required) Select the floor level. It must be in the range of -10 to +99.
* **Upload Floor Image** — (Required) Click **Choose** and upload the floor plan. You can upload image files of type .jpeg, .jpg, or .png.
  {% endstep %}

{% step %}
To save the floor plan, in the upper-right corner of the page, click **Save Floor**.
{% endstep %}
{% endstepper %}

### Calibrate Floor Plans

{% hint style="info" %}
**NOTE:** You can calibrate floor plans only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

Calibrating floor plans allows you to map the latitude and longitude coordinates of each floor in a venue and visualize it on a map.

**To calibrate a floor plan:**

{% stepper %}
{% step %}
In the navigation pane, click **Venues**.
{% endstep %}

{% step %}
For the venue that you want to recalibrate floor plans for, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **View**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FyUTqNicefkYdN25FKps6%2Fimage.png?alt=media&amp;token=ba2d48dd-3fda-45a5-bf22-cd883437fe3d" alt="" width="110"><figcaption></figcaption></figure></div>

The ***\<venue name>*** page displays the venue’s details.
{% endstep %}

{% step %}
In the **Floors** section, for the floor plan that you want to recalibrate, click the ⋮ (options) icon, then click **Calibrate**.

The **Calibrate Floor Plan** page displays the floor plan’s details.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F4DyJv8W9ko9G8QAGEoE0%2Fimage.png?alt=media&amp;token=ff83f26a-3666-4c23-a2be-c914ccf02389" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To calibrate the floor plan, adjust the point markers.
{% endstep %}

{% step %}
To save the calibration, in the upper-right corner of the page, click **Save Calibration**.
{% endstep %}
{% endstepper %}

### Recalibrate Floor Plans

{% hint style="info" %}
**NOTE:** You can recalibrate floor plans only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

Recalibrating floor plans allows you to map the latitude and longitude coordinates of each floor in a venue and visualize it on a map. You can recalibrate a floor plan only if the floor plan has already been calibrated.

**To recalibrate a floor plan:**

{% stepper %}
{% step %}
In the navigation pane, click **Venues**.
{% endstep %}

{% step %}
For the venue that you want to recalibrate floor plans for, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **View**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FfeJbKf06Y7JN6q7RupIq%2Fimage.png?alt=media&amp;token=4f187ee4-2816-4e2e-bb61-baafed22edc8" alt="" width="110"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the **Floors** section, for the floor plan that you want to recalibrate, click the ⋮ (options) icon, then click **Re-Calibrate**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FIgq9WKYaC7SSCJ18gbB4%2Fimage.png?alt=media&amp;token=f01a7909-51eb-4f5c-842d-92de53b7900f" alt="" width="533"><figcaption></figcaption></figure></div>

The **Recalibrate Floor Plan** page displays the floor plan’s details.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fp9tfQb8JWB60p4iSh6DG%2Fimage.png?alt=media&amp;token=4317c5bb-fc59-44c5-b72a-e7f0a589a3e9" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To recalibrate the floor plan, adjust the point markers.
{% endstep %}

{% step %}
To save the calibration, in the upper-right corner of the page, click **Save Calibration**.
{% endstep %}
{% endstepper %}

### Delete Floor Plans

{% hint style="info" %}
**NOTE:** You can delete floor plans only if you are a GXC Administrator, Partner Administrator, or a Super Administrator.
{% endhint %}

**To delete a floor plan from a venue:**

{% stepper %}
{% step %}
In the navigation pane, click **Venues**.
{% endstep %}

{% step %}
For the venue that you want to delete the floor plan from, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **View**.
{% endstep %}

{% step %}
In the **Floors** section, for the floor plan that you want to delete, click the corresponding ⋮ (options) icon, then click **Delete**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQJcCOHPaFtF73GMaogZ2%2Fimage.png?alt=media&amp;token=c5427a64-c884-4433-a125-6819097d3513" alt="" width="563"><figcaption></figcaption></figure></div>

A confirmation dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FNaovz2nmUES0LbmmNW5A%2Fimage.png?alt=media&amp;token=9cf5d2d1-38f0-4bb2-9825-008fc68dfe1e" alt="" width="374"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To confirm deleting the floor plan, click **Yes**.

The venue's details are displayed and the selected floor plan is removed.
{% endstep %}
{% endstepper %}

## Add Venues

This section describes how to add venues to 4G networks.

{% hint style="info" %}
**NOTE:** You can add venues only if you are a GXC Administrator, Partner Administrator, or a Super Administrator.
{% endhint %}

**To add a venue to a 4G network:**

{% stepper %}
{% step %}
In the navigation pane, click **Venues**.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Add Venue**.

The **Create Venue** page > **Venue** tab is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fg3ezbKVYeNtuofDzOUR2%2Fimage.png?alt=media&amp;token=5700241f-55f1-4620-935c-e3fcf4855056" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

* **Venue Name** — (Required) The venue's name. The venue's name must be unique within the network and must be an alphanumeric string of 1–32 characters.
* **Description** — (Required) The venue's description.
* **Address / Coordinates** — Select the address type.
  * If you select **Address**, enter the venue's address.
    * **Address** — (Required) The venue's address. After you enter the address, the location will be displayed on the map.
  * If you select **Coordinates**, enter the venue's GPS latitude and longitude coordinates in Decimal Degrees (DD) format. For example, Latitude: 12.93421, Longitude: 77.62989. After you enter the coordinates, the location will be displayed on the map.

    * **Latitude** — (Required) The venue's GPS latitude coordinate.
    * **Longitude** — (Required) The venue's GPS longitude coordinate.

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FqgrNt6qV8o3Or9o0qnyj%2Fimage.png?alt=media&amp;token=8a026823-041a-4bb9-9246-acc5af729479" alt=""><figcaption></figcaption></figure></div>

{% endstep %}

{% step %}
In the lower-right corner of the page, click **Configure RAN**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fn8xYDMxAEqWjF24uNdg0%2Fimage.png?alt=media&amp;token=37bf3e35-763a-4346-8d4a-51cc2adb1d7f" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the **RAN** tab, enter the following details:

* **DL/UL Distribution (SA)** — (Editable only when the **Use network-level configuration** check box is cleared. Optional.) Select the DL/UL Subframe Assignment (SA) for all APs in the venue. SA determines the percentage of transmission resources in downlink and uplink.
  * **85%DL, 15%UL (SA2)**
  * **70%DL, 30%UL (SA1)**
  * **60%DL, 40%UL (SA6)**
* **Radio Range (SSF)** — (Editable only when the **Use network-level configuration** check box is cleared. Optional.) Select the Radio Range parameter, also referred to as Signal Strength Floor (SSF), for all APs in the venue. SSF determines the signal strength thresholds for different coverage areas within the network. This ensures optimal connectivity and handover performance across varying distances and terrain conditions.
  * **Normal (SSF7)** — This SSF category represents the typical signal strength threshold for cell selection and handover within a network. It is used for areas where the network coverage is considered standard, and the signal strength is within the normal operating range.
  * **> 6 miles (SSF5)** — This SSF category represents an extended coverage area where the signal strength may be weaker compared to the normal operating range. It is used for areas where the distance between the cell site and the UE exceeds six miles, requiring a lower signal strength threshold for cell selection and handover.
* **Use network-level configuration** — Select this check box to inherit the network-level SA and SSF configurations, which will be applied to all APs in the venue.
  {% endstep %}

{% step %}
To save the venue, in the upper-right corner of the page, click **Save Venue**.
{% endstep %}
{% endstepper %}

## Edit Venues

This section describes how to edit venues in 4G networks.

{% hint style="info" %}
**NOTE:** You can edit venues only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

**To edit a venue in a 4G network:**

{% stepper %}
{% step %}
In the navigation pane, click **Venues**.
{% endstep %}

{% step %}
For the venue that you want to edit, in the **Actions** column click the corresponding ⋮ (options) icon, then click **Edit**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FZJcfLfvs8fiJc6Gdo7k3%2Fimage.png?alt=media&amp;token=cd8f30d6-43ad-4aea-9c29-fbe99c0b1ce7" alt="" width="110"><figcaption></figcaption></figure></div>

The **Edit Venue&#x20;*****\<venue name>*** page displays the venue's details.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FdtALxUSKwvegIVqDpRfL%2Fimage.png?alt=media&amp;token=2f0dc47a-0469-468a-a612-1b9982503aa5" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Update the venue's details as required.

* **Venue Name** — (Required) The venue's name. The venue's name must be unique within the network and must be an alphanumeric string of 1–32 characters.
* **Description** – (Required) The venue's description.
* **Address / Coordinates** — Select the address type.
  * If you select **Address**, enter the venue's address.
    * **Address** — (Required) The venue's address. After you enter the address, the location will be displayed on the map.
  * If you select **Coordinates**, enter the venue's GPS latitude and longitude coordinates in Decimal Degrees (DD) format. For example, Latitude: 12.93421, Longitude: 77.62989. After you enter the coordinates, the location will be displayed on the map.

    * **Latitude** — (Required) The venue's GPS latitude coordinate.
    * **Longitude** — (Required) The venue's GPS longitude coordinate.

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F3VMB2xNJUpUG7RAUhlBX%2Fimage.png?alt=media&amp;token=826a2537-5854-46bc-950f-cca906255872" alt=""><figcaption></figcaption></figure></div>

{% endstep %}

{% step %}
In the lower-right corner of the page, click **Configure RAN**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5tyVGErLjgBoYsx0aVAF%2Fimage.png?alt=media&amp;token=ce6f7169-7edd-47e3-a5ad-aa41735ffff8" alt=""><figcaption></figcaption></figure></div>

Configure RAN details:

* **DL/UL Distribution (SA)** — (Editable only when the **Use network-level configuration** check box is cleared. Optional.) Select the DL/UL Subframe Assignment (SA) for all APs in the venue. SA determines the percentage of transmission resources in downlink and uplink.
  * **85%DL, 15%UL (SA2)**
  * **70%DL, 30%UL (SA1)**
  * **60%DL, 40%UL (SA6)**
* **Radio Range (SSF)** — (Editable only when the **Use network-level configuration** check box is cleared. Optional.) Select the Radio Range parameter, also referred to as Signal Strength Floor (SSF), for all APs in the venue. SSF determines the signal strength thresholds for different coverage areas within the network. This ensures optimal connectivity and handover performance across varying distances and terrain conditions.
  * **Normal (SSF7)** — This SSF category represents the typical signal strength threshold for cell selection and handover within a network. It is used for areas where the network coverage is considered standard, and the signal strength is within the normal operating range.
  * **> 6 miles (SSF5)** — This SSF category represents an extended coverage area where the signal strength may be weaker compared to the normal operating range. It is used for areas where the distance between the cell site and the UE exceeds six miles, requiring a lower signal strength threshold for cell selection and handover.
* **Use network-level configuration** — Select this check box to inherit the network-level SA and SSF configurations, which will be applied to all APs in the venue.
  {% endstep %}

{% step %}
To save your edits, in the upper-right corner of the page, click **Save Venue**.
{% endstep %}
{% endstepper %}

## Delete Venues

{% hint style="info" %}
**NOTE:** You can delete venues only if you are a GXC Administrator, Partner Administrator, or a Super Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** You cannot delete a venue if there are any floors, APs, or Onyx Edge associated with the venue.
{% endhint %}

**To delete a venue:**

{% stepper %}
{% step %}
In the navigation pane, click **Venues**.
{% endstep %}

{% step %}
For the venue that you want to delete, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Delete**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FjuPImmw6GFZnNH85N33k%2Fimage.png?alt=media&amp;token=9a001fa8-e066-4bcf-99df-c40a0b2fd430" alt="" width="110"><figcaption></figcaption></figure></div>

A confirmation dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FiMSYPTbqPLmv2W036Xq3%2Fimage.png?alt=media&amp;token=12b37b5a-cc2c-4dfd-93c0-7e54f157435d" alt="" width="329"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To confirm deleting the venue, click **Yes**.
{% endstep %}
{% endstepper %}


# Manage Equipment

The Onyx Portal enables you to onboard, monitor, and manage Onyx Edge, APs, DAS, and Mesh Node equipment in your network.

## 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.

## IPSec Support

{% hint style="info" %}
**NOTE:** In this release, IPSec is supported only in 4G networks.
{% endhint %}

IPSec is an open, standards-based secure network architecture / protocol suite used to secure traffic between two endpoints in an IP network. When enabled on an Onyx Edge and an associated AP, an encrypted IPSec tunnel is set up between them, and data flows between them are authenticated and encrypted for secure communications.

{% hint style="info" %}
**NOTE:** IPSec-enabled Onyx Edge must be associated only with directly connected IPSec-enabled APs. Any directly connected non-IPSec APs, if present, must be on a different subnet from the IPSec virtual-IP-pool subnet.
{% endhint %}

{% hint style="info" %}
**NOTE:** IPSec must not be enabled on APs behind Mesh Nodes.
{% endhint %}

{% hint style="info" %}
**NOTE:** IPSec on an Onyx Edge cannot be disabled until IPSec is disabled on all associated APs.
{% endhint %}

{% hint style="info" %}
**NOTE:** When IPSec is enabled, DHCP service will be disabled as all directly connected APs will have to connect via IPSec.
{% endhint %}

{% hint style="info" %}
**NOTE:** IPSec is not supported in conjunction with HA/Onyx Edge pools. IPSec-enabled Onyx Edge and APs must not be associated with an Onyx Edge pool. IPSec must not be enabled on Onyx Edge and APs already associated with a pool. For more information, see [*Manage Onyx Edge High Availability*](#manage-onyx-edge-high-availability).
{% endhint %}

The Onyx Portal/Orchestrator provides the IPSec certificates for the Onyx Edge and the AP. The IPSec CA Certificate, IPSec Equipment Certificate, and IPSec Private Key files must be downloaded from the Onyx Portal and uploaded on the AP equipment's configuration interface.

**Workflow to enable IPSec support:**

{% stepper %}
{% step %}
In the Onyx Portal, configure the Onyx Edge for IPSec support.

See [*Manage Onyx Edge*](#provisioning-support).
{% endstep %}

{% step %}
In the Onyx Portal, configure the AP for IPSec support.

See [*Manage APs*](#manage-aps).
{% endstep %}

{% step %}
In the AP equipment's configuration interface, enable and configure IPSec support.\
\
See [*Enable and Configure IPSec on AP Equipment*](#enable-and-configure-ipsec-on-ap-equipment).
{% endstep %}
{% endstepper %}


# Manage Onyx Edge

The Onyx Edge is the Evolved Packet Core (EPC) function of the Onyx network. It provides the backhaul connectivity to the APs and Mesh Nodes. The Onyx Edge terminates the Control Plane traffic from the APs and most of the management plane traffic from the Onyx Portal. It also enforces traffic policies on the user plane traffic from the subscribers.

### View Onyx Edge Details

This section describes how to:

* [*View Summary Details of All Onyx Edge*](#view-summary-details-of-all-onyx-edge)
* [*View an Onyx Edge's Details*](#view-an-onyx-edges-details)

#### View Summary Details of All Onyx Edge

**To view the summary details of all Onyx Edge in the 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.

* **Onyx Edge (n)** – (n) indicates the number of Onyx Edge in the network.
* Status of services running on the Onyx Edge.

  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJk145EQJhFMBGoE9Be8P%2Fimage.png?alt=media&amp;token=f9524954-2fd5-435b-8208-0f52b36bc1d0" alt="" data-size="line"> 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.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FfhxCDUkPjJ2edzMDaivI%2Fimage.png?alt=media&amp;token=2c120687-5e98-452b-a601-82ca85c65069" alt="" data-size="line"> 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.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FITWEpzVeyeTRAwHr8Qs8%2Fimage.png?alt=media&amp;token=d082fddb-f3a4-4185-9772-575126e4869e" alt="" data-size="line"> 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.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FD8AgwtIGO4ByUfmRAX8F%2Fimage.png?alt=media&amp;token=66ef4597-48ec-436b-b834-4aee0ca0b828" alt="" data-size="line"> 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.
* **Name** – The Onyx Edge's name.
* **Venue / VM** – The name of the venue or the VM hosting the Onyx Edge.
* **Access Point** – The number of APs that are MME-connected to the Onyx Edge is displayed in green, and those that are MME-disconnected in red.

  To view the AP 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.

  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJrrXZRCv8frKxIyPw27n%2Fimage.png?alt=media&amp;token=6db051a8-1c11-4b4b-ae63-697c44206561" alt="" data-size="line"> Green – Indicates the Onyx Edge has checked-in with Onyx Portal in the last five minutes.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJIyyoPtdtRE1pShsX94j%2Fimage.png?alt=media&amp;token=9196e717-4de4-4b29-80d6-0e118ecd7839" alt="" data-size="line"> 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 SGi and RAN (S1) interfaces.

  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FlSrOl3ImFUYkJAl8RTXg%2Fimage.png?alt=media&amp;token=283c9750-a5bb-49d0-822d-e54f0bd3f8cc" alt="" data-size="line"> 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).
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FVl5llwzMaZ6PtNBPyJqa%2Fimage.png?alt=media&amp;token=691b8159-7333-4bfd-b823-52824fa66b6e" alt="" data-size="line"> 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).
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FdmWLnG8LCLimSlB4F2zn%2Fimage.png?alt=media&amp;token=0d795c0a-3a33-4057-821b-9fb3b3b053a3" alt="" data-size="line"> 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).
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FEVOqxkDfvCjWy6rKynoe%2Fimage.png?alt=media&amp;token=3d87cfed-fa64-4914-abf9-0a7b3ee53693" alt="" data-size="line"> Grey – Indicates the Onyx Edge is offline.

  Hovering your cursor over the "Interface Status" icon displays the following details:

  * **MME Connected APs** – Number of MME-connected APs.
  * **MME Disconnected APs** – Number of MME-disconnected APs.
  * **Offline APs** – Number of APs whose MME connection status is unknown.
  * **SGI Info (IP address)** – SGi interface's IP address.
  * **Reporting Time** – SGi health last reported timestamp.
* **Compute Resource** – Indicates utilization of the Onyx Edge's computing resources – CPU percentage, Memory percentage, and Disk Utilization percentage.

  * &#x20;<img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmyRM32iQMzeWDREI5xUL%2Fimage.png?alt=media&amp;token=4af47e72-e734-4b6a-87ae-1be84b166536" alt="" data-size="line"> Green – Indicates all parameters are below 50%.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8MvfMWKoIPuaOglaTK3J%2Fimage.png?alt=media&amp;token=41d02fc1-d704-4e3d-b700-36cc4ea3079d" alt="" data-size="line"> Amber – Indicates at least one parameter is above 50% and below 70%.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FchmcDIYbMR39WRtpGeYG%2Fimage.png?alt=media&amp;token=b460b6f9-2245-48a1-92e8-f6a512fdf012" alt="" data-size="line"> Red – Indicates at least one parameter is above 70%.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FVzSdxIOcnbyolzZBsKOh%2Fimage.png?alt=media&amp;token=1224cb7c-d366-4828-8260-9f27c56f3106" alt="" data-size="line"> 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.
* **IPSec** – Indicates the Onyx Edge's IPSec status.

  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FlGQGBv1PrKpN72zovej5%2Fimage.png?alt=media&amp;token=d6d9f794-bb83-485d-be7a-3cce2f490dd0" alt="" data-size="line"> Green – The Onyx Edge is IPSec-enabled, and all IPSec-enabled APs have active IPSec tunnels with the Onyx Edge.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FVuNfRzdbN4nYpKwh0ohh%2Fimage.png?alt=media&amp;token=58bff764-94d8-4e83-8a68-15e276195313" alt="" data-size="line"> Amber – The Onyx Edge is IPSec-enabled, and while at least one IPSec-enabled AP has an active IPSec tunnel with the Onyx Edge, other IPSec-enabled APs are unreported or have bad IPSec status.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FTMJH5opeIfzMyHLKUlUJ%2Fimage.png?alt=media&amp;token=3067dc9c-d5b3-4a70-ad1c-e31e33e55e6a" alt="" data-size="line"> Red – The Onyx Edge has bad IPSec status, and/or all IPSec-enabled APs are unreported or have bad IPSec status.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FbTJrHTldNLM8OPUWZFBr%2Fimage.png?alt=media&amp;token=399e42cb-48a1-4826-9cc5-e63aec55ca4a" alt="" data-size="line"> Grey – The Onyx Edge is offline, is IPSec-disabled, and/or all the APs are IPSec-disabled.

  Hovering your cursor over the "IPSec Status" icon displays the counts of IPSec-connected and IPSec-not-connected APs.
* **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).
* **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. This graph excludes Mesh UE traffic.
* **Onyx Edge Pool** – The list of Onyx Edge pools in the network and their details. For information on Onyx Edge pools, see [*Manage Onyx Edge High Availability*](#manage-onyx-edge-high-availability).
  * Status – The Onyx Edge pool's HA connectivity status.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FC3xMdnY44R6TK46VUkyw%2Fimage.png?alt=media&amp;token=07d44f3f-6b55-4926-91b7-580b5d495e48" alt="" data-size="line"> Green – One Onyx Edge is functioning as the Primary ACS, and the others as Standby ACS.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FOeMqVEVSjf6b1RHSnoSv%2Fimage.png?alt=media&amp;token=5bdbd573-b4c5-46a4-a6cc-27f084ad3b0b" alt="" data-size="line"> Amber – One Onyx Edge is functioning as the Primary ACS, but one or more of the other Onyx Edge are non-functional.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F4vDwy1hze0L8vmwXcXuT%2Fimage.png?alt=media&amp;token=af612f63-6dea-4284-b14b-4e20a9bb5d6e" alt="" data-size="line"> Red – All Onyx Edge are non-functional, or their status is not available.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F1gErlJz5JZkar9OYjry1%2Fimage.png?alt=media&amp;token=929318c5-4c3f-4fab-bc51-a2ec22b34c89" alt="" data-size="line"> 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** – The virtual management IP address used to anchor TR069 endpoint in the Primary ACS Onyx Edge.
  * **Associated Onyx Edge** – The number of Onyx Edge associated with the pool.
  * **Associated Access Points** – The number of APs associated with the pool.
  * **Actions** – Options to view details, edit, and delete the Onyx Edge pool.
  * **Add Pool** – (GXC Administrators, Customer Administrators, or Administrators only.) To add an Onyx Edge pool. For information on managing Onyx Edge Pools, see [*Manage Onyx Edge High Availability*](#manage-onyx-edge-high-availability).
* **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** – Plot of control plane transaction outcomes for all or a selected Onyx Edge, transaction type, and duration. Success count is displayed in green, and failure count in red color. Select the event type from the following:
  * **Attach Request** – Initial requests from a UE to connect to the network.
  * **Auth Request** – Authentication requests to verify UE/subscriber identity.
  * **Create Session Request** – Requests to establish a data session for user-plane traffic.
  * **Service Request** – Requests for specific network services.
  * **Handovers** – Requests to transfer an active connection between cells.
    {% endstep %}
    {% endstepper %}

#### View an Onyx Edge's Details

**To view the details of an Onyx Edge in a 4G 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 %}
To view the details of a particular Onyx Edge, in the **Onyx Edge (n)** panel, click its name.

The Onyx Edge details page > **Overview** tab displays the following details:

* **Overview** tab:
  * **Onyx Edge Details**:
    * **Type** – The Onyx Edge's deployment type.
    * **Name** – The Onyx Edge's name.
    * **Pool Name** – If the Onyx Edge is associated with an Onyx Edge pool, the pool's name. For information on Onyx Edge Pools, see [*Manage Onyx Edge High Availability*](#manage-onyx-edge-high-availability).
    * **Host Name** – The Onyx Edge's hostname.
    * **Description** – The Onyx Edge's description.
    * **SGi Interface (Eth0)** – The SGi interface's eth0 IP address.
    * **S1 Interface (Eth1)** – The S1 interface's eth1 IP address.
    * **Version** – The Onyx Edge's software version.
    * **Upgrade Status** – Status of the previous Onyx Edge software upgrade. Note that the **Upgrade Status** parameter is displayed only during and for one hour after an upgrade.

      To view 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.
    * **Up Time** – The duration for which the Onyx Edge has been operational without any downtime or interruptions.
    * **Venue** – The name of the venue hosting the Onyx Edge. To view the venue's details, click its name.
    * **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 <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FG2vCKbjlEPNGUitTE1wu%2Fimage.png?alt=media&amp;token=7e9f9a79-2b22-4eaa-a5ab-77923b4b227c" alt="" data-size="line">.
      * **Challenge Key** – The Onyx Edge's Challenge Key used in challenge-response authentication mechanism. To copy the challenge key to the clipboard, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FxkDHBK1JSir9lUMUov4t%2Fimage.png?alt=media&amp;token=ca8aa6ac-130c-483b-9ae3-ebe74fb94cde" alt="" data-size="line">.
      * **AGW User Configuration** – The AGW User account's password, displayed only if it has been set. If the AGW User account's password has not been changed from the default value, a warning message is displayed.
      * **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. If a key has not been added, the default key is used.
    * The Onyx Edge's health status.
      * **Online** – The Onyx Edge's online status indicating its reachability from the Onyx Portal.

        * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FgTuDyEtZ51Zdlp6QjuAO%2Fimage.png?alt=media&amp;token=9703211d-ce34-481a-b848-1893ebbd4909" alt="" data-size="line"> Green – Indicates the Onyx Edge has checked-in with Onyx Portal in the last five minutes.
        * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FnPTK8nEsUjWcnakpT3Pj%2Fimage.png?alt=media&amp;token=fc8a7ef0-0c45-4164-adef-583e970bbc49" alt="" data-size="line"> 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.

        * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FdmMzGVlqVy5KYRttt8CG%2Fimage.png?alt=media&amp;token=221dff5c-185d-4585-89cb-741244a79e35" alt="" data-size="line"> 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).
        * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQS01x07XeSWeO5eWIlPf%2Fimage.png?alt=media&amp;token=bd6b640b-9293-4729-9b73-32a7e7a9d98c" alt="" data-size="line"> 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).
        * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FeK6IWH3t64mEHynCRalK%2Fimage.png?alt=media&amp;token=0f564326-772e-4c10-ba88-02d5ba1d86cf" alt="" data-size="line"> 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).
        * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fjr5PiVg2ZIcCPI5wQtqq%2Fimage.png?alt=media&amp;token=f1889c90-615b-4902-a16b-fe1028e0e875" alt="" data-size="line"> Grey – Indicates the Onyx Edge is offline, or data is not available.

        Hovering your cursor over the "Interface Status" icon displays the following details:

        * **MME Connected APs**
        * **MME Disconnected APs**
        * **Offline APs**
        * **SGi Info (IP Address)**
        * **Reporting Time**
      * **Compute Resource** – Status of the Onyx Edge's computing resources.

        * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Ffwp1bF5mav9yqAG9PZ8M%2Fimage.png?alt=media&amp;token=0b5cac9c-27bd-433a-ad39-eb5537a9148c" alt="" data-size="line"> Green – Indicates all parameters are below 50%.
        * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FqnEOrFP4EW7V414l1p5r%2Fimage.png?alt=media&amp;token=c9545663-0c5c-4a89-b744-aa2a860c4fe5" alt="" data-size="line"> Amber – Indicates at least one parameter is above 50% and below 70%.
        * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FdbH1Ss1NFE90tyj7ytIg%2Fimage.png?alt=media&amp;token=3a10dc73-a85c-4a74-bf30-d2b9bd9faecb" alt="" data-size="line"> Red – Indicates at least one parameter is above 70%.
        * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FPSOZp0GbiOlZQ9hfqyFu%2Fimage.png?alt=media&amp;token=055fe363-e478-4c12-8011-df8a527b3581" alt="" data-size="line"> 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.

        * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fe2iqdRoFk8Peg9jPROLT%2Fimage.png?alt=media&amp;token=542043e3-3272-4f14-8f51-81822cd0e8d3" alt="" data-size="line"> 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.
        * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FVyOy9GqBgf9vlCaQ5JBF%2Fimage.png?alt=media&amp;token=f8e8108e-6fad-4679-952c-4fa552c43fed" alt="" data-size="line"> 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.
        * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5vyNarBe595BHfvYslau%2Fimage.png?alt=media&amp;token=8f582a8b-3f23-4d01-9cf2-8523512fed1a" alt="" data-size="line"> 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.
        * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FwPKWO0K84HpQCuhaMkr2%2Fimage.png?alt=media&amp;token=f763c28d-1816-4b9f-99d2-2b29b0920a44" alt="" data-size="line"> 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.
      * **IPSec Status** – The Onyx Edge's IPSec status.

        * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0cCkQ7P8A2bwFrkmKYxA%2Fimage.png?alt=media&amp;token=6d91bfee-daee-40bd-a76c-728688cf91e2" alt="" data-size="line"> Green – The Onyx Edge is IPSec-enabled, and all IPSec-enabled APs have active IPSec tunnels with the Onyx Edge.
        * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FRtcdcmELpNFasE2hUp8h%2Fimage.png?alt=media&amp;token=1a8345ed-39af-43d9-9008-b8a6d3c52890" alt="" data-size="line"> Amber – The Onyx Edge is IPSec-enabled, and while at least one IPSec-enabled AP has an active IPSec tunnel with the Onyx Edge, other IPSec-enabled APs are unreported or have bad IPSec status.
        * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F1yssOwC0JuS1Pz2Y2YSu%2Fimage.png?alt=media&amp;token=855f92b9-a0c1-4859-908d-56a7a70a51cf" alt="" data-size="line"> Red – The Onyx Edge has a bad IPSec status, and/or all IPSec-enabled APs are unreported or have bad IPSec status.
        * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5lDaFqMR0va9GKpD8ZkN%2Fimage.png?alt=media&amp;token=8c221668-2a07-4433-9bdf-01ba3fd6e4bd" alt="" data-size="line"> Grey – Indicates the Onyx Edge is offline, is IPSec-disabled, and/or all the APs are IPSec-disabled.

        Hovering your cursor over the "IPSec Status" icon displays the counts of IPSec-connected and IPSec-not-connected APs.
* **Core**:
  * **UE IP Configuration**:
    * **IP Block** – The IP pool 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 Secondary Server** – (Displayed only when **Onyx Edge-as-DNS-Server** is enabled.) Enabled or Disabled. When enabled, if the Onyx-Edge is unavailable, or if it fails to resolve domain name, the UE will contact the DNS secondary server for domain name resolution.
    * **DNS Primary** – The primary DNS server's IP address.
    * **DNS Secondary** – The secondary DNS server's IP address.
  * **SGI Interface**:
    * **SGI 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.
    * **SGI Management VLAN** – (Displayed only in VLAN mode if UE IP allocation mode is Static.) The SGi Management VLAN ID.
  * **Mesh Node Management**:
    * **Onyx Edge-Tunnel-Anchoring Subnet** – The Onyx Edge subnet used to set up tunnels with Mesh Nodes.
    * **Mesh Node Assignment Subnet** – The subnet used to assign IP addresses to APs behind Mesh Nodes.
    * **Mesh Node UE Assignment Subnet** – (Displayed only in VLAN mode.) The subnet to assign IP addresses for CPEs to attach to the Onyx Edge.
    * **Mesh Node VLAN** – (Displayed only in VLAN mode.) The VLAN ID used for APN to VLAN mapping.
  * **Per APN 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.
* **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.
* **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 **Subscribers** > subscriber details > **UE Latency** parameter.
* **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.
* **Mesh Node** – Details of Mesh Nodes connected to the Onyx Edge.
  * The Mesh AP's RF Tx status.
  * **Name** – The Mesh Node's name.
  * **Serial No.** – The Mesh Node's serial number.
  * **RSSI (dBm)** – The Mesh Node's Received Signal Strength Indicator (RSSI) level in dBm.
  * **Online** – The Mesh Node's online status.

    To view the last check-in timestamp, hover your cursor over the "Online Status" icon. To view details of all Mesh Nodes, click **View All**. The **Mesh Nodes** page is displayed.
* **RAN**:
  * **S1 Interface**:
    * **S1 Interface** – If enabled, Static or DHCP. Static indicates the Onyx Edge serves as the DHCP server for static IP address allocation to directly connected APs. DHCP indicates DHCP is enabled for IP address allocation to the Onyx Edge's S1 interface.
    * **IP/Subnet** – (Displayed only if S1 interface is enabled in Static mode.) The subnet from which the first IP address is used for the S1 interface. In the case of AP DHCP Service, the rest are for IP address allocation to APs to connect to the Onyx Edge.
    * **Access Point DHCP Service** – (Displayed only if S1 interface is enabled in Static mode.) Indicates the AP DHCP service status—Enabled or Disabled. When enabled, the Onyx Edge serves as a DHCP server for IP address allocation to directly connected APs.
    * **Start IP** – (Displayed only when the AP DHCP service is enabled.) The DHCP pool's start IP address.
    * **No. of IP** – (Displayed only when the AP DHCP service is enabled. Required.) The number of IP addresses.
  * **Onyx Edge IPSec Configuration**:
    * **IPSec** – The Onyx Edge's IPSec configuration status—Enabled or Disabled.
      * **Advanced Config** – (Displayed only when **IPSec** is enabled.) To view the advanced configuration parameters, click the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FfapjNdQNxwrV9DegQ5yO%2Fimage.png?alt=media&amp;token=dc69221b-9fb3-41d5-9fac-8670c7190a4c" alt="" data-size="line"> (view details) icon:
      * **Ike Rekey Time (seconds)** – Time in seconds for renewing Internet Key Exchange (IKE) Security Association.
      * **Child SA Rekey Time (seconds)** – Time in seconds for renewing IPSec Security Association.
      * **DPD Time (seconds)** – Time in seconds to do Dead Peer Detection (DPD) for idle peers.
      * **MTU Overhead (bytes)** – IPSec overhead to each packet in bytes to assume for MTU calculation of actual UE packets.
      * **Allow Non-IPSec Direct APs** – Specifies whether all directly connected APs are expected over IPSec. If set to **False**, all direct-APs must be coming over IPSec, the Onyx Edge will reject any clear-text connection attempts. If there is a mix of both IPSec and non-IPSec APs, set to **True**. Note that Mesh-APs are always non-IPSec. This setting only deals with direct-APs.
      * **MME Local IP** – The inner IP address on which the MME service is available within the IPSec tunnel.
      * **AP Assignment Subnet** – Whenever IPSec is established, the Onyx Edge runs the DHCP service to provide IP address for the AP to use from this subnet.
* **Connected Access Point** – Details of APs connected to the Onyx Edge:
  * The AP's RF Tx status.
  * **Name** – The AP's name.
  * **Serial No.** – The AP equipment's vendor-assigned serial number.
  * **IP Address** – The AP's IP address.
  * **VIP Address** – For IPSec-enabled APs, the Virtual IP address (inner IP address) used for MME connection.
  * **Online** – The AP's online status. To view the last check-in timestamp, hover your cursor over the "Online Status" icon.
  * **Interface Status** – The AP's interface status. To view the following details, hover your cursor over the "Interface Status" icon:
    * **MME Status**
    * **Last Synced At**
  * **IPSec Status** – The status of the IPSec tunnels with the Onyx Edge and the IPSec certificate's validity. Note that the certificate status is that of the generated certificate, and not of the one uploaded to the AP. To view the status details, hover your cursor over the "IPSec Status" icon.
* **Subscribers** – Details of subscribers connected to the Onyx Edge.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE</strong>: For non-GXC Administrator users this list excludes MeshBackhaul subscriber data.</p></div>

  * **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 is displayed.
    {% endstep %}

{% step %}
Click the **Events & Alerts** tab.

* **Events & Alerts** tab:
  * **Alerts** – Details of Onyx Edge related alerts for the selected severity level.

    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 duration:

    * **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 associated entity's name.
    * **Event Description** – The event's description.

    To view more details for a particular event, click the corresponding ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FiAIHX23TmbavcG8VNCvy%2Fimage.png?alt=media\&token=0e5589c2-9d38-4ad3-96d7-85911d2a9bd3) (view details) icon.
    {% endstep %}

{% step %}
Click the **Logs** tab.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FDpZZX9BLorOmk8KhjQtg%2Fimage.png?alt=media&amp;token=af5cd052-ec8e-4909-8d8f-2e9471d733c4" alt=""><figcaption></figcaption></figure>

* **Logs (n)** – The number of logs for the Onyx Edge in the selected date and time range.
  * Download Logs – To download the logs in .csv format, in the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FioD8wNf4nYeUcI0UXKeT%2Fimage.png?alt=media&amp;token=dd70e970-1c87-4908-90f4-4a514a40713d" alt="" data-size="line"> field enter the number of logs to be included in the .csv file, then click the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJAoMUAVryUVMrGcApZrU%2Fimage.png?alt=media&amp;token=5b902c9a-e118-4849-9145-7a1d0d80ffb7" alt="" data-size="line"> icon. Default value: 5000. The downloaded .csv file includes details such as the timestamp, service, tag, type, and log text.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> You can download a maximum 5000 logs.</p></div>
  * Date and Time Range – To view logs in a specific date and time range, select the required timestamps in the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FTgcLUaNcjArjGIV25nRO%2Fimage.png?alt=media&amp;token=7b8222a6-55f6-4939-b6bf-0891f218ba0e" alt="" data-size="line"> date/time fields. The logs list automatically updates to display the corresponding logs.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> Your selections must fall within a seven-day range.</p></div>
  * Search Logs – To search for a log, enter your search term in the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FgjUILIcy8ujZCS0dCnoU%2Fimage.png?alt=media&amp;token=0b36959f-e979-4f38-82bf-93a1f13aec76" alt="" data-size="line"> 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 %}
In the upper-right corner of the page, click the **Actions** button to access the following options.

{% hint style="info" %}
Note that the **Actions** button is enabled only when the Onyx Edge is online.
{% endhint %}

* **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*](#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.
* **Reboot Neighbor Updated AP** – (GXC Administrators, Super Administrators, and Administrators only.) Schedule reboots for APs with pending neighbor changes:

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FwwE0pYTAmdW1ZHgI85pm%2Fimage.png?alt=media&amp;token=74d5c842-0076-44ca-8916-f4e36fa283a9" alt="" width="563"><figcaption></figcaption></figure></div>

  * Reboot all APs with reboot pending at a chosen time, including immediately.
  * Reboot a specific AP by serial number, if it has a reboot pending, at a chosen time including immediately.
* **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, Super Administrators, and 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) The command's parameters/values.
    {% endstep %}
    {% endstepper %}

### Add Onyx Edge

This section describes how to add an Onyx Edge to 4G networks.

* [*Add Onyx Edge to 4G Network in NAT Mode*](#add-onyx-edge-to-4g-network-in-nat-mode)
* [*Add Onyx Edge to 4G Network in VLAN Mode*](#add-onyx-edge-to-4g-network-in-vlan-mode)

#### Add Onyx Edge to 4G Network 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 exist.
{% endhint %}

{% hint style="info" %}
**NOTE:** Onyx Edge can be deployed either as standalone or as a pool to enable MME/Onyx Edge High Availability. For information on High Availability and Onyx Edge Pools, see [*Manage Onyx Edge High Availability*](#manage-onyx-edge-high-availability).
{% endhint %}

{% hint style="info" %}
**NOTE:** To add Onyx Edge in NAT mode, you must disable VLAN mode at the network level.
{% endhint %}

{% hint style="info" %}
**NOTE**: For detailed information on the networking modes supported by the GXC 4G Onyx Platform, refer to the *4G & 5G Networking Modes Application Note*. The document covers NAT and Bridge (APN-on-VLAN) modes — including Classic and Flat variants for 4G — 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 to a 4G 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.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fg11UcTCZbs1OwoSVIxjE%2F4g-nat-mode-oe-add-onyx-edge-tab.png?alt=media&amp;token=ad4a7ec5-dd5c-4bb5-be6c-91ef76ab3439" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

* **On Premises** – Select to add an Onyx Edge On-Premises.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> For information on Onyx Edge Cloud, contact GXC Technical Support.</p></div>
* **Venue** – (Required) Click to 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 hostname 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.
* **MME Pool** – (Required) Click to select the Onyx Edge pool. \
  Onyx Edge can be deployed as a pool for MME/Onyx Edge High Availability. For information on High Availability and managing Onyx Edge pools, see [*Manage Onyx Edge High Availability*](#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.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FxI6TwQipEEHuKLn5Kwj4%2F4g-nat-mode-oe-add-core-tab.png?alt=media&amp;token=a1a54bab-e72b-442e-9d15-bdab597e2443" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details.

* **UE IP Configuration** – IP pool configuration for the Onyx Edge to assign IP addresses to UE.
  * **IP Block** – (Required) The IP address pool from which the Onyx Edge will allocate IP addresses to UE. Default value: 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 sec (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 is unavailable, or if it fails to resolve domain names, 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.
* **SGI Interface**:
  * **Static** – (Optional) Select to configure the management network parameters.
    * **IP/Subnet** – (Displayed only when the **Static** option is selected. Required.) The management IP address for Onyx Edge to reach corporate network/Internet. Default value: 1.1.1.1/24.
    * **Gateway** – (Displayed only when the **Static** option is selected. Required.) The corporate gateway router IP address. Default value: 1.1.1.0.
    * **DNS Primary** – (Displayed only when the **Static** option is selected. Required.) The primary DNS server IP address. Default value: 8.8.8.8.
    * **DNS Secondary** – (Displayed only when the **Static** option is selected. Required.) The secondary DNS server IP address. Default value: 8.8.4.4.
  * **DHCP** – Select to enable DHCP for management interface, to get IP address for the management interface. Default setting: enabled.
* **Mesh Node Management**:
  * **Onyx Edge Tunnel Anchoring Subnet** – (Required) The Onyx Edge subnet used to set up tunnels with Mesh Nodes. Default value: 192.168.133.0/28. If the default value must be changed, contact GXC Technical Support.
  * **Mesh Node Assignment Subnet** – (Required) The subnet used to assign IP addresses to APs behind Mesh Nodes. Default value: 10.0.3.0/24. If the default value must be changed, contact GXC Technical Support.
* **NAS Security Algorithms** – Configure the security algorithms used for Non-Access Stratum (NAS) signaling — the control plane protocol between UE and the 4G Core.
  * **Integrity Algorithm** – (Required) Algorithm used to ensure NAS message integrity.
    * **EIA1** – 128-SNOW 3G integrity protection
    * **EIA2** – (Default) 128-bit AES-based integrity protection (standard 5G/LTE algorithm)
  * **Encryption Algorithm** – (Required) Algorithm used to encrypt NAS messages.
    * **EEA2** – (Default) 128-bit AES-based ciphering
    * **EEA0** – Null encryption
      {% endstep %}

{% step %}
In the lower-right corner of the page, click **Configure RAN**.

The **Create Onyx Edge** page > **RAN** tab is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FcPVoMF4FOf9GNotOfqRF%2F4g-nat-mode-oe-add-ran-tab.png?alt=media&amp;token=94598c10-fe65-46c8-921d-64e307f90d6f" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details.

* **S1 Interface**:
  * **Static** – Select Static mode for deployments where the APs are directly connected to the Onyx Edge and are in an L2 network of their own. When the **Access Point 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 selected. Required.) The subnet from which the first IP address is used for the S1 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.
    * **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 **Access Point DHCP Service** is selected. 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 **Access Point DHCP Service** is selected. 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.
  * **DHCP** – Select to enable DHCP for IP address allocation for S1 interface of the Onyx Edge. Default setting: disabled.
  * **Same as SGI** – 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. Default setting: disabled.
* **Associated Access Point** – (Optional) Select the APs to directly associate with the Onyx Edge. For information on adding and configuring APs, see [*Manage APs*](#manage-aps).

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> An AP can be associated with any one Onyx Edge or Onyx Edge pool at any time. Only APs that are not associated with any Onyx Edge or Onyx Edge pool are available for association.</p></div>
* **Onyx Edge IPSec Configuration** – Enable or disable IPSec, which, when enabled, establishes a tunnel between the Onyx Edge and associated IPSec-enabled APs for secure communications. Default setting: disabled.
  * **MME Local IP** – (Applicable only when the **Onyx Edge IPSec Configuration** toggle is turned on. Required.) The inner IP address on which the MME service is available is within the IPSec tunnel. Default value: 10.0.10.1. If the default value must be changed, contact GXC Technical Support.
  * **Access Point Assignment Subnet** – (Applicable only when the **Onyx Edge IPSec Configuration** toggle is turned on. Required.) Whenever IPSec is established, the Onyx Edge runs DHCP service to provide IP address for the AP to use from this subnet. Default value: 10.0.30.0/24. If the default value must be changed, contact GXC Technical Support.
  * **Show Advanced Configs** – Click to configure advanced IPSec parameters:

    * **IKE Rekey Time (seconds)** – (Required) Time in seconds for renewing Internet Key Exchange (IKE) Security Association. Default value: 14400 seconds.
    * **Child SA Rekey Time (seconds)** – (Required) Time in seconds for renewing IPSec Security Association. Default value: 3600 seconds.
    * **DPD Time (seconds)** – (Required) Time in seconds for Dead Peer Detection (DPD) of idle peers. Default value: 60 seconds.
    * **MTU Overhead (bytes)** – (Required) IPSec overhead to each packet in bytes to assume for MTU calculation of actual UE packets. Default value: 100.
    * **Allow Non-IPSec Direct APs** – Specify whether all directly-connected APs are expected over IPSec. If all direct-APs must be coming over IPSec, set to **False**. The AGW will reject any clear-text connection attempts. If there is a mix of both IPSec and non-IPSec APs, set to **True**. Note that Mesh-APs are always non-IPSec. This setting only deals with direct-APs. Default setting: False.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> If IPSec is disabled on Onyx Edge On-Premises, you can only associate IPSec-disabled APs with it.</p></div>

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> IPSec is not supported in conjunction with HA/Onyx Edge pools. IPSec-enabled Onyx Edge must not be associated with an Onyx Edge pool. IPSec must not be enabled on Onyx Edge already associated with a pool. For more information, see <a href="#manage-onyx-edge-high-availability"><em>Manage Onyx Edge High Availability</em></a>.</p></div>

{% endstep %}

{% step %}
In the lower-right corner of the page, click **Configure Others**.

The **Create Onyx Edge** page > **Others** tab is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FfEc6awdaaidAa0279yd1%2F4g-nat-mode-oe-add-others-tab.png?alt=media&amp;token=f4b25200-c56c-4512-96b5-8f10b9ef6068" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details.

* **CPE Monitoring** – (Optional) Enable or disable data-path latency monitoring for UE connected to the Onyx Edge. Default: Disabled. 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.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> 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.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> 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 <strong>Last Reported Time</strong> parameter is blank, displayed as \–.</p></div>
* **AGW User Configuration** – (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** –&#x20;
    1. Click to add SSH keys for *agw\_user*.

       The **Add SSH Key** dialog box is displayed.
    2. Enter the SSH key, then click **Save**.

       You can add a maximum of 10 SSH keys.
  * **Change Password** –&#x20;
    1. Click to change the *agw\_user* password.

       The **Change Password** dialog box is displayed.
    2. Enter the following details:

       * **Password** — (Required) Password for *agw\_user*.
       * **Confirm Password** — (Required) Reenter the password to confirm.

       The list of SSH keys is updated.
    3. You have the option to view details, edit, and delete SSH keys.
* **Backhaul Speedtest** — Prioritized list of iPerf-compatible speedtest servers used to measure backhaul link performance. Four servers are pre-configured. The following details are displayed:

  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FwA2Au3Dcc1Lcm4zFYam4%2Ficon-drag-handle.png?alt=media\&token=e70342c5-bd26-444f-ad7d-eec7ef1cc7df) (Drag Handle) icon — Drag-and-drop to reorder a speedtest server's priority.
  * **Priority** — The order in which servers are tried (1 being highest).
  * **URL** — The speedtest server's hostname/URL.
  * **Start Port** — The beginning of the port range used for the test.
  * **End Port** — The end of the port range.
  * **Actions** — Allows deleting a server entry.

  Add and manage Backhaul Speedtest servers.

  * **Add Server**
    1. Click to add a speedtest server.\
       A new blank row is added.
    2. Enter the following details:
       * **Server Hostname/URL** — The speedtest server's hostname/URL.
       * **Start Port** — The beginning of the port range used for the test.
       * **End Port** — The end of the port range.
       * Drag and drop to set the server's priority.
  * Delete Server — To delete a server, in the **Actions** column, click the corresponding ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F1oTYgD6vbQgPuwfZ3d3G%2Fspeedtest-server-delete-icon.png?alt=media\&token=7c0fe181-0dbc-4908-bd26-c93ab0ed914b) (delete) icon.
    {% endstep %}

{% step %}
To save the Onyx Edge, in the upper-right corner of the page, click **Save Onyx Edge**.
{% endstep %}
{% endstepper %}

#### Add Onyx Edge 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, make sure the customer account, and the required network and venue exist.
{% endhint %}

{% hint style="info" %}
**NOTE:** Onyx Edge can be deployed either standalone or as a pool to enable MME/Onyx Edge High Availability. For information on High Availability and Onyx Edge Pools, see [*Manage Onyx Edge High Availability*](#manage-onyx-edge-high-availability).
{% 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 4G Onyx Platform, refer to the *4G & 5G Networking Modes Application Note*. The document covers NAT and Bridge (APN-on-VLAN) modes — including Classic and Flat variants for 4G — 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 to a 4G 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.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F9e4fnPf0jFVelDFZ0cWv%2F4g-vlan-mode-oe-add-onyx-edge-tab.png?alt=media&amp;token=550840c8-e108-42b0-88fa-1483220eeecc" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

* **On Premises** – Select to add an Onyx Edge On-Premises.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> For information on Onyx Edge Cloud contact GXC Technical Support.</p></div>
* **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 hostname 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.
  * **MME Pool** – (Required) Click to select the Onyx Edge pool.

    Onyx Edge can be deployed as a pool for MME/Onyx Edge High Availability. For information on High Availability and managing Onyx Edge pools, see [*Manage Onyx Edge High Availability*](#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.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FC3Ya3b1Dj8dXhrofBTaU%2F4g-vlan-mode-oe-add-core-tab.png?alt=media&amp;token=533b9619-1878-4f43-a008-d66e15544bf4" alt=""><figcaption></figcaption></figure></div>
{% 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).
* **DNS Server for UE**
  * **Onyx Edge-as-DNS-Server** – Enable or disable the Onyx Edge functioning as the primary DNS server for UE. Default setting: enabled.
    * **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.
    * **Second Server** – If the Onyx Edge 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. Required.) IP address of the second DNS server.
* **SGI Interface**:
  * **Static** – Select to configure the management network parameters.
    * **IP/Subnet** – (Displayed only when the **Static** option is selected. Required.) The management IP address for Onyx Edge to reach corporate network/Internet. Default value: 1.1.1.1/24.
    * **Gateway** – (Displayed only when the **Static** option is selected. Required.) The corporate gateway router IP address. Default value: 1.1.1.0.
    * **DNS Primary** – (Displayed only when the **Static** option is selected. Required.) The primary DNS server IP address. Default value: 8.8.8.8.
    * **DNS Secondary** – (Displayed only when the **Static** option is selected. Required.) The secondary DNS server IP address. Default value: 8.8.4.4.
    * **SGI Management VLAN** – (Displayed only when **Static** option is selected. Required.) The SGi Management VLAN ID. Default value: 0.
* **Mesh Node Management**:
  * **Onyx Edge Tunnel Anchoring Subnet** – (Required) The Onyx Edge subnet used to set up tunnels with Mesh Nodes. Default value: 192.168.133.0/28. If the default value must be changed, contact GXC Technical Support.
  * **Mesh Node Assignment Subnet** – (Required) The subnet used to assign IP addresses to APs behind Mesh Nodes. Default value: 10.0.3.0/24. If the default value must be changed, contact GXC Technical Support.
  * **Mesh Node UE Assignment Subnet** – (Required) The subnet to assign IP addresses for CPEs to attach to the Onyx Edge. Default value: 192.168.129.0/24.
  * **Mesh Node VLAN** – (Required) The VLAN ID for APN to VLAN mapping. Default value: 2.
* **NAS Security Algorithms** – Configure the security algorithms used for Non-Access Stratum (NAS) signaling — the control plane protocol between UE and the 4G Core.
  * **Integrity Algorithm** – (Required) Algorithm used to ensure NAS message integrity.
    * **EIA1** – 128-bit SNOW 3G-based integrity protection
    * **EIA2** – (Default) 128-bit AES-based integrity protection (standard 5G/LTE algorithm)
  * **Encryption Algorithm** – (Required) Algorithm used to encrypt NAS messages.
    * **EEA2** – (Default) 128-bit AES-based ciphering
    * **EEA0** – 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.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FcEeVggzjJ4C9jrg2uK4c%2F4g-vlan-mode-oe-add-ran-tab.png?alt=media&amp;token=ba13cd77-569b-419b-aa40-5e7bdbaf74c0" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details.

* **S1 Interface**:
  * **Static** – Select Static mode 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 S1 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.
    * **Access Point DHCP Service** – (Applicable only when Static mode is enabled. 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.
  * **DHCP** – Select to enable DHCP for IP address allocation for S1 interface of the Onyx Edge. Default setting: disabled.
  * **Same as SGI** – 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. Default setting: disabled.
* **Associated Access Point** – (Optional) Select the APs to directly associate with the Onyx Edge.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> An AP can only be associated with one Onyx Edge or Onyx Edge pool at any time. Only APs that are not associated with any Onyx Edge or Onyx Edge pool are available for association. For information on adding and configuring APs, see <a href="#manage-aps"><em>Manage APs</em></a>.</p></div>
* **Onyx Edge IPSec Configuration** – Enable or disable IPSec. When enabled, establishes a tunnel between the Onyx Edge and associated IPSec-enabled APs for secure communications. Default setting: disabled.
  * **MME Local IP** – (Applicable only when the **Onyx Edge IPSec Configuration** toggle is turned on. Required.) The inner IP address on which the MME service is available is within the IPSec tunnel. Default value: 10.0.10.1. If the default value must be changed, contact GXC Technical Support.
  * **Access Point Assignment Subnet** – (Applicable only when the **Onyx Edge IPSec Configuration** toggle is turned on. Required.) Whenever IPSec is established, the Onyx Edge runs DHCP service to provide IP address for the AP to use from this subnet. Default value: 10.0.30.0/24. If the default value must be changed, contact GXC Technical Support.
  * **Show Advanced Config** – Click to configure advanced IPSec parameters:
    * **IKE Rekey Time (seconds)** – (Required) Time in seconds for renewing Internet Key Exchange (IKE) Security Association. Default value: 14400 seconds.
    * **Child SA Rekey Time (seconds)** – (Required) Time in seconds for renewing IPSec Security Association. Default value: 3600 seconds.
    * **DPD Time (seconds)** – (Required) Time in seconds for Dead Peer Detection (DPD) of idle peers. Default value: 60 seconds.
    * **MTU Overhead (bytes)** – (Required) IPSec overhead to each packet in bytes to assume for MTU calculation of actual UE packets. Default value: 100.
    * **Allow Non-IPSec Direct APs** – Specify whether all directly-connected APs are expected over IPSec. If all direct-APs must be coming over IPSec, set to **False**. The AGW will reject any clear-text connection attempts. If there is a mix of both IPSec and non-IPSec APs, set to **True**. Note that Mesh-APs are always non-IPSec. This setting only deals with direct-APs. Default setting: False.

{% hint style="info" %}
**NOTE:** If IPSec is disabled on Onyx Edge On-Premises, you can only associate IPSec-disabled APs with it.
{% endhint %}

{% hint style="info" %}
**NOTE:** IPSec is not supported in conjunction with HA/Onyx Edge pools. IPSec-enabled Onyx Edge must not be associated with an Onyx Edge pool. IPSec must not be enabled on Onyx Edge already associated with a pool. For more information, see [*Manage Onyx Edge High Availability*](#manage-onyx-edge-high-availability).
{% endhint %}
{% endstep %}

{% step %}
In the lower-right corner of the page, click **Per APN Per Onyx Edge Config**.

The **Create Onyx Edge** page > **APN-VLAN** tab is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQ3O78b55uoEhcpNJueHu%2F4g-vlan-mode-oe-add-apn-vlan-tab.png?alt=media&amp;token=a60da37d-3696-43fa-ad62-f7ad2ca967d3" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

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** – Enables 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.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FYtU6fAmlRE7Arvzma203%2F4g-vlan-mode-oe-add-others-tab.png?alt=media&amp;token=8809e332-3d9b-4e95-87cb-6123196f0d78" alt=""><figcaption></figcaption></figure></div>
{% 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.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> 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.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> Some commercially available UE have ICMP ping responses disabled. In such cases, CPE monitoring for the UE fails. In the subscriber details, the <strong>Last Reported Time</strong> parameter is displayed as blank \–.</p></div>
* **AGW User Configuration** – (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** –&#x20;
    1. Click to add SSH keys for *agw\_user*.

       The **Add SSH Key** dialog box is displayed.
    2. Enter the SSH key, then click **Save**.

       You can add a maximum of 10 SSH keys.
  * **View All Keys** –&#x20;
    1. Click to view existing SSH keys.

       The list of SSH keys is displayed.
    2. You have the option to view details, edit, and delete SSH keys.
  * **Change Password** –&#x20;
    1. Click to change the *agw\_user* password.

       The **Change Password** dialog box is displayed.
    2. Enter the following details:
       * **Password** – (Required) Password for *agw\_user*.
       * **Confirm Password** – (Required) Reenter the password to confirm.
* **Backhaul Speedtest** — Prioritized list of iPerf-compatible speedtest servers used to measure backhaul link performance. Four servers are pre-configured. The following details are displayed:

  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FvB8rOrZHGtkQy8Sf3bgQ%2Ficon-drag-handle.png?alt=media\&token=e23d66e0-e3a6-4080-91cd-1331dd53b393) (Drag Handle) icon – Drag-and-drop to reorder speedtest server priority.
  * **Priority** — The order in which servers are tried (1 being highest).
  * **URL** — The speedtest server's hostname/URL.
  * **Start Port** — The beginning of the port range used for the test.
  * **End Port** — The end of the port range.
  * **Actions** — Allows deleting a server entry.

  Add and manage Backhaul Speedtest servers.

  * **Add Server** —&#x20;
    1. Click to add a speedtest server.\
       A new blank row is added.
    2. Enter the following details:
       * **Server Hostname/URL** — The speedtest server's hostname/URL.
       * **Start Port** — The beginning of the port range used for the test.
       * **End Port** — The end of the port range.
       * Drag and drop to set the server's priority.
  * Delete Server — To delete a server, in the **Actions** column, click the corresponding ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F1oTYgD6vbQgPuwfZ3d3G%2Fspeedtest-server-delete-icon.png?alt=media\&token=7c0fe181-0dbc-4908-bd26-c93ab0ed914b) (delete) icon.
    {% 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's in a 4G 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 the respective sections:

* [*Add Onyx Edge to 4G Network in NAT Mode*](#add-onyx-edge-to-4g-network-in-nat-mode)
* [*Add Onyx Edge to 4G Network in VLAN Mode*](#add-onyx-edge-to-4g-network-in-vlan-mode)
  {% 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 *Onyx Edge On-Premises Installation and Operations Guide*.

To configure the Onyx Edge *agw\_user* account on an operational Onyx Edge:

{% 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 %}

{% 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**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FsFgKbSGMm7g6K8el9qln%2Fimage.png?alt=media&amp;token=763be2cb-3cc5-4079-a006-02b61d74e6ed" alt="" width="110"><figcaption></figcaption></figure>

The **Edit Onyx Edge (*****\<onyx edge name>*****)** page is displayed.
{% endstep %}

{% step %}
Click the **Others** tab and move to the **AGW User Configuration** section.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FbU0bZ3JFEVBT6lprgeLR%2Fimage.png?alt=media&amp;token=64363f6b-55bb-4489-ad34-2b59f1d673d6" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To add an SSH key:

1. Click **Add Keys**.

   The **Add SSH Key** dialog box is displayed.

   <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FVnrBlogSF42DPqpWiQXu%2Fimage.png?alt=media&amp;token=a0de6739-ed41-457d-886d-f3df0fd6b0f3" alt=""><figcaption></figcaption></figure>
2. Enter the SSH key, then click **Save**.

   The SSH key is added.

   You can add a maximum of 10 SSH keys.
3. 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.
4. To change the password for *agw\_user*, click **Change Password**.

   The **Change Password** dialog box is displayed.

   1. **Password** – (Required) Password for *agw\_user*.
   2. **Confirm Password** – (Required) Reenter the password to confirm.

   The password must be at least eight characters in length.

   <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fwq1KKadOyA6zKlbixK1K%2Fimage.png?alt=media&amp;token=b968ccf6-ee32-48e1-91ee-a8ea54ddbc78" alt=""><figcaption></figcaption></figure>

{% 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**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FakL7iZjCXCMLGyQxy471%2Fimage.png?alt=media&amp;token=c9b8d1d8-e4c9-4575-bba8-0e093be5c823" alt="" width="110"><figcaption></figcaption></figure>

A confirmation dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FWgrjhWrXoKCvPt14N6S1%2Fimage.png?alt=media&amp;token=c2a6ebc4-84f0-47d0-9c5e-87b19d9fd320" alt="" width="419"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To confirm, click **Yes**.
{% endstep %}
{% endstepper %}


# Manage Onyx Edge High Availability

The MME, a crucial component of the Onyx Core Network, plays a key role in the handling of control plane traffic, including signaling messages related to call setup, handovers, and session management. Enabling MME/Onyx Edge High Availability (HA) ensures uninterrupted and reliable MME services, even in the face of failures or disruptions.

MME/Onyx Edge Pooling is the technique used to achieve HA for the MME/Onyx Edge in a network. It involves grouping the Onyx Edge in a network into a pool and associating APs with the pool. All Onyx Edge in a pool have equal capacity and function in Active-Active mode. If an Onyx Edge in a pool experiences failures, the UE registered on that Onyx Edge are moved to the other Onyx Edge in the pool. If the Onyx Edge designated as the Primary "Automatic Configuration Server" (ACS) fails, a Standby ACS Onyx Edge takes over the Primary ACS responsibility. This helps minimize service disruptions due to failures, making the network more reliable.

{% hint style="info" %}
**NOTE:** Onyx Edge HA is supported only in 4G networks.
{% endhint %}

{% hint style="info" %}
**NOTE:** Onyx Edge HA is supported only with Onyx Edge On-Premises.
{% endhint %}

{% hint style="info" %}
**NOTE:** Each pool can have a maximum of three Onyx Edge associated with it.
{% endhint %}

{% hint style="info" %}
**NOTE:** Each Onyx Edge can be associated only with one pool at any time.
{% endhint %}

{% hint style="info" %}
**NOTE:** Each AP can be associated only with one pool at any time.
{% endhint %}

{% hint style="info" %}
**NOTE:** IPSec is not supported in conjunction with HA/Onyx Edge pools. IPSec-enabled Onyx Edge and APs must not be associated with an Onyx Edge pool. IPSec must not be enabled on Onyx Edge and APs already associated with a pool.
{% endhint %}

## Onyx Edge Pool Architecture

The following diagram illustrates the Onyx Edge pool architecture.

<p align="center"><strong>Onyx Edge Pool Architecture</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FvgzoHi2LUkTodjR6MvTj%2Fimage.png?alt=media&amp;token=3da49465-dcbc-46d3-8911-c8e83d4f5e26" alt="" width="563"><figcaption></figcaption></figure>

* The MME/Onyx Edge pool is the overarching entity that groups together the MME/Onyx Edge.
* MME/Onyx Edge 1, MME/Onyx Edge 2, and MME/Onyx Edge 3 represent the individual MME/Onyx Edge within the pool. The Onyx Edge share the same pool identity and configuration. The MME/Onyx Edge 1 is configured as the Primary ACS and manages AP management traffic (AP configuration and AP status).

  Automatic Configuration Server (ACS) Redundancy: The Onyx Edge with the highest ACS priority in a pool acts as the Primary ACS Onyx Edge within the pool. The Primary ACS Onyx Edge anchors the ACS endpoint address configured in the pool and manages AP management traffic to pass on configuration to and read status from the APs. If the Primary ACS Onyx Edge fails, a Standby ACS Onyx Edge takes over the Primary ACS responsibility ensuring continuity of service thereby further improving the network's reliability.
* AP1, AP2, through AP*n* represent the APs associated with the pool. Each of the AP associated with a pool can talk to any operational MME/Onyx Edge within the pool. The APs direct UE traffic to the Onyx Edge in the pool based on the current load on each Onyx Edge. This balancing helps ensure no single Onyx Edge becomes overloaded while others remain underutilized.

In the Onyx Edge pool architecture:

{% stepper %}
{% step %}
An Onyx Edge pool groups the Onyx Edge and has APs associated with it.
{% endstep %}

{% step %}
The APs associated with a pool direct UE traffic to the Onyx Edge in the pool based on the current load on each Onyx Edge.

<p align="center"><strong>Onyx Edge Pool Load Balancing</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FpATaozz8AyvPTgvRpe0l%2Fimage.png?alt=media&amp;token=78eda7e3-a29d-492d-a37d-407a00bbabcd" alt="" width="563"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
If an Onyx Edge in a pool experiences failures, the UE registered on that Onyx Edge are moved to the other Onyx Edge within the pool.

<p align="center"><strong>Onyx Edge Pool High Availability</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FjDtekn5xXe7pSW9aYxqn%2Fimage.png?alt=media&amp;token=480ac66f-30db-4390-b23f-3de8d47c9256" alt="" width="563"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
The Onyx Edge with the highest ACS priority acts as the Primary ACS within the pool. The Primary ACS Onyx Edge manages the AP management traffic.

<p align="center"><strong>Onyx Edge Pool ACS Redundancy</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQSFh6fOS1cT8mwE2g1qb%2Fimage.png?alt=media&amp;token=b5753894-b522-47d2-9b95-8c30271dc332" alt="" width="563"><figcaption></figcaption></figure>

If the Primary ACS Onyx Edge fails, an operational Standby ACS Onyx Edge with the highest priority takes over the Primary ACS responsibility.

<p align="center"><strong>Onyx Edge Pool ACS Redundancy – Primary ACS Switch</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FuRetLCZe0JsOCYPAlfK0%2Fimage.png?alt=media&amp;token=1370a7b0-d9d8-4d4c-a773-3c8ac6721d14" alt="" width="563"><figcaption></figcaption></figure>

This basic architecture forms the foundation for MME/Onyx Edge Pooling, providing redundancy and reliability in core network functions.
{% endstep %}
{% endstepper %}

## Networking Requirements

This section describes the networking configurations recommended for the Onyx Edge associated with an Onyx Edge pool.

* When deploying multiple Onyx Edge for HA, you must allocate an additional IP address within the same S1 subnet as those assigned to each individual Onyx Edge. This extra IP address serves as the "Virtual IP" and is used to centrally manage APs in the Onyx Edge pool as a unified entity from the Onyx Orchestrator.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FeDOMfUOtzA1hliCgXLKO%2Fimage.png?alt=media&amp;token=1f00c4fd-d61d-4cae-9640-590e4f11a9a4" alt="" width="563"><figcaption></figcaption></figure>

* It is also required to avoid deploying the Onyx Edge in "S1 same as SGi" mode. If the network layout follows the "flat networking model", a separate RAN network will be required to run the eth1/S1 network separate from eth0/SGi interfaces. This can be accomplished by segregating the S1/RAN network traffic on its own unique VLAN to maintain traffic separation.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FkB9bGeotm34of40BJnwF%2Fimage.png?alt=media&amp;token=73b85a8f-ca96-4b34-b38b-7761c6783ee0" alt="" width="422"><figcaption></figcaption></figure>

* **S1 Interface IP** – The subnet must be the same across all the Onyx Edge in a pool. The S1 interface should be static and different and should be in the same subnet as the TR069 HA IP. Recommended configuration: 10.0.2.1, 10.0.2.2, 10.0.2.3.

  It is not possible to change the S1 subnet of the Onyx Edge in a pool or the VIP in the pool configuration. You can only edit them to a different IP address. If the subnet must be changed, then the SOP requires:

  1. Disassociating all the Onyx Edge from the pool.
  2. Editing the VIP in the pool configuration.
  3. Editing the S1 subnet (use the same subnet for all Onyx Edge).
  4. Associating the Onyx Edge back with the pool.
* **Access Point DHCP Service** – The Start IP address must be a host inside the S1 IP/Subnet and must be the same across all the Onyx Edge in a pool. Recommended configuration: **Start IP**:10.0.2.240, **No. of IP**: 15.
* **Onyx Edge Tunnel Anchoring Subnet** – The Onyx Edge Tunnel Anchoring subnet must be different across all the Onyx Edge in a pool. Recommended configuration: 192.168.133.0/28, 192.168.151.0/28, 192.168.152.0/28.
* **Mesh Node Assignment Subnet** – The Mesh Node Assignment subnet must be the same across all the Onyx Edge in a pool.
* **Mesh UE IP Subnet** – Applicable for VLAN mode. The Mesh UE IP subnet must be different across all the Onyx Edge in a pool. Recommended configuration: 192.168.129.0/24, 192.168.160.0/24, 192.168.161.0/24.
* **Per APN Per Onyx Edge Config** – Applicable for VLAN mode. Except for the **Local IP** (which must be different across all Onyx Edge and from the same subnet), all the other parameters (**Default GW IP**, **VLAN ID**, and **Default GW MAC**) must be the same across all the Onyx Edge in a pool.

## Manage Onyx Edge Pools

This section describes how to create and manage Onyx Edge pools.

{% hint style="info" %}
**NOTE:** You can create and manage Onyx Edge pools only if you are a GXC Administrator, Customer Administrator, or an Administrator.
{% endhint %}

**Workflow to create and configure Onyx Edge pools:**

<p align="center"><strong>Onyx Edge Pool Configuration Workflow</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FOaZRwTfHIPQqCxtIgQfR%2Fimage.png?alt=media&amp;token=e6a2ca11-3145-46a5-b590-b1cda22f6430" alt="" width="401"><figcaption></figcaption></figure>

{% stepper %}
{% step %}
Create the Onyx Edge pool.

See [*Create Onyx Edge Pools*](#create-onyx-edge-pools).
{% endstep %}

{% step %}
If the Onyx Edge that you want to associate with the pool already exist:

1. Remove any direct Onyx Edge – AP associations.

   See [*Remove Direct Onyx Edge – AP Associations*](#remove-direct-onyx-edge-ap-associations).
2. Update Onyx Edge configurations for pool requirements.

   See [*Networking Requirements*](#networking-requirements).
   {% endstep %}

{% step %}
Add any new Onyx Edge to associate with the pool.

See [*Add Onyx Edge*](#add-onyx-edge).
{% endstep %}

{% step %}
Associate the Onyx Edge with the pool.

See [*Associate or Disassociate Onyx Edge with Pools*](#associate-or-disassociate-onyx-edge-with-pools).
{% endstep %}

{% step %}
Set the ACS priorities for the Onyx Edge in the pool.

See [*Edit Onyx Edge Pools*](#edit-onyx-edge-pools).
{% endstep %}

{% step %}
Add any new APs to associate with the pool.

See [*Add APs*](#add-aps).
{% endstep %}

{% step %}
Associate the APs with the pool.

See [*Edit Onyx Edge Pools*](#edit-onyx-edge-pools).
{% endstep %}
{% endstepper %}

### View Onyx Edge Pool Details

This section describes how to view Onyx Edge pool details.

#### View the Dashboard View of All Onyx Edge Pools

{% 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 display of all Onyx Edge pools in the network:**

{% stepper %}
{% step %}
In the navigation pane, click **Dashboard**.

The Dashboard page is displayed.
{% endstep %}

{% step %}
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's HA connectivity status:

* <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FGPLWZAh6yPFtVfNY5zCv%2Fimage.png?alt=media&amp;token=f40ee4e9-4c15-44f2-a4f1-caebac0d15e2" alt="" data-size="line"> Green – One Onyx Edge is functioning as the Primary ACS, and the others as Standby ACS.
* <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FfGgEE4I3IBfqqjE5R2iR%2Fimage.png?alt=media&amp;token=6a08ece3-3d83-4d70-8bd0-0c7338927700" alt="" data-size="line"> Amber – One Onyx Edge is functioning as the Primary ACS, but one or more of the other Onyx Edge are non-functional.
* <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fmm9fuz3OOwggYtmZ9x0p%2Fimage.png?alt=media&amp;token=cd3b6883-58d9-4926-9ed6-106d18dff8b7" alt="" data-size="line"> Red – All Onyx Edge are non-functional, or their status is not available.
* <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FaRnmgEPv1d15T5EGzLIG%2Fimage.png?alt=media&amp;token=a1de4acd-d5fd-42d7-be82-893aa1da68a5" alt="" data-size="line"> 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.
{% endstep %}

{% step %}
To view a pool's details, click its name.

The ***\<pool name>*** page displays the Onyx Edge pool's details.
{% endstep %}
{% endstepper %}

#### View Summary Details of all Onyx Edge Pools in the Network

**To view the summary details of all Onyx Edge pools in the 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. At the bottom of the page, the **Onyx Edge Pool (n)** panel lists the existing pools.

* **Onyx Edge Pool (n)**
  * Status – The Onyx Edge pool's HA connectivity status.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FBMUg6HR7ktQ2SI1wThgO%2Fimage.png?alt=media&amp;token=74f5cd12-ac96-49ad-bcd8-7c8d48983746" alt="" data-size="line"> Green – One Onyx Edge is functioning as the Primary ACS, and the others as Standby ACS.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FnKT4vMBNFs1jWcTfsdCT%2Fimage.png?alt=media&amp;token=41e528f4-7feb-4184-a5cc-c67c2453841c" alt="" data-size="line"> Amber – One Onyx Edge is functioning as the Primary ACS, but one or more of the other Onyx Edge are non-functional.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FsSLEDIm76NUU9IT7V24S%2Fimage.png?alt=media&amp;token=021dd687-a00d-4d65-bc1a-23cdeba729a8" alt="" data-size="line"> Red – All Onyx Edge are non-functional, or their status is not available.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FEvjOpnZ3zCsxm1ENfcIL%2Fimage.png?alt=media&amp;token=30407f7d-4342-46bb-ac8a-dbb26de7b4e1" alt="" data-size="line"> 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.
  * **Name** – The Onyx Edge pool's name.
  * **HA IP Address** – The virtual management IP address used to anchor TR069 endpoint in the Primary ACS Onyx Edge.
  * **Associated Onyx Edge** – The number of Onyx Edge associated with the pool.
  * **Associated Access Points** – The number of APs 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

**To view an Onyx Edge pool's details:**

{% 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. At the bottom of the page, the **Onyx Edge Pool (n)** panel lists the existing pools.
{% endstep %}

{% step %}
To view the details of a particular pool, click its name.

The \<pool name> page displays the pool's details.

* **Pool Details**
  * **Name** – The pool's name.
  * **ID** – The pool's ID. This ID is system-generated.
  * **MME Group ID** – Uniquely identifies the pool that the MME/Onyx Edge is associated with.
  * **HA IP Address** – The virtual management IP address.
  * **HA Connectivity Status** – The Onyx Edge pool's HA connectivity status.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FyHNiaZn3y3kaPfQ0aiKv%2Fimage.png?alt=media&amp;token=7d92d292-7730-413c-baf2-c663037be66c" alt="" data-size="line"> Green – One Onyx Edge is functioning as the Primary ACS, and the others as Standby ACS.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F7XR3RlykDOWEs83Lxb2S%2Fimage.png?alt=media&amp;token=6da5c059-df4e-49dc-bd32-c85c424f6696" alt="" data-size="line"> Amber – One Onyx Edge is functioning as the Primary ACS, but one or more of the other Onyx Edge are non-functional.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FklCbUTjUfPvitdob3qtq%2Fimage.png?alt=media&amp;token=314adc60-ca23-4752-83d2-ce6218870d7e" alt="" data-size="line"> Red – All Onyx Edge are non-functional, or their status is not available.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FBDNLYzELvOZlLl7H30Yc%2Fimage.png?alt=media&amp;token=42dda26c-f69e-49b1-9c47-be09c0008edf" alt="" data-size="line"> 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.
    * **Priority** – The Onyx Edge's ACS priority within the pool. The ACS priority indicates the probability of an Onyx Edge functioning as the Primary ACS relative to the other Onyx Edge in the pool. Priority 1 is the highest priority and 3 the lowest. If the Primary ACS Onyx Edge fails, an operational Standby ACS Onyx Edge with the highest priority will take over as the Primary.
    * **Name** – The Onyx Edge's name.
    * **Access Point** – The APs associated with the Onyx Edge.
    * **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.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FWH3C4cFRphD6BY9Vd9bl%2Fimage.png?alt=media&amp;token=a4793403-a136-47c2-bb56-fe8aed2bebd5" alt="" data-size="line"> Green – The Onyx Edge has checked in with the Onyx Portal in the last five minutes.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FiUDFvkIiD4tVSnsTZ9ya%2Fimage.png?alt=media&amp;token=cae6ec3c-7eae-4ed7-b658-41f187b9f17d" alt="" data-size="line"> Red – The Onyx Edge has not checked in with the Onyx Portal in the last five minutes.
    * **ACS** – Indicates the Onyx Edge's current ACS status.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FxKXOlyT2bUxpYW5eDaGN%2Fimage.png?alt=media&amp;token=fee562d6-fdbc-4bdd-bce4-14b5c9aaf44f" alt="" data-size="line"> Green – The Onyx Edge holds the Virtual IP, and it manages and provides AP configuration to the APs.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FE7IHWhozpO1Pc0sYqQfg%2Fimage.png?alt=media&amp;token=c07ff6dd-d6a5-446d-bfe8-9da883323709" alt="" data-size="line"> Amber – The Onyx Edge's ACS status is not available.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5gxwyomg2T3Xv9WrLgWO%2Fimage.png?alt=media&amp;token=4d7fef63-ebc2-4918-a1a8-5405130c845f" alt="" data-size="line"> Red – The Onyx Edge is configured with the highest ACS priority (priority 1) but is not the Primary ACS.
      * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fn0ki77DtmOlxhiAnb3sJ%2Fimage.png?alt=media\&token=fdfa5877-a87b-44c1-bc22-415520d55c96) Grey – The Onyx Edge is configured with a lower ACS priority and is not the Primary ACS as expected.
    * **Interface Status** – Indicates the SGi and RAN (S1) interface connection status.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FcibBhLWrb6ZDoNzclYIp%2Fimage.png?alt=media&amp;token=1331c877-f48c-4950-a102-7c3782298f7a" alt="" data-size="line"> Green – All APs are MME-connected to the Onyx Edge, the SGi interface is up and has IP, and the SGi link is active (periodic ICMP checks every five minutes).
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fvksao8K5p8VEMYyHDD5W%2Fimage.png?alt=media&amp;token=3b743a44-5b75-4af6-9f65-534128a493a8" alt="" data-size="line"> Amber – At least one AP is MME-connected, but some are not, the SGi interface is UP and has IP (SGi link is active).
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fww8v3PI32qorPDIy1gOs%2Fimage.png?alt=media&amp;token=c066f89b-12bf-487e-aee0-8760181ea07b" alt="" data-size="line"> Red – 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).
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FgZFEOxhGwEkJN1VXDkpf%2Fimage.png?alt=media&amp;token=975e6e5b-81e7-49fe-b9ba-2eabd3995a52" alt="" data-size="line"> Grey – The Onyx Edge is offline, or data is not available.
  * **Associated Access Points** – The APs associated with the pool.
    * **Name** – The AP's name.
    * **B/W 1 (MHz)** – Cell 1's bandwidth in MHz.
    * **Freq 1 (MHz)** – Cell 1's frequency cell 1 in MHz.
    * **Cell ID 1** – Cell 1's cell ID.
    * **PCI 1** – Cell 1's Physical Cell ID (PCI). The PCI is used for cell identity during the cell selection procedure and is used by UE to decode physical layer data being transmitted by the AP.
    * **Pwr 1 (dBm)** – Cell 1's power in dBm.
    * **Online** – Indicates the AP's online status, which is determined by its reachability from the Onyx Portal.

      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FlRTGEACjh6Esfw47PJxx%2Fimage.png?alt=media&amp;token=8d79e41d-80a4-46d3-bf94-d419598a3af8" alt="" data-size="line"> Green – The AP has checked in with the Onyx Portal in the last five minutes.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FfMxenIVrnWaMqMRZni3h%2Fimage.png?alt=media&amp;token=c694e5db-e63d-43ae-9a81-216557d66934" alt="" data-size="line"> Red – The AP has not checked in with the Onyx Portal in the last five minutes. Or, the time reported is older than five minutes.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FyWNj2MrgVJncvdQlMEHp%2Fimage.png?alt=media&amp;token=a2d0621c-7c73-4e7f-b7c4-dd073be58ee6" alt="" data-size="line"> Grey – The associated Onyx Edge is offline.

      To view the last check-in timestamp, hover your cursor over the "Online Status" icon.
    * **Interface Status** – Indicates the AP's interface status.

      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FEhzXw8gNNiaSCCpq11pG%2Fimage.png?alt=media&amp;token=718d7540-f6b2-443b-bfdc-53f67184e6f1" alt="" data-size="line"> Green – The AP is MME-connected.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FyYHtyEtLpqrAYnvrj6kW%2Fimage.png?alt=media&amp;token=d01ceea4-bbb9-4b94-941b-78f2c6bd0d46" alt="" data-size="line"> Red – The AP is MME-disconnected.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FWCK2eKKTa9H0ASntmi6B%2Fimage.png?alt=media&amp;token=fe984ec7-d44b-497e-97fb-e37a477813fd" alt="" data-size="line"> Grey – The AP is offline.

      To view the MME status and the Onyx Edge that the AP is connected to, hover your cursor over the "Interface Status" icon.

To include or exclude additional details from the list, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F9ODVUgGWnsHy35x5thCH%2Fimage.png?alt=media&amp;token=47a970db-c851-4187-83dd-0f92828a3aa7" alt="" data-size="line"> (additional details) and select or clear from the following additional parameters:

* **IP Address** – The AP's IP address.
* **Model** – The AP equipment's model.
* **Software Version** – The AP's software version.
* **Up Time** – The duration for which the AP has been continuously operational without any downtime or interruptions.
* **FSM State** – The Finite State Machine (FSM) state.
* **GPS Latitude** – The AP equipment's GPS latitude coordinate.
* **GPS Longitude** – The AP equipment's GPS longitude coordinate.
* **Access Mode** – The UE access mode. By default, **Open Access**—authorized UE will have access to any cell in the network.
  {% 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:** An AP can only be associated with one pool at a time.
{% endhint %}

**To create an Onyx Edge pool:**

{% 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. At the bottom of the page, the **Onyx Edge Pool (n)** panel lists the existing pools.
{% endstep %}

{% step %}
In the **Onyx Edge Pool** panel, click **Add Pool**.

The **Create Onyx Edge Pool** page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FICkf0FjA8KpJecJyidj0%2Fimage.png?alt=media&amp;token=e9f77584-bc80-46b9-a881-b22574679b75" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details:

* **Name** – (Required) The pool's name. The Onyx Portal automatically populates the pool name, which you can edit if required. The pool name must be unique within the network and must be an alphanumeric string of 1–64 characters.
* **HA IP Address** – (Required) The TR069 anchoring endpoint address.

{% hint style="info" %}
**NOTE:** The HA IP address must be in the same subnet as the S1 interface of the Onyx Edge to be associated with this pool.
{% endhint %}

* **Associated Access Points** – To associate an AP with this pool, select the corresponding checkbox. To simultaneously associate all available APs with this pool, select the **Select All** checkbox.

  To disassociate an AP currently associated with the pool, clear the corresponding checkbox. To simultaneously disassociate all APs currently associated with the pool, click the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQDQBiwivHt9HPjHZQHLx%2Fimage.png?alt=media&amp;token=b7080f7c-908e-43df-9e8f-6ed82b865439" alt="" data-size="line"> icon. A confirmation dialog box is displayed. To confirm, click **Yes**.

{% hint style="info" %}
**NOTE:** An AP can only be associated with one Onyx Edge pool at any time. Only APs that are not associated with any Onyx Edge pool are available for association.
{% endhint %}

{% hint style="info" %}
**NOTE:** IPSec is not supported in conjunction with HA/Onyx Edge pools. IPSec-enabled APs must not be associated with an Onyx Edge pool.
{% endhint %}
{% endstep %}

{% step %}
Click **Save Onyx Edge Pool**.

The pool is created and is listed in the **Equipment** > **Onyx Edge** tab > **Onyx Edge Pool (n)** panel.
{% endstep %}

{% step %}
Associate the Onyx Edge with this pool. For more information, see [*Associate or Disassociate Onyx Edge with Pools*](#associate-or-disassociate-onyx-edge-with-pools).
{% endstep %}

{% step %}
Set the ACS priority order of the Onyx Edge within the pool, for which you must edit the pool's details. For more information, see [*Edit Onyx Edge Pools*](#edit-onyx-edge-pools).
{% endstep %}
{% endstepper %}

### 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 %}

**To edit an Onyx Edge pool:**

{% 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. At the bottom of the page, the **Onyx Edge Pool** panel lists the existing pools.
{% endstep %}

{% step %}
For the pool that you want to edit, in the **Onyx Edge Pool (n)** panel > **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQI04biOMQs4pweG4O0Wk%2Fimage.png?alt=media&amp;token=806c25c7-c7fd-43ac-a419-3cd34d29a542" alt="" width="110"><figcaption></figcaption></figure>

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) The TR069 anchoring endpoint address.

{% hint style="info" %}
**NOTE:** The HA IP address must be in the same subnet as the S1 interface of the Onyx Edge associated with this pool.
{% endhint %}

* **Associated Access Points** – To associate an AP with this pool, select the corresponding checkbox. To simultaneously associate all available APs with this pool, select the **Select All** checkbox.

  To disassociate an AP currently associated with this pool, clear the corresponding checkbox. To simultaneously disassociate all APs currently associated with this pool, click the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FC0MOf6CRGLOuglQuW5ON%2Fimage.png?alt=media&amp;token=b0feb5b9-88f1-4b91-90c7-d7fbc0a5315f" alt="" data-size="line"> icon. A confirmation dialog box is displayed. To confirm, click **Yes**.

{% hint style="info" %}
**NOTE:** IPSec is not supported in conjunction with HA/Onyx Edge pools. IPSec-enabled APs must not be associated with an Onyx Edge pool.
{% endhint %}
{% endstep %}

{% step %}
To save your edits, click **Save Onyx Edge Pool**.
{% endstep %}

{% step %}
Associate/disassociate Onyx Edge with the pool. For more information, see [*Associate or Disassociate Onyx Edge with Pools*](#associate-or-disassociate-onyx-edge-with-pools).
{% endstep %}

{% step %}
Set the ACS priority order of the Onyx Edge within the pool.

**Onyx Edge Priority** – The Onyx Edge's ACS priority within the pool. The ACS priority indicates the probability of an Onyx Edge functioning as the Primary ACS relative to the other Onyx Edge in the pool. Priority 1 is the highest priority and 3 the lowest. If the Primary ACS Onyx Edge fails, an operational Standby ACS Onyx Edge with the current highest priority will take over as the Primary.

1. To change the ACS priority of an Onyx Edge in the pool, drag and drop the corresponding row up or down as required.
2. To save your changes, click **Save Priority**.
   {% 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 an Onyx Edge 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*](#associate-or-disassociate-onyx-edge-with-pools). For information, on disassociating APs from a pool, see [*Edit Onyx Edge Pools*](#edit-onyx-edge-pools).
{% endhint %}

**To delete an Onyx Edge pool:**

{% 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. At the bottom of the page, the **Onyx Edge Pool** panel lists the configured Onyx Edge pools.
{% endstep %}

{% step %}
For the Onyx Edge pool that you want to delete, in the **Onyx Edge Pool (n)** panel > **Actions** column, click the corresponding ⋮ (options) icon, then click **Delete**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FP599hjXsd5xfbbYS6l6z%2Fimage.png?alt=media&amp;token=7a0f5f54-b28a-4ffa-ba2e-4ccb67b2af3c" alt="" width="110"><figcaption></figcaption></figure>

A confirmation dialog box is displayed.
{% endstep %}

{% step %}
To confirm, click **Yes**.
{% endstep %}
{% endstepper %}

### Remove Direct Onyx Edge – AP Associations

{% hint style="info" %}
**NOTE:** You can disassociate APs associated with Onyx Edge only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

Before you associate an existing Onyx Edge (added pre-1.4.0 release) with a pool, you must disassociate any APs that are directly associated with the Onyx Edge.

**To disassociate any APs directly associated with 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 edit, in the **Onyx Edge (n)** panel > **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F7TXeT29Eq4wgp2bOTvov%2Fimage.png?alt=media&amp;token=eb73a5af-0f3e-4e60-8281-25b6a2c074b0" alt="" width="110"><figcaption></figcaption></figure>

The **Edit Onyx Edge (*****\<onyx edge name>*****)** page displays the Onyx Edge's details.
{% endstep %}

{% step %}
In the **RAN** tab > **Associated Access Point** section, click the **Associated Access Point** dropdown and clear any selected APs.
{% endstep %}

{% step %}
To save your edits, in the upper-right corner of the page, click **Save Onyx Edge**.
{% endstep %}
{% endstepper %}

### Associate or Disassociate Onyx Edge with Pools

{% hint style="info" %}
**NOTE:** You can associate and disassociate Onyx Edge with a pool only if you are a GXC Administrator, Customer Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** Onyx Edge HA is supported only for Onyx Edge On-Premises AGWs.
{% 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 %}

{% hint style="info" %}
**NOTE:** Before associating an Onyx Edge with a pool, ensure that there are no APs directly associated with it. Before associating the Onyx Edge with a pool, remove any existing AP associations. The Orchestrator manages the AP associations with the Onyx Edge.
{% endhint %}

{% hint style="info" %}
**NOTE:** After associating an Onyx Edge with a pool, you must not directly associate APs with it.
{% endhint %}

{% hint style="info" %}
**NOTE:** When you dissociate an Onyx Edge from a pool, the Onyx Edge is also dissociated from the APs associated with the pool.
{% endhint %}

{% hint style="info" %}
**NOTE:** IPSec is not supported in conjunction with HA/Onyx Edge pools. IPSec-enabled Onyx Edge must not be associated with an Onyx Edge pool.
{% endhint %}

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.

**To associate or disassociate an existing Onyx Edge with a pool:**

{% 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 associate with a pool, in the **Onyx Edge (n)** panel > **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F67ILfOHYIorQ6jWP1E9c%2Fimage.png?alt=media&amp;token=8b3d813c-b6c4-405c-bd68-b2544de170df" alt="" width="110"><figcaption></figcaption></figure>

{% hint style="info" %}
**NOTE:** Onyx Edge HA is supported only for Onyx Edge On-Premises.
{% endhint %}

The **Edit Onyx Edge (*****\<onyx edge name>*****)** 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 %}


# Manage Access Points

The AP, in 4G networks the eNodeB and in 5G networks the gNodeB function, handles the air interface for UE. For core services, each AP connects to an Onyx Edge. For getting grants from SAS, a different kind of resource called a CBSD must be created. Each CBSD is associated with a single AP. CBSDs do not directly contact the SAS; Domain Proxy is used to communicate with SAS, it sends requests to SAS on behalf of CBSDs.

## Carrier Modes

The 4G Onyx solution supports the Single Carrier (SC), Dual Carrier (DC), and Carrier Aggregation (CA) carrier modes.

{% hint style="info" %}
**NOTE:** The DC and CA modes are not supported on Mesh APs. This is because the CA and DC modes require four antenna ports (filters), while the Mesh Node only supports two.
{% endhint %}

* Single Carrier (SC) Mode – In SC mode, APs use a single carrier frequency, making it suitable for smaller networks or areas with lower traffic where bandwidth needs can be met with one frequency. SC mode is often used for basic services with lower data rates. While it performs well in environments with limited spectrum, it may become less effective as data demands grow. APs in SC mode use a single antenna and support up to 96 active UE per AP.

* Dual Carrier (DC) Mode – In DC mode, APs use two carrier frequencies simultaneously, effectively doubling the available bandwidth. Compared to the SC mode, DC mode provides the same data rates but allows for increased network capacity by effectively doubling the number of connected UE. DC mode is particularly advantageous for covering two distinct areas from a single AP, especially when the required throughput is less than that of a single channel. APs in DC mode use two antennas and support up to 96 + 96 active UE per carrier sector, with a total aggregate UE capacity of 192 UE per AP.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> DC handovers are not supported in this release.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> For DC mode, the APs must be updated with the "FAP010 Dual Carrier Function" license.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The DC mode is not supported with Mesh APs.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> If APs running software version BaiBLQ_3.1.14 are configured for DC mode, to ensure seamless handovers between an AP's cells, GXC Technical Support must remotely log on to DC APs and run an internal command. Please contact GXC Technical Support to fulfill this requirement.</p></div>

* Carrier Aggregation (CA) Mode – In CA mode, APs can combine up to two component carriers (frequencies from the same or different bands) to increase throughput capacity and peak data rates. This mode enhances spectrum efficiency and significantly improves network performance, supporting high-speed data for bandwidth-intensive applications. CA mode is ideal for scenarios requiring peak data rates that exceed the capacity of a single carrier. It is better suited for use cases with lower device density but higher data throughput requirements, effectively doubling the data capacity. APs in CA mode use a single antenna and can support up to 96 active UE per AP.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> For CA mode, the APs must be updated with the "FAP009 Carrier Aggregation Function" license.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> For CA mode, the UE must also support CA.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The CA mode is not supported with Mesh APs.</p></div>

### AP LCI

The carrier mode configurations required in the AP equipment are managed by GXC. For queries, please contact GXC Technical Support.

## Managed Neighbor Relations

Handovers enable uninterrupted service continuity as active UE move between cells. GXC's Onyx solution supports both intra-AP and inter-AP handovers using a "make-before-break" approach, ensuring seamless mobility for mission-critical applications.

Neighbor cell relationships are configured in the Onyx Portal, providing administrators with complete control over handover topology. The system automatically generates an initial all-to-all neighbor configuration that can be customized with prioritized neighbor lists for each cell.

For comprehensive information configuring and managing neighbor relations, see the *4G Onyx Handovers Application Note*.

## Suspended Grant Handling

When a grant is suspended, spectrum inquiry is initiated to seek a new grant. If a new grant is chosen, the suspended grant is relinquished immediately, and a grant request is sent for the chosen new grant.

* In single grant scenarios:
  * If a new grant is available, it is chosen, and the suspended grant is relinquished.
  * If no new grant is available, the suspended grant is maintained.
* In dual grant scenarios:
  * If both grants are suspended:
    * If two new grants are available, they are both chosen, and the suspended grants are relinquished.
    * If only one new grant is available, the new grant is chosen. Depending on the best compatibility with this new grant:
      * The better of the two suspended grants is retained, and the other relinquished. Here, better is the one that is first larger in bandwidth size and then contiguous. Preference order or power of grants is not used here to keep the implementation simple. If both grants are equal with respect to both bandwidth size and contiguity, then the lower frequency is chosen first.
      * If none of the suspended grants is compatible with the new grant, both the suspended grants are relinquished. If no new grants are available, both suspended grants are retained.
  * If only one grant is suspended:

    * If at least two new grants are available:
      * Of the possible choice of grants, the best compatible two are chosen (new grant + the existing authorized grant).
      * The suspended grant is relinquished.
      * If it is not part of the chosen two, the existing authorized grant is also relinquished.
    * If only one new grant is available and it is compatible with the existing authorized grant, it is chosen, and the suspended grant is relinquished.
    * If no such new grant is available, the suspended grant is maintained.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The suspended grant is relinquished immediately, and a grant request is sent for the chosen new grant. However, the SAS may reject the grant request, leaving the CBSD bereft of grants.</p></div>

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> It is expected that the SAS does not include currently issued grants (be it granted, authorized, or suspended) as part of available channels, especially when it is suspended. If the suspended grant is part of the available channel, then the same suspended channel/grant may be chosen. It is also possible that some other channel will be chosen. There is no guarantee that another channel will be tried instead of the suspended grant.</p></div>

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> Since Spectrum Inquiry is now initiated as long as there are suspended grants, to avoid continuous Spectrum Inquiry, a Spectrum Inquiry is sent only five minutes after the previous Spectrum Inquiry.</p></div>

## View AP Details

This section describes how to:

* [*View Summary Details of All APs*](#view-summary-details-of-all-aps)
* [*View an AP's Details*](#view-an-aps-details)

### **View Summary Details of All APs**

**To view the summary details of all APs in a 4G network:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment > Access Points** tab.

The **Equipment** page > **Access Points** tab displays the summary details of all APs configured in the network.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FV0v4Gcph1cSbOzSus5EJ%2Fap-view-summary.png?alt=media&amp;token=8ce5a037-8690-4646-a655-81cb4f29da4f" alt=""><figcaption></figcaption></figure></div>

* AP Service Status — Indicates the AP's service status based on the RF transmission state of its cell(s).

  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FZywebLtTLxXc2MKnAYIb%2Ficon-service-status-green.png?alt=media\&token=d5eb44a4-9aa3-4bcd-a4ce-bdd3dcd2a563) (green) – Indicates the AP's service state is healthy and the neighbor configuration is in sync.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fvu42mnExMXEjCu3VGyhX%2Fimage.png?alt=media\&token=ce6e31d1-542c-4fdc-9839-11ec8f94582e) (amber) — Indicates the AP's service state is Partial or Unwarranted, or the neighbor configuration is not in sync.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FiHEQhrrr113aWHfk3SdF%2Ficon-service-status-red.png?alt=media\&token=4eb60ea7-7e37-498f-ab3f-d76fab2eaa56) (red) – Indicates the AP's service state is Service Down.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FxE2wEaJsMMBETSGqFjCo%2Ficon-service-status-grey.png?alt=media\&token=bce212be-77a4-4d85-8cff-baf4c5a8b451) (grey) – Indicates the AP is offline, the associated Onyx Edge is offline, or the service state is Shutdown.

  Hovering over the Service Status icon displays the following details:

  * **Cell 1 Rf Tx** – Indicates whether RF transmission for Cell 1 is On or Off.
  * **Cell 1 Desired State** – Indicates whether RF transmission for Cell 1 is in the desired state — Yes or No.
  * **Cell 2 Rf Tx** – (Displayed only for dual-cell APs) Indicates whether RF transmission for Cell 2 is On or Off.
  * **Cell 2 Desired State** – (Displayed only for dual-cell APs) Indicates whether RF transmission for Cell 2 is in the desired state — Yes or No.
  * **Neighbor Update Status** – Indicates whether the AP's neighbor configuration is in sync — IN\_SYNC or NOT\_IN\_SYNC.
* **Name** – The AP's name.

  To view the AP equipment's vendor-assigned serial number, hover your cursor over the AP's name.
* **Venue** – The name of the venue hosting the AP.
* **B/W 1 (MHz)** – The bandwidth for cell 1 in MHz.
* **B/W 2 (MHz)** – (Displayed only if DC mode is configured) The bandwidth for cell 2 in MHz.
* **Freq 1 (MHz)** – The frequency for cell 1 in MHz.
* **Freq 2 (MHz)** – (Displayed only if DC mode is configured) The frequency for cell 2 in MHz.
* **Cell ID 1** – The Cell ID for Cell 1.
* **Cell ID 2** – (Displayed only if DC mode is configured) The Cell ID for Cell 2.
* **PCI 1** – The Physical Cell ID (PCI) for cell 1. The PCI is used for cell identity during cell selection procedure, and is used by UE to decode physical layer data being transmitted by the AP.
* **PCI 2** – (Displayed only if DC mode is configured) The PCI for cell 2.
* **Pwr 1 (dBm)** – The power in dBm for cell 1.
* **Pwr 2 (dBm)** – (Displayed only if DC mode is configured) The power for cell 2.
* **Online** – Indicates the AP's online status, which is determined by its reachability from the Onyx Portal.

  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FweFEJNnJsmVdvFDHmRsm%2Ficon-online-status-green.png?alt=media\&token=17b6e737-de82-473d-aad7-2f802028a13f) (green) – Indicates the AP has checked-in with the Onyx Portal in the last five minutes.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FZohzOGtzTsuXHQaFWIBM%2Ficon-online-status-red.png?alt=media\&token=5e81ae71-e1ed-48cb-8380-b83880e79d70) (red) – Indicates the AP has not checked-in with the Onyx Portal in the last five minutes. Or, the time reported is older than five minutes.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FIxHbkQtQQUDqyHP6MdwF%2Ficon-online-status-grey.png?alt=media\&token=591f8d34-d3f3-4023-bf25-7966fd116774) (grey) – Indicates the associated Onyx Edge is offline.

  Hovering your cursor over the "Online Status" icon displays the last check-in timestamp.
* **Interface Status** – Indicates the AP's interface status.

  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F4CBj8TZIUDPsdxCuGkEN%2Ficon-interface-status-green.png?alt=media\&token=1e98e305-88b5-442e-99e6-02ac1745e033) (green) – Indicates the AP is MME-connected.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fu1MOfffYGH62lqdVYQcP%2Ficon-interface-status-red.png?alt=media\&token=798bed1a-7986-4140-8086-8c5ea4d5894a) (red) – Indicates the AP is MME-disconnected.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FfkRNbsj0pI0iT0nB2gsD%2Ficon-interface-status-grey.png?alt=media\&token=bf9874b0-79fb-4371-9065-b742c5079932) (grey) – Indicates the AP is offline.

  Hovering your cursor over the "Interface Status" icon displays the MME status and last synchronized at timestamp.
* **IPSec Status** – Indicates status of IPSec tunnel between the AP and the Onyx Edge and the IPSec certificate’s validity. Note that the certificate status is that of the generated certificate, and not of the one uploaded to the AP.

  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fl3c9H7KZwAPC28d5wdDn%2Ficon-ipsec-status-green.png?alt=media\&token=02c5b8c5-c038-48c9-b9b4-fca11cc145bf) (green) – The AP is IPSec-enabled and the desired number of active IPSec tunnels with the Onyx Edge are up, and the certificate is valid for more than seven days.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FeAbCntt9UDX8T2ZgKrqk%2Ficon-ipsec-status-amber.png?alt=media\&token=de4fcf71-5817-44e8-9f90-4942222778a4) (amber) – The AP is IPSec-enabled and less than the desired number of active IPSec tunnels with the Onyx Edge are up, and/or the certificate is valid for less than seven days.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FIUrYSsOnZzJKMvo31kDV%2Ficon-ipsec-status-red.png?alt=media\&token=689c0bd6-93b3-448d-aa58-a57bf1a56e72) (red) – All the IPSec tunnels with the Onyx Edge are down, and the certificate’s validity has expired.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FxeP3iNaxrysNZQLwhxH6%2Ficon-ipsec-status-grey.png?alt=media\&token=b6ac67c0-6dee-4acb-ba78-441b01f59c8a) (grey) – Any of the following:
    * The AP is offline.
    * The associated Onyx Edge is offline.
    * The AP is IPSec-disabled.
    * IPSec tunnel information is not available.

  Hovering your cursor over the “IPSec Status” icon displays additional details.
* **Sync Status** – Indicates status of the AP's time reference synchronization with the primary clock source.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fl3c9H7KZwAPC28d5wdDn%2Ficon-ipsec-status-green.png?alt=media\&token=02c5b8c5-c038-48c9-b9b4-fca11cc145bf) (green) – AP is in sync with the clock source.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FIUrYSsOnZzJKMvo31kDV%2Ficon-ipsec-status-red.png?alt=media\&token=689c0bd6-93b3-448d-aa58-a57bf1a56e72) (red) – AP is not in sync with the clock source.
  * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FxeP3iNaxrysNZQLwhxH6%2Ficon-ipsec-status-grey.png?alt=media\&token=b6ac67c0-6dee-4acb-ba78-441b01f59c8a) (grey) – Any of the following:
    * The AP is offline.
    * The Onyx Edge associated with the AP is offline.
    * The AP's Sync Mode is set to “Free Running”.
    * The AP’s sync status is not available.
* **Actions** – Options to view details, edit, and delete APs.

To include or exclude additional details from the list, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F1t6W43smlaKTcL93oWyL%2Fimage.png?alt=media&amp;token=5ec847a7-8812-4a19-ab97-c86655e36118" alt="" data-size="line"> (additional details) and select or clear from the following additional parameters:

* **IP Address** – The AP's IP address.
* **Model** – The AP equipment's model.
* **Software Version** – The AP's software version.
* **Up Time** – The duration for which the AP has been continuously operational without any downtime or interruptions.
* **FSM State** – The AP's Finite State Machine (FSM) state indicating the AP's operational state.
* **GPS Latitude** – The AP equipment's GPS latitude coordinate.
* **GPS Longitude** – The AP equipment's GPS longitude coordinate.
* **Access Mode** – The UE access mode. By default, Open Access—authorized UE will have access to any cell in the network.
  {% endstep %}
  {% endstepper %}

### **View an AP's Details**

**To view an AP's details in a 4G network:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** **> Access Point** tab.

The **Equipment** page > **Access Points** tab displays the summary details of all APs configured in the network.
{% endstep %}

{% step %}
To view the details of a particular AP, click its name.

The ***\<AP name>*** page > **Overview** tab displays the AP's details.

* **Access Point Details**:
  * **Name** – The AP's name.
  * **Serial Number** – The AP equipment's vendor-assigned serial number.
  * **Description** – The AP's description.
  * **Venue** – The name of the venue hosting the AP.
  * **Upgrade Status** – Status of the previous AP software upgrade.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The <strong>Upgrade Status</strong> parameter is displayed only during an upgrade and for one hour after the upgrade.</p></div>

    To view details, click the status.

    The **Upgrade Status** dialog box displays the following details:

    * **Description** – Description of the last upgrade's status.
    * **Old Version** – The AP software version before the upgrade.
    * **New Version** – The new AP software version.
    * **Updated At** – Timestamp at which the last upgrade completed.
    * **Start Time** – Timestamp at which the last upgrade started.
  * **Online** – Indicates the AP's online status, which is determined by its reachability from the Onyx Portal.

    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5Fb0HOqHNq9pf5SsFcQN%2Ficon-online-status-green.png?alt=media\&token=a6282035-609d-4036-bdf5-37cf39d00619) (green) – Indicates the AP has checked-in with the Onyx Portal in the last five minutes.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FCMzIjwf3zchkkOMZeohs%2Ficon-online-status-red.png?alt=media\&token=ce1f4660-a0df-487e-bfeb-c33c9d2e52c9) (red) – Indicates the AP has not checked-in with the Onyx Portal in the last five minutes. Or, the time reported is older than five minutes.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FuAjf57FGGngRwtUiOxZE%2Ficon-online-status-grey.png?alt=media\&token=8516b150-50c2-4fd4-8e8c-0e335f1d6374) (grey) – Indicates the associated Onyx Edge is offline.

    Hovering your cursor over the "Online Status" icon displays the last check-in timestamp.
  * **Interface Status** – Indicates the AP's interface status.

    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJMYN4gczD8ad8s5Uexta%2Ficon-interface-status-green.png?alt=media\&token=b0e36f00-9d80-4b9f-a08c-28422e6a6c17) (green) – Indicates the AP is MME-connected.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F9nBHXH5Th3tJ8OnoHiTO%2Ficon-interface-status-red.png?alt=media\&token=cf3cb05a-8139-4a6c-b250-a962d90a0f8c) (red) – Indicates the AP is MME-disconnected.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FzGZiZFjRbilVB4Mch0nV%2Ficon-interface-status-grey.png?alt=media\&token=ea3dc764-ce77-4867-920a-91dbb036dc9f) (grey) – Indicates the AP is offline.

    Hovering your cursor over the "Interface Status" icon displays the MME status and last synchronized at timestamp.
  * **Service Status** – Indicates the AP's service status.

    An AP can have one or two cells depending on the AP's carrier mode.

    Cell states per cell:

    <table><thead><tr><th width="120">RF Tx Desired</th><th width="119.6666259765625">Rf Tx Actual</th><th width="157.6666259765625">“Service Status” Icon</th><th>Cell State</th></tr></thead><tbody><tr><td>On</td><td>On</td><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FWfs3as0Kjkley3LYIfdF%2Ficon-service-status-green.png?alt=media&amp;token=fedb174a-97bf-4976-af92-00004f9b0837" alt=""> (green)</td><td>Healthy</td></tr><tr><td>Off</td><td>Off</td><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKVUfPfGWjuvw5EiXsIlq%2Ficon-service-status-grey.png?alt=media&amp;token=4f682728-404f-4233-bb4c-409b9c5b4b04" alt=""> (grey)</td><td>Shutdown, the AP is offline, or the associated Onyx Edge is offline.</td></tr><tr><td>On</td><td>Off</td><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FO3j3tMTfAKPO4Kf1B7P3%2Ficon-service-status-red.png?alt=media&amp;token=2477b5c9-4201-4d98-aaa1-83f9f028f4c0" alt=""> (red)</td><td>Service Down</td></tr><tr><td>Off</td><td>On</td><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FwRbhytNFPgCZiKgSHsP7%2Ficon-service-status-amber.png?alt=media&amp;token=e2fda2a7-3eac-49f0-bfb5-67e39be7f15f" alt=""> (amber)</td><td>Unwarranted Transmission</td></tr></tbody></table>

    \
    Cell states for two cells:

    <table><thead><tr><th width="128.6666259765625">Cell 1 State</th><th width="127.6666259765625">Cell 2 State</th><th width="157.6666259765625">“Service Status” Icon</th><th>Notes</th></tr></thead><tbody><tr><td>Healthy</td><td>Healthy</td><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FWfs3as0Kjkley3LYIfdF%2Ficon-service-status-green.png?alt=media&amp;token=fedb174a-97bf-4976-af92-00004f9b0837" alt=""> (green)</td><td>Perfectly okay transmission.</td></tr><tr><td>Healthy</td><td>Shutdown</td><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FWfs3as0Kjkley3LYIfdF%2Ficon-service-status-green.png?alt=media&amp;token=fedb174a-97bf-4976-af92-00004f9b0837" alt=""> (green)</td><td>As desired, the service is up.</td></tr><tr><td>Healthy</td><td>Service Down</td><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FwRbhytNFPgCZiKgSHsP7%2Ficon-service-status-amber.png?alt=media&amp;token=e2fda2a7-3eac-49f0-bfb5-67e39be7f15f" alt=""> (amber)</td><td>One cell is down.</td></tr><tr><td>Healthy</td><td>Unwarranted</td><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FwRbhytNFPgCZiKgSHsP7%2Ficon-service-status-amber.png?alt=media&amp;token=e2fda2a7-3eac-49f0-bfb5-67e39be7f15f" alt=""> (amber)</td><td>One cell is not behaving as expected.</td></tr><tr><td>Shutdown</td><td>Healthy</td><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FWfs3as0Kjkley3LYIfdF%2Ficon-service-status-green.png?alt=media&amp;token=fedb174a-97bf-4976-af92-00004f9b0837" alt=""> (green)</td><td>As desired, the service is up.</td></tr><tr><td>Shutdown</td><td>Shutdown</td><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKVUfPfGWjuvw5EiXsIlq%2Ficon-service-status-grey.png?alt=media&amp;token=4f682728-404f-4233-bb4c-409b9c5b4b04" alt=""> (grey)</td><td>User shuts down full service.</td></tr><tr><td>Shutdown</td><td>Service Down</td><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FO3j3tMTfAKPO4Kf1B7P3%2Ficon-service-status-red.png?alt=media&amp;token=2477b5c9-4201-4d98-aaa1-83f9f028f4c0" alt=""> (red)</td><td>User's desire is one cell and that cell’s service is down.</td></tr><tr><td>Shutdown</td><td>Unwarranted</td><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FwRbhytNFPgCZiKgSHsP7%2Ficon-service-status-amber.png?alt=media&amp;token=e2fda2a7-3eac-49f0-bfb5-67e39be7f15f" alt=""> (amber)</td><td>Unwarranted.</td></tr><tr><td>Service Down</td><td>Healthy</td><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FwRbhytNFPgCZiKgSHsP7%2Ficon-service-status-amber.png?alt=media&amp;token=e2fda2a7-3eac-49f0-bfb5-67e39be7f15f" alt=""> (amber)</td><td>One cell is down.</td></tr><tr><td>Service Down</td><td>Shutdown</td><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FO3j3tMTfAKPO4Kf1B7P3%2Ficon-service-status-red.png?alt=media&amp;token=2477b5c9-4201-4d98-aaa1-83f9f028f4c0" alt=""> (red)</td><td>User's desire is one cell and that cell’s service is down.</td></tr><tr><td>Service Down</td><td>Service Down</td><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FO3j3tMTfAKPO4Kf1B7P3%2Ficon-service-status-red.png?alt=media&amp;token=2477b5c9-4201-4d98-aaa1-83f9f028f4c0" alt=""> (red)</td><td>Both cells are out of service.</td></tr><tr><td>Service Down</td><td>Unwarranted</td><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FO3j3tMTfAKPO4Kf1B7P3%2Ficon-service-status-red.png?alt=media&amp;token=2477b5c9-4201-4d98-aaa1-83f9f028f4c0" alt=""> (red)</td><td>User's desire is one cell and that cell’s service is down.</td></tr><tr><td>Unwarranted</td><td>Healthy</td><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FwRbhytNFPgCZiKgSHsP7%2Ficon-service-status-amber.png?alt=media&amp;token=e2fda2a7-3eac-49f0-bfb5-67e39be7f15f" alt=""> (amber)</td><td>One cell is not behaving as expected.</td></tr><tr><td>Unwarranted</td><td>Shutdown</td><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FwRbhytNFPgCZiKgSHsP7%2Ficon-service-status-amber.png?alt=media&amp;token=e2fda2a7-3eac-49f0-bfb5-67e39be7f15f" alt=""> (amber)</td><td>Unwarranted.</td></tr><tr><td>Unwarranted</td><td>Service Down</td><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FO3j3tMTfAKPO4Kf1B7P3%2Ficon-service-status-red.png?alt=media&amp;token=2477b5c9-4201-4d98-aaa1-83f9f028f4c0" alt=""> (red)</td><td>User's desire is one cell and that cell’s service is down.</td></tr><tr><td>Unwarranted</td><td>Unwarranted</td><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FwRbhytNFPgCZiKgSHsP7%2Ficon-service-status-amber.png?alt=media&amp;token=e2fda2a7-3eac-49f0-bfb5-67e39be7f15f" alt=""> (amber)</td><td>Unwarranted.</td></tr></tbody></table>

    Hover your cursor over the "Service Status" icon to view the cell's RF Tx status and cell's desired status. In DC mode, info is displayed for Cell 1 and Cell 2, and in CA mode for Primary and Secondary cells.
  * **IPSec Status** – (Displayed only if IPSec is enabled.) Indicates status of the IPSec tunnels with the Onyx Edge and the IPSec certificate's validity. Note that the certificate status is that of the generated certificate, and not of the one uploaded to the AP.

    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fzv59kRKuJvxG2kPSnHa4%2Ficon-ipsec-status-green.png?alt=media\&token=0ab72ea6-698f-4f83-bc4b-a9476962a3da) (green) – The AP is IPSec-enabled and the desired number of active IPSec tunnels with the Onyx Edge are up, and the certificate is valid for more than seven days.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FqtIl80fafg2AITzFgrbi%2Ficon-ipsec-status-amber.png?alt=media\&token=58afc7df-709c-4722-942c-a15bd588ca1b) (amber) – The AP is IPSec-enabled and less than the desired number of active IPSec tunnels with the Onyx Edge are up, and/or the certificate is valid for less than seven days.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FGzWlFxxdWGakQszbzTS8%2Ficon-ipsec-status-red.png?alt=media\&token=a3e75cfa-af46-441f-a318-ce7f3d66b381) (red) – All the IPSec tunnels with the Onyx Edge are down, and the certificate's validity has expired.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FzUU60lu6hxvs5CVjdCpR%2Ficon-ipsec-status-grey.png?alt=media\&token=48f51d0f-021a-4eea-89b6-1334092169cb) (grey) – Any of the following:
      * The AP is offline.
      * The associated Onyx Edge is offline.
      * The AP is IPSec-disabled.
      * IPSec tunnel information is not available.

    Hovering your cursor over the "IPSec Status" icon displays additional details.
  * **Sync Status** – Indicates the AP's time reference synchronization status with the primary clock source.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fzv59kRKuJvxG2kPSnHa4%2Ficon-ipsec-status-green.png?alt=media\&token=0ab72ea6-698f-4f83-bc4b-a9476962a3da) (green) – AP is in sync with the clock source.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FGzWlFxxdWGakQszbzTS8%2Ficon-ipsec-status-red.png?alt=media\&token=a3e75cfa-af46-441f-a318-ce7f3d66b381) (red) – AP is not in sync with the clock source.
    * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FzUU60lu6hxvs5CVjdCpR%2Ficon-ipsec-status-grey.png?alt=media\&token=48f51d0f-021a-4eea-89b6-1334092169cb) (grey) – Any of the following:
      * The AP is offline.
      * The Onyx Edge associated with the AP is offline.
      * The AP's Sync Mode is set to "Free Running".
      * The AP's sync status is not available.
  * **Onyx Edge** – The associated Onyx Edge.
  * **MME Status** – The AP's MME connection status—Connected or Disconnected.
  * **IP Address** – The AP's IP address.
  * **VIP Address** – (Displayed only for IPSec-enabled APs) The Virtual IP address (inner IP address) used for MME connection.
  * **Mesh Node** – (Displayed only for Mesh APs) The associated Mesh Node.
* **AP Properties**:
  * **View License** — Click to view the AP's license details.

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FLHjJ2WG9O7b8t4W5sypx%2F4g-ap-view-details-license-db.png?alt=media&amp;token=69f99aac-6529-4b86-9749-36c5110ba0c9" alt="" width="432"><figcaption></figcaption></figure></div>
  * **Certificate Status** – (Displayed only when IPSec is enabled.) The IPSec certificate expiry status.
  * **Model** – The AP equipment's model—G100, G101, G501.
  * **Software Version** – The AP's software version.
  * **Up Time** – The duration for which the AP has been continuously operational without any downtime or interruptions.
  * **Reported Time** – The timestamp at which the AP's data was last reported.
  * **Config/FSM State** – The current configuration synchronization status between the Onyx Portal and the AP. The **Config/FSM State** parameter displays one of the following status values:

    * **Updating Configuration** – Configuration changes made in the Onyx Portal have not yet been applied to the AP.
    * **In Sync** – Configuration between Onyx Portal and the AP is in sync.
    * **Disconnected** – The AP is offline and not connected to the Onyx Portal.
    * **Rebooting** – The AP is currently rebooting.
    * **Stuck** – Configuration update has not completed within 10 minutes of being pushed from the Onyx Portal as the AP is rejecting the configuration.
    * **Pending Reboot with Schedule** – A reboot is pending to apply neighbor configuration updates and is scheduled for a specified time. The scheduled time is shown in the **Reboot Schedule for Neighbor Update** parameter.
    * **Pending Reboot Without Schedule** – A reboot is pending to apply neighbor configuration updates but has not yet been scheduled. User action is required to schedule the reboot before neighbor changes will take effect.

    Hovering over the Config/FSM State value displays additional details in an info tooltip.

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FSKHyq6cSffMM1gmfU5bm%2Fimage.png?alt=media&amp;token=357e9818-79c4-4551-8688-7716ecaa2447" alt="" width="428"><figcaption></figcaption></figure></div>

    This information is intended for troubleshooting and includes:

    * **Last Session Start Time** – Start timestamp of the most recent TR069 session (displayed in local time).
    * **Last Session End Time** – End timestamp of the most recent TR069 session (displayed in local time).
    * **Portal Config Time** – Timestamp when the configuration was last updated in the Onyx Portal (displayed in local time).
    * **AP Config Receive Time** – Timestamp when the AP last received and acknowledged a configuration update from the Onyx Portal (displayed in local time).
    * **Last Neighbor Update Time** — Timestamp of the last neighbor configuration update pushed to the AP. Displays **Already in Sync** if no update is pending.
    * **Last Reboot Sent Time** — Timestamp of the last reboot command sent to the AP from the Onyx Portal. Displays **Already in Sync** if no reboot has been triggered for a pending update.
    * **Last Boot Time** — Timestamp of the AP's last boot. Displays **--** (double dashes) if unavailable.
    * **FSM State** – The internal Finite State Machine (FSM) state of the AP, reflecting its current operational phase (e.g., *Waiting for an Inform with eNB post error state*). Intended for advanced troubleshooting.
    * **CBSD Details** – (CBSD-AP Only) For each Citizens Broadband Radio Service Device (CBSD) associated with the AP:
      * **Last Session End Time** – End timestamp of the most recent TR069 session (displayed in local time).
      * **Portal Config Time** – Timestamp when the CBSD configuration was last updated in the Onyx Portal.
      * **AP Config Rcv Time** – Timestamp when the AP last received the CBSD configuration update (displayed in local time).

        If any debug information is unavailable, the system displays -- (double dashes) in place of value.
      * **CBSD Serial Number** — The serial number identifying this specific CBSD.
  * **Reboot Schedule for Neighbor Update** – Indicates the AP's current reboot scheduling status for applying neighbor configuration updates. This parameter provides operators with clear visibility into which APs are waiting on a reboot to apply neighbor changes. Displays one of the following values:
    * **Neighbor Config in Sync** – No reboot is pending; the AP's neighbor configuration is already up to date.
    * **Auto Reboot Set** – The network is configured to automatically reboot APs when neighbor updates are pending.
    * **No Scheduled Time** – A reboot is required to apply neighbor changes, but no reboot time has been scheduled. User action is required to schedule the reboot.
    * A specific timestamp indicating when the reboot is scheduled to occur.
    * **Stuck** — The AP's configuration update is stuck and the reboot schedule status cannot be determined.
  * **GPS Latitude** – The AP equipment's GPS latitude coordinate.
  * **GPS Longitude** – The AP equipment's GPS longitude coordinate.
* SAS Status – (Displayed only if SAS is enabled.) Indicates the AP's Spectrum Access System (SAS) status—Registered, Granted, or Authorized.

  To view the grant state, hover your cursor over the "SAS Status" icon.

  * SC mode – Displays grant state of the only cell.
  * CA mode – Displays grant states of the Primary and Secondary Cells.
  * DC mode – Displays grant states of Cell 1 and Cell 2.

  Color coding for "SAS Status" icons:

  * Registered icon:
    * Green – All CBSDs are registered.
    * Amber – Some CBSDs are registered, and some are not registered.
    * Red – No CBSDs are registered.
  * Granted icon:
    * Green – Required number of grants are available.
    * Amber – Some grants are available but not the required number.
    * Red – No grants are available.
    * Grey – No CBSDs are registered.
  * Authorized icon:
    * Green – Required number of grants are authorized.
    * Amber – Some grants are authorized but not the required number.
    * Red – No grants are authorized.
    * Grey – No grants are available.
* **RAN**:

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fk2CJSKZymsYbdxCk3zKT%2Fimage.png?alt=media&amp;token=3465acf2-30ad-45bc-b53d-8187935356b3" alt=""><figcaption></figcaption></figure></div>

  * **SAS** – Indicates whether SAS is used for frequency allocation—Enabled or Disabled.
  * **TAC** – The Tracking Area Code (TAC). The TAC is a unique code assigned to a geographical area to track mobile devices within the network.
  * **DAS** – Indicates whether the AP is associated with a DAS.
  * **Carrier Mode** – The AP's carrier mode—Single Carrier, Dual Carrier, or Carrier Aggregation.
  * **Sync Mode** — The AP's time reference synchronization mode — Free Running, GPS, or PTP. Synchronization helps adjacent APs avoid interfering with each other, optimizes bandwidth usage, and enhances network capacity.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> In this release, the PTP sync mode is qualified only for PTP over Ethernet in Single Carrier mode. The PTP over UDP, and DC and CA modes will be qualified in a later release.</p></div>
  * **PCI** – The Physical Cell ID (PCI) used for cell identity during the cell selection procedure. The PCI is used by UE to decode physical layer data transmitted by the AP.\
    In CA mode, it is displayed for Primary and Secondary Cells.\
    In DC mode, it is displayed for Cell 1 and Cell 2.
  * **Cell ID** – The cell's unique ID.\
    In CA mode, it is displayed for Primary and Secondary Cells.\
    In DC mode, it is displayed for Cell 1 and Cell 2.
  * **Radio Range (SSF)** – (Displayed only if configured at the venue level or inherited from the network level.) The Radio Range parameter, also referred to as Signal Strength Floor (SSF). SSF determines the signal strength thresholds for different coverage areas within a network, ensuring optimal connectivity and handover performance across varying distances and terrain conditions.
    * **Normal (SSF7)** – This SSF category represents the typical signal strength threshold for cell selection and handover within a network. It is used for areas where the network coverage is considered standard, and the signal strength is within the normal operating range.
    * **> 6miles (SSF5)** – This SSF category represents an extended coverage area where the signal strength may be weaker compared to the normal operating range. It is used for areas where the distance between the cell site and the UE exceeds six miles, requiring a lower signal strength threshold for cell selection and handover.
  * **DL/UL Distribution (SA)** – (Displayed only if configured at the venue level or inherited from the network level.) The DL/UL Subframe Assignment (SA). SA determines the percentage of transmission resources in downlink and uplink.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> In CA mode, the Cell ID, PCI, Bandwidth, Frequency, Max Tx Power, and Transmit parameters are displayed for the Primary and Secondary cells. In DC mode, it is displayed for Cell 1 and Cell 2. </p></div>

  * **SAS Configuration** – (Displayed only if SAS is enabled.)

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FDBbnrv23A2TFXCvF2H7S%2Fimage.png?alt=media&amp;token=a6884814-79aa-4aa8-99ed-2437f8e9369a" alt=""><figcaption></figcaption></figure></div>

    * **CBSD Category** – (Displayed only if SAS is enabled.) The CBSD's power class under CBRS regulations—Category A (devices that operate at maximum 30 dBm EIRP), Category B (devices that operate at maximum 47 dBm EIRP).
    * **User ID** – (Displayed only if SAS is enabled.) The SAS account's user ID for SAS registration and authentication.
    * **Desired State** – (Displayed only if SAS is enabled.) The desired state—Registered, Unregistered. If SAS is enabled, the CBSD's desired state is Registered, it will search for grants, and if available, acquire them. If SAS is disabled, the state is Unregistered.
    * **Antenna Gain (dBi)** – The amount of signal boost provided by the CBSD's antenna, measured in "decibels relative to an isotropic antenna" (dBi), measured in dBi. A higher gain focuses energy more effectively but may have stricter deployment requirements.
    * **No. of Antenna** – The number of physical antennas associated with the CBSD.
    * **Preferred Min Pwr (dBm)** – The minimum transmit power level that the CBSD prefers to use.
    * **Preferred Max Pwr (dBm)** – The maximum transmit power level that the CBSD prefers to use.
    * **Preferred BW (MHz)** – The channel width that the CBSD requests.
    * **Preferred Frequencies (MHz)** – The frequencies that the device prefers to operate on in the CBRS band in MHz.\
      In CA mode, it is displayed for Primary and Secondary Cells.\
      In DC mode, it is displayed for Cell 1 and Cell 2.
    * **Strict Freq Preference** – If set to true, the CBSD strongly prefers the listed frequency and may reject alternate frequencies offered by the SAS.
    * **Transmit** – The CBSD's transmission status—Enabled or Disabled.\
      In CA mode, it is displayed for Primary and Secondary Cells.\
      In DC mode, it is displayed for Cell 1 and Cell 2.
  * **SAS Status**

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FjkLxLaHpSUU5DL3DIywH%2Fimage.png?alt=media&amp;token=49f38fea-5dda-468e-8357-587edc7fd25a" alt=""><figcaption></figcaption></figure></div>

    * **BW (MHz)** – The actual bandwidth the SAS has granted or is in the process of granting to the CBSD.
    * **Freq (MHz)** – The specific frequency center or range that the SAS has granted to the CBSD or is considering.
    * **Max Tx Pwr (dBm)** – The maximum transmit power level that the SAS allows the CBSD to use on the granted frequency.
    * **AP to DP Connection** – Indicates whether the CBSD is connected to the Domain Proxy (DP), which acts as an intermediary between multiple CBSDs and SAS.
    * **FCC ID** – (Displayed only if SAS is enabled.) The AP's Federal Communications Commission (FCC) ID, which indicates the CBSD complies with FCC regulations for operation in the CBRS spectrum.
    * **Heartbeat Interval** — The interval, in seconds, at which the CBSD sends heartbeat messages to the SAS to maintain its grant.
    * **Grant Expire Time** — The timestamp at which the current SAS grant expires. After this time, the CBSD must re-request a grant from the SAS to continue transmitting.
    * **Transmit Expire Time** — The timestamp by which the CBSD must send a heartbeat to the SAS to maintain authorization to transmit. If the heartbeat is not sent before this time, the CBSD must stop transmitting.
    * **View Available Spectrum** — Click to view display of the available frequency ranges between 3550 MHz and 3700 MHz, as reported by the SAS following Spectrum Inquiry. This information is available only after the CBSD is registered.

      <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FhM3xYuK1204tZfQcC3xe%2Fimage.png?alt=media&amp;token=0b11dab7-248b-4a62-9372-68a617d5cb15" alt=""><figcaption></figcaption></figure></div>
* **Subscribers (n)** – The count and list of subscribers attached to the AP.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> For non-GXC Administrator users this list excludes MeshBackhaul subscriber data.</p></div>

  For APs in DC mode, you can choose to view all subscribers or only subscribers attached to a particular cell—select "**Cell&#x20;*****\<cell\_id>*****&#x20;Subscribers**" from the dropdown.<br>

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmVw0Echo21vu6PNo0Uzn%2Fimage.png?alt=media&amp;token=633cb1e5-fef3-4716-b48f-75c68518323a" alt=""><figcaption></figcaption></figure></div>

  \
  Also, in the Onyx Edge's details, you can view the specific cells that individual subscribers are attached to (Onyx Portal > **Subscribers** > list of subscribers > **Access Point Cell ID** column).

  * **Status** – The subscriber's service state—Active or Inactive.
  * **Name** – The subscriber account's name.
  * **IMSI** – The subscriber's IMSI number.
  * **Subscriber Group Name** – The subscriber group to which the subscriber belongs.
    {% endstep %}

{% step %}
Click the **Handover** tab.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F3sqAkrSwOlrD9okCSlzC%2Fimage.png?alt=media&amp;token=4963ef38-d9c4-41d9-9d6a-fd620012f433" alt=""><figcaption></figcaption></figure></div>

{% hint style="info" %}
**NOTE:** For detailed information on 4G Handovers and configuring and managing neighbor relations for handovers refer to the *4G Onyx Handovers Application Note*.
{% endhint %}

* **Handover**
  * **Neighbor Management —** Indicates whether the Onyx Edge automatically manages neighbor relationships for this AP—**Enabled** or **Disabled**. When enabled, the Onyx Edge automatically populates and maintains this AP's "Neighbor Frequency Table" and "Neighbor Cell Table" based on the other cells associated with it.
  * **Hysteresis —** A buffer value (in dB) that prevents handover flapping due to small signal fluctuations. The neighbor cell's signal must exceed the serving cell's signal by this margin for the handover to be triggered. This prevents oscillating handovers caused by minor signal variations.
  * **Time To Trigger —** 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 or momentary interference.
  * Measurement Event Thresholds:
    * **A1 RSRP —** 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.\
      Conversion: Portal value 60 = -80 dBm (Portal value = dBm + 140)
    * **A2 RSRP —** 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.\
      Conversio&#x6E;**:** Portal value 55 = -85 dBm
    * **A5 RSRP Serving Cell —** 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. Part of the dual-condition A5 event logic.\
      Conversion: Portal value 50 = -90 dBm
    * **A5 RSRP Neighbor Cell —** 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. Part of the dual-condition A5 event logic.\
      Conversion: Portal value 52 = -88 dBm
    * **A3 Offset —** 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. Unlike A1, A2, and A5 thresholds, this is a relative value (dB offset), not an absolute power level (dBm).
* **Neighbors —** Displays the list of configured neighbor cells for this AP:
  * **Serial No** - Sequential number of the neighbor in the list.
  * **Freq (MHz)** - The neighbor cell's frequency in MHz (e.g., 3660, 3600).
  * **EARFCN** - E-UTRA Absolute Radio Frequency Channel Number - the channel number used in LTE to identify the carrier frequency (e.g., 56340, 55740).
  * **PCI** - Physical Cell ID - used for cell identity during cell selection procedure (e.g., 4, 6).
  * **Cell ID** - The neighbor cell's unique identifier (e.g., 769, 1025).
  * **PLMN-TAC** - Public Land Mobile Network - Tracking Area Code (e.g., 315010-1).
  * **Q Offset Cell** - Cell-specific offset used in handover and reselection decisions (e.g., 24).
  * **CIO** - Cell Individual Offset - Additional offset applied to this specific neighbor cell relationship (e.g., 24).
    {% endstep %}

{% step %}
Click the **Events & Alerts** tab.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fk9vGVxL34RmQsEuqWNKc%2Fimage.png?alt=media&amp;token=3e4fa1b0-6ea0-4d48-bf2e-7db4b7db96f9" alt=""><figcaption></figcaption></figure></div>

* **Alerts** – Details of AP and SAS-related alerts based on the selected severity level. You can select the alert severity level from **All**, **Major**, **Minor**, **Critical**, or **Others**.<br>

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FaKSNdLYEoTj8n9NKEeKX%2Fimage.png?alt=media&amp;token=751266a2-4fdf-4e38-9431-c85d5b227739" alt="" width="375"><figcaption></figcaption></figure></div>

  * **Date** – The alert's creation timestamp.
  * **Status** – The alert's status.
  * **Alert Name** – The alert's name.
  * **Severity** – The alert's severity level.
* **Events** – Details of AP and SAS related events for the selected duration:
  * **Timestamp** – The timestamp at which the event occurred.
  * **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.
  * **Event Description** – The event's description.
  * To view the details of a particular event, click the corresponding <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FK3DABEHTuVJgUAmTFKIs%2Fimage.png?alt=media&amp;token=0d5004f8-49c0-42ff-b5b5-3b94a7787bc7" alt="" data-size="original"> (view details) icon.
    {% endstep %}

{% step %}
Click the **Logs** tab.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJeN6kZc3JlHGZOLhBE3U%2Fimage.png?alt=media&amp;token=7b8f6f46-3e93-478e-839f-7005d87e4b4c" alt="" width="563"><figcaption></figcaption></figure></div>

* **Logs** – The total number and list of log events for the AP in the selected duration.
  * **Timestamp** – The timestamp at which the log was generated.
  * **Severity** – The severity of the log message.
  * **Message** – The actual information logged by the system.\
    To change the date and time range, select the required timestamps in the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FdAELcnvPLE5CgdTQNqLS%2Fimage.png?alt=media&amp;token=d1e74d1f-51e1-438c-84b8-dfc30feed2b8" alt="" data-size="line"> fields. The logs list automatically updates to display the corresponding logs.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> Your selections must fall within a seven-day range.</p></div>

    To download the logs in .csv format, in the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fr9FpIy194lB6iHZgKceH%2Fimage.png?alt=media&amp;token=4d92cb24-408d-4ddd-97c1-b8848e1d6f94" alt="" data-size="line"> field, enter the number of logs to be included in the .csv file, then click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8P0Pdmczs72k5siljbSJ%2Fimage.png?alt=media&amp;token=3c6bcf82-ddde-4bc9-ae99-eef2e269204c" alt="" data-size="line">. Default value: 5000. The downloaded .csv file includes details such as the timestamp, service, tag, type, and log text.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> You can download a maximum 5000 logs.</p></div>
* **DP Logs (n)** – The total number and list of Domain Proxy (DP) log events between the selected entities—**DP**, **ACS**, **CBSD**, and **SAS**.

  To change the selected entities, click the corresponding dropdown.<br>

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FCXzMAW6O6Fg5ygxj6y6C%2Fimage.png?alt=media&amp;token=f40ac959-e6a6-4406-8613-ec51a3d3d5bd" alt="" width="282"><figcaption></figcaption></figure></div>

  For 4G APs operating in SAS Dual Carrier Mode, the DP Logs section includes cell-specific filtering, enabling you to isolate and analyze First Cell or Second Cell traffic for targeted troubleshooting and improved dual carrier network visibility.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FdXZXM3OMvKbEbBnVrca8%2Fimage.png?alt=media&amp;token=02d726af-935a-43e4-a4de-86143a0be6a4" alt="" width="563"><figcaption></figcaption></figure></div>

  First Cell: Filter using the AP's serial number (e.g., ABX123).

  Second Cell: Filter using the AP's serial number with "-2" suffix (e.g., ABX123-2).

  The list of DP log events between the selected entities.

  * **Timestamp** – The timestamp at which the log was generated.
  * **From** – The source or origin of the data.
  * **To** – The destination or target of the data.
  * **Type** – The type of the log entry.
  * **Message** – The actual information logged by the system.
  * **Download** – (Available only if IPSec is enabled for the AP.) To download the AP Certificate and AP Private Key, in the upper-right corner of the page, click **Download**.

    On enabling IPSec for an AP, these AP Certificate and AP Private Key files, and the network's Root CA Certificate file must be uploaded to the AP equipment's configuration interface. For more information see [*Enable and Configure IPSec on AP Equipment*](#enable-and-configure-ipsec-on-ap-equipment).
  * **Actions** (**Actions** button in the upper-right corner of the page):
    * **Delete** – (Super Administrator and Administrators only.) To delete the AP. For more information, see *Delete APs*.
    * **Reboot** – (Super Administrator and Administrators only.) To reboot the AP. For more information, see *Reboot APs*.
    * **Upgrade** – (Super Administrator and Administrators only.) To upgrade the AP software running on the APs. For more information, see [*Manage AP Software Upgrades*](#manage-ap-software-upgrades).
      {% endstep %}
      {% endstepper %}

## Add APs

This section describes how to add APs.

{% hint style="info" %}
**NOTE:** You can add APs only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

**To add an AP to a 4G network:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **Access Points** tab.

The **Equipment** page > **Access Points** tab displays the summary details of all APs configured in the network.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Add Node** > **Add Access Point**.

The **Create Access Point** page > **Access Point** tab is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FbBn1k2gwKe7ailIs51Ts%2Fimage.png?alt=media&amp;token=5268f047-fcf5-439a-b61b-b2a3f4685d2c" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

* **Venue** – (Required) Select the venue hosting the AP.
* **Name** – (Required) The AP's name.
* **Serial Number** – (Required) The AP equipment's vendor-assigned serial number.
* **Description** – (Required) The AP's description.
  {% endstep %}

{% step %}
In the lower-right corner of the page, click **Configure RAN**.

The **RAN** tab is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F2PwkBjAV91bOeCpe0AZn%2Fimage.png?alt=media&amp;token=ab3b96d0-cc6f-49fd-8875-c9a01d710700" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

* **Device Class** – (Required) Select the AP equipment's model from the following:

  * **G100** – Indoor Low Power AP
  * **G101** – Outdoor Low Power AP
  * **G501** – Outdoor High Power AP

  For detailed information on these 4G APs, refer to the corresponding Specification Sheets and Hardware Installation Guides.
* **TAC** – (Optional) The Tracking Area Code used for UE mobility handling within this AP's service area. Default value: 55.
* **Carrier Mode** – (Required) Select the carrier mode from **Single Carrier**, **Dual Carrier**, **Carrier Aggregation**. Default value: Single Carrier.

  If you select **Carrier Aggregation**, you must configure the Bandwidth, Frequency, Max Tx Power, and Transmit parameters for the Primary and Secondary Cells.

  If you select **Dual Carrier**, you must configure the Bandwidth, Frequency, Max Tx Power, and Transmit parameters for Cell 1 and Cell 2.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> For CA mode, the APs must be updated with the "FAP009 Carrier Aggregation Function" license.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> For CA mode, the UE must also support CA.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> DC handovers are not supported in this release.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> For DC mode, the APs must be updated with the "FAP010 Dual Carrier Function" license.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The CA and DC modes are not supported with Mesh APs. This is because the CA and DC modes require four antenna ports (4 filters), while the GM01 Mesh Node supports two. However, the Gateway AP serving a Mesh Node can be operated in CA or DC modes.</p></div>
* **Sync Mode** – (Required) Select the AP's time reference synchronization mode. Synchronization helps adjacent APs avoid interfering with each other, optimizes bandwidth usage, and enhances network capacity. Default value: Free Running.
  * **Free Running** – The AP synchronizes to its own internal clock set by an NTP server.
  * **GPS** – The AP synchronizes time using a directly-connected GPS antenna.
  * **PTP** – The AP synchronizes time with a local PTP server.
    * **PTP Transport** – (Displayed only when the PTP sync mode is selected. Required.) Select the Precision Time Protocol (PTP) transport protocol—**Ethernet**, **UDP**. Default value: Ethernet.

      <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> In this release, the PTP sync mode is qualified only for PTP over Ethernet in Single Carrier mode. The PTP over UDP, and DC and CA modes will be qualified in a later release.</p></div>
* **Operation Mode** – (Required) Select the AP's operation mode:
  * **Manual** – Select to disable SAS. The AP uses user-defined radio parameters such as frequency, bandwidth, and power without relying on SAS automation.
  * **SAS** – Select to enable SAS. The AP operates under the SAS, automatically receiving CBRS channel assignments and power limits based on SAS grants.
  * **DAS** – The AP operates as part of a DAS where RF parameters are centrally controlled, and the AP functions as a remote radio head rather than an independently managed radio node.
* **IPSec** – Enable or disable IPSec. Default setting: disabled.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> IPSec must be enabled only on APs that are directly connected to IPSec-enabled Onyx Edge. IPSec must not be enabled for APs behind Mesh Nodes.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> If enabled here, IPSec must also be enabled and configured on the AP equipment. For more information, see <a href="#enable-and-configure-ipsec-on-ap-equipment"><em>Enable and Configure IPSec on AP Equipment</em></a>.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> IPSec is not supported in conjunction with HA/Onyx Edge pools. IPSec-enabled APs must not be associated with an Onyx Edge pool. IPSec must not be enabled on APs already associated with a pool. For more information, see <em>Manage Onyx Edge High Availability</em>.</p></div>

In SC mode with SAS enabled.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FHZIUMBioXaew4mimN8uZ%2Fimage.png?alt=media&amp;token=446c1907-6a3d-4d4d-9e90-3fc3bd615695" alt=""><figcaption></figcaption></figure></div>

In DC mode with SAS enabled.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FDG0gwzpiVTr9rHzAm1OY%2Fimage.png?alt=media&amp;token=5d658d90-d44a-4328-8480-43e83569e1c5" alt=""><figcaption></figcaption></figure></div>

In CA mode with SAS enabled.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKWYHGzudhTORxZTUJ9aO%2Fimage.png?alt=media&amp;token=d3ed960d-72b4-4faa-8fc1-9439b986441f" alt=""><figcaption></figcaption></figure></div>

* **CBSD Category** – (Displayed only if SAS is enabled. Required.) The Citizens Broadband Radio Service Device (CBSD) category. Select either **A** or **B**. Category A devices operate at a maximum of 30 dBm EIRP, while Category B devices operate at a maximum of 47 dBm EIRP.
  * G100 – (Cannot be changed.) A.
  * G101 – A or B. Default value: B.
  * G501 – A or B. Default value: B.
* **User ID** – (Displayed only if SAS is enabled. Required.) The SAS account's user ID.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> To obtain the SAS user ID, contact GXC Technical Support.</p></div>
* **Antenna Gain (dBi)** – (Displayed only if SAS is enabled. Required.) The antenna's gain in dBi.
  * G100 – (Cannot be changed.) Default value: 4.
  * G101 – Must be in the range of -5–30. Default value: 13.
  * G501 – Must be in the range of -5–30. Default value: 0.

    In DC mode, configure this parameter for Cell 1 and Cell 2.
* **Preferred Max Pwr (dBm)** – (Displayed only if SAS is enabled. Required.) The preferred maximum power in dBm.
  * G100 – Must be in the range of 0–24. Default value: 24.
  * G101 – Must be in the range of 0–24. Default value: 24.
  * G501 – Must be in the range of 0–30. Default value: 30.

    In DC mode, configure this parameter for Cell 1 and Cell 2.
* **Preferred BW (MHz)** – (Displayed only if SAS is enabled. Required.) Select the preferred bandwidth value in MHz.
  * G100 – Must be 10 or 20. Default value: 10.
  * G101 – Must be 10 or 20. Default value: 10.
  * G501 – Must be 10 or 20. Default value: 10.

    In DC mode, configure this parameter for Cell 1 and Cell 2.
* **Preferred Frequencies (MHz) in Priority Order** – (Displayed only if SAS is enabled. Required.) Select the preferred frequency values (multiple) in priority order, that is, highest priority first, followed by the second priority, and so on. Available values depend on **Preferred BW (MHz)** and are in increments of five.
  * G100 – For 10MHz Preferred Bandwidth = 3555–3695. For 20MHz Preferred Bandwidth = 3560–3690. Default setting: 3680.
  * G101 – For 10MHz Preferred Bandwidth = 3555–3695. For 20MHz Preferred Bandwidth = 3560–3690. Default setting: 3680.
  * G501 – For 10MHz Preferred Bandwidth = 3555–3695. For 20MHz Preferred Bandwidth = 3560–3690. Default setting: 3680.

    In DC mode, configure this parameter for Cell 1 and Cell 2.

{% hint style="info" %}
**NOTE:** For a Mesh Node, you must enter a preferred frequency. Do not use the default **Auto** value. If the Gateway AP is assigned a channel in the high frequency portion of the CBRS band, then the Mesh AP must be configured for a channel in the low frequency portion of the CBRS band and vice versa. For more information, see *GM01 Mesh Node Installation and Configuration Guide > Mesh Filters and Channel Frequency Assignments*.
{% endhint %}

* **Strict Preference** – (Displayed only if SAS is enabled. Optional.) Select **True** to enable and **False** to disable the Strict Frequency Control feature, wherein grant selection is restricted only to the preferred frequencies. Default value: True.

  When enabled, if none of the preferred frequencies are available, the DP will retry with a Spectrum Inquiry Request until one of the preferred frequencies becomes available. Until then, the CBSD will not be able to transmit. When disabled, the next best frequency will be requested for the grant.

  In DC mode, configure this parameter for Cell 1 and Cell 2.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> Strict Preference must be set to True for both the Gateway AP and Mesh AP.</p></div>
* **Transmit** – (Optional) Select to enable or disable transmission. Default setting: disabled.

  In CA mode, configure this parameter for Primary Cell and Secondary Cell.

  In DC mode, configure this parameter for Cell 1 and Cell 2.

Manual in SC mode.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKhL7SzoaMtaESYqnSjWB%2Fimage.png?alt=media&amp;token=e672aafd-7137-4497-84a1-43f8f9834331" alt=""><figcaption></figcaption></figure></div>

Manual in DC mode.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FN3MDUsJCpuEmW3vl7ama%2Fimage.png?alt=media&amp;token=aedaec4d-7560-4258-8ec5-929d9bdb5bfd" alt=""><figcaption></figcaption></figure></div>

Manual in CA mode.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FS3NzpPKw1aoFXxB5MNkx%2Fimage.png?alt=media&amp;token=adceae3b-433b-464f-84b9-75ae4d5e394b" alt=""><figcaption></figcaption></figure></div>

* **BW (MHz)** – (Required) Select the bandwidth value in MHz. Default value: 10.

  In CA mode, configure this parameter for the primary and secondary cells.

  In DC mode, configure this parameter for Cell 1 and Cell 2.
* **Freq (MHz)** – (Required) Select the frequency value in MHz. Default value: 3555.

  In CA mode, configure this parameter for the primary and secondary cells.

  In DC mode, configure this parameter for Cell 1 and Cell 2.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> Ensure that the Mesh AP and the Gateway AP are not assigned the same frequency. If the Gateway AP is assigned a channel in the high-frequency portion of the CBRS band, the Mesh AP must be assigned a channel in the low-frequency portion, and vice versa. For more information, see <em>GM01 Mesh Node Installation and Configuration Guide > Mesh Filters and Channel Frequency Assignments</em>.</p></div>
* **Max Tx Pwr (dBm)** – (Required) The maximum transmission power in dBm.

  * G100: Must be in the range of 17–24. Default value: 24.
  * G101: Must be in the range of 17–24. Default value: 24.
  * G501: Must be in the range of 24–30. Default value: 30.

  In CA mode, configure this parameter for the primary and secondary cells.

  In DC mode, configure this parameter for Cell 1 and Cell 2.
* **Transmit** – (Required) Select to enable or disable transmission. Default setting: disabled.

  In DC mode, configure this parameter for Cell 1 and Cell 2.
  {% endstep %}

{% step %}
In the lower-right corner of the page, click **Configure Handover**.

The **Handover** tab is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FnT6Ladz4TduBf9osRXlV%2Fimage.png?alt=media&amp;token=7091b85a-0fea-4f59-8726-84aa0afd78df" alt=""><figcaption></figcaption></figure></div>

{% hint style="info" %}
**NOTE:** For detailed information on configuring and managing neighbor relations for handovers refer to the *4G Onyx Handovers Application Note*.
{% endhint %}
{% endstep %}

{% step %}
To save the AP, in the upper-right corner of the page, click **Save Access Point**.

{% hint style="info" %}
**NOTE:** In non-HA mode, after adding the AP, to activate it, you must associate it with an Onyx Edge. To associate an AP with an Onyx Edge, click **Equipment** > **Onyx Edge** tab > edit Onyx Edge > **RAN** tab > **Associated Access Point** parameter.

To check the APs associated with an Onyx Edge, click **Equipment** > **Onyx Edge** tab > view Onyx Edge details > **Connected Access Point** section.
{% endhint %}

{% hint style="info" %}
**NOTE:** For information on associating an AP with an Onyx Edge in HA/Onyx Edge Pool mode, see *Manage Onyx Edge High Availability*.
{% endhint %}

These steps must be repeated for each AP that you add to the system. Depending on your network traffic and internet connection, it may take up to 10 minutes or more for an AP to check-in with the Onyx Portal.
{% endstep %}
{% endstepper %}

### Enable and Configure IPSec on AP Equipment

{% hint style="info" %}
**NOTE:** In this release, IPSec is supported only in 4G networks.
{% endhint %}

{% hint style="info" %}
**NOTE:** This section is applicable only if you are enabling IPSec between an AP and the associated Onyx Edge. For more information, see *IPSec Support*.
{% endhint %}

{% hint style="info" %}
**NOTE:** IPSec is not supported in conjunction with HA/Onyx Edge pools. IPSec-enabled APs must not be associated with an Onyx Edge pool. IPSec must not be enabled on APs already associated with a pool. For more information, see *Manage Onyx Edge High Availability*.
{% endhint %}

After you enable IPSec support for an AP in the Onyx Portal, you must download the Root CA Certificate, AP Certificate, and AP Private Key files from the Onyx Portal and upload them to the AP's configuration interface. You must then enable and configure IPSec in the AP's configuration interface.

{% hint style="info" %}
**NOTE:** The "IPSec Equipment" and "IPSec Private" certificates have one-year validity periods. Upon expiration, they must be downloaded again and uploaded to the AP LCI interface.
{% endhint %}

#### Download Certificate Files from the Onyx Portal

**To download the certificate files from the Onyx Portal:**

{% stepper %}
{% step %}
Download the network's Root CA Certificate file:

1. In the navigation pane, click **Network**.

   The ***\<network name>*** page is displayed.
2. In the upper-right corner of the page, click **Download Root CA Certificate**.

   The .pem file is downloaded.
   {% endstep %}

{% step %}
Download the AP Certificate and AP Private Key files:

1. In the navigation pane, click **Equipment** > **Access Points** tab.

   The list of available APs is displayed.
2. Click the name of the AP for which you want to download the certificate files.

   The ***\<AP name>*** page is displayed.
3. In the upper-right corner of the page, click **Download** > **Download AP Certificate**.

   The .pem file is downloaded.
4. In the upper-right corner of the page, click **Download** > **Download AP Private Key**.

   The .key file is downloaded.
   {% endstep %}
   {% endstepper %}

#### **Upload Certificate Files to the AP**

**To upload the certificate files to the AP:**

{% stepper %}
{% step %}
Log on to the AP equipment's LCI.
{% endstep %}

{% step %}
In the AP's LCI navigation menu, click **Network** > **IPSec**.

The **Network/IPSec** page is displayed.
{% endstep %}

{% step %}
In the **IPSec Tunnel List** section, edit the first index and enable IPSec.
{% endstep %}

{% step %}
In the **IPSec Certs** section, in the **Type** drop-down, select each of the certificate types **IPSec CA Certs**, **IPSec Equipment Certs**, and **IPSec Private Certs**, and upload the corresponding files.

The updates are listed in the **Certificate List** section.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fy02xeytalobrbqvqkJTP%2Fimage.png?alt=media&amp;token=1791ebd2-97fb-4258-b34f-fe9de37bd912" alt="" width="563"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click **Save** to exit.
{% endstep %}
{% endstepper %}

### Enable and Configure IPSec in the AP's LCI

**To enable and configure IPSec in the AP's configuration interface:**

{% stepper %}
{% step %}
Log on to the AP equipment's LCI.
{% endstep %}

{% step %}
In the AP's LCI navigation pane, click **Network** > **IPSec**.

The **Network/IPSec** page is displayed.
{% endstep %}

{% step %}
In the **IPSec-Tunnel-List** section, edit the first index.

Click the corresponding edit icon, and then enter the following values:

* **Left-Auth** – (Optional) PUBKEY.
* **Right-Auth** – (Optional) PUBKEY.
* **Gateway** – (Required) The outer IP address of the MME.

  For Onyx Edge On-Premises deployments, this is typically 10.0.2.1.
* **Right Subnet** – (Required) This must match the MME Local IP address configured on the Onyx Edge (Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge's details > **RAN** tab > **AGW IPSec Configuration** > **MME Local IP** parameter).
* **Right Id** – (Optional) “CN=*\<onyx-edge-uuid>*”.

  For example, "CN=ad72fe38-062c-4c51-ae20-4c59c9cc4a0f".
* **Secret key** – (Optional) Name of the AP key file.

  For example, "*enb\_key.pem*".
  {% endstep %}

{% step %}
In the **Advanced Setting** section, enter the following values:

* **Left Id** – The AP's serial. You can obtain this from the *enb\_cert.pem* file by running the following command:

{% code overflow="wrap" %}

```
$ openssl x509 -in enb_cert.pem -noout -text | grep 'Subject:'
        Subject: C = US, O = Gxc, OU = GxcEnodeb, CN = 1202000468222AB0008
```

{% endcode %}

* **Left Cert** – Name of the enb-cert file.

  For example, "*enb\_cert.pem*".
* Keep the second index switched off.
  {% endstep %}

{% step %}
In the AP’s LCI navigation pane, click **Network** > **Core Network**.
{% endstep %}

{% step %}
In the **MME Pool Config** section, add the MME IP address.
{% endstep %}

{% step %}
On saving your edits, you will be required to reboot the AP.   &#x20;

After rebooting, IPSec will be enabled.
{% endstep %}
{% endstepper %}

## Edit APs

This section describes how to edit APs in 4G networks.

{% hint style="info" %}
**NOTE:** You can edit AP details only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** The carrier mode of an AP cannot be changed as long as any of its cells are part of the "Allowed Cell" configuration for any subscriber. The subscriber's configuration must first be cleared of the allowed cell configuration, after which the AP's carrier mode can be changed.
{% endhint %}

**To edit an AP's details:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **Access Points** tab.

The **Equipment** page > **Access Points** tab displays the summary details of all APs configured in the network.
{% endstep %}

{% step %}
For the node that you want to edit, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FGqTV5ejeLgHB4lfMCb4y%2Fimage.png?alt=media&amp;token=0efa7453-fb32-42f6-bd0c-b4acc8dd850c" alt="" width="110"><figcaption></figcaption></figure></div>

The **Edit Access Point** page displays the equipment's details.
{% endstep %}

{% step %}
Edit the AP's details as required.

For parameter descriptions, see [*Add APs*](#add-aps).
{% endstep %}

{% step %}
To save your edits, in the upper-right corner of the page, click **Save Access Point**.
{% endstep %}
{% endstepper %}

## Reboot APs

{% hint style="info" %}
**NOTE:** You can reboot APs only if you are a Super Administrator or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** When you reboot an AP, it will temporarily deactivate any active networks and disconnect any UE that are connected to those networks.
{% endhint %}

To reboot an AP:

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **Access Points** tab.

The **Equipment** page > **Access Points** tab displays the summary details of all APs configured in the network.
{% endstep %}

{% step %}
Click the name of the AP that you want to reboot.

The ***\<AP name>*** page displays the AP's details.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Actions**, then click **Reboot**.

A confirmation dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Foz8y9F7VbX8d6LEJCqmx%2Fap-reboot.png?alt=media&amp;token=54049913-0fc7-4c5f-97e9-f916c7e4ce62" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To confirm rebooting the AP, click **Yes**.
{% endstep %}
{% endstepper %}

## Delete APs

{% hint style="info" %}
**NOTE:** You can delete APs only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** An AP cannot be deleted as long as any of its cells are part of the "Allowed Cell" configuration for any subscriber. The subscriber's configuration must first be cleared of the allowed cell configuration, after which the AP can be deleted. For more information, see *Mesh Node-AP Affinity Feature*.
{% endhint %}

**To delete an AP:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **Access Points** tab.

The **Equipment** page > **Access Points** tab displays the summary details of all APs configured in the network.
{% endstep %}

{% step %}
For the equipment that you want to delete, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Delete**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FSYICYJbhYP9sziLyaBPW%2Fimage.png?alt=media&amp;token=1d690894-96fa-4f23-bff6-a7b52f6036bf" alt="" width="110"><figcaption></figcaption></figure></div>

A confirmation dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F3cin62OGZik4LmkTkHAx%2Fimage.png?alt=media&amp;token=457b12d1-ee99-48df-a098-603d8fd70e37" alt="" width="398"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To confirm deleting the AP, click **Yes**.
{% endstep %}
{% endstepper %}


# Manage Mesh Nodes

The Mesh Node extends RF coverage with an AP. It utilizes a wireless backhaul to connect to an Onyx Edge.

## Mesh Node-AP Affinity Feature

{% hint style="info" %}
**NOTE:** In this release, the Mesh Node-AP Affinity feature is supported only in 4G networks.
{% endhint %}

The Mesh Node-AP Affinity feature manages the association between a Mesh Node and a specific cell. By restricting a Mesh Node to attach to a specific cell, this feature optimizes network resource management and enhances the Mesh Node's performance.

In the Onyx Portal subscriber configuration, administrators can designate a specific cell ID as the "Allowed Cell" for a Mesh Node subscriber. The cell IDs are in the format "<*AP name*>-cell-<*cell id*>". For APs with dual cells, two separate entries, one for each cell, are available for association. For more information, see *Manage Subscriber Accounts*.

{% hint style="info" %}
**NOTE:** For this feature to operate effectively, the desired cell should have a signal strength of around -90 RSRP dBm, while undesired cells should have signal strengths of -110 RSRP dBm or lower.
{% endhint %}

{% hint style="info" %}
**NOTE:** You cannot delete an AP or change its carrier mode while its cell ID is configured as a Mesh Node subscriber's "Allowed Cell". The subscriber configuration must first be cleared of the cell ID, after which the AP can be deleted, or its carrier mode can be changed.
{% endhint %}

{% hint style="info" %}
**NOTE:** Users are responsible for associating valid AP cells. Configuring a non-associated AP cell as an "Allowed Cell" for a Mesh Node, or removing the association of an AP whose cell is configured as an "Allowed Cell", will result in a loss of connectivity for that subscriber.
{% endhint %}

{% hint style="info" %}
**NOTE:** The Mesh Node-AP Affinity feature will not work during handovers between two Gateway APs.
{% endhint %}

## View Mesh Node Details

This section describes how to:

* [*View Summary Details of All Mesh Nodes*](#view-summary-details-of-all-mesh-nodes)
* [*View a Mesh Node's Details*](#view-a-mesh-nodes-details)

### **View Summary Details of All Mesh Nodes**

**To view the summary details of all Mesh Nodes in the network:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment > Mesh Node** tab.

The **Equipment** page > **Mesh Node** tab displays the summary details of all Mesh Nodes configured in the network.

**Mesh Node (n)** – The number of Mesh Node connected to the network.

The list of available Mesh Nodes is displayed.

* Mesh Node Service Status.

  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FN7iOkBO5oSE7SrNUBjst%2Fimage.png?alt=media&amp;token=8597395a-0446-4cbc-b8ba-730e9519fe18" alt="" data-size="line"> Green – Mesh AP cell is in a healthy state.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FIOaQpWLQY1jOmau1DMyM%2Fimage.png?alt=media&amp;token=e5c3d89c-9e1a-4e0a-999d-d26fce22baf5" alt="" data-size="line"> Red – Mesh AP cell is in service down state.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQQ2gYV3bAHI5TrFu9rT7%2Fimage.png?alt=media&amp;token=f34e8ed3-0e0c-4cc6-9293-576e8928b2df" alt="" data-size="line"> Amber – Mesh AP cell is in unwarranted transmission state.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FsXE6duDt2IO6ToFzIL4F%2Fimage.png?alt=media&amp;token=53ec8bbb-ea0a-400a-9aca-312393369840" alt="" data-size="line"> Grey – Mesh AP cell state is shutdown, AP is offline, or Mesh Node is offline.

  To view the Mesh AP Rf Tx status and Mesh AP Last Sync timestamp, hover your cursor over the "Service Status" icon.
* **Name** – The Mesh Node's name.
* **Description** – The Mesh Node's description.
* **Venue** – The name of the venue hosting the Mesh Node.
* **Online** – Indicates the Mesh Node's online status, which is determined by its reachability from the Onyx Portal.

  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F99qGDJljczjeJBLyd4za%2Fimage.png?alt=media&amp;token=acdef267-a172-4c22-8f3e-876d827000e2" alt="" data-size="line"> Green – Indicates the Mesh Node is connected to the Onyx Portal, and it last checked-in with the Onyx Portal within the last two minutes.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5mvjhEfhhozDJgNCDJZU%2Fimage.png?alt=media&amp;token=3c90d639-81df-4dbc-802e-9ccec84da5bb" alt="" data-size="line"> Red – Indicates the Mesh Node is not connected to the Onyx Portal, and it last checked-in with the Onyx Portal more than two minutes ago.

  To view the last synchronized at timestamp, hover your cursor over the "Online Status" icon.
* **Interface Status** – Indicates the Mesh Node's interface status.

  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXIigi4HXPPW1ugkcd5dE%2Fimage.png?alt=media&amp;token=9a3f8927-233b-4637-848f-cd9b833dd113" alt="" data-size="line"> Green – Indicates GRE tunnel status is okay, and Mesh AP is online.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FnEqfpOgCgGMrJGTGBDW3%2Fimage.png?alt=media&amp;token=b151935f-dfe9-4aee-b91f-eb377de4662d" alt="" data-size="line"> Amber – Indicates Mesh Node is online, but Mesh AP is offline, and GRE tunnel Status is okay.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FAWvDOu50JriOUkZlMKMW%2Fimage.png?alt=media&amp;token=0fc36839-8d13-4a62-9d92-69179278a01b" alt="" data-size="line"> Red – Indicates the GRE tunnel status is not okay.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F1EG7Cqeb9WRcbNinCvsd%2Fimage.png?alt=media&amp;token=e786e5f3-39af-4e20-a87a-f082868f9de9" alt="" data-size="line"> Grey – Indicates the Mesh Node is offline.

  To view the Tunnel status and Mesh AP Power Up status, hover your cursor over the "Interface Status" icon.
* **Compute Resource** – Indicates utilization status of the Mesh Node's computing resources—CPU percentage, Memory percentage, and Disk Utilization percentage.

  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fl2axRRXn664zxHDphsg0%2Fimage.png?alt=media&amp;token=9242e8eb-5a34-4f45-ad3c-6595c127f94c" alt="" data-size="line"> Green – Indicates all parameters are less than or equal to 50%.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXbHFYEOW5YQsqBGeDKYq%2Fimage.png?alt=media&amp;token=ae32a73a-007c-46d8-be61-57820fab0841" alt="" data-size="line"> Amber – Indicates all parameters are less than or equal to 70%, and at least one parameter is above 50%.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FSKllqNhHbQp4FC7Gtwt8%2Fimage.png?alt=media&amp;token=26406e9d-0933-4a87-b6e3-82b3f8ed38aa" alt="" data-size="line"> Red – Indicates at least one parameter is above 70%.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F7vwZ95O8s520FWCrLpba%2Fimage.png?alt=media&amp;token=b1ff7e80-2ca5-4a22-b9e8-3b86fe724591" alt="" data-size="line"> Grey – Indicates the Mesh Node is offline.

  To view the Disk Utilization, CPU Utilization, and Memory Utilization percentages, hover your cursor over the "Compute Resource Status" icon.
* **Actions** – Options to view details, edit, and delete a Mesh Node.
  {% endstep %}
  {% endstepper %}

### **View a Mesh Node's Details**

* [*View a GM01 Mesh Node's Details*](#view-a-gm01-mesh-nodes-details)
* [*View a GM02 Mesh Node's Details*](#view-a-gm02-mesh-nodes-details)

#### **View a GM01 Mesh Node's Details**

**To view a GM01 Mesh Node's details:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment > Mesh Node** tab.

The **Equipment** page > **Mesh Node** tab displays the summary details of all Mesh Nodes configured in the network.
{% endstep %}

{% step %}
To view a Mesh Node's details, in the list, click its name.

The ***\<Mesh Node name>*** page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F2uidM6lGKAkUqDXjJ78m%2Fimage.png?alt=media&amp;token=5b291a54-e2d1-460f-8dda-91a6e8157542" alt=""><figcaption></figcaption></figure>

* **Overview** tab:
  * **Mesh Node Details**:

    * **Name** – The Mesh Node's name.
    * **Serial No.** – The Mesh Node equipment's vendor-assigned serial number.
    * **Venue Name** – The name of the venue hosting the Mesh Node.
    * **Version** – The Mesh Node's software version.
    * **Up Time** – The duration for which the Mesh Node has been continuously operational without any downtime or interruptions.
    * **Mesh AP** – The Mesh AP equipment's vendor-assigned serial number.
    * **Donor AP** – The Mesh Node's donor AP's name.
    * **UUID/Challenge Key** – To view the Mesh Node's Hardware UUID and Challenge Key, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F3FMBfOKtw2zjI4ONERQM%2Fimage.png?alt=media&amp;token=01ddb5e4-04e0-409d-8170-7e4492b0c479" alt="" data-size="line"> (view details).
    * **Hostname** – The Mesh Node's hostname.
    * **Description** – The Mesh Node's description.
    * **Device Class** – The Mesh Node's device class—GM01.
    * **Upgrade Status** – Status of the previous Mesh Node software upgrade.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The <strong>Upgrade Status</strong> parameter is displayed only during an upgrade and for one hour after the upgrade.</p></div>

    &#x20;

    * To view the previous upgrade's details, click the status.

      The **Upgrade Status** dialog box displays the following details:

      * **Description** – Description of the last upgrade's status.
      * **Old Version** – The software version before the upgrade.
      * **New Version** – The new software version.
      * **Updated At** – The timestamp at which the last upgrade completed.
      * **Start Time** – The timestamp at which the last upgrade started.
* **SIM Related Info**:
  * **Active SIM** – The active SIM's status—**Disabled**, **Enabled**.
  * **IMSI** – The IMSI number that identifies the SIM within the network.
  * **IMEI** – The IMEI number that uniquely identifies the equipment.
* Status:
  * **Online** – The Mesh Node's online status.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FggNTxqK9UfbLaOFCRhWB%2Fimage.png?alt=media&amp;token=ebd0d85b-f7de-4461-acae-96ffff317171" alt="" data-size="line"> Green – Indicates the Mesh Node is connected to the Onyx Portal, and it last checked-in with the Onyx Portal within the last two minutes.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FADWXl52OhsogM26d7377%2Fimage.png?alt=media&amp;token=52d41512-e74a-447a-919a-d5b3f1ca8e53" alt="" data-size="line"> Red – Indicates the Mesh Node is not connected to the Onyx Portal, and it last checked-in with the Onyx Portal more than two minutes ago.

    To view the last synchronized at timestamp, hover your cursor over the "Online Status" icon.
  * **Interface Status** – The Mesh Node's interface status.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FsqJBRBRO0RZEMu46Ubdp%2Fimage.png?alt=media&amp;token=bbf96426-72e8-4cc5-bd67-4ef4c77b10dd" alt="" data-size="line"> Green – Indicates GRE tunnel status is okay, and Mesh AP is online.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F9AUaDfOXt939KOdtOtwL%2Fimage.png?alt=media&amp;token=f291442d-8817-4d1a-a181-1f72e385e3fa" alt="" data-size="line"> Amber – Indicates the Mesh Node is online, but Mesh AP is offline, and GRE tunnel Status is okay.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fr9oEeikPcpxtSp6zoqzy%2Fimage.png?alt=media&amp;token=366515c0-15f6-41b7-9b91-bf76578fd8cd" alt="" data-size="line"> Red – Indicates the GRE tunnel status is not okay.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FxD9pWBNAyoalqOWWdgKR%2Fimage.png?alt=media&amp;token=58d43ad3-693d-4270-9e96-086aad498e2f" alt="" data-size="line"> Grey – Indicates the Mesh Node is offline.

    To view the Tunnel status and the Mesh AP Power Up status, hover your cursor over the "Interface Status" icon.
  * **Compute Resource** – The Mesh Node's compute resource status.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FZ2Tn8QwFm01QyKobkKAJ%2Fimage.png?alt=media&amp;token=be85be73-0790-4332-9883-32d15840883c" alt="" data-size="line"> Green – Indicates all parameters are below 50%.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FoQbb3wdoXXRWySMC4fEy%2Fimage.png?alt=media&amp;token=fe60ab4e-c24d-4dda-9829-98b1ff3e97ad" alt="" data-size="line"> Amber – Indicates at least one parameter is above 50% and below 75%.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FnHIj0bMckMneLgHMfjHC%2Fimage.png?alt=media&amp;token=a3341da9-683b-4d1b-abdc-0240d6b6048e" alt="" data-size="line"> Red – Indicates at least one parameter is above 75%.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FsVBbumUodxvI2F3hIvVl%2Fimage.png?alt=media&amp;token=8b57e62b-d048-44b8-b812-0c9a6afe8893" alt="" data-size="line"> Grey – Indicates the Mesh Node is offline.

    To view the Disk Utilization, CPU Utilization, and Memory Utilization percentages, hover your cursor over the "Compute Resource Status" icon.
  * **Service Status** – The Mesh Node's service status.

    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FdNE7uBfyY2dumEbCYGdh%2Fimage.png?alt=media&amp;token=9019d893-ca21-4fa6-af16-952b1fcf7db7" alt="" data-size="line"> Green – Mesh AP cell is in a healthy state.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FDgovl2shO8ocZcX0ImkA%2Fimage.png?alt=media&amp;token=b3ff1951-d470-49fb-aca8-24758fbef3f1" alt="" data-size="line"> Red – Mesh AP cell is in service down state.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FdOOzsKzdILWRMfO9CrJ5%2Fimage.png?alt=media&amp;token=6d11225c-d655-4850-a2f9-d3144191072c" alt="" data-size="line"> Amber – Mesh AP cell is in unwarranted transmission state.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmUHTZ1aMG7XzkdtQAtcE%2Fimage.png?alt=media&amp;token=a6e379ed-e7f7-4edb-852d-80fc08620f1e" alt="" data-size="line"> Grey – Mesh AP is offline, or Mesh Node is offline.

    To view the Mesh AP Rf Tx status and the Mesh AP last synchronized at timestamp, hover your cursor over the "Service Status" icon.
* **Backhaul Status Details** – Indicates how consistent and stable the network connection is.

  * **Backhaul IP** – The backhaul IP address.
  * **Backhaul Filter State** – The backhaul filter state—Low Pass, High Pass.
  * **Mesh AP Filter State** – The Mesh AP filter state—Low Pass, High Pass.

  The following details are displayed in the case of SC mode for Primary cell, and in the case of CA mode for the Primary and Secondary Cells.

  * **Freq** – The cell's frequency in MHz.
  * **BW** – The cell's bandwidth in dBm.
  * **RSRQ** – The cell's RSRQ in dB.
  * **RSRP (dBm)** – The antenna's RSRP in dBm. Displayed for Antenna 0 and Antenna 1.
  * **RSSI (dBm)** – The antenna's RSSI in dBm. Displayed for Antenna 0 and Antenna 1.
* **Alert Thresholds** – Pre-defined limits set in the system to monitor radio signal quality and generate alerts when certain metrics drop below acceptable levels. These thresholds help proactively identify and address connectivity or performance issues with the mesh node.
  * **RSRP Limit** – Reference Signal Received Power (RSRP) indicates the power level of the LTE reference signals received by the antenna. It is a critical measurement for determining coverage quality and cell selection. If the RSRP drops below -90 dB, it implies weak received signal power, which may lead to coverage holes or poor connectivity for the UE.
  * **RSRQ Limit** – Reference Signal Received Quality (RSRQ) is a measure of signal quality, factoring in interference and noise, and is derived from RSRP and Received Signal Strength Indicator (RSSI). When RSRQ falls below -15 dB, it indicates a high level of interference or poor quality of the received signal. This can result in degraded throughput and unreliable connections.
  * **SINR Limit** – Signal-to-Interference-plus-Noise Ratio (SINR) measures the quality of the wireless link by comparing the strength of the desired signal to the level of background interference and noise. SINR below -13 dB suggests severe interference or noise, potentially leading to significant performance degradation, reduced data rates, or dropped connections.
    {% endstep %}

{% step %}
Click the **Analytics** tab.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FWqcLLYkucPBhSX3aWvBW%2Fimage.png?alt=media&amp;token=79c51ddc-7bd1-45d0-b721-0ce2b86b278c" alt=""><figcaption></figcaption></figure>

The Analytics tab displays time-based visualizations of critical radio signal metrics collected from the Mesh Node. It helps monitor signal stability and quality in real time, identify degradations, and take corrective actions.

* **Selected Range** – The time period from which signal metrics are displayed on the analytics plots. Select the time period in the dropdown to the far right.
* **RSRP Signal** – Measures the average power of reference signals received by the Mesh Node from the donor cell. It serves as a primary indicator of coverage strength. Higher RSRP indicates a stronger and more reliable signal. If RSRP falls below certain thresholds, it may signal weak coverage or physical obstructions. This plot displays frequency-based color coding.
  * **Primary/Secondary** – Select the cell's role.
  * **ant0/ant1** – Select the antenna.
* **RSRQ Signal** – Indicates the quality of the received signal (interference and noise in the signal) by combining information on interference and overall signal strength. It is derived using RSRP and RSSI (total received power). Lower (more negative) RSRQ values signify higher interference or noise in the environment, which can degrade throughput and reliability. This plot displays frequency-based color coding.
  * **Primary/Secondary** – Select the cell's role.
* **SINR Signal** – Signal-to-Interference-pus Noise ratio. Measures the ratio of the desired signal strength to the sum of interference and noise. It is a key indicator of overall link quality and expected data rates. Higher SINR values correspond to better radio conditions and higher possible throughput. When SINR drops, it can indicate interference from nearby cells, environmental noise, or hardware faults. This plot displays frequency-based color coding.
* **Check-In Count** – The number of check-in events from the Mesh Node over time, used to monitor node connectivity responsiveness and health.
  {% endstep %}

{% step %}
Click the **Logs** tab.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0IenxJAEZpgH7kbLAHMF%2Fimage.png?alt=media&amp;token=7bab1078-7d31-4814-8c85-e8dbfa38137e" alt=""><figcaption></figcaption></figure>

* **Logs (n)** – The number of logs for the Mesh Node in the selected date and time range.
* **Timestamp** – The date and time when each log entry was recorded.
* **Severity** – The log entry's severity.
* **Message** – The log message.

  To change the date and time range, select the required timestamps in the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQz7fOlIyfrOBx5u8WpeR%2Fimage.png?alt=media&amp;token=9b2b6ecb-e79a-4f01-913f-f111fb34538e" alt="" data-size="line"> fields. The logs list automatically updates to display the corresponding logs.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> Your selections must fall within a seven-day range.</p></div>

  To download the logs in .csv format, in the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQcorBYTM4BFSJEsukhXE%2Fimage.png?alt=media&amp;token=31029dba-9ad0-4579-bca2-79a385b11d42" alt="" data-size="line"> field, enter the number of logs to be included in the .csv file, then click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FA9d0Aek1jV2iPxXuMOWG%2Fimage.png?alt=media&amp;token=edd7a6f0-7ada-421a-857e-c76ec352928d" alt="" data-size="line">. Default value: 5000. The downloaded .csv file includes details such as the timestamp, service, tag, type, and log text.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> You can download a maximum 5000 logs.</p></div>

  To search for a log, in the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FAMro7PwVe8p4zdXFzvqB%2Fimage.png?alt=media&amp;token=e5107389-4ddf-4e70-b698-553e8879afe7" alt="" data-size="line"> field, enter your search term. The logs list automatically updates to display logs containing the term.
  {% endstep %}
  {% endstepper %}

### **View a GM02 Mesh Node's Details**

**To view a GM02 Mesh Node's details:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment > Mesh Node** tab.

The **Equipment** page > **Mesh Node** tab displays the summary details of all Mesh Nodes configured in the network.
{% endstep %}

{% step %}
To view a Mesh Node's details, in the list, click its name.

The ***\<Mesh Node name>*** page > **Overview** tab is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FGxzfjXoB45gqemw6MU4N%2Fimage.png?alt=media&amp;token=4377554d-a3db-48df-afef-2aaaa713598b" alt=""><figcaption></figcaption></figure>

* **Mesh Node Details**:
  * **Name** – The Mesh Node's name.
  * **Serial No.** – The Mesh Node equipment's vendor-assigned serial number.
  * **Venue Name** – The name of the venue hosting the Mesh Node.
  * **Version** – The Mesh Node's software version.
  * **Up Time** – The duration for which the Mesh Node has been continuously operational without any downtime or interruptions.
  * **Mesh AP** – The Mesh AP equipment's vendor-assigned serial number.
  * **Donor AP** – The Mesh Node's donor AP's name.
  * **UUID/Challenge Key** – To view the Mesh Node's Hardware UUID and Challenge Key, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FGvZwgC0GKFBfced72Rsf%2Fimage.png?alt=media&amp;token=64fc321e-0daf-4b1a-960b-f24581baedde" alt="" data-size="line"> (view details).
  * **Hostname** – The Mesh Node's hostname.
  * **Description** – The Mesh Node's description.
  * **Device Class** – The Mesh Node's device class—GM02.
  * **Carrier Mode** – The Mesh Node's carrier mode—Single Carrier, Dual Carrier.
  * **Upgrade Status** – Status of the previous Mesh Node software upgrade.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The <strong>Upgrade Status</strong> parameter is displayed only during an upgrade and for one hour after the upgrade.</p></div>
  * To view the previous upgrade's details, click the status.

    The **Upgrade Status** dialog box displays the following details:

    * **Description** – Description of the last upgrade's status.
    * **Old Version** – The software version before the upgrade.
    * **New Version** – The new software version.
    * **Updated At** – The timestamp at which the last upgrade completed.
    * **Start Time** – The timestamp at which the last upgrade started.
  * **SIM Related Info**:
    * **Active SIM** – The active SIM's status—Disabled, Enabled.
    * **IMSI** – The IMSI number that identifies the SIM within the network.
    * **IMEI** – The IMEI number that uniquely identifies the equipment.
  * Status:
    * **Online** – The Mesh Node's online status.

      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FAbzbqNbYO7NmlXewGVJI%2Fimage.png?alt=media&amp;token=c5dd5d9c-965d-4481-b2ab-af198d8154dd" alt="" data-size="line"> Green – Indicates the Mesh Node is connected to the Onyx Portal, and it last checked-in with the Onyx Portal within the last two minutes.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fu1nutXVi6Tfp1gOIfJvb%2Fimage.png?alt=media&amp;token=1c3d7d9c-1a2f-4a2b-86a8-4673109610ed" alt="" data-size="line"> Red – Indicates the Mesh Node is not connected to the Onyx Portal, and it last checked-in with the Onyx Portal more than two minutes ago.

      To view the last synchronized at timestamp, hover your cursor over the "Online Status" icon.
    * **Interface Status** – The Mesh Node's interface status.

      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FoLV8iD5W3TgUuYIgXaUN%2Fimage.png?alt=media&amp;token=0113329a-8535-436d-81b2-7b073f8d970e" alt="" data-size="line"> Green – Indicates GRE tunnel status is okay, and Mesh AP is online.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FdAWPd8sh3g0hyJezn8I3%2Fimage.png?alt=media&amp;token=2037c4a6-2ae5-49ea-97e6-abf30d5499bc" alt="" data-size="line"> Amber – Indicates the Mesh Node is online, but Mesh AP is offline, and GRE tunnel Status is okay.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FNXEH1vAKvyt5NzQqjT1b%2Fimage.png?alt=media&amp;token=74517e56-d913-4845-9f09-5fe8209a1c7c" alt="" data-size="line"> Red – Indicates the GRE tunnel status is not okay.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fr1wvZ8QEvf5DJi34QgE4%2Fimage.png?alt=media&amp;token=2f261c51-bc39-450c-945c-02603013d323" alt="" data-size="line"> Grey – Indicates the Mesh Node is offline.

      To view the Tunnel status and the Mesh AP Power Up status, hover your cursor over the "Interface Status" icon.
    * **Compute Resource** – The Mesh Node's compute resource status.

      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fygf0GInK9ZDV7hdLEntW%2Fimage.png?alt=media&amp;token=ca9b8818-d748-454e-b611-e72c7dce1540" alt="" data-size="line"> Green – Indicates all parameters are below 50%.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F69xQQ7ZXUOUiaZooQrdq%2Fimage.png?alt=media&amp;token=906a0ea6-b304-4a5a-ab30-9693334c54cf" alt="" data-size="line"> Amber – Indicates at least one parameter is above 50% and below 75%.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FUesJKxm7MPlDWdX0wLQU%2Fimage.png?alt=media&amp;token=040ec475-64a4-419d-9b47-f5c95d7271ca" alt="" data-size="line"> Red – Indicates at least one parameter is above 75%.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FZ44UcRBaO7YMsXACmviG%2Fimage.png?alt=media&amp;token=ce3970db-ba6a-40a2-bcc1-e7c699e7f7a1" alt="" data-size="line"> Grey – Indicates the Mesh Node is offline.

      To view the Disk Utilization, CPU Utilization, and Memory Utilization percentages, hover your cursor over the "Compute Resource Status" icon.
    * **Service Status** – The Mesh Node's service status.

      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FMQ96E9bmft3tndYAxO3C%2Fimage.png?alt=media&amp;token=86437116-8538-429a-af10-8964fae3c13f" alt="" data-size="line"> Green – Mesh AP cell is in a healthy state.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FyfSeiVrScCNyBYwtUsLL%2Fimage.png?alt=media&amp;token=cdb0ff91-6e4b-4e5a-8490-5ce96cb4f9ab" alt="" data-size="line"> Red – Mesh AP cell is in service down state.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FgptpFqtns95XimQZA0Hg%2Fimage.png?alt=media&amp;token=0f3ca6ca-6eaa-4d84-bef0-c3fab0abb471" alt="" data-size="line"> Amber – Mesh AP cell is in unwarranted transmission state.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FF91DaZkfHJnRnjVUlopU%2Fimage.png?alt=media&amp;token=764ab8cf-8db1-4bf5-b3e7-b33aa8ced82b" alt="" data-size="line"> Grey – Mesh AP is offline, or Mesh Node is offline.

      To view the Mesh AP Rf Tx status and the Mesh AP last synchronized at timestamp, hover your cursor over the "Service Status" icon.
* SAS Status – Indicates the Mesh Node's SAS status—Registered, Granted, or Authorized.

  Color coding for "SAS Status" icons:

  * Registered icon:
    * Green – All CBSDs are registered.
    * Amber – Some CBSDs are registered, and some are not registered.
    * Red – No CBSDs are registered.
  * Granted icon:
    * Green – Required number of grants are available.
    * Amber – Some grants are available but not the required number.
    * Red – No grants are available.
    * Grey – No CBSDs are registered.
  * Authorized icon:

    * Green – Required number of grants are authorized.
    * Amber – Some grants are authorized but not the required number.
    * Red – No grants are authorized.
    * Grey – No grants are available.

    The following indicates the Mesh Node's SAS status is fully healthy—all CBSDs are registered, have the necessary grants, and those grants are authorized.

  <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FwjNwM84bF5EsvsHjtCeG%2Fimage.png?alt=media&amp;token=ce9a3dcb-7d75-443b-a521-d815b23805ab" alt=""><figcaption></figcaption></figure>
* **SAS** – The Mesh Node's SAS configuration status—Enabled or Disabled.
  * **BW (MHz)** – The range of frequencies available to the Mesh Node for transmission within the CBRS spectrum.
  * **Max Tx Pwr (dBm)** – The maximum transmission power per antenna port when operating in the CBRS spectrum. Indicates the equipment's compliance with regulatory requirements regarding maximum power emissions to prevent interference with other users of the spectrum.
  * **FCC ID** – The Mesh Node's Federal Communications Commission (FCC) ID. Indicates the equipment's compliance with FCC regulations for operation in the CBRS spectrum.
  * **Single Step Enabled** – Indicates if Single Step CBSD Registration is enabled or disabled—true or false.

    When true (enabled), the CPI provides the device registration information to the CBSD. The CBSD then uses registration requests to send the required information to the SAS.

    When false, (disabled / Multi-step Registration), the CPI sends the device registration information to the SAS. The CBSD then sends a registration request to the SAS. The SAS then combines the information from the SAS Portal and the CBSD to process the registration request.
  * **Grant Expire Time** – The time when the current spectrum grant provided by the SAS ends. It ensures that spectrum usage is temporary and must be renewed, preventing indefinite or unauthorized use.
  * **Heartbeat Interval** – The interval (in seconds) at which the Mesh Node must send heartbeat messages to the SAS. These regular check-ins confirm the Mesh Node remains active and compliant; missed heartbeats can result in the grant to be revoked.
  * **Freq (MHz)** – The Mesh Node's operating frequency within the CBRS spectrum. Frequency refers to the specific radio frequency at which the Mesh Node operates within the CBRS spectrum.
  * **SAS Granted Pwr (dBm)** – The maximum transmit power level (in dBm) authorized by the SAS for the Mesh Node on the assigned frequency. This setting controls signal strength and prevents interference with other spectrum users.
  * **CBSD Category** – The Mesh Node's CBSD category—Category A (devices that operate at maximum 30 dBm EIRP), Category B (devices that operate at maximum 47 dBm EIRP).
  * **User ID** – The SAS account's user ID.
  * **Transmit Expire Time** – The time when the Mesh Node must stop transmitting unless its grant is actively renewed through heartbeats or SAS reauthorization. It acts as a safeguard to automatically end transmissions if SAS approval is lost.
* **Backhaul Status Details** – Indicates how consistent and stable the network connection is.

  * **Backhaul IP** – The backhaul IP address.
  * **Backhaul Filter State** – The backhaul filter state—Low Pass, High Pass.
  * **Mesh AP Filter State** – The Mesh AP filter state—Low Pass, High Pass.

  The following details are displayed in the case of SC mode for Primary cell, and in the case of CA mode for the Primary and Secondary Cells:

  * **Freq** – The cell's frequency in MHz.
  * **BW** – The cell's bandwidth in dBm.
  * **RSRQ** – The cell's RSRQ in dB.
  * **RSRP (dBm)** – The antenna's RSRP in dBm. Displayed for Antenna 0 and Antenna 1.
  * **RSSI (dBm)** – The antenna's RSSI in dBm. Displayed for Antenna 0 and Antenna 1.
* **Alert Thresholds** – Pre-defined limits set in the system to monitor radio signal quality and generate alerts when certain metrics drop below acceptable levels. These thresholds help proactively identify and address connectivity or performance issues with the mesh node.
  * **RSRP Limit** – Reference Signal Received Power (RSRP) indicates the power level of the LTE reference signals received by the antenna. It is a critical measurement for determining coverage quality and cell selection. If the RSRP drops below -90 dB, it implies weak received signal power, which may lead to coverage holes or poor connectivity for the UE.
  * **RSRQ Limit** – Reference Signal Received Quality (RSRQ) is a measure of signal quality, factoring in interference and noise, and is derived from RSRP and Received Signal Strength Indicator (RSSI). When RSRQ falls below -15 dB, it indicates a high level of interference or poor quality of the received signal. This can result in degraded throughput and unreliable connections.
  * **SINR Limit** – Signal-to-Interference-plus-Noise Ratio (SINR) measures the quality of the wireless link by comparing the strength of the desired signal to the level of background interference and noise. SINR below -13 dB suggests severe interference or noise, potentially leading to significant performance degradation, reduced data rates, or dropped connections.
    {% endstep %}

{% step %}
Click the **Analytics** tab.

The **Analytics** tab displays time-based visualizations of critical radio signal metrics collected from the Mesh Node. It helps monitor signal stability and quality in real time, identify degradations, and take corrective actions.

{% hint style="info" %}
**NOTE:** In this release, the Mesh Node Analytics feature is qualified only with GM01 Mesh Nodes. Support for GM02 Mesh Node will be available in an upcoming release.
{% endhint %}

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FWP86XdMSLUqWm7EPVYak%2Fimage.png?alt=media&amp;token=893aab04-1beb-42d6-9ef6-b6590fcd89f5" alt=""><figcaption></figcaption></figure>

* **Selected Range** – The time period from which signal metrics are displayed on the analytics plots. Select the time period in the dropdown to the far right.
* **RSRP Signal** – Measures the average power of reference signals received by the Mesh Node from the donor cell. It serves as a primary indicator of coverage strength. Higher RSRP indicates a stronger and more reliable signal. If RSRP falls below certain thresholds, it may signal weak coverage or physical obstructions. This plot displays frequency-based color coding.
  * **Primary/Secondary** – Select the cell's role.
  * **ant0/ant1** – Select the antenna.
* **RSRQ Signal** – Indicates the quality of the received signal (interference and noise in the signal) by combining information on interference and overall signal strength. It is derived using RSRP and RSSI (total received power). Lower (more negative) RSRQ values signify higher interference or noise in the environment, which can degrade throughput and reliability. This plot displays frequency-based color coding.
  * **Primary/Secondary** – Select the cell's role.
* **SINR Signal** – Signal-to-Interference-pus Noise ratio. Measures the ratio of the desired signal strength to the sum of interference and noise. It is a key indicator of overall link quality and expected data rates. Higher SINR values correspond to better radio conditions and higher possible throughput. When SINR drops, it can indicate interference from nearby cells, environmental noise, or hardware faults. This plot displays frequency-based color coding.
* **Check-In Count** – The number of check-in events from the Mesh Node over time, used to monitor node connectivity responsiveness and health.
  {% endstep %}

{% step %}
Click the **Logs** tab.

* **Logs (n)** – The number of Mesh Node logs in the selected date and time range.
  * **Timestamp** – The date and time when each log entry was recorded.
  * **Service** – The service name or process associated with the log entry.
  * **Type** – The log severity or type (for example, ERR for errors).
  * **Output** – The log message.

    To change the date and time range, select the required timestamps in the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FAjAxxsF4cOH6RdqxQKnl%2Fimage.png?alt=media&amp;token=7b717085-4911-428e-8816-f67d3d6c220c" alt="" data-size="line"> fields. The logs list automatically updates to display the corresponding logs.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> Your selections must fall within a seven-day range.</p></div>

    To download the logs in .csv format, in the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fx6huAdhNvkBOcUydXemE%2Fimage.png?alt=media&amp;token=08e41bf8-548c-4de9-81fe-a5be32e29593" alt="" data-size="line"> field, enter the number of logs to be included in the .csv file, then click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5renisVZXk9quSe3Qn8f%2Fimage.png?alt=media&amp;token=75631532-6cc9-49df-b374-b872409435db" alt="" data-size="line">. Default value: 5000. The downloaded .csv file includes details such as the timestamp, service, tag, type, and log text.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> You can download a maximum 5000 logs.</p></div>

    To search for a log, in the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FGY4x5sch5etMkMuIDD8F%2Fimage.png?alt=media&amp;token=e5549c7c-a6c2-4d8b-8263-802a58bc705c" alt="" data-size="line"> field, enter your search term. The logs list automatically updates to display logs containing the term.
* **DP Logs (n)** – The total number of Domain Proxy (DP) log entries between the selected entities—DP, ACS, CBSD, and SAS—in the selected date and time range.

  The list of DP log events between the selected entities.

  * **Timestamp** – The timestamp at which the log was generated.
  * **From** – The source or origin of the data.
  * **To** – The destination or target of the data.
  * **Type** – The type of the log entry.
  * **Message** – The actual information logged by the system.
    {% endstep %}
    {% endstepper %}

### Register Mesh Node SIM Card

GXC ships Mesh Nodes with one SIM card preinstalled. The Mesh Node's SIM card/IMSI must be activated in the Onyx Portal before the Mesh Node can join the network. The Mesh Node's SIM card/IMSI can be added in the Onyx Portal even before the Mesh Node equipment is powered up.

{% hint style="info" %}
**NOTE:** The IMSI of the SIM Card and the Serial Number of the Mesh Node can be found on the Mesh Node's LCI > **System** page.
{% endhint %}

**To register a Mesh Node in the Onyx Portal:**

{% stepper %}
{% step %}
In the navigation pane, click **Subscribers**.

The **Subscribers** page > **Subscriber** tab displays the list of subscribers and any Mesh Nodes in the network.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Add Subscriber**.

The **Add Subscriber** page is displayed.
{% endstep %}

{% step %}
Enter the following details:

* **Subscriber Name** – (Required) The Mesh Node's name.
* **IMSI** – (Required) The Mesh Node SIM's IMSI number.
* **Auth Key** – (Required) The authentication key.
* **Auth OPC** – (Required) The authentication OPc. Operator Code used to validate the network.
* **Service** – (Required) Select the SIM card's service state—Active or Inactive.
* **Subscriber Groups** – (Required) Select the "Mesh Nodes" subscriber group. For more information on subscriber groups, see *Manage Subscriber Groups*.
* **Add More Subscriber** – Shortcut option to add additional SIM cards/IMSI.
  {% endstep %}

{% step %}
To save the Mesh Node subscriber account, in the upper-right corner of the page, click Save Subscriber.

{% hint style="info" %}
**NOTE:** In the subscriber list and subscriber details, the Mesh Node IMSI's Status will be "Unregistered" until the Mesh Node is powered up and its CPE antenna is pointed correctly to the gateway node.
{% endhint %}
{% endstep %}
{% endstepper %}

## Add Mesh Nodes

* [*Add GM01 Mesh Nodes*](#add-gm01-mesh-nodes)
* [*Add GM02 Mesh Nodes*](#add-gm02-mesh-nodes)

### Add GM01 Mesh Nodes

{% hint style="info" %}
**NOTE:** You can add a Mesh Node only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** The Mesh Node must check in with the Onyx Portal before it can be registered on the network. It must make an attempt to connect first before you can add its serial number. Once it attempts to connect, you can configure the Mesh Node in the system.
{% endhint %}

**To add a GM01 Mesh Node:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **Mesh Node** tab.

The **Equipment** page > **Mesh Node** tab displays the summary details of all Mesh Nodes configured in the network.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Add Node** > **Add Mesh Node**.

The **Create Mesh Node** page > **Mesh Node** tab is displayed.
{% endstep %}

{% step %}
Enter the following details:

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FG46h0sPyLAh5gac6INvv%2Fimage.png?alt=media&amp;token=09169144-3044-4de7-a955-70a272b408f1" alt=""><figcaption></figcaption></figure>

* **Venue** – (Required) Select the venue hosting the Mesh Node.
* **Mesh Node Name** – (Required) The Mesh Node's name.
* **Serial No.** – (Required) The Mesh Node equipment's vendor-assigned serial number. The Provisioning Server uses this serial number to generate and provision the keys required for the Mesh Node to operate with the Onyx Portal.
* **Host Name** – (Optional) The Mesh Node's host name.
* **Device Class** – (Required) The Mesh Node's device class. Select **GM01**. Default value: **GM01**.
* **Description** – (Required) The Mesh Node's description.
  {% endstep %}

{% step %}
Click the **Alert Threshold** tab and enter the following details.

You can configure alert thresholds for the following Mesh Node radio signal quality metrics. When real-time metrics fall below the configured thresholds, alerts trigger automatically enabling timely diagnostics and corrective action.

For information on the corresponding alert rules, see *Semi-Custom Alert Rules*.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8kJlSoO8ZxdCVMVK0OnQ%2Fimage.png?alt=media&amp;token=0231b34e-cc75-4617-8b8e-647bd2dec7a2" alt=""><figcaption></figcaption></figure>

* **RSRP Limit** – (Required) Enter the minimum acceptable RSRP limit in the range of -140—44. RSRP measures the average received signal power. A value below this limit indicates weak coverage or possible connection issues. When this limit is breached, an alert is triggered. Default value: -100.
* **RSRQ Limit** – (Required) Enter the minimum acceptable RSRQ limit in the range of -20—3. RSRQ reflects signal quality, considering strength and interference. A value below this limit indicates poor quality or high interference, which may affect performance. When this limit is breached, an alert is triggered. Default value: -15.
* **SINR Limit** – (Required) Enter the minimum acceptable SINR limit in the range of -20–30. SINR measures signal quality against interference and noise. A value below this limit can cause slow data rates or dropped connections. When this limit is breached, an alert is triggered. Default value: 13.
  {% endstep %}

{% step %}
To save the Mesh Node, in the upper-right corner of the page, click **Save Mesh Node**.
{% endstep %}
{% endstepper %}

### Add GM02 Mesh Nodes

{% hint style="info" %}
**NOTE:** You can add a Mesh Node only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** The Mesh Node must check in with the Onyx Portal before it can be registered on the network. It must make an attempt to connect first before you can add its serial number. Once it attempts to connect, you can configure the Mesh Node in the system.
{% endhint %}

**To add a GM02 Mesh Node:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **Mesh Node** tab.

The **Equipment** page > **Mesh Node** tab displays the summary details of all Mesh Nodes configured in the network.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Add Node** > **Add Mesh Node**.

The **Create Mesh Node** page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fzwt5pxygu4d2AHdxjYcS%2Fimage.png?alt=media&amp;token=ddd0ffc9-015d-43cb-baee-3056d5c72078" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details:

* **Venue** – (Required) Select the venue hosting the Mesh Node.
* **Mesh Node Name** – (Required) The Mesh Node's name.
* **Serial No.** – (Required) The Mesh Node equipment's vendor-assigned serial number. The Provisioning Server uses this serial number to generate and provision the keys required for the Mesh Node to operate with the Onyx Portal.
* **Host Name** – (Optional) The Mesh Node's host name.
* **Device Class** – (Required) The Mesh Node's device class. Select **GM02**. Default value: **GM01**.
* **Description** – (Required) The Mesh Node's description.
* **Carrier Mode** – (Required.) Select the Mesh Node's carrier mode from **Single Carrier**, **Dual Carrier**, or **Carrier Aggregation**.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The available carrier mode options depend on the specific equipment and is based on the serial number entered in the <strong>Serial No.</strong> field.</p></div>

  <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FRY2dkA638U8QSRgs3BzZ%2Fimage.png?alt=media&amp;token=0c34b090-3610-4f0f-952b-3a723619047c" alt=""><figcaption></figcaption></figure>
* **CBSD Configuration**:
  * **FCC ID** – (Optional) The Mesh Node's Federal Communications Commission (FCC) ID. Indicates the equipment's compliance with FCC regulations for operation in the CBRS spectrum.
  * **User ID** – (Optional) The SAS account's user ID.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> To obtain the SAS user ID, contact GXC Technical Support.</p></div>
  * **Max Pwr** – (Required) The maximum output power of the equipment when operating in the CBRS spectrum. Indicates the equipment's compliance with regulatory requirements regarding maximum power emissions to prevent interference with other users of the spectrum.
    {% endstep %}

{% step %}
Click the **Alert Threshold** tab and enter the following details.

You can configure alert thresholds for the following Mesh Node radio signal quality metrics. Alerts trigger automatically when real-time metrics fall below the configured thresholds, enabling timely diagnostics and corrective action.

For information on the corresponding alert rules, see *Semi-Custom Alert Rules*.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FwC52giVNBJahO1JkAQqg%2Fimage.png?alt=media&amp;token=ea5d6b90-9af2-4645-9078-26b6a70e9772" alt=""><figcaption></figcaption></figure>

* **RSRP Limit** – (Required) Enter the minimum acceptable RSRP limit in the range of -140—44. RSRP measures the average received signal power. A value below this limit indicates weak coverage or possible connection issues. When this limit is breached, an alert is triggered. Default value: -100.
* **RSRQ Limit** – (Required) Enter the minimum acceptable RSRQ limit in the range of -20—3. RSRQ reflects signal quality, considering strength and interference. A value below this limit indicates poor quality or high interference, which may affect performance. When this limit is breached, an alert is triggered. Default value: -15.
* **SINR Limit** – (Required) Enter the minimum acceptable SINR limit in the range of -20–30. SINR measures signal quality against interference and noise. A value below this limit can cause slow data rates or dropped connections. When this limit is breached, an alert is triggered. Default value: 13.
  {% endstep %}

{% step %}
To save the Mesh Node, in the upper-right corner of the page, click **Save Mesh Node**.
{% endstep %}
{% endstepper %}

## Edit Mesh Nodes

* [*Edit GM01 Mesh Nodes*](#edit-gm01-mesh-nodes)
* [*Edit GM02 Mesh Nodes*](#edit-gm02-mesh-node)

### Edit GM01 Mesh Nodes

{% hint style="info" %}
**NOTE:** You can edit Mesh Node details only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** When editing a Mesh Node's details, you can either edit its serial number or edit the rest of its editable parameters. If you edit the serial number, the other parameters will be read-only.
{% endhint %}

**To edit a GM01 Mesh Node's details:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **Mesh Node** tab.

The **Equipment** page > **Mesh Node** tab displays the summary details of all Mesh Nodes configured in the network.
{% endstep %}

{% step %}
For the Mesh Node that you want to edit, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F2B1Kb2otIgLfYffZVAaT%2Fimage.png?alt=media&amp;token=415d6979-3b1a-4e80-adf8-60c0569ad005" alt="" width="110"><figcaption></figcaption></figure>

The **Edit Mesh Node** page displays the node's details.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXuVAfltnT4VKuhk6ACqV%2Fimage.png?alt=media&amp;token=0b21536c-a279-498d-9232-cabf6b0dae49" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Edit the following details as required:

* **Venue** – (Read only) The name of the venue hosting the Mesh Node.
* **Mesh Node Name** – (Required) The Mesh Node's name.
* **Serial No.** – (Required) The Mesh Node equipment's vendor-assigned serial number. To edit the serial number, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fk3qQE9wLufBN9iqCJhhX%2Fimage.png?alt=media&amp;token=1e47f66b-4eed-4065-b52e-13b4bcc5dc0f" alt="" data-size="line"> then edit the serial number and save the Mesh Node.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> When editing a Mesh Node's details, you can either edit its serial number or rest of its editable parameters. If you edit the serial number, the other parameters will be view only.</p></div>
* **Host Name** – (Optional) The Mesh Node's host name.
* **Device Class** – (Read only) The Mesh Node's device class.
* **Description** – (Required) The Mesh Node's description.

  You can configure alert thresholds for the following Mesh Node radio signal quality metrics. When real-time metrics fall below the configured thresholds, alerts trigger automatically enabling timely diagnostics and corrective action.
  {% endstep %}

{% step %}
Click the **Alert Threshold** tab and edit the following details as required.

You can configure alert thresholds for the following Mesh Node radio signal quality metrics. When real-time metrics fall below the configured thresholds, alerts trigger automatically enabling timely diagnostics and corrective action.

For information on the corresponding alert rules, see *Semi-Custom Alert Rules*.

* **RSRP Limit** – (Required) Enter the minimum acceptable RSRP limit. RSRP measures the average received signal power. A value below this limit indicates weak coverage or possible connection issues. When this limit is breached, an alert is triggered. Default value: -100.
* **RSRQ Limit** – (Required) Enter the minimum acceptable RSRQ limit. RSRQ reflects signal quality, considering strength and interference. A value below this limit indicates poor quality or high interference, which may affect performance. When this limit is breached, an alert is triggered. Default value: -15.
* **SINR Limit** – (Required) Enter the minimum acceptable SINR limit. SINR measures signal quality against interference and noise. A value below this limit can cause slow data rates or dropped connections. When this limit is breached, an alert is triggered. Default value: 13.
  {% endstep %}

{% step %}
To save your edits, in the upper-right corner of the page, click **Save Mesh Node**.
{% endstep %}
{% endstepper %}

#### Edit GM02 Mesh Node

{% hint style="info" %}
**NOTE:** You can edit Mesh Node details only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** When editing a Mesh Node's details, you can either edit its serial number or edit the rest of its editable parameters. If you edit the serial number, the other parameters will be read-only.
{% endhint %}

**To edit a GM02 Mesh Node's details:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **Mesh Node** tab.

The **Equipment** page > **Mesh Node** tab displays the summary details of all Mesh Nodes configured in the network.
{% endstep %}

{% step %}
For the Mesh Node that you want to edit, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FlKJ6uBI03EXVxWrkNTTo%2Fimage.png?alt=media&amp;token=e61f4dcf-fc79-4974-b9b8-bb8e608694c9" alt="" width="110"><figcaption></figcaption></figure>

The **Edit Mesh Node&#x20;*****\<Mesh Node name>*** page displays the node's details.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FV3LkPUikI8yX2xgGnyS1%2Fimage.png?alt=media&amp;token=3968e7d9-c554-494c-893d-899704adf470" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Edit the following details as required:

* **Venue** – (Read only) The name of the venue hosting the Mesh Node.
* **Mesh Node ID** – (Read only) The Mesh Node’s ID.
* **Mesh Node Name** – (Required) The Mesh Node’s name.
* **Serial No.** – (Required) The Mesh Node equipment’s vendor-assigned serial number. To edit the serial number, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmRQYFZv0EBAi7yIfRJRa%2Fimage.png?alt=media&amp;token=fb19f041-f29f-4dc4-9309-d36545150bf1" alt="" data-size="line"> then edit the serial number and save the Mesh Node.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> When editing a Mesh Node’s details, you can either edit its serial number or rest of its editable parameters. If you edit the serial number, the other parameters will be view only.</p></div>
* **Host Name** – (Optional) The Mesh Node’s host name.
* **Device Class** – (Read only) The Mesh Node’s device class.
* **Description** – (Required) The Mesh Node’s description.
* **Carrier Mode** – (Required) The Mesh Node’s carrier mode. Select from **Single Carrier** or **Dual Carrier**.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The available carrier mode options depend on the specific equipment and is based on the serial number entered in the Serial No. field.</p></div>
* **CBSD Configuration**
  * **User ID** – (Optional) The SAS account’s user ID.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> To obtain the SAS user ID, contact GXC Technical Support.</p></div>
* **Max Pwr** – (Required) The maximum output power of the equipment when operating in the CBRS spectrum. Indicates the equipment’s compliance with regulatory requirements regarding maximum power emissions to prevent interference with other users of the spectrum.
  {% endstep %}

{% step %}
Click the **Alert Threshold** tab and edit the following details as required.

You can configure alert thresholds for the following Mesh Node radio signal quality metrics. When real-time metrics fall below the configured thresholds, alerts trigger automatically enabling timely diagnostics and corrective action.

For information on the corresponding alert rules, see *Semi-Custom Alert Rules*.

* **RSRP Limit** – (Required) Enter the minimum acceptable RSRP limit. RSRP measures the average received signal power. A value below this limit indicates weak coverage or possible connection issues. When this limit is breached, an alert is triggered. Default value: -100.
* **RSRQ Limit** – (Required) Enter the minimum acceptable RSRQ limit. RSRQ reflects signal quality, considering strength and interference. A value below this limit indicates poor quality or high interference, which may affect performance. When this limit is breached, an alert is triggered. Default value: -15.
* **SINR Limit** – (Required) Enter the minimum acceptable SINR limit. SINR measures signal quality against interference and noise. A value below this limit can cause slow data rates or dropped connections. When this limit is breached, an alert is triggered. Default value: 13.
  {% endstep %}

{% step %}
To save your edits, in the upper-right corner of the page, click **Save Mesh Node**.
{% endstep %}
{% endstepper %}

## Reboot Mesh Nodes

**To reboot a Mesh Node:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **Mesh Node** tab.

The **Equipment** page > **Mesh Node** tab displays the summary details of all Mesh Nodes configured in the network.
{% endstep %}

{% step %}
For the Mesh Node that you want to reboot, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **View**.

The ***\<Mesh Node name>*** page is displayed.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Actions > Reboot**.

A confirmation dialog box is displayed.
{% endstep %}

{% step %}
To confirm rebooting the Mesh Node, click **Yes**.
{% endstep %}
{% endstepper %}

## Delete Mesh Nodes

{% hint style="info" %}
**NOTE:** You can delete a Mesh Node only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

**To delete a Mesh Node:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **Mesh Node** tab.

The **Equipment** page > **Mesh Node** tab displays the summary details of all Mesh Nodes configured in the network.
{% endstep %}

{% step %}
For the Mesh Node that you want to delete, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Delete**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8a5RvLCx9bqGqQsS1I9I%2Fimage.png?alt=media&amp;token=825b1a9c-967c-4393-a2cd-c361f1ec71e5" alt="" width="110"><figcaption></figcaption></figure>

A confirmation dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FSmRbhF1rmKkNxiJ8uIMk%2Fimage.png?alt=media&amp;token=718b1f5c-dd8e-43f2-9265-c379043ceb88" alt="" width="407"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To confirm deleting the Mesh Node, click **Yes.**
{% endstep %}
{% endstepper %}


# Manage DAS

This section describes GXC's Distributed Antenna System (DAS) solution and explains how to add and manage DAS equipment.

A DAS is a network of antennas connected to a common signal source that optimizes cellular coverage and signal quality within buildings or large facilities. Integrated with the GXC Onyx 4G Platform, the DAS extends cellular coverage across large indoor and outdoor environments where a single Access Point cannot provide adequate signal strength or capacity.

GXC's DAS solution supports both Active DAS and Passive DAS architectures, offering flexible deployment options to address a wide range of venue and performance requirements.

* **Active DAS** – In an Active DAS configuration, the signal from a GXC AP is distributed via fiber optics (RF over Fiber) to multiple Transmission Points (TPs). This architecture enables precise power management, improved signal quality, and minimal loss across long distances. Active DAS is supported in conjunction with Wilson DAS (pre-configured Wilson Electronics systems) as well as generic DAS (third-party systems requiring manual configuration).
* **Passive DAS** – In a Passive DAS configuration, the AP's signal is distributed through coaxial cabling and passive components such as splitters and couplers. Passive DAS provides a cost-effective option for smaller or less complex deployments where fiber distribution is not necessary. Passive DAS is supported in conjunction with generic DAS equipment.

Both architectures operate under full SAS coordination and leverage the Onyx Edge for power and grant management.

By combining these architectures, GXC's DAS solution allows network planners to select the optimal design to meet specific venue size, RF conditions, and infrastructure constraints. This flexible implementation ensures consistent, high-quality coverage while maintaining full coordination with the SAS through the Onyx Edge and Domain Proxy.

## System Architecture

A GXC DAS deployment consists of three primary components:

* **Signal Source** – The GXC AP serves as the signal source for the DAS. It is responsible for generating the cellular signal and controlling the overall system power based on SAS grants.

{% hint style="info" %}
**NOTE:** The GXC AP must be a G501 unit operating in either Single Carrier mode or Carrier Aggregation mode.
{% endhint %}

* **DAS Equipment** – The DAS equipment distributes the signal from the GXC AP using a constant gain configured during commissioning. GXC's DAS solution supports both Active DAS and Passive DAS architectures, enabling flexible integration with different vendor systems and deployment requirements.
  * **Wilson DAS** – Pre-configured Wilson Electronics equipment that supports Active DAS deployments. It uses RF over Fiber for signal distribution and is optimized for high-performance, low-loss environments.
  * **Generic DAS** – Third-party equipment that supports either Active or Passive DAS deployments. It requires manual configuration during setup and can be adapted to suit venue-specific coverage, cabling, and power requirements.
* **Transmission Points (TPs)** – Distributed antenna endpoints that transmit signals to user devices in their coverage area. Each TP is registered as an individual CBSD with the SAS and represents an individual radiating element in the DAS system with typical DAS deployments consisting of tens to hundreds of TPs.

{% hint style="info" %}
**NOTE:** TPs are created and registered as CBSDs only after the DAS is associated with an AP. The TP configuration automatically inherits frequency and bandwidth from the associated AP. All TPs in a DAS deployment operate using the same frequency and bandwidth as the associated AP. Any updates to AP frequency or bandwidth automatically apply to all associated TPs.
{% endhint %}

{% hint style="info" %}
**NOTE:** In CBRS and WinnForum documentation, DAS Remote Antenna Units are referred to as "Transmission Points". This document consistently uses "Transmission Point" / "TP" to describe the individual antenna endpoints in the DAS system.
{% endhint %}

### **Active DAS**

<p align="center"><strong>GXC DAS Architecture in Active DAS Configuration</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FPV0xBhCRAXhR518WMpde%2Fimage.png?alt=media&amp;token=90172b7f-6dad-4dd6-b61d-7e7f132242e5" alt="" width="563"><figcaption></figcaption></figure></div>

The Active DAS configuration extends the GXC network by distributing the AP's signal via RF over Fiber to multiple TPs. In this setup, the GXC AP connects to the DAS Head End via RF coax, where the signal is actively amplified and converted for optical fiber transport. The fiber distribution minimizes signal loss and ensures high-quality transmission across long distances and multiple floors.

Each TP receives a precisely controlled signal and rebroadcasts it to user devices within its coverage area. The Onyx Edge integrates with the Onyx Portal and Domain Proxy, providing centralized configuration, monitoring, and coordination with the SAS.

Active DAS is typically used in large or complex venues where:

* Long-distance signal distribution or multi-floor coverage is required
* Fiber-based infrastructure is available
* Enhanced power management and low-loss amplification are needed

Supported DAS equipment:

* Wilson DAS – Pre-configured Active DAS solution optimized for high-performance distribution.
* Generic DAS – Manually configured third-party systems that can operate in Active DAS mode using RF over Fiber transport.

This architecture enables scalable, high-performance indoor coverage with precise power control, centralized management, and full SAS compliance.

### **Passive DAS**

<p align="center"><strong>GXC DAS Architecture in Passive DAS Configuration</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FIctPZNmx39H3Z2UUYEGP%2Fimage.png?alt=media&amp;token=7fe8e770-d139-48e1-8a39-38028d019f71" alt="" width="563"><figcaption></figcaption></figure></div>

In a Passive DAS configuration, the GXC AP provides the cellular signal that is distributed through RF coaxial cabling and passive components such as splitters, couplers, and taps to multiple TPs within the building. Unlike Active DAS, this design does not rely on optical fiber or active amplification—instead, it leverages signal splitting and attenuation control for simpler and cost-effective deployment.

Each TP radiates the RF signal within its coverage zone without active electronics or powered amplifiers. The Onyx Edge connects to the Onyx Portal and SAS Domain Proxy, ensuring consistent management, configuration, and SAS coordination across the system.

Passive DAS is best suited for:

* Small to medium-sized venues
* Single-floor or compact layouts
* Installations with shorter cable runs where fiber distribution is not necessary

Supported DAS equipment:

* Generic DAS – Third-party systems configured manually to operate in either Active or Passive mode, suitable for cost-sensitive or smaller-scale deployments.

This architecture provides an efficient and economical solution for environments where basic signal distribution is sufficient to achieve reliable in-building coverage.

### DAS Deployment Considerations

DAS is ideal for large, complex indoor environments where radio frequency signals face significant propagation challenges, including multi-floor buildings with concrete or steel construction, hospitals, hotels, underground facilities, and areas with substantial wall penetration and signal attenuation. DAS excels when centralized signal distribution is preferred, physical constraints require discreet antenna placement, or when remote antenna locations lack power or network connectivity.

Multiple APs work best for open environments, smaller facilities, and situations where capacity is the primary driver. APs allow independent coverage with full backhaul capacity, enable effective load balancing, and provide flexibility for phased rollouts. For deployments under 50,000 square feet or when budget constraints favor lower initial capital expense, multiple APs typically provide better value than DAS infrastructure.

A hybrid approach often delivers optimal results in complex environments. Large campuses might use APs for outdoor coverage while deploying DAS within large structures or use APs for open areas and DAS for challenging RF environments. The decision depends on building construction density, coverage area complexity, power and backhaul availability, RF obstacles, user capacity requirements, and aesthetic considerations.

#### **Capacity Planning**

The number of TPs in a deployment varies by venue size:

* Small venues under 20,000 square feet may need 2-4 points.
* Medium venues (20,000-100,000 sq ft) may need 4-8 points.
* Large venues (100,000-500,000 sq ft) may need 8-20 points.
* Very large venues may need 20 or more points.

Coverage per TP ranges from 5,000-12,000 square feet for dense indoor spaces to 50,000-100,000 square feet for outdoor areas.

Critical factors include building materials, floor plan complexity, target signal strength, user density, and power constraints. Capacity-wise, light usage supports 30-50 users per point, moderate usage handles 20-30 users, and heavy usage supports 10-20 users. Never deploy fewer than two TPs, plan infrastructure for 25-50% growth, and monitor for red flags like signal strength below -90 dBm, frequent drops, or more than 30-40 concurrent users per point.

#### **How DAS Power Control Works**

The GXC DAS system uses cascading power control architecture:

> Power Flow: GXC Access Point > DAS Head End > TPs

The DAS equipment operates with constant gain, meaning changes to the AP's output power results in proportional changes to all TP output powers. For example:

* AP's configured output: 24 dBm
* DAS constant gain: Variable per installation
* Target TP output: 21 dBm

**How It Works:**

1. During commissioning, the DAS vendor configures the DAS to produce the desired output power at each TP when the AP transmits at the expected level (e.g., 24 dBm).
2. Each TP requests a grant from the SAS for its desired power level.
3. The system adjusts the AP's power level based on the lowest grants received from SAS.
4. All TPs respond proportionally to the AP's power changes.

   The power control system operates based on the following technical principles:

   * **Target Power Specification** – Target power for each TP is specified as the combined TP output power and antenna gain, measured at the antenna input. Cable losses are accounted for in the target power configuration to ensure accurate power delivery. During DAS commissioning, amplifiers are configured to achieve the target power when the AP operates at maximum output. This approach ensures that each TP delivers the appropriate signal strength to its coverage area while maintaining compliance with SAS grant limits.
   * **Power Calculation** – The Onyx Edge monitors grant status for each TP and calculates the required AP power based on the lowest granted TP power levels. This calculation accounts for cable loss, antenna gains, and amplifier configuration to ensure accurate power distribution throughout the system. A linear relationship between AP output and TP output is maintained, allowing the Onyx Edge to dynamically adjust transmission power while preserving proportional signal strength across all TPs in the coordinated transmitter group.
   * **All-or-None Operation** – The GXC system operates in an "all-or-none" mode due to its shared signal architecture, where all TPs receive the same signal source from the AP without individual power control capability. This means that all TPs in the system must have valid grants before any transmission can occur; if even one TP lacks authorization, the entire system remains offline and does not radiate. To maintain compliance across all TPs, the AP adjusts its power to ensure that the most restrictive TP grant is not exceeded, effectively allowing the lowest-authorized power level to govern the entire coordinated transmitter group.

#### **Grant Management Overview**

Each TP must receive an individual SAS grant, and all TPs must be granted access to the same channel. If any TP fails to obtain or maintain a valid SAS grant, the entire DAS system stops transmission to ensure regulatory compliance.

The entire DAS system operates at the power level determined by the lowest grant received by any TP.

**Example Scenario:**

* 10 TPs in the system
* 9 TPs receive grants for 21 dBm
* 1 TP receives a grant for 19 dBm (2 dB less than requested)

**System Response:**

* AP power reduced from 24 dBm to 22 dBm (2 dB reduction)
* All 10 TPs now operate at 2 dB below their configured target power
* 9 TPs operate at 19 dBm
* 1 TP operates at 17 dBm

This ensures the restricted TP does not exceed its granted power while maintaining system operation.

#### **AP Grant Coordination**

The GXC AP itself does not require a SAS grant as it transmits via cable to the DAS Head End rather than over-the-air. However, the AP must coordinate with all TP grants, as the Onyx Edge monitors grant status for every associated TP by serial number. The AP cannot transmit until all TPs receive authorization from the SAS, and all TPs must be granted on the same frequency channel, though they may receive different power levels within that channel. To ensure compliance, the AP adjusts its power to accommodate the lowest grant received among all TPs.

#### **Coordinated Transmitter Group**

All TPs associated with a single AP form a coordinated transmitter group that operates as a unified transmission unit for grant purposes. Within this group, all TPs must operate on the same channel, though individual TPs can have different power levels as granted by the SAS. This coordinated approach ensures that the DAS system functions cohesively while allowing for site-specific power adjustments based on coverage requirements and regulatory authorizations.

#### **Grant Failure Behavior**

If any single TP fails to receive a grant, the entire DAS system is immediately muted, the GXC AP ceases transmission, and all TPs become non-operational. The system will indicate grant failures, ensuring FCC compliance and preventing unauthorized spectrum usage.

#### **Registration Process**

The GXC DAS solution uses two-step registration for all TPs, consistent with the AP registration process:

1. **Registration** – The TP registers with the SAS through the Domain Proxy (DP). During this process, the system provides the CBSD identification and parameters, which the SAS then validates and acknowledges to complete the registration. The SAS registration process is Multi-Step registration, requiring user input.
2. **Grant Request** – The TP requests a spectrum grant specifying the desired power and frequency parameters. The SAS evaluates these requests based on interference and regulatory constraints, then issues a grant with approved parameters, which may differ from those originally requested.

#### **Category Assignment**

Each TP is registered as a CBSD with a category determined by its Effective Isotropic Radiated Power (EIRP):

* **Category A** – Lower power devices, typically for indoor use
* **Category B** – Higher power devices for indoor or outdoor use

TPs in a DAS system can have different categories (A or B), provided each TP's maximum EIRP does not exceed its certified hardware limit.

#### **Location Requirements**

Each TP must be registered with coordinates corresponding to its fixed physical antenna location. Accurate location data is required for SAS interference analysis.

#### **Same Channel Requirement**

All TPs in a DAS system must operate on the same frequency channel. Channel consistency is enforced during grant requests. Different power levels are permitted within the same channel.

### **Bulk Provision TPs**

To simplify operations, Onyx Portal supports bulk provisioning of TPs. The TP Bulk Provisioning feature uses a comma-separated values (CSV) file containing the details required to configure new TPs. You can obtain a sample CSV data file from GXC Technical Support. The CSV file can be edited in Microsoft Excel or any text editor.

The CSV data file requires the following information for each TP:

* Name – (Required) TP's identifier.
* Serial Number – (Required) The TP equipment's vendor-assigned serial number.
* Antenna Gain (dBi) – (Required) Antenna RF gain value (integer ≤ 128).
* Max Power (dBm) – (Required) Maximum transmit power (integer 0-30).

## **View DAS Details**

This section describes how to view summary and detailed information of existing DAS equipment:

* [*View Summary Details of All DAS*](#view-summary-details-of-all-das)
* [*View Details of a DAS*](#view-details-of-a-das)

### **View Summary Details of All DAS**

**To view the summary details of all DAS equipment configured in the network:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **DAS** tab.

The **Equipment** page > **DAS** tab displays the summary details of all DAS equipment configured in the network.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FEV91ZoyMFtOKlqNkiE0T%2Fimage.png?alt=media&amp;token=b3ed1d8a-824b-45a8-b107-675376173bba" alt=""><figcaption></figcaption></figure></div>

* **Name** – The DAS equipment's name.
* **Venue** – The venue hosting the DAS equipment.
* **Device Class** – The DAS equipment's type/model.
* **Transmission Points** – The number of TPs connected to the DAS.
* **Access Point** – The cellular AP that serves as the signal source (Gateway AP).
* **Actions** – Shortcut menu options to view details, edit, and delete a DAS equipment.
  {% endstep %}
  {% endstepper %}

### **View Details of a DAS**

**To view details of a particular DAS equipment:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **DAS** tab.

The **Equipment** page > **DAS** tab displays the summary details of all DAS configured in the network.
{% endstep %}

{% step %}
To view the details of a particular DAS, click its name.

The ***\<DAS name>*** page displays the DAS equipment's details.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8gIKBzFNF2nSi6Ooc37I%2Fimage.png?alt=media&amp;token=28ec4fdf-9886-4b25-a4d7-427042104d34" alt=""><figcaption></figcaption></figure></div>

* **Overview** tab:
  * **DAS Details**:
    * **Name** – The DAS equipment's name.
    * **Serial** – The DAS equipment's vendor-assigned hardware serial number.
    * **Description** – The DAS equipment's description.
    * **Venue** – The venue hosting the DAS equipment.
    * **Device Class** – The DAS equipment's type/model.
    * **Access Point** – The associated AP's name.
  * **Transmission Points**:
    * **User ID** – Registration identifier in CBSD registration process.
      * **Registration Type** – The CBSD registration process type—**Multi-Step** (Manual registration process).
    * **Name** – TP's name.
    * **Serial Number** – TP's vendor-assigned hardware serial number.
    * **Antenna Gain** – RF gain in dBi.
    * **Max Pwr** – Maximum transmit power in dBm.
    * **State** – TP's SAS grant status:
      * **Registered** – TP has successfully registered with SAS but has not yet requested a grant.
      * **Granted** – SAS has approved a spectrum grant for this TP with specific power and frequency parameters.

        Note that Registered or Granted states are transitional; if a TP remains in Registered or Granted state for more than 5 minutes, review the Logs tab for potential issues with SAS communication.
      * **Authorized** – TP has an active grant and is permitted to transmit (operational state).

        Note that all TPs must be in Authorized state for system operation.
      * **Failed** – Grant request was denied or revoked; TP cannot operate.

        Note that if any single TP shows Failed, the entire DAS system is muted.
      * **Details** – To view a CBSD's details, click the corresponding ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FeCmJ6XO5ZMN3GPtaeixR%2Fimage.png?alt=media\&token=6e361534-69c7-4961-85b3-da8c9743880c) icon.

        The **CBSD Details** dialog box is displayed.

        <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FjqhE1GBCmTtfPv87U71h%2Fimage.png?alt=media&amp;token=e5b791ff-01d6-48b8-be62-f5bfc714f5e0" alt=""><figcaption></figcaption></figure></div>

        * CBSD Status – The CBSD's current SAS registration status, showing progression through Registered > Granted > Authorized stages.
          * **Registered** – CBSD has registered with SAS.
          * **Granted** – SAS has granted spectrum access.
          * **Authorized** – CBSD is authorized to transmit.
        * **SAS Configuration**:
          * **CBSD Category** – Classification type.
            * B – Indoor/enterprise category
          * **User ID** – Registration identifier.
          * **Desired State** – Target operational state.
          * **Antenna Gain (dBi)** – RF antenna gain in dBi.
          * **No. of Antennas** – Number of antenna elements.
          * **Preferred Min Pwr (dBm)** – Minimum operating power in dBm.
          * **Preferred Max Pwr (dBm)** – Maximum operating power in dBm.
          * **Preferred BW (MHz)** – Channel bandwidth in MHz.
          * **Preferred Frequencies (MHz)** – Operating frequency in MHz.
          * **Strict Preference** – Whether parameters specified are strict requirements.
        * **SAS Status**:
          * **FCC ID** – Federal Communications Commission identifier. Identifies the certified radio hardware used by the TP. For Wilson DAS, predefined. For Generic DAS, provided during configuration.
          * **No. of Grants** – Number of spectrum grants received.
          * **AP to DP Connection** – Whether connected to domain proxy.
          * **Current State** – Operational status – Registered, Granted, Authorized.
            {% endstep %}

{% step %}
Click the **Logs** tab.

The **Logs** tab displays communication logs for the selected TP and between the selected entities—Domain Proxy (DP), Citizens Broadband Radio Service Devices (CBSDs/TPs), and the Spectrum Access System (SAS). Use these logs to:

* Troubleshoot specific TP – Select a problematic TP to view its registration, grant, and heartbeat history.
* Compare TP behavior – Switch between different TPs to compare their log patterns.
* Isolate configuration changes – View logs for a newly added or recently modified TP.
* Monitor Performance – Track the communication pattern for a specific TP over time.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FHobfV5b8ItyBjveNpr3j%2Fimage.png?alt=media&amp;token=60794786-f61b-4ebd-959f-1ca2a66e9b92" alt=""><figcaption></figcaption></figure></div>

* **DP Logs (n)** – Displays, within parenthesis, the total number of DP log entries currently shown.
* **Transmission Point** – The specific TP for which log entries are displayed. The **Transmission Point** filter works in conjunction with the **From** and **To** dropdowns, allowing users to narrow down logs. For example:

  * Transmission Point: das\_tp1
  * From: DP
  * To: CBSD

  This combination would show only messages sent from the DP to the specific TP das\_tp1.
* **From** – The source entity that sent the message—DP, CBSD, SAS.
* **To** – The destination entity that received the message—DP, CBSD, SAS.
* DP Logs table:
  * **Timestamp** – Date and time when the log entry was recorded, displayed in MM/DD/YYYY, HH:MM:SS format.
  * **From** – The source entity that sent the message—DP, CBSD, SAS.
  * **To** – The destination entity that received the message—DP, CBSD, SAS.
  * **Type** – The type of SAS protocol message or operation.
  * **Message** – Detailed message content containing the complete protocol exchange data.
    {% endstep %}
    {% endstepper %}

## **Add DAS**

This section describes how to add a DAS to your network.

{% hint style="info" %}
**NOTE:** You can add DAS only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

**To add a DAS:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **DAS** tab.

The **Equipment** page > **DAS** tab displays the summary details of all DAS configured in the network.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Add Node** > **Add DAS**.

The **Create DAS** page > **DAS** tab is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FAN0m53gaoldyUMEI398h%2Fimage.png?alt=media&amp;token=f5badbb8-f10f-4942-8711-e3e32ed12269" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

* **Venue** – (Required) The venue hosting the DAS equipment.
* **Name** – (Required) The DAS equipment's name. The name must be an alphanumeric value of maximum 32 characters.
* **Serial Number** – (Required) The DAS equipment's vendor-assigned hardware serial number.
* **Description** – (Required) Enter notes or details about the DAS equipment or the deployment. The description must be an alphanumeric value of maximum 128 characters.
* **Device Class** – (Required) The DAS equipment's type/model:
  * **Wilson DAS** – Wilson Electronics-manufactured DAS equipment with pre-configured specifications.
  * **Generic DAS** – Third-party DAS equipment requiring manual configuration.
    {% endstep %}

{% step %}
At the lower-right corner of the page, click **Configure Transmission Points**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FhZOUJzwZ35Vd58Hl8mLt%2Fimage.png?alt=media&amp;token=472d433e-c17c-48f6-a55e-0a090a6ef6ee" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

* **User ID** – Unique identifier for registering with the SAS. Enter an alphanumeric value of maximum 32 characters.
* **Registration Type** – (Required) The CBSD registration process type. Default: **MultiStep**.
* **FCC ID** – The Federal Communications Commission identifier for the equipment.
* Add TPs:
  * **To add one TP at a time:**
    1. Select the **Manual Add** radio button, then click **+ Add Transmission Point**.

       The **Add Transmission Point** dialog box is displayed.<br>

       <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fc2vWmcyuoIczA0i0JS65%2Fimage.png?alt=media&amp;token=4906f983-147b-4d0f-84cb-7355227cf657" alt=""><figcaption></figcaption></figure></div>
    2. Enter the following details:
       * **Name** – TP identifier.
       * **Serial Number** – (Required) The TP equipment's vendor assigned serial number.
       * **Antenna Gain (dBi)** – (Required) Antenna RF gain value in dBi. Enter an integer value less than or equal to 128.
       * **Max Pwr (dBm)** – (Required) Maximum transmit power in dBm. Enter an integer value in the range of 0–30.
    3. To save the TP, click **Save**.
    4. To add additional TPs, repeat Steps 1–3.
  * **To bulk provision TPs:**
    1. Select the **Upload CSV** radio button, then click **Upload CSV**.
    2. Select the csv file to upload and submit it. For more information, see [*Bulk Provision TPs*](#bulk-provision-tps).
* TP table: Empty unless at least one TP has already been added.
  * **Name** – TP identifier.
  * **Serial Number** – The TP equipment's vendor-assigned serial number.
  * **Antenna Gain** – RF gain value in dBi for each antenna.
  * **Max Pwr** – Maximum transmit power in dBm for each TP.
  * **Actions** – Options to edit and delete TPs.
    {% endstep %}

{% step %}
To save the DAS, in the upper-right corner of the screen, click **Save DAS**.
{% endstep %}
{% endstepper %}

## Edit DAS

This section describes how to edit a DAS.

{% hint style="info" %}
NOTE: You can edit DAS only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
NOTE: Editing an active DAS may cause service interruption. Changes to TPs, power settings, or registration parameters will require the TPs to re-register with the SAS and obtain new grants. During this process (typically 5–10 minutes), the DAS system will not provide coverage. Schedule configuration changes during maintenance windows when possible.
{% endhint %}

**To edit a DAS:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **DAS** tab.

The **Equipment** page > **DAS** tab displays the summary details of all DAS configured in the network.
{% endstep %}

{% step %}
For the DAS equipment that you want to edit, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0e2cIRY9NsqiHYZQZiRG%2Fimage.png?alt=media&amp;token=63b02eb3-b6b8-4934-bd6a-1d3cebd91a2d" alt="" width="95"><figcaption></figcaption></figure></div>

The **Edit DAS&#x20;*****\<DAS name>*** page displays the DAS equipment's details.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FHNZZa5ae63fffXfCTkFB%2Fimage.png?alt=media&amp;token=d189a242-64cb-44c2-9b03-6db6c3e23e92" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Edit the following details as required:

* **Venue** – (Required) The venue hosting the DAS equipment.
* **Name** – (Required) The DAS equipment's name.
* **Serial Number** – (View-only) The DAS equipment's vendor-assigned hardware serial number.
* **Description** – (Required) Enter notes or details about the DAS equipment or the deployment.
* **Device Class** – (Required) The DAS equipment's type/model.
  * **Wilson DAS** – Wilson Electronics-manufactured DAS equipment with pre-configured specifications.
  * **Generic DAS** – Third-party DAS equipment requiring manual configuration.
    {% endstep %}

{% step %}
At the lower-right corner of the page, click **Configure Transmission Points**.
{% endstep %}

{% step %}
Enter the following details:

* **User ID** – Unique identifier for registering with the SAS.
* **Registration Type** – (Required) The CBSD registration process type.
* **FCC ID** – The Federal Communications Commission identifier for the equipment.
* Add TP:
  * **To add one TP at a time:**
    1. Select the **Manual Add** radio button, then click **+ Add Transmission Point**.

       The **Add Transmission Point** dialog box is displayed.<br>

       <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQHKrBpvWsV6KoDUKI6uC%2Fimage.png?alt=media&amp;token=9d956644-d983-4664-b754-65918c6b6cba" alt=""><figcaption></figcaption></figure></div>
    2. Enter the following details:
       * **Name** – TP identifier.
       * **Serial Number** – (Required) The TP equipment's vendor assigned serial number.
       * **Antenna Gain (dBi)** – (Required) Antenna RF gain value in dBi. Enter an integer value less than or equal to 128.
       * **Max Pwr (dBm)** – (Required) Maximum transmit power in dBm. Enter an integer value in the range of 0-30.
    3. To save the TP, click **Save**.
    4. To add additional TPs, repeat steps 1–2.
  * **To bulk provision TPs:**
    1. Select the **Upload CSV** radio button, then click **Upload CSV**.
    2. Select the CSV file to upload and submit it.
    3. For more information, see [*Bulk Provision TPs*](#bulk-provision-tps).
* TP table: Empty unless at least one TP has already been added.
  * Edit TP:
    1. Click the corresponding <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Ft3sNQ7LmE17Oa4ODc5Io%2Fimage.png?alt=media&amp;token=3d5d89e4-2d4d-4cd9-aebd-b475475a9036" alt="" data-size="line"> (edit) icon.\
       The **Edit Transmission Point** dialog box is displayed.<br>

       <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F1ORw8UNwR7sjr2cBhCdG%2Fimage.png?alt=media&amp;token=bb634ba6-1d2d-4e8a-b809-84b1b0f000f6" alt=""><figcaption></figcaption></figure></div>
    2. Edit the TP's details and click **Save**.
       * **Name** – TP identifier.
       * **Serial Number** – (Required) The TP equipment's vendor assigned serial number.
       * **Antenna Gain (dBi)** – (Required) Antenna RF gain value in dBi. Enter an integer value less than or equal to 128.
       * **Max Pwr (dBm)** – (Required) Maximum transmit power in dBm. Enter an integer value in the range of 0–30.
  * Delete TP: Click the corresponding<img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FnDF49pISoz1uqmHsPQKy%2Fimage.png?alt=media&amp;token=8eca2bbc-be9b-49d1-b879-663fda03a8e8" alt="" data-size="line"> (delete) icon.
    {% endstep %}

{% step %}
To save your edits, in the upper-right corner of the screen, click **Save DAS**.
{% endstep %}
{% endstepper %}

## Associate/Disassociate DAS with AP

This section describes how to associate or disassociate a DAS with an AP.

{% hint style="info" %}
**NOTE:** You can associate or disassociate DAS with AP only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** A DAS can be associated only with GXC G501 APs configured in either Single Carrier mode or Carrier Aggregation mode. All TP operations are coordinated through that AP.
{% endhint %}

**On associating a DAS with an AP:**

1. All TPs register with SAS as individual CBSDs.
2. Grant requests are submitted for each TP.
3. System becomes operational once all TPs are authorized. Process typically takes 5-10 minutes.

**On disassociating a DAS with an AP:**

1. All SAS grants are immediately released.
2. TPs cease transmission.
3. DAS configuration is preserved but becomes inactive.
4. Re-association requires full re-registration of all TPs.

**To associate/disassociate a DAS with an AP:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **Access Point** tab.

The **Equipment** page > **Access Point** tab displays the summary details of all APs configured in the network.
{% endstep %}

{% step %}
For the AP that you want to edit, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FM1ykSWuf6pKyhjzHcFVc%2Fimage.png?alt=media&amp;token=26aa6d96-2e3c-459d-998d-3ebd38e79290" alt="" width="95"><figcaption></figcaption></figure></div>

The **Edit Access Point** page > **Access Point** tab is displayed.
{% endstep %}

{% step %}
Navigate to the **RAN** tab.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJo9lApzfgQzMesOFM3jL%2Fimage.png?alt=media&amp;token=af0fb72f-a78b-4116-9cda-7b1de5bb9845" alt=""><figcaption></figcaption></figure></div>

{% hint style="info" %}
NOTE: When associating with a DAS, verify the following AP prerequisites:\
**Device Class** – Must be set to G501\
**Carrier Mode** – Must be set to Single Carrier mode or Carrier Aggregation mode
{% endhint %}
{% endstep %}

{% step %}
Associate/disassociate a DAS.

* To associate a DAS:
  * Toggle the **DAS** switch to ON position.

    The **Select DAS** dropdown becomes enabled.
  * In the **Select DAS** dropdown, select the DAS to associate with this AP.

{% hint style="info" %}
NOTE: The **Select DAS** dropdown lists only DAS equipment that is not currently associated with another AP. If no DAS is available, the dropdown is disabled.
{% endhint %}

* To disassociate a DAS:
  * Toggle the **DAS** switch to the OFF position.

    The **Select DAS** dropdown becomes disabled.
    {% endstep %}

{% step %}
To save your changes, in the upper-right corner of the screen, click **Save Access Point**.

On associating a DAS, the selected DAS receives cellular signal from this AP and distributes it to all configured TPs.

On disassociating a DAS, the DAS no longer receives signal from this AP.
{% endstep %}
{% endstepper %}

## **Delete DAS**

{% hint style="info" %}
NOTE: You can delete DAS only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
NOTE: You cannot delete a DAS while it is associated with an AP. If a DAS is associated with an AP, you must disassociate it before you can delete it. See [*Associate/Disassociate DAS with AP*](#associate-disassociate-das-with-ap).
{% endhint %}

**To delete a DAS:**

{% stepper %}
{% step %}
In the navigation pane, click **Equipment** > **DAS** tab.

The **Equipment** page > **DAS** tab displays the summary details of all DAS configured in the network.
{% endstep %}

{% step %}
For the DAS that you want to delete, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Delete**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Ffzjbh79JINh9Oz2vqHKz%2Fimage.png?alt=media&amp;token=35c21a2e-b05f-4e17-a4d8-f5a3d6b853ea" alt="" width="95"><figcaption></figcaption></figure></div>

A confirmation dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FjeOGTQ3mYTGlHdQApseG%2Fimage.png?alt=media&amp;token=3a7b1654-e8f1-4454-b4be-fe902260ae94" alt="" width="326"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To confirm deleting the DAS, click **Yes**.
{% endstep %}
{% endstepper %}


# Manage Subscribers

## Manage Subscriber Groups

{% hint style="info" %}
**NOTE:** You can create and manage subscriber groups only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

Subscriber groups enable organizing subscribers into different groups based on factors such as usage patterns and network policies. Individual subscriber groups can be managed differently to ensure fair allocation of network resources and prioritize critical traffic.

### View Subscriber Groups

{% hint style="info" %}
**NOTE:** By default, the Onyx system creates the "Default" and "Mesh Nodes" subscriber groups for the network. Note that the "Mesh Nodes" subscriber group is visible only to GXC Administrators.
{% endhint %}

This section describes how to:

* [*View Summary Details of All Subscriber Groups*](#view-summary-details-of-all-subscriber-groups)
* [*View a Subscriber Group's Details*](#view-a-subscriber-groups-details)

#### View Summary Details of All Subscriber Groups

**To view summary details of all subscriber groups in the network:**

{% stepper %}
{% step %}
In the navigation pane, click **Subscribers** > **Subscriber Groups** tab.

The **Subscriber (n)** page > **Subscriber Groups** tab displays the list of configured subscriber groups.

* **Name** – The subscriber group's name.
* **APN** – The APN associated with the subscriber group. The APN specifies the default bearer characteristics.
* **Total Subscribers** – The total number of subscribers in the subscriber group.
* **Connected Subscribers** – The number of subscribers with active sessions.
* **Idle Subscribers** – The number of idle subscribers.
* **Actions** – Options to edit and delete a subscriber group.
  {% endstep %}
  {% endstepper %}

#### View a Subscriber Group's Details

**To view a subscriber group's details:**

{% stepper %}
{% step %}
In the navigation pane, click **Subscribers** > **Subscriber Groups** tab.

The **Subscriber (n)** page > **Subscriber Groups** tab displays the list of configured subscriber groups.
{% endstep %}

{% step %}
To view a particular subscriber group's detail, click the group's name.

The ***\<subscriber group name>*** page displays the subscriber group's details.

* **Subscriber Group Details**
  * **Name** – The subscriber group's name.
  * **APN** – The APN associated with the subscriber group.
  * **Aggregate BW (Upload)** – The maximum bandwidth allowed for all non-GBR bearers per UE in the uplink direction in Mbps.
  * **Aggregate BW (Download)** – The maximum bandwidth allowed for all non-GBR bearers per UE in the downlink direction in Mbps.
  * **QoS Category** – The associated APN's QoS category, which specifies the QoS policy for the default bearer.
  * The counts of Connected, Inactive, Idle, Stale, and Unregistered subscriber accounts in the group.
* **Subscribers (n)** – The list of subscribers associated with the subscriber group.
  * **Name** – The subscriber's name.
  * **IMSI** – The subscriber's IMSI. To view a subscriber's details, click the corresponding IMSI. The details page is displayed.
* **Application Groups** – The list of application groups associated with the subscriber group.
  * **Name** – The application group's name.
  * **Applications** – The applications associated with the application group.
  * **Downlink BW**
    * **Max** – The maximum bandwidth in the downlink direction.
    * **Guaranteed** – The guaranteed bandwidth in the downlink direction.
  * **Uplink BW**
    * **Max** – The maximum bandwidth in the uplink direction.
    * **Guaranteed** – The guaranteed bandwidth in the uplink direction.
  * **QoS Category** – The QoS category associated with the application group. The QoS category specifies the QoS policy for the application group. For more information, see [*QoS Categories*](#qosCategories).
  * **QCI** – The QoS Class Identifier assigned to the application group.
  * **Pre-emption**
    * **Priority (ARP)** – (Displayed only for custom QoS categories.) The priority level of the bearer associated with this application group relative to other bearers in the network. On a congested cell, it determines the priority of a new bearer setup request—whether to release an established bearer with a lower priority to make way for the new bearer, or to reject the new bearer setup request. Higher priority bearers, indicated by higher ARP values, are less likely to be released in favor of lower priority bearers. Preemption priority ensures that critical services, such as real-time applications, receive preferential treatment, maintaining QoS during periods of network congestion.
    * **Vulnerability** – (Displayed only for custom QoS categories.) Indicates whether, during periods of network congestion, the bearer associated with this application group can be released to make way for a new bearer with a higher priority.
    * **Capability** – (Displayed only for custom QoS categories.) Indicates whether, during periods of network congestion, the establishment of the bearer associated with this application group could lead to the release of an established bearer with a lower priority.
      {% endstep %}
      {% endstepper %}

### Create Subscriber Groups

This section describes how to create subscriber groups.

{% hint style="info" %}
**NOTE:** You can create subscriber groups only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** By default, the system creates the "Default" and "Mesh Nodes" subscriber groups in the network. Note that the "Mesh Nodes" subscriber group is visible only to GXC Administrators. Avoid creating subscriber groups unless there is a specific requirement.
{% endhint %}

**To create a subscriber group:**

{% stepper %}
{% step %}
In the navigation pane, click **Subscribers** > **Subscriber Groups** tab.

The **Subscriber (n)** page > **Subscriber Groups** tab displays the list of configured subscriber groups.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Add Subscriber Group**.

The **Add Subscriber Group** page is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FHjPB9aUXzOsX15SplVr8%2Fimage.png?alt=media&amp;token=3643ae00-3ee1-426f-9af5-5fb4caabcdbb" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

* **Name** – (Required) This subscriber group's name. The name can be an alphabetic, numeric, or alphanumeric string of up to 32 characters.
* **APN** – (Required) Select the APN to associate with this subscriber group. Each subscriber group can be associated with a single APN.
* **Select Application Groups** – Click to select the application groups to associate with this subscriber group and set their priority order.

The **Select and Order Application Groups** dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F7maE9eeHN8UneuvsbYgS%2Fimage.png?alt=media&amp;token=c317770e-c818-4b50-b912-89025d3b1b4c" alt=""><figcaption></figcaption></figure></div>

* To associate an available application group with the subscriber group, in the **Available Application Groups** box, select the applications group(s), then click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FthspNEs6o3EwmNzBWrtV%2Fimage.png?alt=media&amp;token=14300e69-c4be-4e80-8163-84f5e484e242" alt="" data-size="line">.
* To disassociate an application group from the subscriber group, in the **Selected Application Groups** box, select the applications group(s), then click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FxltWvVrsNdQkSLzI2uE9%2Fimage.png?alt=media&amp;token=f9278bc7-9353-467d-ba26-41896d681dbb" alt="" data-size="line">.
* To set the priority order of an associated application group, in the **Selected Application Groups** box, drag and drop the corresponding row above or below as required.
  {% endstep %}

{% step %}
To save the subscriber group, in the lower-right corner of the page, click **Save Subscriber Group**.
{% endstep %}
{% endstepper %}

### Edit Subscriber Groups

{% hint style="info" %}
**NOTE:** You can edit subscriber groups only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** By default, the system creates the "Default" and "Mesh Nodes" subscriber groups in the network. The "Mesh Nodes" subscriber group is visible only to GXC Administrators.
{% endhint %}

**To edit a subscriber group:**

{% stepper %}
{% step %}
In the navigation pane, click **Subscribers** > **Subscriber Groups** tab.

The **Subscriber (n)** page > **Subscriber Groups** tab displays the list of configured subscriber groups.
{% endstep %}

{% step %}
For the subscriber group that you want to edit, in the **Actions** column, click the corresponding ⋮ (options) icon then click **Edit**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FxwchwCYZyu0w2W3z3Eu0%2Fimage.png?alt=media&amp;token=e4c56e99-7dca-48bb-9d4f-8fb972edda0a" alt="" width="104"><figcaption></figcaption></figure></div>

The **Edit Subscriber Group** page is displayed.
{% endstep %}

{% step %}
Edit the following details as required:

* **Name** – (Required) This subscriber group's name.
* **APN** – (Required) The APN to associate with this subscriber group. Each subscriber group can be associated with a single APN.
* **Select Application Groups** – Click to select the application groups to associate with this subscriber group and set their priority order.

  The **Select and Order Application Groups** dialog box is displayed.

  * To associate application group(s) with the subscriber group, in the **Available Application Groups** box, select the applications group(s), then click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FwkFzb9j8q92Dks5pjmQg%2Fimage.png?alt=media&amp;token=2630aaa4-6528-43bd-9bf4-a547de57e182" alt="" data-size="line">.
  * To set the priority order of an associated application group, in the **Selected Application Groups** box, drag and drop the corresponding row above or below as required.
  * To disassociate application group(s) from the subscriber group, in the **Selected Application Groups** box, select the applications group(s), then click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FYAofvNQBuNbnbZ5zOSQh%2Fimage.png?alt=media&amp;token=a30904d9-376e-47c9-95fb-6ab0df86bfbf" alt="" data-size="line">.
    {% endstep %}

{% step %}
To save your edits, in the lower-right corner of the page, click **Save Subscriber Group**.
{% endstep %}
{% endstepper %}

### Delete Subscriber Groups

{% hint style="info" %}
**NOTE:** You can delete subscriber groups only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

**To delete a subscriber group:**

{% stepper %}
{% step %}
In the navigation pane, click **Subscribers** > **Subscriber Groups** tab.

The **Subscriber (n)** page > **Subscriber Groups** tab displays the list of configured subscriber groups.
{% endstep %}

{% step %}
For the subscriber group that you want to delete, in the **Actions** column, click the corresponding ⋮ (options) icon then click **Delete**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Ffw5nen4dTIOw9V96J6OE%2Fimage.png?alt=media&amp;token=756d4c1e-a378-4b27-866c-ebb12d0060c9" alt="" width="104"><figcaption></figcaption></figure></div>

A confirmation dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKEKQCwwe5ITn3Lt7i4Wm%2Fimage.png?alt=media&amp;token=25466848-259c-44e8-95b1-52095de6a907" alt="" width="387"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To confirm deleting the subscriber group, click **Yes**.
{% endstep %}
{% endstepper %}

## Manage Subscriber Accounts

{% hint style="info" %}
**NOTE:** You can create and manage subscriber accounts only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

The Onyx Portal enables creating and managing subscriber accounts for your networks.

The subscriber accounts must be created before the UE can access your network. The UE must be provisioned with GXC-provided SIM cards or eSIM profiles configured exclusively for your network. For information on the SIM cards/eSIM profiles and supported UE devices, contact your GXC Account representative or GXC Technical Support.

### UE IMEI Verification to Prevent SIM Swapping

To prevent SIM swapping between UE, the IMSI of the SIM assigned to a subscriber account can be associated with a UE's IMEI. If a UE attempts to attach to the network with a different IMSI, the Attach Request is rejected and a "UE IMSI-IMEI Validation Failure" alert is triggered.

To enable UE IMEI verification for an individual subscriber account, see [*Create Individual Subscriber Accounts*](#_Ref167119695).

You can also enable IMEI verification for multiple subscriber accounts at once with the "Bulk Provision Subscriber Accounts" feature using a CSV file. For more information, see [*Bulk Provision Subscriber Accounts*](#_Ref118300815).

### Subscriber Speed Test Monitoring

The Subscriber Speed Test Monitoring feature provides real-time speed test metrics for individual subscribers/UE, offering enhanced visibility into per-subscriber network performance. This feature reports key real-time measurements, including uplink speed, downlink speed, jitter, and ping.

The feature leverages the free and open-source software provided by OpenSpeedtest. An OpenSpeedtest server runs on the Onyx Edge Core, allowing UE connected to the Onyx Edge to test the health of their 4G/5G network. The speed test operates independently of the backhaul speeds that the Onyx Edge itself is connected to, ensuring accurate measurement of the cellular radio link performance.

To perform a speed test, users open a browser on the UE and navigate to [*http://uespeedtest.gxc.io*](http://uespeedtest.gxc.io/), then click **Start**. The browser executes the speed test and displays the results. For CPE-like UE that lack browser support, an iPerf server is also available on the Onyx Edge. Speed test results are automatically recorded and displayed in the subscriber details page for the respective subscriber.

This feature enables administrators to quickly identify and troubleshoot subscribers/UE experiencing degraded network performance while proactively monitoring QoS compliance. Administrators can validate that upgrades deliver expected results, and connectivity issues can be resolved faster using data-driven insights.

This speed test results are displayed in the subscriber's details page > **Overview** tab > **Speed Test Details** section, and includes the following details:

* **Last Speed Test** – Timestamp of the most recently executed speed test.
* **Uplink Speed** – Measures upload data transfer rate (Mbps).
* **Downlink Speed** – Measures download data transfer rate (Mbps).
* **Jitter** – Tracks latency variation (ms) for connection stability assessment.
* **Ping (RTT)** – Measures round-trip time (ms) for latency evaluation.

Speed test results display as "\–" when no data is available.

Speed test functionality requires compatible UE/subscriber device.

### View Subscriber Accounts

This section describes how to:

* [*View Summary Details of Subscriber Accounts*](#view-summary-details-of-subscriber-accounts)
* [*View a Subscriber Account's Details*](#view-a-subscriber-accounts-details)

#### View Summary Details of Subscriber Accounts

**To view summary details of all subscriber accounts in the network:**

{% stepper %}
{% step %}
In the navigation pane, click **Subscribers**.

The **Subscribers (n)** page > **Subscriber** tab by default displays the list of all subscriber accounts under all subscriber groups.
{% endstep %}

{% step %}
To view the subscriber accounts associated with a specific group, in the groups dropdown, select the group's name.

The list of subscriber accounts associated with the selected group is displayed.

The list of subscribers is sorted by their network connection status and their recent network activity, making it easier to identify and manage subscribers based on their current state. The list is automatically sorted using a two-tier approach:

1. Primary Sort – Subscribers are grouped based on their connection status in the following priority order:
   * Connected
   * Idle
   * Detached
   * Not Yet Connected
   * Disabled
2. Secondary Sort – Within each connection status group, subscribers are ordered by their most recent network activity timestamps.\
   Any subscribers with missing timestamp values are sorted after those with valid timestamps within the same status group.

{% hint style="info" %}
**NOTE:** For non-GXC Administrator users this list excludes MeshBackhaul subscriber data.
{% endhint %}

* **Type** – Indicates whether the subscriber/UE is using a physical SIM or an eSIM, shown with the corresponding icon.
* **Status** – The subscriber's status—Connected, Idle, Detached, Not Yet Connected, Disabled.
* **Name** – The subscriber's name.
* **IMSI** – The IMSI number of the SIM assigned to the subscriber account. To view a subscriber's details, click the corresponding IMSI. The ***\<subscriber name>*** page is displayed.
* **APN** – The APN associated with the subscriber account.
* **Cell ID** – The cell ID of the AP cell that the subscriber is attached to.
* **IP Address** – The subscriber/UE's IP address.
* **Usage** – The subscriber's data usage in the last 24 hours.
* **Session Duration** – The duration for which the subscriber's session has remained active.
* **Actions** – (GXC Administrators, GXC Partner Administrators, Super Administrators, and Administrators only.) Options to edit and delete subscriber accounts.
  {% endstep %}

{% step %}
To search for a particular subscriber, in the **Search** field, enter your search term.
{% endstep %}

{% step %}
**Download CSV** – (Super Administrators and Administrators only.) To download the list of subscribers and their details as a CSV file, in the upper-right corner of the page, click **Download CSV**.
{% endstep %}

{% step %}
**Upload CSV** – (Super Administrators and Administrators only.) To bulk provision new subscribers using a CSV file, in the upper-right corner of the page, click **Upload CSV**. For more information, see [*Bulk Provision Subscriber Accounts*](#_Ref118300815).
{% endstep %}
{% endstepper %}

#### View a Subscriber Account's Details

**To view a subscriber account's details:**

{% stepper %}
{% step %}
In the navigation pane, click **Subscribers**.

The **Subscribers (n)** page > **Subscriber** tab by default displays the list of all subscriber accounts under all subscriber groups.
{% endstep %}

{% step %}
To view the subscriber accounts associated with a specific group, in the groups dropdown, select the group's name.

The list of subscriber accounts associated with the selected group is displayed.
{% endstep %}

{% step %}
To view the details of a particular subscriber, click the subscriber's IMSI number.

The ***\<subscriber name>*** page > **Overview** tab displays the following details:

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FvbCm2sn7x0J1N1dryCwT%2F4g-subscriber-view-details-overview-tab.png?alt=media&amp;token=420d506b-b579-42fc-bd91-b18a9a24a2c3" alt=""><figcaption></figcaption></figure></div>

* **Subscriber Details**:

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F6YGxqFGavpiY3yvz9VZs%2F4g-subscriber-view-subscriber-details-panel.png?alt=media&amp;token=85e018de-dda3-4c23-8e9b-788eccb64ecf" alt="" width="407"><figcaption></figcaption></figure></div>

  * **IMSI** – The IMSI number of the SIM assigned to this subscriber account.
  * **MAC** – (Displayed only in VLAN mode.) The subscriber's MAC address. Facilitates DHCP reservations in corporate-managed DHCP environments. The MAC address is displayed only when the network and Onyx Edge are in VLAN mode.
  * **Service** – The subscriber's service status—Enabled or Disabled.
  * **Last Reported Time** – The timestamp at which the subscriber's status was last reported.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE</strong>: Some commercially available UE have ICMP ping responses disabled. In such cases, CPE monitoring for the UE fails and the <strong>Last Reported Time</strong> parameter displays as blank \–.</p></div>
  * **IP Address** – The subscriber's IP address.
  * **Active Duration** – The duration for which the subscriber has been active.
  * **Allowed Cell** – (Displayed only for Mesh Node subscribers.) The designated "Allowed Cell" to which the Mesh Node subscriber can attach to. For more information, see *Mesh Node-AP Affinity Feature*.
  * **Last Uplink Signaling Activity Time** – Last time the subscriber/UE sent uplink signaling to the network.
  * **Last Attach Time** – Last successful network attach time for the subscriber/UE.
  * **Onyx Edge** – The Onyx Edge that the subscriber is associated with.
  * **Access Point** – The AP that the subscriber is attached to.
  * **Status** – The subscriber's current status—Connected, Idle, Detached, Not Yet Connected, Disabled.
* **Subscriber Group Details**:

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F02Tk38FXS7gFZrH1x3EQ%2F4g-subscriber-view-subscriber-group-details-panel.png?alt=media&amp;token=654766df-befe-49f3-8ab7-0e1f8cf2233f" alt="" width="407"><figcaption></figcaption></figure></div>

  * **Subscriber Group Name** – The subscriber group that the subscriber account is associated with. For more information on subscriber groups, see [*Manage Subscriber Groups*](#manage-subscriber-groups).
  * **APN** – The APN associated with the subscriber group.
* **Device Details**:

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FIovHwR9eB2A1ZPZAoHNm%2F4g-subscriber-view-device-details-panel.png?alt=media&amp;token=9421c03f-34f6-4a2f-967a-cbe151d8b4d3" alt="" width="407"><figcaption></figcaption></figure></div>

  * **IMEI** – The device's IMEI number.
  * **IMEISV** – The device's IMEISV.
  * **Brand** – The device's manufacturer or vendor name.
  * **Model** – The device's model name or number.
  * **Last IMEI Lookup Time** – Timestamp of the last successful query to the IMEI Cloud database for the device's metadata.
  * **Speed Test Details**: real-time network performance measurements for individual subscribers. For more information, see [*Subscriber Speed Test Monitoring*](#subscriber-speed-test-monitoring).

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FFUM4Q3dL423opwwVPniY%2F4g-subscriber-view-speed-test-details-panel.png?alt=media&amp;token=8448fbba-ff7d-451c-8bac-dc34dd5d80d3" alt="" width="406"><figcaption></figcaption></figure></div>

    * **Last Speed Test** – Timestamp of the most recently executed speed test.
    * **Uplink Speed** – Measures upload data transfer rate (Mbps).
    * **Downlink Speed** – Measures download data transfer rate (Mbps).
    * **Jitter** – Tracks latency variation (ms) for connection stability assessment.
    * **Ping (RTT)** – Measures round-trip time (ms) for latency evaluation.
  * **Data Consumption** – The subscriber's data usage in the current session.

    <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKna40HYhiVAs88jCkq7X%2F4g-subscriber-view-data-consumption-panel.png?alt=media&amp;token=839fb870-d48f-4ff3-a5df-7ef5b4a87452" alt="" width="407"><figcaption></figcaption></figure></div>

    * **Download** – The amount of data received by the subscriber from the network during the current session.
    * **Upload** – The amount of data sent by the subscriber to the network during the current session.
      {% endstep %}

{% step %}
Click the **Analytics** tab.

The **Analytics** tab displays real-time and historical data usage and connection performance metrics per subscriber.

* **Selected Range** – The time range for which the subscriber analytics data is displayed. You can change the time range from the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fyg8DZBrnT0VIs9nMYAvf%2Fimage.png?alt=media&amp;token=040d4ab3-5b4e-4bd3-a576-3369b8192253" alt="" data-size="line"> dropdown at the far-right.
* **Summary** tab – Displays quick metrics for the selected time range.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FV7JDEhKunWcpiyIcOALB%2F4g-subscriber-view-analytics-tab-summary-tab.png?alt=media&amp;token=dd0e2316-842b-4875-b703-60eab0e868dd" alt=""><figcaption></figcaption></figure></div>

  * **Throughput Summary** – Subscriber's throughput summary.
    * **Downlink Throughput** – Subscriber's downlink throughput in the core.
    * **Uplink Throughput** – Subscriber's uplink throughput in the core.
  * **Data Usage Summary** – Subscriber's data usage summary.
    * **Downlink Data Usage** – Subscriber's downlink data usage.
    * **Uplink Data Usage** – Subscriber's uplink data usage.
  * **Connection Latency** – Latency for ping from Onyx Edge to UE.
    * **Connection Latency (If available)** – Note that for this to populate, CPE Monitoring must be enabled (**Equipment** > **Onyx Edge** tab > Onyx Edge details page > **Dynamic Services** section > **CPE Monitoring** parameter) / (Add/Edit Onyx Edge > **Others** tab > **CPE Monitoring** toggle switch).
* **Plots** tab – Displays time-series plots visualizing usage patterns, spikes and drops, latency gaps, etc. with time granularity for the selected time range.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FYdYtiR75pgYnFJJSQgjr%2F4g-subscriber-view-analytics-tab-plots-tab.png?alt=media&amp;token=13563bcb-e2ef-45b9-b3a1-b0d92579004e" alt=""><figcaption></figcaption></figure></div>

  To manage the plots displayed, click **Manage Reports**. In the **Manage Report KPI** dialog box, select the required KPIs.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fcl2Y3cw566VXkmL48m9a%2F4g-subscriber-view-analytics-tab-plots-tab-manage.png?alt=media&amp;token=b2c8350d-df99-48d3-a74f-fae1ccc1b25f" alt=""><figcaption></figcaption></figure></div>

  * **Common KPIs**:
    * **Downlink Throughput** – Subscriber's downlink throughput measured at the core.
    * **Uplink Throughput** – Subscriber's uplink throughput measured at the core.
    * **Downlink Data Usage** – Total downlink data consumed by the subscriber.
    * **Uplink Data Usage** – Total uplink data consumed by the subscriber.
    * **Connection Latency** – Ping latency from Onyx Edge to UE (requires CPE Monitoring enabled).
  * **4G Only KPIs**:
    * **Serving Cell Transition** – Frequency of UE switching between LTE cells due to mobility or radio conditions.
      {% endstep %}

{% step %}
Click the **Events** tab.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FFKfLlSHXE6oOnicVtis2%2F4g-subscriber-view-events-tab.png?alt=media&amp;token=6ce02c7f-0115-464d-a7df-5547e6e7f41d" alt=""><figcaption></figcaption></figure></div>

* **Events (n)** – The number of subscriber-specific events in the selected date and time range.
  * To change the date and time range, select the required timestamps in <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F6h3jKZ2w4Y7imHARft3k%2Fimage.png?alt=media&amp;token=f258f5a3-1d61-4e4e-9451-c7ed63b156eb" alt="" data-size="line">. The events list automatically updates to display the corresponding events.
  * The tabular list of subscriber-specific events displays the following details:
    * **Timestamp** – The timestamp at which the event was generated.
    * **Module** – The specific module or source from which the event originated. To filter the events based on the 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.
    * **Event Description** – The event's description.
    * Actions – To view an event's details, in the Actions column, click the corresponding <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8VmBevdwB1uBTFn0CzE4%2Fimage.png?alt=media&amp;token=d9daf6c3-fffb-44ce-8ff5-9ec96fd2a195" alt="" data-size="line"> (view details) icon. The "Event Details" frame displays the event's details.
* **Detach Subscriber** – Forcefully disconnect the subscriber/UE.
  {% endstep %}
  {% endstepper %}

### Create Subscriber Accounts

Subscriber addition is integrated into the SIM Provisioning workflow managed by GXC. For more information contact GXC Technical Support.

### Edit Subscriber Accounts

{% hint style="info" %}
**NOTE:** You can edit subscriber accounts only if you are a GXC Administrator.
{% endhint %}

**To edit a subscriber account:**

{% stepper %}
{% step %}
In the navigation pane, click **Subscribers**.

The **Subscriber (n)** page is displayed.
{% endstep %}

{% step %}
For the subscriber account that you want to edit, in the subscriber groups dropdown, select the corresponding subscriber group.

All the subscriber accounts in the selected subscriber group are listed.
{% endstep %}

{% step %}
For the subscriber account that you want to edit, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

The **Edit Subscriber** page displays the subscriber's details.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FX4o1A15Wp0096hOc0QHu%2F4g-subscriber-edit.png?alt=media&amp;token=ea162f9e-6ff8-43b2-aa76-91f673024ebe" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Update the following details as required:

* **Subscriber Name** – (Required) The subscriber's name.
* **Service State** – (Required) Select the subscriber's SIM card's service state—**Active** or **Inactive**. Default value: Active.
* **Subscriber Groups** – (Required) Select the subscriber group with which this subscriber account must be associated. Each subscriber account can be associated with a single subscriber group. For information on subscriber groups, see [*Manage Subscriber Groups*](#manage-subscriber-groups).
  * **Mesh Nodes** – For Mesh Node subscribers, select the **Mesh Nodes** subscriber group.

    Selecting the **Mesh Nodes** subscriber group displays the **Allowed Cell** parameter, which allows you to associate a specific cell ID with the Mesh Node subscriber. For more information, see [*Mesh Node-AP Affinity Feature*](#mesh-node-ap-affinity-feature).
  * **Allowed Cell** – (Displayed only when the **Mesh Nodes** subscriber group is selected. Optional.) Select the cell ID to associate with this Mesh Node subscriber.

{% hint style="info" %}
**NOTE:** The **Allowed Cell** dropdown also lists the cell IDs of all Mesh APs. Do not select a Mesh AP cell ID.
{% endhint %}

* **IMEI Verification** – (Optional) To enable IMEI verification for this subscriber account, select the toggle button.
  * **IMEI** – (Displayed only if IMEI Verification is enabled.) The IMEI of the UE that is assigned to this subscriber account.
    {% endstep %}

{% step %}
To save your edits, in the upper-right corner of the page, click **Save Subscriber**.
{% endstep %}
{% endstepper %}

### Bulk Assign Subscribers to a Subscriber Group

The Onyx Portal lets you move multiple subscriber accounts into a subscriber group in a single action, instead of editing each subscriber individually.

{% hint style="info" %}
**NOTE**: You can bulk-assign subscribers to a subscriber group only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.

**NOTE**: This is a bulk equivalent of changing the Subscriber Groups field on the Edit Subscriber page; it does not change any other subscriber setting (Service State, IMEI Verification, etc.).
{% endhint %}

**To bulk-assign subscribers to a subscriber group:**

{% stepper %}
{% step %}
In the navigation pane, click **Subscribers**.

The **Subscribers (n)** page > **Subscriber** tab displays the list of subscriber accounts.
{% endstep %}

{% step %}
In the first column, select the checkbox for each subscriber account that you want to move, then click **Update Subscriber Group**.

The **Assign to Subscriber Group** dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FezOVBycDYKkyfdhw3fJG%2Fimage.png?alt=media&amp;token=87441564-bae8-430b-b73f-188abf143206" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the **Select Subscriber Group** dropdown, select the target subscriber group.
{% endstep %}

{% step %}
To confirm, click **Assign**.

The selected subscribers are moved into the chosen subscriber group. Each subscriber's **Subscriber Group Details** (visible on that subscriber's **Overview** tab) update to reflect the new group and its associated APN.
{% endstep %}
{% endstepper %}

### Delete Subscriber Accounts

{% hint style="info" %}
**NOTE:** You can delete subscriber accounts only if you are a GXC Administrator.
{% endhint %}

**To delete a subscriber account:**

{% stepper %}
{% step %}
In the navigation pane, click **Subscribers**.

The **Subscriber (n)** page is displayed.
{% endstep %}

{% step %}
For the subscriber account that you want to delete, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Delete**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FFqioWZF75dLPtExNxoPW%2Fimage.png?alt=media&amp;token=74f419b7-e0a4-4636-a729-71f0e7d614eb" alt="" width="151"><figcaption></figcaption></figure>

A confirmation dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FGTEIhiFvCa66HRAOVRyC%2Fimage.png?alt=media&amp;token=d31fd32a-9f86-4d93-acea-33122ead6975" alt="" width="359"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To confirm deleting the subscriber account, click **Yes**.
{% endstep %}
{% endstepper %}

### Detach Active Subscribers

Administrators can forcefully disconnect active subscribers/UE directly from the Onyx Portal in any of the following ways:

* From subscriber summary view
* From subscriber details page
* From Onyx Edge details page

#### Detach Subscribers from Subscriber Summary View

{% hint style="info" %}
**NOTE:** You can detach subscribers only if you are a GXC Administrator.
{% endhint %}

**To detach a subscriber from the subscriber summary view:**

{% stepper %}
{% step %}
In the navigation pane, click **Subscribers**.

The **Subscriber (n)** page > **Subscriber** tab is displayed.
{% endstep %}

{% step %}
For the subscriber account that you want to detach, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Detach Subscriber**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FHz9xsFcPSAm02PjuZUIz%2Fimage.png?alt=media&amp;token=c3a2f209-3822-4b67-a1ea-cb7701edb408" alt="" width="151"><figcaption></figcaption></figure>

A confirmation dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F1Xf7EtfifLYvTRPevACf%2Fimage.png?alt=media&amp;token=0c80beb0-a6dd-48da-884e-f00b68fd6cd6" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To confirm, click **Execute**.
{% endstep %}
{% endstepper %}

#### Detach Subscribers from Subscriber Details Page

{% hint style="info" %}
**NOTE:** You can detach subscribers only if you are a GXC Administrator.
{% endhint %}

**To detach a subscriber from the subscriber's details page:**

{% stepper %}
{% step %}
In the navigation pane, click **Subscribers**.

The **Subscribers (n)** page > **Subscriber** tab by default displays the list of all subscriber accounts under all subscriber groups.
{% endstep %}

{% step %}
To view the subscriber accounts associated with a specific group, in the groups dropdown, select the group's name.

The list of subscriber accounts associated with the selected group is displayed.
{% endstep %}

{% step %}
Click the subscriber IMSI number for the subscriber you want to detach.

The ***\<subscriber name>*** page displays the subscriber's details.
{% endstep %}

{% step %}
In the top-right corner of the page, click **Detach Subscriber**.

A confirmation dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FBlJyWyDnPTS7uaETeMdD%2Fimage.png?alt=media&amp;token=fb3e482b-40a9-47cb-a254-e795b3e6055f" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To confirm, click **Execute**.
{% endstep %}
{% endstepper %}

#### Detach Subscribers from Onyx Edge Details Page

{% hint style="info" %}
**NOTE:** You can detach subscribers only if you are a GXC Administrator.
{% endhint %}

**To detach subscribers from the associated Onyx Edge's details page:**

{% 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 **Onyx Edge (n)** panel, click the Onyx Edge's name.

The ***\<onyx edge name>*** page displays the Onyx Edge's details.
{% endstep %}

{% step %}
In the top-right corner of the page, click **Actions** > **Detach Subscriber**.

The **Detach Subscriber** dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FuF1wjyrwpBtEAbNMJsEm%2Fimage.png?alt=media&amp;token=22b554f0-e52d-4b0c-b244-3c53a37391b8" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
In the **Subscriber IMSI** dropdown, select the subscriber's IMSI and click **Execute**.

A confirmation dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F7PMjylix5Rm9HZUREjci%2Fimage.png?alt=media&amp;token=9df6e768-cce9-4f4f-b26b-6bf000d3a406" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To confirm, click **Execute**.
{% endstep %}
{% endstepper %}


# Manage Traffic

Traffic management enables effective prioritization and control of network traffic, ensuring efficient utilization of network resources and enhanced user experience.

## Application-based Policies and Resource Management

This section describes the Onyx QoS Management architecture.

* Default Bearer – A default bearer is the initial logical connection established when a UE initiates a data session. It provides basic connectivity between the UE and the PDN and handles best-effort data traffic with moderate QoS requirements. One default bearer is established per APN.
* Dedicated Bearer – A dedicated bearer is a secondary logical connection established for specific types of traffic, such as video streaming or IoT telemetry, with a tailored QoS policy. It ensures optimized performance for these specialized services, running alongside the default bearer. One dedicated bearer is established per application group.
* APNs – Access Point Name (APN) specify the PDNs that subscribers/UE should connect to. They are essential for routing data traffic from UE to the appropriate networks, which could be public internet or a private corporate network. One default bearer is established per APN. Each APN is associated with a QoS category, which specifies the QoS policy for the default bearer. For more information on APNs, see [Manage APNs](#manage-apns).
* Applications – Application definitions specify the traffic classification rules that distinguish between different types of data flows based on their flow characteristics (direction, protocol, peer IP address, and source and destination ports). Multiple flow classification rules can be used to define what constitutes an application. For more information on applications, see [Manage Applications](#manage-applications).
* Application Groups – Application groups categorize application definitions into different groups based on their similarities such as data rate, latency sensitivity, and reliability requirements. For example, all real-time streaming applications can be grouped into one application group, while all monitoring applications can be in another group. One dedicated bearer is established per application group. The QoS category associated with an application group specifies the QoS policy for the dedicated bearer used for data flows associated with all applications in that group. For more information on application groups, see [Manage Application Groups](#manage-application-groups).
* QoS Categories – QoS categories are predefined QoS policies that can be applied to APNs and application groups. The predefined QoS categories help simplify the QoS configuration procedure. If required, operators have the option to create their own custom QoS categories.
  * For APNs, the system supports the following QoS categories:

    <table><thead><tr><th width="174">QoS Category</th><th width="83">QCI</th><th width="101">Priority</th><th width="103">PDB</th><th width="101">PELR</th><th>Use Case</th></tr></thead><tbody><tr><td>NA</td><td>5</td><td>1</td><td>100ms</td><td>10^-6</td><td>IMS signaling</td></tr><tr><td>High Priority Data</td><td>6</td><td>6</td><td>300ms</td><td>10^-6</td><td>Buffered video/TCP based</td></tr><tr><td>NA</td><td>7</td><td>7</td><td>100ms</td><td>10^-3</td><td>Live streaming</td></tr><tr><td>Medium Priority Data</td><td>8</td><td>8</td><td>300ms</td><td>10^-6</td><td>Buffered video/TCP based</td></tr><tr><td>Low Priority Data</td><td>9</td><td>9</td><td>300ms</td><td>10^-6</td><td>Buffered video/TCP based</td></tr></tbody></table>
  * For application groups, the system supports the following QoS categories.
    * GBR Type

      <table><thead><tr><th width="174">QoS Category</th><th width="83">QCI</th><th width="101">Priority</th><th width="103">PDB</th><th width="101">PELR</th><th>Use Case</th></tr></thead><tbody><tr><td>Live Audio</td><td>1</td><td>2</td><td>100ms</td><td>10^-2</td><td>Conversational voice</td></tr><tr><td>Live Video</td><td>2</td><td>4</td><td>150ms</td><td>10^-6</td><td>Video/live streaming</td></tr><tr><td>Real-time Applications</td><td>3</td><td>3</td><td>50ms</td><td>10^-3</td><td>Real-time gaming</td></tr><tr><td>High Priority Data</td><td>4</td><td>5</td><td>300ms</td><td>10^-6</td><td>Non-conversation video/buffering streaming</td></tr></tbody></table>
    * Non-GBR Type

      <table><thead><tr><th width="174">QoS Category</th><th width="83">QCI</th><th width="101">Priority</th><th width="103">PDB</th><th width="101">PELR</th><th>Use Case</th></tr></thead><tbody><tr><td>NA</td><td>5</td><td>1</td><td>100ms</td><td>10^-6</td><td>IMS signaling</td></tr><tr><td>High Priority Data</td><td>6</td><td>6</td><td>300ms</td><td>10^-6</td><td>Buffered video/TCP based</td></tr><tr><td>NA</td><td>7</td><td>7</td><td>100ms</td><td>10^-3</td><td>Live streaming</td></tr><tr><td>Medium Priority Data</td><td>8</td><td>8</td><td>300ms</td><td>10^-6</td><td>Buffered video/TCP based</td></tr><tr><td>Low Priority Data</td><td>9</td><td>9</td><td>300ms</td><td>10^-6</td><td>Buffered video/TCP based</td></tr></tbody></table>
* Subscriber Groups – Subscriber groups categorize subscribers/UE into different groups based on their usage patterns and other criteria. Subscribers within the same subscriber group share a common set of application groups. This grouping helps avoid repeating the same configuration for each subscriber/UE that must be treated on par. For example, all camera devices can be grouped into a "Cameras" group, all IoT scanners can be put into an "IoT Scanners" group, and so on. By default, the system creates the "Default" and "Mesh Nodes" subscriber groups in the network.

{% hint style="info" %}
**NOTE:** Each subscriber group is associated with a single APN. All the subscribers/UE associated with a subscriber group connect to the same APN.
{% endhint %}

{% hint style="info" %}
**NOTE:** Each subscriber/UE can be associated only with a single subscriber group.
{% endhint %}

{% hint style="info" %}
**NOTE:** All the subscribers/UE associated with a subscriber group use the same set of application groups.
{% endhint %}

{% hint style="info" %}
**NOTE:** Each subscriber group can contain multiple application groups. Within a subscriber group, the order in which application groups are prioritized determines which application group (QoS policy) is applied when there are overlapping traffic selection rules.
{% endhint %}

{% hint style="info" %}
**NOTE:** The "Mesh Nodes" subscriber group is visible only to GXC Administrators.
{% endhint %}

{% hint style="info" %}
**NOTE:** The QoS Management 2.0.0 feature works only in conjunction with Onyx Edge running software release 2.0.0 or later.
{% endhint %}

For more detailed information, refer to the *QoS Management Application Note*.

### How it Works

{% stepper %}
{% step %}
A subscriber group is associated with an APN and a set of application groups.
{% endstep %}

{% step %}
A subscriber/UE associated with the subscriber group uses the APN and application groups associated with that specific subscriber group.
{% endstep %}

{% step %}
An application group is associated with applications that classify different types of traffic based on their flow characteristics.
{% endstep %}

{% step %}
The QoS category associated with the application group decides the QoS treatment for those applications.
{% endstep %}

{% step %}
While registering with the network, the UE sends an Attach Request to the AP, which contains the APN identifying the PDN that the UE wants to connect to. The network verifies the UE's identity and checks if the UE is authorized to access the requested APN. The network establishes the default bearer and applies the QoS policy defined in the APN to the default bearer.
{% endstep %}

{% step %}
After the default bearer is established, for each application group associated with the subscriber group that the subscriber/UE is associated with, the network establishes a dedicated bearer and applies the QoS policy defined in the application group to it.
{% endstep %}

{% step %}
After the default and dedicated bearers are established, data packets are transmitted over these bearers facilitating communication between the UE and the network. While the default bearer handles general data traffic, the dedicated bearers cater to their respective application groups with defined QoS requirements.
{% endstep %}

{% step %}
At the UE and the Onyx Edge, the downlink and uplink packets are routed to the respective bearers based on the application definitions associated with the corresponding application group.

* Uplink data packets (originating from the UE) are processed and routed to the appropriate bearer based on the application definitions associated with the applications running on the UE.
* At the Onyx Edge, downlink data packets are inspected and routed to the appropriate bearers based on the application definitions associated with the corresponding application group.
  {% endstep %}

{% step %}
The default and dedicated bearers are released when:

* The UE detaches from the network.
* The user session is terminated.
* Network/operator policies trigger bearer release under specific conditions.
  {% endstep %}
  {% endstepper %}

### Limitations

This section outlines the limitations of the QoS Management feature in this release.

{% stepper %}
{% step %}
The QoS functionality works end-to-end only with UE connected to APs that are directly connected with an Onyx Edge.
{% endstep %}

{% step %}
When application definitions are modified, changes will not affect current sessions. The modifications will only come into effect when the UE establishes a new session.
{% endstep %}

{% step %}
Downlink-only application groups are not supported. To ensure the creation of a dedicated bearer, at least one uplink rule (even if it is a dummy rule) must be included in any of its member applications.
{% endstep %}

{% step %}
A maximum of four simultaneous dedicated bearers are supported per UE.
{% endstep %}

{% step %}
It is possible that not all dedicated bearers (one per application group) will always be established. For example, due to radio resource constraints.
{% endstep %}

{% step %}
The Onyx Edge can only create up to 15 TFTs in a bearer. This is further restricted by how many TFTs can be encoded within 255 octets in the "Create Bearer Request" message. Consequently, this restricts the number of flows across all applications within an application group.
{% endstep %}

{% step %}
The Preemption Vulnerability and Preemption Capability functionality are available only for trials in this release.
{% endstep %}
{% endstepper %}

### QoS Configuration

This section describes the QoS configuration workflow and the procedure.

#### QoS Configuration Workflow

<p align="center"><strong>QoS Configuration Workflow</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fote3KiMZJEu5ikjjxW22%2Fimage.png?alt=media&amp;token=e8b96386-ce3f-4b97-a54a-a64d719dcdd3" alt="" width="449"><figcaption></figcaption></figure>

QoS Configuration Workflow:

{% stepper %}
{% step %}
Create APNs.

* Specify the default bearer characteristics (associate with a predefined QoS category or define custom a QoS category).

See [Create APNs](#create-apns).
{% endstep %}

{% step %}
Create application definitions.

* Specify the flow classification rules.

See [Create Applications](#create-applications).

{% hint style="info" %}
**NOTE:** Avoid creating application definitions unless there is a specific requirement to prioritize certain types of traffic over others.
{% endhint %}
{% endstep %}

{% step %}
Create application groups.

* Specify the application group's QoS characteristics (associate with a predefined QoS category or define a custom QoS category).
* Associate the application group with application definitions.

See [Create Application Groups](#create-application-groups).
{% endstep %}

{% step %}
Create subscriber groups.

* Associate the subscriber group with an APN.
* Associate the subscriber group with application groups.

See [Create Subscriber Groups](#create-subscriber-groups).

{% hint style="info" %}
**NOTE:** By default, the system creates the "Default" and "Mesh Nodes" subscriber groups in the network. Note that the "Mesh Nodes" subscriber group is visible only to GXC Administrators.
{% endhint %}

{% hint style="info" %}
**NOTE:** Avoid creating subscriber groups unless there is a specific requirement.
{% endhint %}
{% endstep %}

{% step %}
Create subscriber accounts.

* Associate subscriber accounts with subscriber groups.

See [Create Subscriber Accounts](#create-subscriber-accounts).
{% endstep %}
{% endstepper %}

<p align="center"><strong>QoS Configuration Associations</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FLBktEgzMgsAzKLnO91EX%2Fimage.png?alt=media&amp;token=4b7c2d04-44b5-454b-a525-629ba804d60a" alt=""><figcaption></figcaption></figure>

## Manage APNs

{% hint style="info" %}
**NOTE:** You can create and manage APNs only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

APNs serve as network identifiers to route UE traffic to a specific PDN. When a UE establishes a data connection, it must specify the APN it wants to use. The APN also specifies the QoS policy for the default bearer established between the UE and the PDN.

By default, Onyx Portal supports the following APNs:

* "internet": Used for various data services, including web browsing, email, and other Internet-related activities.
  * QCI – 9
  * ARP Priority Level – 15
  * Aggregate Bandwidth Downlink – 100 Mbps
  * Aggregate Bandwidth Uplink – 100 Mbps
* "MeshBackhaul": For use by Mesh devices in the network.
  * QCI – 6
  * ARP Priority Level – 15
  * Aggregate Bandwidth Downlink – 200 Mbps
  * Aggregate Bandwidth Uplink – 50 Mbps

{% hint style="info" %}
**NOTE:** The "MeshBackhaul" APN is visible only to GXC Administrators.
{% endhint %}

{% hint style="info" %}
**NOTE:** The default APNs cannot be deleted.
{% endhint %}

{% hint style="info" %}
**NOTE:** The default APNs cannot be renamed. APN names are case-insensitive, that is "internet" and "Internet" are treated as identical by the system.
{% endhint %}

### View APNs

**To view APN details:**

{% stepper %}
{% step %}
In the navigation pane, click **Traffic**.

The **Traffic** page > **APNs** tab displays the list of configured APNs.

The APNs list shows:

* **APN ID** – The APN's ID.
* **Aggregate BW**
  * **Download** – The maximum bandwidth allowed for all non-GBR bearers per UE in the downlink direction.
  * **Upload** – The maximum bandwidth allowed for all non-GBR bearers per UE in the uplink direction.
* **QoS Category** – The QoS category associated with the APN, which specifies the QoS policy for the default bearer associated with the APN—High Priority Data, Medium Priority Data, Low Priority Data, Custom.
* **QCI** – (Displayed only for custom QoS categories.) The QoS Class ID.
* **Pre-emption**
  * **Priority (ARP)** – (Displayed only for custom QoS categories.) The priority level of the bearer associated with this APN relative to other bearers in the network. On a congested cell, it determines the priority of a new bearer setup request—whether to release an established bearer with a lower priority to make way for the new bearer, or to reject the new bearer setup request. Higher priority bearers, indicated by higher ARP values, are less likely to be released in favor of lower priority bearers. Preemption priority ensures that critical services, such as real-time applications, receive preferential treatment, maintaining QoS during periods of network congestion.
  * **Vulnerability** – (Displayed only for custom QoS categories.) – Indicates whether, during periods of network congestion, the bearer associated with this APN can be released to make way for a new bearer with a higher priority.
  * **Capability** – (Displayed only for custom QoS categories.) – Indicates whether, during periods of network congestion, establishment of the bearer associated with this APN could lead to the release of an established bearer with a lower priority.
* **Actions** – (GXC Administrators, GXC Partner Administrators, Super Administrators, and Administrators only.) Options to edit and delete APNs.
  {% endstep %}

{% step %}
To search for a particular APN, in the Search field, enter your search term.
{% endstep %}
{% endstepper %}

### Create APNs

{% hint style="info" %}
**NOTE:** You can create APNs only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

**To create an APN:**

{% stepper %}
{% step %}
In the navigation pane, click **Traffic**.

The **Traffic** page > **APNs** tab displays the list of APNs configured in the network.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Add APN**.

The **Add APN** page > **Add APN** tab is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FNZG5iFYujLzFTjHNFXlD%2Fimage.png?alt=media&amp;token=e51f5c84-4dbf-4d86-96cb-b74faa3ed777" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
In the **Add APN** tab, enter the following details:

* **ID** – (Required) The APN's ID.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> APN names are case-insensitive, that is "internet" and "Internet" are identical in the system.</p></div>
* **Aggregate BW (Upload)** – (Required) The maximum bandwidth allowed for all non-GBR bearers per UE in uplink direction in Mbps. The value must be in the range of range: 1 Mbps to 1000 Mbps. Default value: 100 Mbps.
* **Aggregate BW (Download)** – (Required) The maximum bandwidth allowed for all non-GBR bearers per UE in downlink direction in Mbps. The value must be in the range of range: 1 Mbps to 1000 Mbps. Default value: 250 Mbps.
* **QoS Category** – (Required) Click to select the APN's QoS category, which specifies the QoS policy for the default bearer associated with the APN. Default value: Low Priority Data. For more information including the QoS parameters per each category, see [QoS Categories](#qosCategories).
  * **High Priority Data** – This category is suitable for critical data traffic that requires high-priority treatment and reliable transmission with low latency and minimal packet loss. Examples include control signals for industrial automation systems, emergency communications, and real-time transactions.
  * **Medium Priority Data** – This category is suitable for important but less time-sensitive data traffic that requires reliable transmission with moderate priority and latency. Examples include email services and non-real-time communications that can tolerate some latency while still requiring reliable delivery.
  * **Low Priority Data** – This category is suitable for non-urgent or background traffic that can tolerate delays or occasional packet loss. Examples include software updates, non-critical file transfers, and bulk data backups.
  * **Custom** – The custom category allows for the creation of a tailored QoS policy that will be applied to all traffic associated with the APN.
    * **QCI** – (Displayed only when the **Custom** QoS category is selected. Required.) Select the QoS Class ID from QCI 5 to QCI 9. Default value: QCI=9.
      * QCI=5 (PDB=100, PER=10^-6)
      * QCI=6 (PDB=300, PER=10^-6)
      * QCI=7 (PDB=100, PER=10^-3)
      * QCI=8 (PDB=300, PER=10^-6)
      * QCI=9 (PDB=300, PER=10^-6)
    * **Pre-emption Priority** – (Displayed only if the **QoS Category** is **Custom**.) The priority level of the bearer associated with this APN relative to other bearers in the network. On a congested cell, it determines the priority of a new bearer setup request—whether to release an established bearer with a lower priority to make way for the new bearer, or to reject the new bearer setup request. Higher priority bearers, indicated by higher ARP values, are less likely to be released in favor of lower priority bearers. Preemption priority ensures that critical services, such as real-time applications, receive preferential treatment, maintaining QoS during periods of network congestion. Default value: 15.
    * **Pre-emption Vulnerability** – (Displayed only if the **QoS Category** is **Custom**.) Enable or disable ARP preemption vulnerability. Specifies whether, during periods of network congestion, the bearer associated with this APN can be released to make way for a new bearer with a higher priority. To enable preemption vulnerability, turn on the toggle button. Default setting: disabled.

      <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The Pre-emption Vulnerability configuration is available only for trials in this release. Keep it disabled. For more information, contact GXC Technical Support.</p></div>
    * **Pre-emption Capability** – (Displayed only if the **QoS Category** is **Custom**.) Enable or disable ARP preemption capability. Specifies whether, during periods of network congestion, establishment of the bearer associated with this APN can lead to the release of an established bearer with a lower priority. To enable preemption capability, turn on the toggle button. Default setting: disabled.

      <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The Pre-emption Capability configuration is available only for trials in this release. Keep it disabled. For more information, contact GXC Technical Support.</p></div>

{% endstep %}

{% step %}
(Applicable only if the Multi-APN-VLAN (non-NAT) mode is enabled at the network level. Required if you are creating the APN after adding the Onyx Edge. Not applicable if you are creating the APN before adding the Onyx Edge.) At the bottom of the page, click **Configure Per APN Per GW**.

If the Multi-APN-VLAN (non-NAT) mode is enabled at the network level, and the Onyx Edge has already been added, enter the following details:

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FqA9A5RUqRcNt5TfqN8rb%2Fimage.png?alt=media&amp;token=af78548b-0369-49a5-a553-29e551a78eb3" alt=""><figcaption></figcaption></figure>

* **GW Name** – (Read only) The associated Onyx Edge's name.
* **Local IP / Subnet** – (Required) The local IP address of the Onyx Edge on the VLAN. The local IP address 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. At the max, any one APN can share the Management VLAN. The VLAN ID must be unique across all APNs and can be 0 or in the range of 2–4095.
* **Default GW MAC** – (Required) The Onyx Edge's MAC address.

If the Multi-APN-VLAN (non-NAT) mode is enabled at the network level, but the Onyx Edge has not been added yet, this section will not be presented. This will be configured later when the Onyx Edge is added.
{% endstep %}

{% step %}
To save the APN, in the upper-right corner of the page, click **Save APN**.
{% endstep %}
{% endstepper %}

### Edit APNs

{% hint style="info" %}
**NOTE:** You can edit APNs only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

**To edit an APN:**

{% stepper %}
{% step %}
In the navigation pane, click **Traffic**. The **Traffic** page > **APNs** tab displays the list of APNs configured in the network.
{% endstep %}

{% step %}
For the APN that you want to edit, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F6Z0wB7p1F2313UTmdI50%2Fimage.png?alt=media&amp;token=0403fc4d-51db-4661-87fe-7594b3f707bd" alt="" width="104"><figcaption></figcaption></figure>

The **Edit APN** page is displayed.
{% endstep %}

{% step %}
Edit the APN's details as required:

* **APN ID** – (Required) The APN's ID.
* **Aggregate BW (Upload)** – (Required) The maximum bandwidth allowed for all non-GBR bearers per UE in the uplink direction in Mbps.
* **Aggregate BW (Download)** – (Required) The maximum bandwidth allowed for all non-GBR bearers per UE in downlink direction in Mbps.
* **QoS Category** – (Required) Click to select the APN's QoS category. The QoS category specifies the QoS policy for the bearer associated with this APN. For more information including the QoS parameters per each category, see [QoS Categories](#qosCategories).
  * **High Priority Data** – Suitable for critical data traffic requiring high-priority treatment and low latency.
  * **Medium Priority Data** – Suitable for important but less time-sensitive traffic.
  * **Low Priority Data** – Suitable for non-urgent or background traffic.
  * **Custom** – Allows creation of tailored QoS policies.
    * **QCI** – (Displayed only if the **QoS Category** is **Custom**. Required.) The QoS Class ID from QCI 5 to QCI 9. Default value: QCI=9.
      * QCI=5 (PDB=100, PER=10^-6)
      * QCI=6 (PDB=300, PER=10^-6)
      * QCI=7 (PDB=100, PER=10^-3)
      * QCI=8 (PDB=300, PER=10^-6)
      * QCI=9 (PDB=300, PER=10^-6)
    * **Pre-emption Priority** – (Displayed only if the **QoS Category** is **Custom**. Required.) The priority level of the bearer associated with this APN relative to other bearers in the network. On a congested cell, it determines the priority of a new bearer setup request—whether to release an established bearer with a lower priority to make way for the new bearer, or to reject the new bearer setup request. Higher priority bearers, indicated by higher ARP values, are less likely to be released in favor of lower priority bearers. Preemption priority ensures that critical services, such as real-time applications, receive preferential treatment, maintaining QoS during periods of network congestion.
    * **Pre-emption Vulnerability** – (Displayed only if the **QoS Category** is **Custom**.) Enable or disable ARP preemption vulnerability. Specifies whether, during periods of network congestion, the bearer associated with this APN can be released to make way for a new bearer with a higher priority. To enable preemption vulnerability, turn on the toggle button. Default setting: disabled.

      <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The Pre-emption Vulnerability configuration is available only for trials in this release. Keep it disabled. For more information, contact GXC Technical Support.</p></div>
    * **Pre-emption Capability** – (Displayed only if the **QoS Category** is **Custom**.) Enable or disable ARP preemption capability. Specifies whether, during periods of network congestion, establishment of the bearer associated with this APN can lead to the release of an established bearer with a lower priority. To enable preemption capability, turn on the toggle button. Default setting: disabled.

      <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The Pre-emption Capability configuration is available only for trials in this release. Keep it disabled. For more information, contact GXC Technical Support.</p></div>

{% endstep %}

{% step %}
To save your edits, in the upper-right corner of the page, click **Save APN**.
{% endstep %}
{% endstepper %}

### Delete APNs

{% hint style="info" %}
**NOTE:** You can delete APNs only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** You can only delete APNs that are not associated with any subscriber groups.
{% endhint %}

{% hint style="info" %}
**NOTE:** You cannot delete the two default APNs available out of the box—Internet and MeshBackhaul.
{% endhint %}

**To delete an APN:**

{% stepper %}
{% step %}
In the navigation pane, click **Traffic**.

The **Traffic** page > **APNs** tab displays the list of APNs configured in the network.
{% endstep %}

{% step %}
For the APN that you want to delete, in the **Actions** column click the corresponding ⋮ (options) icon, then click **Delete**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FicmJpgAfhPssQUla1YMl%2Fimage.png?alt=media&amp;token=55645d62-a848-4d4e-ac69-cf5b36c798a1" alt="" width="104"><figcaption></figcaption></figure>

A confirmation dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FF8W5UbMjDQUAn6cdqzUD%2Fimage.png?alt=media&amp;token=9beca427-0d34-4878-b774-81c8d40a5143" alt="" width="372"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To confirm deleting the APN, click **Yes**.
{% endstep %}
{% endstepper %}

## Manage Applications

{% hint style="info" %}
**NOTE:** You can create and manage applications only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

Application definitions specify the traffic classification rules that distinguish between different types of data flows based on their flow characteristics (direction, protocol, peer IP address, and source and destination ports).

{% hint style="info" %}
**NOTE:** You can create a maximum of 15 flow classification rules per application.
{% endhint %}

The application group's order in the list of associations within a subscriber group determines which application/rule will be matched against a given flow. A flow will only ever be assigned to one application.

For example, a video streaming application deployed in cameras can have a rule like:

{% code overflow="wrap" %}

```
TCP traffic from local port 45000 to {Streaming server IP} port 50000 and vice versa
```

{% endcode %}

A resource-constrained monitoring application that sends status reports periodically may have rules like:

{% code overflow="wrap" %}

```
TCP traffic any local port to {Monitoring Server IP} port 80 and vice versa
UDP traffic from local port 46000 to {Monitoring Server IP} port 50100
```

{% endcode %}

### View Applications

To view applications configured in the network:

{% stepper %}
{% step %}
In the navigation pane, click **Traffic** > **Applications** tab.

The **Traffic** page > **Applications** tab displays the list of configured applications.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FS1NcaMXc0vMdqMy9Ldil%2Fimage.png?alt=media&amp;token=5de9a084-1cb7-41be-8337-be32d829f7e1" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To view an application's details, click the corresponding row.

Any flow classification rules associated with the application are listed.

Application details include:

* **Description** – The application's description.
* **Direction** – The flow's direction—Downlink, Uplink.
* **Protocol** – The flow's communication protocol—ICMP, IP, TCP, UDP.
* **Peer IP/Subnet** – The peer IP address.
* **Peer Port** – The flow's source port number.
* **Destination Port** – The flow's destination port number.
* **Bidirectional** – Indicates if an additional rule has been created internally to match all packets (not just responses) in the reverse direction (based on the selected **Direction**)—No, Yes.
* Actions – (GXC Administrators, GXC Partner Administrators, Super Administrators, and Administrators only.) Click the ⋮ (options) icon to view the options to edit and delete applications.
  {% endstep %}
  {% endstepper %}

### Create Applications

{% hint style="info" %}
**NOTE:** You can create applications only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** Avoid creating applications unless there is a specific need to prioritize certain types of traffic over others. Otherwise, unnecessary applications may increase complexity and overhead in managing the network.
{% endhint %}

**To create an application:**

{% stepper %}
{% step %}
In the navigation pane, click **Traffic** > **Applications** tab.

The **Traffic** page > **Applications** tab displays the list of configured applications.
{% endstep %}

{% step %}
In the upper-right area of the page, click **Add Application**.

The **Add Application** page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fvg3exj4VtK9YuGhqr9V3%2Fimage.png?alt=media&amp;token=1a80a96b-1b4b-4922-92e0-ad7d63707694" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details:

* **Application**
  * **Name** – (Required) The application's name. The application name can be an alphabetic, numeric, or alphanumeric string of up to 32 characters.
    {% endstep %}

{% step %}
Add the flow classification rules to route traffic based on the flow characteristics. For example, to block IP traffic in the uplink direction.

{% hint style="info" %}
NOTE: You can create a maximum of 15 flow classification rules per application.
{% endhint %}

1. To add a flow classification rule, click **Add Flows**, and enter the following details:
   * **Description** – (Optional) The rule's description.
   * **Direction** – (Required) Select the flow's direction between **Uplink** (outgoing), **Downlink** (incoming), and **Bidirectional** (outgoing and incoming, the Onyx system internally creates an additional rule to match all packets (not just responses)). Default value: Bidirectional.
   * **Protocol** – (Required) Select the flow's communication protocol between **ICMP**, **IP**, **TCP**, and **UDP**. Default value: IP.
   * **Peer IP/Subnet** – (Optional) Enter the flow's peer IP address.
   * **Peer Port** – (Optional) Enter the flow's destination port number.
   * **UE Port** – (Optional) Enter the flow's source port number.
2. To save the flow classification rule, under **Actions**, click ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FaJ3moM89OMPgNT6qg6QH%2Fimage.png?alt=media\&token=a25b3d08-50d6-4c65-87c3-52b0c8874e44) (save).
3. To discard the flow classification rule without saving it, under **Actions**, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FEdhWw9qfX43y0dWBVoMA%2Fimage.png?alt=media&amp;token=824ca4ab-1ac8-4efa-814e-f8e935e84746" alt="" data-size="line"> (delete).
   {% endstep %}

{% step %}
To save the application, click **Save Application**.
{% endstep %}
{% endstepper %}

{% hint style="info" %}
**NOTE:** You will not be able save an application until you create and save at least one flow classification rule under it.
{% endhint %}

### Edit Applications

{% hint style="info" %}
**NOTE:** You can edit applications only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** In case application definitions are modified, the changes will not affect the current sessions. The changes will only take effect when the UE establishes a new session.
{% endhint %}

**To edit an application definition:**

{% stepper %}
{% step %}
In the navigation pane, click **Traffic** > **Applications** tab.

The **Traffic** page > **Applications** tab displays the list of configured applications.
{% endstep %}

{% step %}
For the application that you want to edit, click the corresponding ⋮ (options) icon, then click **Edit**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FdgIkRobsA6RmnkHLh4cW%2Fimage.png?alt=media&amp;token=c9258d91-d9b8-4338-9505-15057495fc91" alt="" width="98"><figcaption></figcaption></figure>

The **Edit Application** page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F6TJVVfXaX3Ow6G7X2uwc%2Fimage.png?alt=media&amp;token=178c8766-87bd-43a6-be2a-375afce7bb9f" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Edit the following details as required:

* **Application**
  * **Application Name** – (Required) The application's name.
* **Flows**
  * Add Flows:

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>NOTE: You can create a maximum of 15 flow classification rules per application.</p></div>

    1. To add a flow classification rule, click **Add Flows**, and enter the following details:
       * **Description** – (Optional) The rule's description.
       * **Direction** – (Required) Select the flow's direction between **Uplink**, **Downlink**, and **Bidirectional**. Default value: Bidirectional.
       * **Protocol** – (Required) Select the flow's communication protocol between **ICMP**, **IP**, **TCP**, and **UDP**. Default value: IP.
       * **Peer IP/Subnet** – (Optional) Enter the flow's peer IP address.
       * **Peer Port** – (Optional) Enter the flow's destination port number.
       * **UE Port** – (Optional) Enter the flow's source port number.
    2. To save the rule, under **Actions**, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FbAbtX253iKi7qaEb7CeS%2Fimage.png?alt=media&amp;token=7936ab5b-79cd-4f2a-be23-ade54e94dee3" alt="" data-size="line"> (save).
    3. To discard the rule without saving it, under **Actions**, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FMGTGcq3XMDv4mF7YNHsZ%2Fimage.png?alt=media&amp;token=b605a51c-41ba-4823-bef6-918718a6061b" alt="" data-size="line"> (delete).
  * Edit Flows:

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>NOTE: You can create a maximum of 15 flow classification rules per application.</p></div>

    1. To edit a flow classification rule, click the corresponding <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fps54EyHVPFFrrqi15iFe%2Fimage.png?alt=media&amp;token=d7e53aa8-df01-49da-8538-cd3f858d80d8" alt="" data-size="original"> (edit) icon and edit the following details as required.
       * **Description** – (Optional) The rule's description.
       * **Direction** – (Required) Select the flow's direction between Uplink and Downlink. Default value: Uplink.
       * **Protocol** – (Required) Select the flow's communication protocol between ICMP, IP, TCP, and UDP. Default value: IP.
       * **Peer IP** – (Optional) Enter the flow's peer IP address.
       * **Source Port** – (Optional) Enter the flow's source port number.
       * **Destination Port** – (Optional) Enter the flow's destination port number.
       * **Bidirectional** – (Required) If the Onyx system should internally create an additional rule to match all packets (not just responses) in the reverse direction (based on the selected **Direction)**, select the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FWzCTpCdNjTrQgKS67WLD%2Fimage.png?alt=media&amp;token=e5abfb77-0b6a-43b3-a1f1-e9d84c89549c" alt="" data-size="line">/<img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FILuLEOQmFZreD9Boz5Qa%2Fimage.png?alt=media&amp;token=b89d4108-1c15-4244-9c1e-3923b433903e" alt="" data-size="line"> check box.
    2. To save your edits, under **Actions**, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmL1MaDNgekgE5aYgW1rS%2Fimage.png?alt=media&amp;token=10fd495f-61af-4b22-99ce-389ba6c7eb34" alt="" data-size="line"> (save).
  * Delete Flows: To delete a flow classification rule, click the corresponding <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FrqmljQnaFUjNVBBMhl05%2Fimage.png?alt=media&amp;token=39726f8b-e4f3-4162-9292-1f4941e4b3ed" alt="" data-size="line"> (delete) icon.
    {% endstep %}

{% step %}
To save your edits, in the lower-right area of the page, click **Save Application**.
{% endstep %}
{% endstepper %}

### Delete Applications

{% hint style="info" %}
**NOTE:** You can delete applications only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** You cannot delete applications that are associated with application groups.
{% endhint %}

**To delete an application definition:**

{% stepper %}
{% step %}
In the navigation pane, click **Traffic** > **Applications** tab.

The **Traffic** page > **Applications** tab displays the list of configured applications.
{% endstep %}

{% step %}
For the application that you want to delete, click the corresponding ⋮ (options) icon, then click **Delete**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FArdmK3nx4geguSlOg5pV%2Fimage.png?alt=media&amp;token=4e0eb6c9-01e6-4178-80c5-089272c48eae" alt="" width="98"><figcaption></figcaption></figure>

A confirmation dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8AP9ce78YAne0WsDGwpM%2Fimage.png?alt=media&amp;token=e2524a72-1a79-4499-b817-2a78e2f756a3" alt="" width="378"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To confirm deleting the application, click **Yes**.
{% endstep %}
{% endstepper %}

## Manage Application Groups

{% hint style="info" %}
**NOTE:** In this release, Application Groups are supported only in 4G networks.
{% endhint %}

{% hint style="info" %}
**NOTE:** You can create and manage application groups only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

Application groups allow you to group applications together based on their common characteristics, such as similar resource usage patterns. These groups can be used as match criteria to optimize the allocation of network resources to different application groups. For instance, you could create a "Monitoring Application Group" that contains multiple monitoring applications.

### View Application Groups

**To view application groups configured in the network:**

{% stepper %}
{% step %}
In the navigation pane, click **Traffic** > **Application Groups** tab.

The **Traffic** page > **Application Groups** tab displays the list of configured application groups.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXN5UQ69OwO3dJQCdnp9V%2Fimage.png?alt=media&amp;token=066cc925-2eb3-4c53-9c7f-d730df2fea87" alt=""><figcaption></figcaption></figure>

The application groups list shows:

* **Name** – The application group's name.
* **Application** – The applications associated with the application group.
* **Downlink BW (Mbps)**
  * **Max** – The maximum bandwidth allocated to traffic flows originating from the network or internet and traveling towards a UE. Any packets arriving at the bearer after this limit is exceeded will be discarded.
  * **Guaranteed** – The minimum bandwidth allocated to traffic flows originating from the network or internet and traveling towards a UE.
* **Uplink BW (Mbps)**
  * **Max** – The maximum bandwidth allocated to traffic flows originating from a UE and traveling towards the network or internet. Any packets arriving at the bearer after this limit is exceeded will be discarded.
  * **Guaranteed** – The guaranteed/minimum bandwidth that will be allocated to traffic flows originating from a UE and traveling towards the network or internet.
* **QoS Category** – The application group's QoS category, which specifies the QoS policy for the bearer associated with this application group—Live Audio, Live Video, Real-time Applications, High Priority Data, or Custom. For more information see [QoS Categories](#qosCategories).
* **QCI** – (Displayed only for custom QoS categories.) The QoS Class Identifier assigned to the application group.
* **Pre-emption**
  * **Priority (ARP)** – (Displayed only for custom QoS categories.) The priority level of the bearer associated with this application group relative to other bearers in the network.
  * **Vulnerability** – (Displayed only for custom QoS categories.) Indicates whether, during periods of network congestion, the bearer associated with this application group can be released to make way for a new bearer with a higher priority.
  * **Capability** – (Displayed only for custom QoS categories.) Indicates whether, during periods of network congestion, establishment of the bearer associated with this application group could lead to the release of an established bearer with a lower priority.
* **Actions** – (GXC Administrators, GXC Partner Administrators, Super Administrators, and Administrators only.) Options to edit and delete application groups.
  {% endstep %}
  {% endstepper %}

### Create Application Groups

{% hint style="info" %}
**NOTE:** You can create application groups only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

**To create an application group:**

{% stepper %}
{% step %}
In the navigation pane, click **Traffic** > **Application Groups** tab.

The **Traffic** page > **Application Groups** tab displays the list of configured application groups.
{% endstep %}

{% step %}
In the upper-right area of the page, click **Add Application Group**.

The **Add Application Group** page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FZuK3V0LguqmR7PKGeWXQ%2Fimage.png?alt=media&amp;token=9964a823-472a-430b-b311-b6bc3684da59" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details:

* **Application Group Name** – (Required) The application group's ID. It can be an alphabetic, numeric, or alphanumeric string of up to 32 characters.
* **Applications** – (Required) Click to select the applications to add to the group.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> You can associate a maximum of 15 applications with an application group.</p></div>
* **Downlink Max BW (Mbps)** – (Required) The maximum bandwidth that will be allocated to traffic flows originating from the network or internet and traveling towards a UE. Any packets arriving at the bearer after this limit is exceeded will be discarded. Default value: 100 Mbps.
* **Uplink Max BW (Mbps)** – (Required) The maximum bandwidth that will be allocated to traffic flows originating from a UE and traveling towards the network or internet. Any packets arriving at the bearer after this limit is exceeded will be discarded. Default value: 100 Mbps.
* **Guaranteed BW** – To reserve bandwidth for the bearer associated with this application group, select the **Guaranteed BW** check box. This parameter decides if the bearer is a GBR bearer or a non-GBR bearer. Default setting: Selected (GBR bearer).
  * **Downlink Guaranteed BW (Mbps)** – (Displayed only if the **Guaranteed BW** check box is selected.) The guaranteed/minimum bandwidth that will be allocated to traffic flows originating from the network or internet and traveling towards a UE. Default value: 10 Mbps.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> <strong>Downlink Guaranteed BW</strong> must always be less than or equal to <strong>Downlink Max BW</strong>.</p></div>
  * **Uplink Guaranteed BW (Mbps)** – (Displayed only if the **Guaranteed BW** check box is selected.) The guaranteed/minimum bandwidth that will be allocated to traffic flows originating from a UE and traveling towards the network or internet. Default value: 10 Mbps.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> <strong>Uplink Guaranteed BW</strong> must always be less than or equal to <strong>Uplink Max BW</strong>.</p></div>

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The maximum possible GBR values for downlink and uplink based on the Subframe Assignment and Primary Cell Channel Bandwidth.</p></div>

    | Bandwidth of the Primary Carrier | Subframe Assignment | GBR Downlink (Mbps) | GBR Uplink (Mbps) |
    | -------------------------------- | ------------------- | ------------------- | ----------------- |
    | 20 MHz +                         | 2                   | 28                  | 3                 |
    | 10 MHz                           | 2                   | 14                  | 1.5               |
    | 20 MHz +                         | 6                   | 16                  | 8                 |
    | 10 MHz                           | 6                   | 8                   | 4                 |
* **QoS Category** – (Required) Click to select the application group's QoS category. The QoS category specifies the QoS policy for the application group. For more information including the QoS parameters configured per category, see [QoS Categories](#qosCategories).

  * **Live Audio** – This category is suitable for applications and services that require real-time transmission of audio data. It ensures low latency and minimal jitter to maintain the real-time nature of the audio stream.
  * **Live Video** – This category is suitable for applications and services that involve real-time transmission of video data, such as video conferencing, live streaming, or remote surveillance. It prioritizes low latency and stable throughput to support smooth video playback and minimize buffering.
  * **Real-time Applications** – This category is suitable for applications and services (other than audio and video) that require real-time responsiveness and low latency, such as remote desktop applications. It provides a balance between low latency and efficient resource utilization.
  * **High Priority Data** – This category is suitable for applications and services that require high-priority treatment with moderate latency, while still maintaining a high level of reliability to support time-sensitive operations. Examples include control signals for industrial automation systems and telemetry data in IoT deployments.
  * **Custom** – The custom category allows for the creation of tailored QoS policies based on the needs of specific applications, services, or subscriber groups.

  <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FDVjEdT54DRKpcX6QkXLz%2Fimage.png?alt=media&amp;token=b526a21b-85a9-4538-8c65-31b1a2f6d0ff" alt=""><figcaption></figcaption></figure>
* **QCI** – (Displayed only if the **QoS Category** is **Custom**. Required.) Select the QoS Class Identifier.

  (If the **Guaranteed BW** check box is selected.) For GBR bearer configuration, select from QCI 1 to QCI 4. Default value: QCI=1.

  * QCI=1 (PDB=100, PER=10^-2)
  * QCI=2 (PDB=150, PER=10^-3)
  * QCI=3 (PDB=50, PER=10^-3)
  * QCI=4 (PDB=300, PER=10^-6)

  (If the **Guaranteed BW** check box is cleared.) For non-GBR bearer configuration, select from QCI 5 to QCI 9. Default value: QCI=5.

  * QCI=5 (PDB=100, PER=10^-6)
  * QCI=6 (PDB=300, PER=10^-6)
  * QCI=7 (PDB=100, PER=10^-3)
  * QCI=8 (PDB=300, PER=10^-6)
  * QCI=9 (PDB=300, PER=10^-6)
* **Pre-emption Priority (ARP)** – (Displayed only if the **QoS Category** is **Custom**. Required.) The priority level of the bearer associated with this application group relative to other bearers in the network. On a congested cell, it determines the priority of a new bearer setup request—whether to release an established bearer with a lower priority to make way for the new bearer, or to reject the new bearer setup request. Higher priority bearers, indicated by higher ARP values, are less likely to be released in favor of lower priority bearers. Preemption priority ensures that critical services, such as real-time applications, receive preferential treatment, maintaining QoS during periods of network congestion. Default value: 2.
* **Pre-emption Vulnerability** – (Displayed only if the **QoS Category** is **Custom**.) Enable or disable ARP preemption vulnerability. Specifies whether, during periods of network congestion, the bearer associated with this application group can be released to make way for a new bearer with a higher priority. To enable preemption vulnerability, turn on the toggle button. Default setting: disabled. Default setting: disabled.

{% hint style="info" %}
**NOTE:** The Pre-emption Vulnerability configuration is available only for trials in this release. Keep it disabled. For more information, contact GXC Technical Support.
{% endhint %}

* **Pre-emption Capability** – (Displayed only if the **QoS Category** is **Custom**.) Enable or disable ARP preemption capability. Specifies whether, during periods of network congestion, establishment of the bearer associated with this application group can lead to the release of an established bearer with a lower priority. To enable preemption capability, turn on the toggle button. Default setting: disabled.

{% hint style="info" %}
**NOTE:** The Pre-emption Capability configuration is available only for trials in this release. Keep it disabled. For more information, contact GXC Technical Support.
{% endhint %}
{% endstep %}

{% step %}
To save the application group, in the lower-right corner of the page, click **Save Application Group**.
{% endstep %}
{% endstepper %}

### Edit Application Groups

{% hint style="info" %}
**NOTE:** You can edit application groups only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

**To edit an application group:**

{% stepper %}
{% step %}
In the navigation pane, click **Traffic** > **Application Groups** tab.

The **Traffic** page > **Application Groups** tab displays the list of configured application groups.
{% endstep %}

{% step %}
For the application group that you want to edit, in the **Actions** column click the corresponding ⋮ (options) icon, then click **Edit**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FcrosokhuEdZpjh9MmLA0%2Fimage.png?alt=media&amp;token=f7f2bd38-4117-484f-8963-1a33177af3ff" alt="" width="104"><figcaption></figcaption></figure>

The **Edit Application Group** page displays the application group's details.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FEkOBFP7HHDa3yaofLv8K%2Fimage.png?alt=media&amp;token=5c599069-a21c-4ea5-85ae-163fb337ea12" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Edit the following details as required:

* **Name** – (Required) The application group's name.
* **Applications** – (Required) Click to add or remove applications from the group— select or clear the corresponding check boxes.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> You can associate a maximum of 15 applications with an application group.</p></div>
* **Downlink Max BW (Mbps)** – (Required) The maximum bandwidth that will be allocated to traffic flows originating from the network or internet and traveling towards a UE. Any packets arriving at the bearer after this limit is exceeded will be discarded. Default value: 100 Mbps.
* **Uplink Max BW (Mbps)** – (Required) The maximum bandwidth that will be allocated to traffic flows originating from a UE and traveling towards the network or internet. Any packets arriving at the bearer after this limit is exceeded will be discarded. Default value: 100 Mbps.
* **Guaranteed BW** – To reserve bandwidth for the application group, select the **Guaranteed BW** check box. This parameter decides if the bearer is a GBR bearer or a non-GBR bearer. Default setting: selected (GBR bearer).

  * **Downlink Guaranteed BW (Mbps)** – (Displayed only if the Guaranteed BW check box is selected.) The guaranteed/minimum bandwidth that will be allocated to traffic flows originating from the network or internet and traveling towards a UE. Default value: 10 Mbps.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> <strong>Downlink Guaranteed BW</strong> must always be less than or equal to <strong>Downlink Max BW</strong>.</p></div>
  * **Uplink Guaranteed BW (Mbps)** – (Displayed only if the Guaranteed BW check box is selected.) The guaranteed/minimum bandwidth that will be allocated to traffic flows originating from a UE and traveling towards the network or internet. Default value: 10 Mbps.

    <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> <strong>Uplink Guaranteed BW</strong> must always be less than or equal to <strong>Uplink Max BW</strong>.</p></div>

  Note the maximum possible GBR values for downlink and uplink based on the Subframe Assignment and Primary Cell Channel Bandwidth.

  | Bandwidth of the Primary Carrier | Subframe Assignment | GBR Downlink (Mbps) | GBR Uplink (Mbps) |
  | -------------------------------- | ------------------- | ------------------- | ----------------- |
  | 20 MHz +                         | 2                   | 28                  | 3                 |
  | 10 MHz                           | 2                   | 14                  | 1.5               |
  | 20 MHz +                         | 6                   | 16                  | 8                 |
  | 10 MHz                           | 6                   | 8                   | 4                 |
* **QoS Category** – (Required) Click to select the application group's QoS category. The QoS category specifies the QoS policy for the application group. For more information including the QoS parameters configured per category, see [QoS Categories](#qosCategories).

  * **Live Audio** – This category is suitable for applications and services that require real-time transmission of audio data. It ensures low latency and minimal jitter to maintain the real-time nature of the audio stream.
  * **Live Video** – This category is suitable for applications and services that involve real-time transmission of video data, such as video conferencing, live streaming, or remote surveillance. It prioritizes low latency and stable throughput to support smooth video playback and minimize buffering.
  * **Real-time Applications** – This category is suitable for applications and services (other than audio and video) that require real-time responsiveness and low latency, such as remote desktop applications. It provides a balance between low latency and efficient resource utilization.
  * **High Priority Data** – This category is suitable for applications and services that require high-priority treatment with moderate latency, while still maintaining a high level of reliability to support time-sensitive operations. Examples include control signals for industrial automation systems and telemetry data in IoT deployments.
  * **Custom** – The custom category allows for the creation of tailored QoS policies based on the needs of specific applications, services, or subscriber groups.

  <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQCldLbTiY44rTdHbSxwG%2Fimage.png?alt=media&amp;token=943bc1dd-602b-4011-8313-47c198b483c6" alt=""><figcaption></figcaption></figure>
* **QCI** – (Displayed only when the **Custom** QoS category is selected. Required.) Select the QoS Class Identifier.

  (If the **Guaranteed BW** check box is selected.) For GBR bearer configuration, select from QCI 1 to QCI 4. Each QCI is assigned a standard Packet Delay Budget and Packet Error Rate. Default value: QCI=1.

  * QCI=1 (PDB=100, PER=10^-2)
  * QCI=2 (PDB=150, PER=10^-3)
  * QCI=3 (PDB=50, PER=10^-3)
  * QCI=4 (PDB=300, PER=10^-6)

  (If the **Guaranteed BW** check box is cleared.) For non-GBR bearer configuration, select from QCI 5 to QCI 9. Default value: QCI=5.

  * QCI=5 (PDB=100, PER=10^-6)
  * QCI=6 (PDB=300, PER=10^-6)
  * QCI=7 (PDB=100, PER=10^-3)
  * QCI=8 (PDB=300, PER=10^-6)
  * QCI=9 (PDB=300, PER=10^-6)
* **Pre-emption Priority (ARP)** – (Displayed only if the **QoS Category** is **Custom**. Required.) The priority level of the bearer associated with this application group relative to the other bearers in the network. On a congested cell, it determines the priority of a new bearer setup request—whether to release an established bearer with a lower priority to make way for the new bearer, or to reject the new bearer setup request. Higher priority bearers, indicated by higher ARP values, are less likely to be released in favor of lower priority bearers. Preemption priority ensures that critical services, such as real-time applications, receive preferential treatment, maintaining QoS during periods of network congestion. Default value: 2.
* **Pre-emption Vulnerability** – (Displayed only if the **QoS Category** is **Custom**.) Enable or disable ARP preemption vulnerability. Specifies whether, during periods of network congestion, the bearer associated with this application group can be released to make way for a new bearer with a higher priority. To enable preemption vulnerability, turn on the toggle button. Default setting: disabled.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The Pre-emption Vulnerability configuration is available only for trials in this release. Keep it disabled. For more information, contact GXC Technical Support.</p></div>
* **Pre-emption Capability** – (Displayed only if the **QoS Category** is **Custom**.) Enable or disable ARP preemption capability. Specifies whether, during periods of network congestion, establishment of the bearer associated with this application group can lead to the release of an established bearer with a lower priority. To enable preemption capability, turn on the toggle button. Default setting: disabled.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The Pre-emption Capability configuration is available only for trials in this release. Keep it disabled. For more information, contact GXC Technical Support.</p></div>

{% endstep %}

{% step %}
To save your edits, click **Save Application Group**.
{% endstep %}
{% endstepper %}

### Delete Application Groups

{% hint style="info" %}
**NOTE:** You can delete application groups only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

**To delete an application group:**

{% stepper %}
{% step %}
In the navigation pane, click **Traffic** > **Application Groups** tab.

The **Traffic** page > **Application Groups** tab displays the list of configured application groups.
{% endstep %}

{% step %}
For the application group that you want to delete, in the **Actions** column click the corresponding ⋮ (options) icon, then click **Delete**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FbS8XPOGDnCjl8b7W5vZo%2Fimage.png?alt=media&amp;token=4268b95e-eefc-4d30-b8eb-038499e7230a" alt="" width="104"><figcaption></figcaption></figure>

A confirmation dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FpmYCK3QbKSHpmhQnsI7n%2Fimage.png?alt=media&amp;token=70ea0626-753f-4372-a568-82912f0648e3" alt="" width="445"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To confirm deleting the application group, click **Yes**.
{% endstep %}
{% endstepper %}


# Manage Alerts

Alerts provide notifications about significant events within the network and are key to monitoring and debugging potential issues in your network in a timely fashion.

For example, you can configure an alert rule to notify when the CPU percentage on the gateway is running > 75% in the last five minutes. Or, for example, when more than three Onyx Edge services restarted in the last one hour.

## Alert Notifications

The Onyx Portal provides alert notifications via the Active Alerts Counters panel and email notifications.

### Active Alert Counters Panel

The Active Alert Counters panel in the header area displays the count of active Critical, Major, Minor, and Other alerts. The "Other" category accounts for alerts of Warning, Info, and Notice severities.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FzFwEfVm1KJGXnlJBV2dY%2Fimage.png?alt=media&amp;token=0325cbca-79a1-4d5d-b056-815a03c86ee9" alt="" width="179"><figcaption></figcaption></figure>

**To view active alerts:**

{% stepper %}
{% step %}
Click the Alert Counters panel.

The **Active Alerts** page is displayed.

For more information, see [*View Active Alerts*](#view-active-alerts).
{% endstep %}
{% endstepper %}

### Alert Email Notifications

The Onyx Portal sends alert notification emails when an alert is triggered, every one hour until the alert gets cleared, and when the alert finally gets cleared.

{% hint style="info" %}
**NOTE:** The alert notification emails are only sent to receivers configured to receive alert notifications for specified alert severity levels. For more information, see [*Manage Alert Receiver Accounts*](#manage-alert-receiver-accounts).
{% endhint %}

The alert notification emails use the following format for their subject lines:

`Alert Notifications | <alert severity level> | <customer name>`

The body of the alert notification emails include the following details:

* **Time Zone** – The timestamp at which the alert was generated or cleared, and the time zone of the venue where the alert was generated or cleared.
* **Alert Duration** – The duration for which the alert has remained active.
* **Network Name** – The network's name.
* **Alert Name** – The alert's name.
* **Equipment Name** – The alert's source (AP, Mesh Node, or Onyx Edge equipment's name) linking to the Onyx Portal equipment details page.
* Link to the Onyx Portal Alerts page—[*https://portal.gxc.io/#/alert/alerts*](https://portal.gxc.io/%23/alert/alerts).

## View Active Alerts

Active alerts are alerts that have been triggered but not yet cleared and still require attention. The Active Alerts view displays all currently active instances of all alerts.

The Active Alerts view is auto-refreshed every one minute.

**To view active alerts' details:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts**.

The **Alerts** page > **Active Alerts** tab displays the list of active alert instances.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F4PRXHNINobJlLYhxXP3p%2Fimage.png?alt=media&amp;token=e62d099d-f17a-40c3-9b2a-e31c703b932f" alt=""><figcaption></figcaption></figure>

* **Start Time** – The timestamp at which the alert was triggered.\
  To sort the list of alerts by start time, click the column header.
* **Duration** – The duration for which the alert is active.
* **Severity** – The alert's severity level—Critical, Major, Minor, Warning, Info, Notice.\
  To sort the list of alerts by severity, click the column header.
* **ID** – The alert's ID used to identify the alert. This is a fixed ID that third-party tooling can use to identify the alerts.
* **Type** – The alert's type used to identify the problem source or type—Access Point, Mesh Node, Onyx Edge, Orchestrator, Provisioning Server.
* **Module** – The associated module.
  * Management Plane – Relating to equipment configuration and communicating the configuration to the device. Module ID: 01.
  * Control Plane – Relating to protocol operations of the equipment for control plane. Module ID: 02.
  * User Plane – Relating to protocol operations of the equipment for user plane. Module ID: 03.
  * Platform – Relating to functioning of the equipment. Module ID: 04.
  * CU Plane – Relating to either or both control and user plane. Module ID: 05.
  * MCU Plane – Relating to either or all of Management, Control, User Plane. Module ID: 06.
  * Domain Proxy – Relating to Domain Proxy. Module ID: 07.
* **Name** – The alert's name.\
  To view the alert's details, click the alert's name.\
  To sort the list of alerts by alert name, click the column header.
* **Device ID** – The associated device's ID.
* **Description** – The alert's description.
* **Instance ID** – The alert's instance ID, which differentiates between multiple instances of the same alert.
* **Mute Alert** – While investigating an active alert, mute or unmute an active alert instance to suppress or enable the hourly alert email notifications for that specific alert instance.

  To mute an alert instance to stop alert email notifications, turn on the toggle button. To resume the alert email notifications, unmute the alert instance by turning off the toggle button.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> This mute/unmute configuration is alert instance specific. If necessary, any new or other instances of an alert must be explicitly muted/unmuted.</p></div>

{% endstep %}

{% step %}
To view an alert's details, in the alerts list, click the alert's name.

The ***\<alert name>*** dialog box displays the alert's details.
{% endstep %}

{% step %}
To sort the list by alert creation timestamp, click the **Start Time** column header.
{% endstep %}

{% step %}
To sort the list by alert severity level, click the **Severity** column header.
{% endstep %}
{% endstepper %}

## View Cleared Alerts

Cleared alerts are alerts that were previously active but have subsequently been cleared either by user intervention or automatically by the system.

{% hint style="info" %}
**NOTE:** The cleared alerts history is available only for alerts cleared in the last seven days and lists only the most recent 1000 cleared alerts.
{% endhint %}

{% hint style="info" %}
**NOTE:** The Cleared Alerts view auto-refreshes every one minute.
{% endhint %}

**To view cleared alerts' details:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Cleared Alerts** tab.

The **Alerts** page > **Cleared Alerts** tab displays the list of alerts cleared in the selected time duration.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fgs6KBaJg9lGL89FG0zCy%2Fimage.png?alt=media&amp;token=60f39f03-dded-48c9-a514-d0b26071f49b" alt=""><figcaption></figcaption></figure>

* **Start Time** – The timestamp at which the alert was triggered.\
  To sort the list of alerts by start time, click the column header.
* **Duration** – The duration for which the alert was active.\
  To sort the list by duration, click the column header.
* **Severity** – The alert's severity level—Critical, Major, Minor, Warning, Info, Notice.\
  To sort the list by severity, click the column header.
* **ID** – The alert's ID used to reference the alert.

  To search for cleared alerts by alert ID, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FcM66o5rGP1k9sEBWbxoB%2Fimage.png?alt=media&amp;token=227e33ca-1c95-4ac3-8cdf-c815a74ab97a" alt="" data-size="line">, then in the Search box, enter the alert ID.
* **Type** – The alert's type—Onyx Edge, Access Point, Provisioning Server, etc.

  To search for cleared alerts by alert type, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FcM66o5rGP1k9sEBWbxoB%2Fimage.png?alt=media&amp;token=227e33ca-1c95-4ac3-8cdf-c815a74ab97a" alt="" data-size="line">, then in the Search box, enter the alert type.
* **Module** – The associated module—Platform, Management Plane, MCU Plane, etc.

  To search for cleared alerts by associated module, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FcM66o5rGP1k9sEBWbxoB%2Fimage.png?alt=media&amp;token=227e33ca-1c95-4ac3-8cdf-c815a74ab97a" alt="" data-size="line">, then in the Search box, enter the module name.
* **Name** – The alert's name.

  To search for cleared alerts by alert name, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FcM66o5rGP1k9sEBWbxoB%2Fimage.png?alt=media&amp;token=227e33ca-1c95-4ac3-8cdf-c815a74ab97a" alt="" data-size="line">, then in the Search box, enter the alert name.\
  To sort the list by alert name, click the column header.
* **Device ID** – The associated device ID.

  To search for cleared alerts by device ID, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FcM66o5rGP1k9sEBWbxoB%2Fimage.png?alt=media&amp;token=227e33ca-1c95-4ac3-8cdf-c815a74ab97a" alt="" data-size="line">, then in the Search box, enter the device ID.
* **Description** – The alert's description.
* **Instance ID** – The alert's instance ID, which differentiates between multiple instances of the same alert.

  To search for cleared alerts by instance ID, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FcM66o5rGP1k9sEBWbxoB%2Fimage.png?alt=media&amp;token=227e33ca-1c95-4ac3-8cdf-c815a74ab97a" alt="" data-size="line">, then in the Search box, enter the instance ID.
  {% endstep %}

{% step %}
To change the duration for which the cleared alerts are displayed, change the selected from and to timestamps <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8yULO0e33BwO7cHwrU6S%2Fimage.png?alt=media&amp;token=5e67cbc6-5383-4cf0-8bb0-029727922707" alt="" data-size="line">.
{% endstep %}

{% step %}
To sort the alerts list by alert creation timestamp, click the **Start Time** column header.
{% endstep %}
{% endstepper %}

## Manage Muting Alerts

Muting alerts involves suspending the alert email notifications sent by the Onyx system. Typically, alerts are muted to prevent unnecessary alert email notifications during planned maintenance and other situations where the alerts may not require immediate attention.

Alerts can be muted at the following levels:

* Active Alert Instance Level – Muting and unmuting active alert instances allows you to suppress and enable alert email notifications for specific active instances of an alert. For more information, see [*Mute/Unmute Specific Instances of Active Alerts*](#muteunmute-specific-instances-of-active-alerts).
* Alert Rule Level – Muting and unmuting alerts per alert rule allows to suppress and enable alert email notifications for all alerts generated by individual alert rules. For more information, see [*Mute/Unmute Alerts per Alert Rule*](#muteunmute-alerts-per-alert-rule).

### View Muted Alerts

**To view muted alerts:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Muted Alerts** tab.

The **Alerts** page > **Muted Alerts** tab displays the list of muted alerts.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FP3dGyLjZYmR3kcDgqdfl%2Fimage.png?alt=media&amp;token=53b43324-5b7c-434a-869d-2a8eefcebe14" alt=""><figcaption></figcaption></figure>

* <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FAols322iaP7kivxoJF4w%2Fimage.png?alt=media&amp;token=b94462a9-7d67-49e8-baf4-79f9a71e55fa" alt="" data-size="line"> (checkbox) – Select/clear all or specific alerts.
* **Type** – The alert's type—Access Point, Mesh Node, Onyx Edge, Orchestrator.
* **Name** – The alert's name.
* **Devices** – The device names for which an alert is muted.
* **Actions** – Options to edit and delete a muted alert rule.
  {% endstep %}
  {% endstepper %}

### Mute/Unmute Active Alert Instances

Muting and unmuting active alert instances allows you to suppress or enable alert email notifications for specific active instances of an alert.

You can mute alert email notifications for a specific alert either for all equipment or only for specific equipment. For example, you can mute alert notifications for the "Offline" and "Cell Service Down" alerts for a specific AP or for all APs in the network.

#### Mute Active Alerts

{% hint style="info" %}
**NOTE:** You can mute active alert notifications only if you are a GXC Administrator.
{% endhint %}

You can either mute:

* All alert notifications for a specific alert.
* Alert notifications for a specific alert either for all equipment or only for specific equipment. For example, you can mute alert notifications for the "Offline" and "Cell Service Down" alerts for a specific AP or for all APs in the network.

#### Create Alert Mute Rules

**To create an alert mute rule:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Muted Alerts** tab.

The **Alerts** page > **Muted Alerts** tab displays the list of muted alerts.
{% endstep %}

{% step %}
Click **Mute New Alerts**.

The **Add Mute Rule** dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FFrPWhvUZOgzoNaFGpeXh%2Fimage.png?alt=media&amp;token=6cb20286-1442-4e64-8afb-92f2e957303e" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
In the **Select Alert Type** dropdown, select the alert type from **Onyx Edge**, **Access Point**, **Orchestrator**, **Mesh Node**.

The list of alerts related to the selected alert type is displayed.
{% endstep %}

{% step %}
In the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FO891yzMQkmUIEGBPbRlK%2Fimage.png?alt=media&amp;token=3f5dac1d-7e9f-4a1e-8a25-2e4f49250caf" alt="" data-size="line"> (select/clear) column, select the alert that you want to mute.
{% endstep %}

{% step %}
(Applicable only to Onyx Edge, Access Point, and Mesh Node alert types.) To mute the selected alert for specific equipment, in the **Device List** column, click the corresponding **Select Devices** dropdown, and select the specific equipment.

To mute alert notifications for all equipment, select **Select All**.
{% endstep %}

{% step %}
Select any other alerts to mute and select the required equipment.
{% endstep %}

{% step %}
To save your edits, click **Submit**.
{% endstep %}
{% endstepper %}

#### Edit Alert Mute Rules

{% hint style="info" %}
**NOTE:** You can edit alert mute rules only if you are a GXC Administrator.
{% endhint %}

**To edit alert mute rules:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Muted Alerts** tab.

The **Alerts** page > **Muted Alerts** tab displays the list of muted alerts.
{% endstep %}

{% step %}
For the alert mute rule that you want to edit, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FiAbGBADtM07VEvxzLG2w%2Fimage.png?alt=media&amp;token=2afd373a-831d-404d-b82f-6f44345174f9" alt="" width="104"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
In the **Devices** column, select or clear the devices for which the alert is muted.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FpM2f0JasMhWvv6juZXDL%2Fimage.png?alt=media&amp;token=b5f4060f-fa09-4b9b-8b78-f6b700701e4a" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To save your edits, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJZQgc85dfdzB5nyPmiD8%2Fimage.png?alt=media&amp;token=a45bcd7d-d0e6-401a-9235-b42284ec813a" alt="" data-size="line">.
{% endstep %}
{% endstepper %}

#### Delete Alert Mute Rules

{% hint style="info" %}
**NOTE:** You can delete alert mute rules only if you are a GXC Administrator.
{% endhint %}

**To delete alert mute rules:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Muted Alerts** tab.

The **Alerts** page > **Muted Alerts** tab displays the list of muted alerts.
{% endstep %}

{% step %}
For the alert mute rule(s) that you want to delete, in the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F1DsszPwAFE3YpNlCiPYr%2Fimage.png?alt=media&amp;token=e0192cb2-44e3-4120-b58c-0d9cd2be79c1" alt="" data-size="line"> (select/clear) column, select the rule(s), then click **Delete**.

Alternately, to delete a particular alert mute rule, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Delete**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FUQHk4TdWuejvTPteLh6W%2Fimage.png?alt=media&amp;token=b570c7c2-a1b6-42e9-bf7b-ebc4ec979e88" alt="" width="104"><figcaption></figcaption></figure>

A confirmation dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fu9bOeBFHZ4P4PUmWoLOs%2Fimage.png?alt=media&amp;token=5510b04f-dba3-4922-9932-f68471257e67" alt="" width="511"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To confirm the deletion, click **Yes**.
{% endstep %}
{% endstepper %}

### Mute/Unmute Specific Instances of Active Alerts

Muting and unmuting alert instances allows you to suppress or enable alert email notifications for specific instances of an active alert. This allows to silence an alert's individual instance instead of silencing the entire alert providing more granular control over the alerting process.

{% hint style="info" %}
**NOTE:** This mute/unmute configuration is alert instance specific. If necessary, any new or other instances of an alert must be explicitly muted/unmuted.
{% endhint %}

#### Mute Specific Instance of an Active Alert

**To mute an alert's instance:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Active Alerts** tab.

The **Alerts** page > **Active Alerts** tab displays the list of active alert instances.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FAKVTjZG9ZiXwPRdv3zjg%2Fimage.png?alt=media&amp;token=a3b345e2-6219-418a-9dbb-057ecf0b85e7" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
For the alert instance that you want to mute, in the **Mute Alert** column, turn on the corresponding toggle switch.

The **Mute&#x20;*****\<alert type> \<alert name>*****&#x20;Alert** dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FGXL80gZgs3adXr14ZG5j%2Fimage.png?alt=media&amp;token=e51ab2f1-7846-4d9c-a103-742b96b8b842" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
In the **Select a Time Duration** dropdown, select the duration for which the alert instance must remain muted from **Twenty-Four Hours**, **One Week**, **Forever**.
{% endstep %}

{% step %}
To save your changes, click **Submit**.
{% endstep %}
{% endstepper %}

#### Unmute Specific Instance of an Active Alert

**To unmute an alert's instance:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Active Alerts** tab.

The **Alerts** page > **Active Alerts** tab displays the list of active alert instances.
{% endstep %}

{% step %}
For the alert instance that you want to unmute, in the **Mute Alert** column, turn off the corresponding toggle switch.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FTWX8v3ZxSM8oaBp1hk6w%2Fimage.png?alt=media&amp;token=4aea8d51-bfa9-46ec-9f4e-765642d90474" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To save your change, click **Submit**.
{% endstep %}
{% endstepper %}

### Mute/Unmute Alerts per Alert Rule

Muting and unmuting alerts per alert rule allows you to suppress or enable alert email notifications for any alerts generated by individual alert rules. Muting or unmuting alerts per alert rule enables you to receive notifications only for the most relevant alerts, offering more granular control over the alerting process.

#### Mute Alert Notifications per Custom Alert Rule

{% hint style="info" %}
**NOTE:** You can disable or enable alert notifications for custom alert rules only if you are a GXC Administrator.
{% endhint %}

**To disable or enable alert notifications for a custom alert rule:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Alert Rules** tab.

The **Alerts** page > **Alert Rules** tab is displayed. The **Custom Alerts** section lists the custom alert rules.

{% hint style="info" %}
**NOTE:** The **Custom Alerts** section is displayed only if at least one custom alert rule exists.
{% endhint %}
{% endstep %}

{% step %}
For the custom alert rule that you want to disable or enable alert notifications for, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.
{% endstep %}

{% step %}
Under **Notifications**:

* To disable alert notifications, clear the **Enable Email Notification** checkbox.
* To enable alert notifications, select the **Enable Email Notification** checkbox.
  {% endstep %}

{% step %}
To save your edit, in the upper-right corner of the page, click **Save Rule**.
{% endstep %}
{% endstepper %}

#### Mute Alert Notifications per Predefined Alert Rule

{% hint style="info" %}
**NOTE:** You can disable or enable alert notifications for predefined alert rules only if you are a GXC Administrator.
{% endhint %}

**To disable or enable alert notifications for a predefined alert rule:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Alert Rules** tab.

The **Alerts** page > **Alert Rules** tab is displayed. The **Predefined Alerts** section lists the predefined alert rules.
{% endstep %}

{% step %}
In the **Predefined Alerts** section, for the predefined alert rule that you want to disable or enable alert notifications for, in the **Notifications** column, click the toggle button to enable or disable notifications.

A confirmation dialog box is displayed.
{% endstep %}

{% step %}
To confirm your change, click **Yes**.
{% endstep %}
{% endstepper %}

## Manage Alert Rules

An alert rule specifies the criteria of a condition based on Prometheus Query Language expressions. When the condition becomes true, an alert is triggered, which changes the state of the alert to active, and initiates an alert notification. As long as an alert is active, an alert notification is sent every one hour until the alert gets cleared. When the condition becomes false, the state of the alert changes to resolved, which clears the alert and initiates an alert notification.

The Onyx Portal supports alert rules of three types—predefined, custom, and semi-custom.

* Predefined alert rules are provided pre-configured with the Onyx Solution product, and can be created, edited, and deleted only by GXC.
* Custom alert rules are specific to each network. You can create and manage custom alert rules only if you are a GXC Administrator.
* Semi-custom alert rules are predefined by GXC but allow limited configuration changes, such as threshold values. These rules retain their core logic as defined by GXC but can be adjusted by to better fit a specific network's operational needs.

### View Alert Rules

**To view available alert rules:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Alert Rules** tab.

The **Alerts** page > **Alert Rules** tab displays predefined and custom alert rule lists.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FG67Kc39CTaTekaL2kKWv%2Fimage.png?alt=media&amp;token=9bbd14ee-b1d0-4190-9359-d88e5a691448" alt=""><figcaption></figcaption></figure>

* **Predefined Alerts**
  * **ID** – The alert rule's ID.
  * **Type** – The alert rule's type—Access Point, Mesh Node, Onyx Edge, Orchestrator, and Provisioning Server.
  * **Module** – The alert rule's module—Control Plane, CU Plane, Domain Proxy, Platform, Management Plane, MCU Plane.
  * **Name** – The alert rule's name.\
    To sort the list by alert names, click the column header.
  * **Severity** – The alert rule's severity classification—Critical, Major, Minor, Warning, Info, Notice.\
    To sort the list by severity, click the column header.
  * **Description** – The alert rule's description.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQxjs55y8aqjuptaIb1w4%2Fimage.png?alt=media&amp;token=7670b500-eb20-4d53-8ed3-bf7ba69f7f31" alt="" data-size="line"> (view details) – Click to view the alert rule's details, including its PromQL expression and labels.
* **Custom Alerts**

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The <strong>Custom Alerts</strong> section is displayed only if at least one custom alert rule has been created.</p></div>

  * **Name** – The alert rule's name.\
    To sort the list by of alert names, click the column header.
  * **Severity** – The alert rule's severity classification—Critical, Major, Minor, Warning, Info, Notice.\
    To sort the list by severity, click the column header.
  * **Description** – The alert rule's description.
  * **Notifications** – Indicates whether email notification receivers are notified when the alert is triggered. For more information, see [*Manage Alert Receiver Accounts*](#manage-alert-receiver-accounts).
  * **Actions** – Options to:
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FVcLnWduo0A0ILWTTcQs1%2Fimage.png?alt=media&amp;token=af76c8be-ca2c-40db-8c9f-c5c6e76a642c" alt="" data-size="line"> (view details) – Click to view the alert rule's details, including its PromQL expression and labels.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FeFXSNvIL76h7MjSU64MB%2Fimage.png?alt=media&amp;token=823335ce-0d54-4a8e-8d9f-b2365ab0ae04" alt="" data-size="line"> (edit) – (GXC Administrators only) Edit the alert rule.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F6tVTjMJP6UL5i74dVXwd%2Fimage.png?alt=media&amp;token=e92843e4-737d-403f-8fa7-fef0177db571" alt="" data-size="line"> (delete) – (GXC Administrators only) Delete the alert rule.

{% hint style="info" %}
**NOTE:** The **Custom Alerts** section is displayed only if at least one custom alert rule has been created.
{% endhint %}
{% endstep %}
{% endstepper %}

### Predefined Alert Rules

This section describes the predefined alert rules.

#### Predefined Alert Rules

{% hint style="info" %}
**NOTE:** The Onyx Portal includes predefined alert rules out of the box.
{% endhint %}

{% hint style="info" %}
**NOTE:** Only GXC can create, modify, and delete predefined alert rules.
{% endhint %}

{% hint style="info" %}
**NOTE:** Whenever a new network is created, the predefined alert rules are auto synchronized, and do not have to be synchronized manually.
{% endhint %}

{% hint style="info" %}
**NOTE:** For detailed information on predefined alert rules, refer to the *4G Onyx Portal Alerts Reference*.
{% endhint %}

The following table lists the predefined alert rules supported in 4G networks.

<p align="center"><strong>4G Predefined Alert Rules</strong></p>

**Access Point > Control Plane Alerts**

<table><thead><tr><th valign="top">Alert</th><th width="149.66668701171875" valign="top">Severity</th><th valign="top">Trigger and Clear Conditions</th></tr></thead><tbody><tr><td valign="top">Neighbor Tables Incomplete</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: Inability to fill all “Neighbor Frequency Table” entries or “Neighbor Cell Table” entries, as the AP has a respective limit of 8 and 16 for the above.</p><p>Clear Condition: When all neighbor entries are filled.</p></td></tr><tr><td valign="top">S1 Disconnected</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: When an AP has not connected to MME S1 interface for at least 15 minutes.</p><p>Clear Condition: When the AP is S1-reconnected.</p></td></tr></tbody></table>

**Access Point > CU-Plane Alerts**

<table data-header-hidden><thead><tr><th valign="top"></th><th width="150.33331298828125" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Cell Service Down</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: When a cell is not transmitting even when it is desired to be transmitting for at least 15 minutes.</p><p>Clear Condition: When the cell starts transmitting as expected.</p></td></tr><tr><td valign="top">DAS Associated Access Point Cell Service Down</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: Cell associated with a DAS is not transmitting for at least five minutes.</p><p>Clear Condition: When the cell starts transmitting again.</p></td></tr><tr><td valign="top">IPSec Certificate Expiry</td><td valign="top">Minor</td><td valign="top"><p>Trigger Condition: When an AP’s IPSec certificate is expiring in three days or less or has already expired.</p><p>Clear Condition: When a new IPSec certificate is generated and uploaded to the AP.</p></td></tr><tr><td valign="top">IPSec Connection Down</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: When the IPSec tunnel between an AP and Onyx Edge is still not up or has gone down.</p><p>Clear Condition: When the IPSec tunnel between the AP and Onyx Edge is up.</p></td></tr></tbody></table>

**Access Point > Domain Proxy Alerts**

<table data-header-hidden><thead><tr><th valign="top"></th><th width="150.3333740234375" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">CBSD Lesser BW Granted</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: When a CBSD is granted lesser-than-desired bandwidth, and it continues to be in this state for at least five minutes.</p><p>Clear Condition: When the CBSD gets the desired bandwidth in a grant, or when CBSD loses the grant.</p></td></tr><tr><td valign="top">CBSD New Grant</td><td valign="top">Warning</td><td valign="top"><p>Trigger Condition: When new grants are received in the last one-hour window.</p><p>Clear Condition: When there are no new grants in the last one-hour window.</p><p>As each grant change is a separate grant success, this alert can also be used to track grant changes. However, note that the very first grant is also tracked.</p></td></tr><tr><td valign="top">CBSD Preferred Frequency Unavailable</td><td valign="top">Warning</td><td valign="top"><p>Trigger Condition: When the preferred frequency list has been exhausted, and other frequencies are being attempted.</p><p>Clear Condition: When a preferred frequency becomes available, or the CBSD is deregistered.</p></td></tr><tr><td valign="top">CBSD Registration Failure</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: When a CBSD registration fails in the last one-hour window.</p><p>Clear Condition: When there are no failed CBSD registrations in the last one-hour window.</p></td></tr></tbody></table>

**Access Point > Management Plane Alerts**

<table data-header-hidden><thead><tr><th valign="top"></th><th width="149.66668701171875" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Offline</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: When an AP has not connected via TR-069 in the last 15 minutes.</p><p>Clear Condition: When the AP reconnects via TR-069.</p></td></tr><tr><td valign="top">TR-069 Session Stuck</td><td valign="top">Major</td><td valign="top">Trigger Condition: When a TR-069 session with an AP has started but not completed for more than 15 minutes, indicating the session is stuck in an error loop.<br>Clear Condition: When the TR-069 session completes successfully.</td></tr><tr><td valign="top">Unexpected TR-069 Fault</td><td valign="top">Minor</td><td valign="top"><p>Trigger Condition: When there is an unexpected TR-069 fault from an AP in the last one hour.</p><p>Clear Condition: When there are no new TR-069 faults from the AP in the last one-hour.</p></td></tr></tbody></table>

**Access Point > MCU-Plane Alerts**

<table data-header-hidden><thead><tr><th valign="top"></th><th width="149.66668701171875" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Cell Unwarranted Transmission</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: When an AP is disabled from transmitting but transmits for at least 15 minutes.</p><p>Clear Condition: When the AP is in sync with desired transmit status.</p></td></tr><tr><td valign="top">Mesh Filter-Frequency Mismatch</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: When a Mesh Node’s filter and frequency of its attached Mesh AP are in an incompatible state for at least five minutes.</p><p>The frequency for Mesh AP attached to Mesh Node is not compatible with filter setting on the Mesh Node. The filter setting is determined by the frequency of the Gateway AP to which the Mesh Node is attached.</p><p>Clear Condition: When the Mesh Node filter and the frequency of its attached Mesh AP become compatible.</p></td></tr></tbody></table>

**DAS > Domain Proxy Alerts**

<table data-header-hidden><thead><tr><th valign="top"></th><th width="150.3333740234375" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">TP CBSD New Grant</td><td valign="top">Warning</td><td valign="top"><p>Trigger Condition: New grants have been received in the last one hour.</p><p>Clear Condition: No new grants have been received for at least one hour.</p></td></tr><tr><td valign="top">TP CBSD Preferred Frequency Unavailable</td><td valign="top">Warning</td><td valign="top"><p>Trigger Condition: For DAS TPs, the frequency selected for associated AP is unavailable with SAS.</p><p>Clear Condition: Any of the following:</p><p>- Preferred frequency is available again</p><p>- CBSD is deregistered</p></td></tr><tr><td valign="top">TP CBSD Preferred Max Power Unavailable</td><td valign="top">Warning</td><td valign="top"><p>Trigger Condition: For DAS TPs, the max power selected for DAS TPs is unavailable with SAS.</p><p>Clear Condition: Any of the following:</p><p>- Preferred power is available again</p><p>- CBSD is deregistered</p></td></tr><tr><td valign="top">TP CBSD Registration Failure</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: CBSD registrations have failed within the past hour.</p><p>Clear Condition: No CBSD registrations have failed for at least an hour.</p></td></tr></tbody></table>

**Mesh Node > Domain Proxy Alerts**

<table data-header-hidden><thead><tr><th valign="top"></th><th width="150.3333740234375" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">CPE CBSD New Grant</td><td valign="top">Warning</td><td valign="top"><p>Trigger Condition: New grants were received within the last one hour.</p><p>Clear Condition: No new grants were received in the last one hour.</p></td></tr><tr><td valign="top">CPE CBSD Preferred Frequency or Bandwidth Unavailable</td><td valign="top">Warning</td><td valign="top"><p>Trigger Condition: The backhaul frequency or bandwidth to which the Mesh Node is connected is unavailable.</p><p>Clear Condition: When the preferred frequencies or bandwidth are available again.</p></td></tr><tr><td valign="top">CPE CBSD Registration Failure</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: CPE CBSD registrations have encountered failures within the last hour.</p><p>Clear Condition: No CPE CBSD registrations have failed for at least one hour.</p></td></tr></tbody></table>

**Mesh Node > Management Plane Alerts**

<table data-header-hidden><thead><tr><th valign="top"></th><th width="149.66668701171875" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Offline</td><td valign="top">Critical</td><td valign="top"><p>Trigger Condition: When a Mesh Node has remained offline for at least 10 minutes.</p><p>Clear Condition: When the Mesh Node comes online.</p></td></tr></tbody></table>

**Mesh Node > MCU-Plane Alerts**

<table data-header-hidden><thead><tr><th valign="top"></th><th width="149.6666259765625" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Tunnel Down</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: When the mesh tunnel between a Mesh Node and Onyx Edge is down for at least five minutes.</p><p>Clear Condition: When the mesh tunnel between the Mesh Node and Onyx Edge comes up.</p></td></tr><tr><td valign="top">Watchdog Powercycle</td><td valign="top">Minor</td><td valign="top"><p>Trigger Condition: A Mesh Node power cycle is triggered by the watchdog within the last 10 minutes.</p><p>Clear Condition: No watchdog-triggered power cycles occur within a subsequent 10-minute window.</p></td></tr></tbody></table>

**Mesh Node > Platform Alerts**

<table data-header-hidden><thead><tr><th valign="top"></th><th width="149.66668701171875" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">CPU Usage Alert</td><td valign="top">Minor</td><td valign="top"><p>Trigger Condition: When a Mesh Node’s CPU utilization in the last five minutes exceeds 70% of capacity.</p><p>Clear Condition: When the CPU utilization falls below 70% of capacity.</p></td></tr><tr><td valign="top">Memory Usage Alert</td><td valign="top">Minor</td><td valign="top"><p>Trigger Condition: When a Mesh Node’s RAM utilization exceeds 70% of capacity.</p><p>Clear Condition: When the RAM utilization falls below 70% of capacity.</p></td></tr><tr><td valign="top">Disk Usage Alert</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: When a Mesh Node’s disk utilization in the last five minutes exceeds 70% of capacity.</p><p>Clear Condition: When the disk usage falls below 70% of capacity.</p></td></tr></tbody></table>

**Mesh Node > Provisioning Server Alerts**

<table data-header-hidden><thead><tr><th valign="top"></th><th width="150.33331298828125" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Provisioning Server Connection Failure</td><td valign="top">Warning</td><td valign="top"><p>Trigger Condition: When a Mesh Node has not successfully checked in with the Provisioning Server within the past 35 minutes.</p><p>Clear Condition: When the Mesh Node successfully checks in with the Provisioning Server.</p></td></tr></tbody></table>

**Onyx Edge (Core) > Control Plane Alerts**

<table data-header-hidden><thead><tr><th valign="top"></th><th width="150.33331298828125" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Authentication Failure</td><td valign="top">Warning</td><td valign="top"><p>Trigger Condition: When an authentication failure occurs during UE attach.</p><p>Clear Condition: When there is no authentication failure in the next five-minute window.</p></td></tr><tr><td valign="top">DHCP Server Failed</td><td valign="top">Major</td><td valign="top">Trigger Condition: When the DHCP server responsible for assigning IP addresses to UE is unavailable for five minutes.<br>Clear Condition: When the DHCP server becomes available.</td></tr><tr><td valign="top">S1 Setup Failure</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: When an S1 Setup failure occurs.</p><p>Clear Condition: When there is no S1 Setup failure in the next five-minute window.</p></td></tr><tr><td valign="top">SCTP Outbound Stalled</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: SCTP inbound ordered chunks have been increasing over the last 15 minutes while SCTP outbound ordered chunks have remained flat.</p><p>Clear Condition: Outbound SCTP chunks resume normal flow, indicating the core is processing and responding to signaling messages again.</p></td></tr><tr><td valign="top">UE Attach Failure</td><td valign="top">Warning</td><td valign="top"><p>Trigger Condition: When UE attach requests fail for reasons other than unknown user/IMEI validations in the last 15 minutes.</p><p>Clear Condition: When no UE attach requests fail for reasons other than unknown user/IMEI validations for at least 15 minutes.</p></td></tr><tr><td valign="top">UE IMSI-IMEI Validation Failure</td><td valign="top">Warning</td><td valign="top"><p>Trigger Condition: When a UE attach failure occurs due to IMSI-IMEI validation failure in the last 15 minutes.</p><p>Clear Condition: When there is no UE attach failure due to IMSI-IMEI validation failure in the last 15 minutes.</p></td></tr><tr><td valign="top">UE Session Failure</td><td valign="top">Warning</td><td valign="top"><p>Trigger Condition: When a PDU Session Creation failure occurs.</p><p>Clear Condition: When there are no PDU Session Creation failures in the next five-minute window.</p></td></tr></tbody></table>

**Onyx Edge (Core) > CU-Plane Alerts**

<table data-header-hidden><thead><tr><th valign="top"></th><th width="149.6666259765625" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">HA Peer Down</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: When, in an Onyx Edge pool, the Primary ACS Onyx Edge detects a peer Onyx Edge is down.</p><p>A peer can be marked as “down” for the following reasons:</p><p>· S1 interface is down</p><p>· SGi interface is down</p><p>· Both S1 and SGi interfaces are down</p><p>· The peer Onyx Edge is powered down</p><p>The Primary Onyx Edge detects a peer is down within 10 minutes of it going down.</p><p>Clear Condition: When the Primary ACS Onyx Edge detects that the peer Onyx Edge is operational.</p></td></tr><tr><td valign="top">IPSec Service Down</td><td valign="top">Critical</td><td valign="top"><p>Trigger Condition: When an Onyx Edge’s IPSec service goes down and is not listening for new IPSec connection requests from APs.</p><p>Clear Condition: When IPSec service is ready and is listening for connections from APs.</p></td></tr><tr><td valign="top">IPSec Service Restarting Frequently</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: When an Onyx Edge’s IPSec service restarts too frequently.</p><p>Clear Condition: When the IPSec service is stable.</p></td></tr></tbody></table>

**Onyx Edge (Core) > Management Plane Alerts**

<table data-header-hidden><thead><tr><th valign="top"></th><th width="150.33331298828125" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Offline</td><td valign="top">Critical</td><td valign="top"><p>Trigger Condition: When an Onyx Edge remains offline for more than 10 minutes.</p><p>Clear Condition: When the Onyx Edge comes online.</p></td></tr></tbody></table>

**Onyx Edge (Core) > MCU-Plane Alerts**

<table data-header-hidden><thead><tr><th valign="top"></th><th width="150.3333740234375" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Service Down</td><td valign="top">Critical</td><td valign="top"><p>Trigger Condition: When critical Onyx Edge services are down, or there is connectivity issue (all APs are S1 disconnected) in the last five minutes.</p><p>Clear Condition: When critical Onyx Edge services are running correctly, and not all APs are S1-disconnected.</p></td></tr></tbody></table>

**Onyx Edge (Core) > Platform Alerts**

<table data-header-hidden><thead><tr><th valign="top"></th><th width="150.3333740234375" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">CPU Usage</td><td valign="top">Minor</td><td valign="top"><p>Trigger Condition: When an Onyx Edge’s CPU usage exceeds 70% in the last five minutes.</p><p>Clear Condition: When the CPU usage falls below 70%.</p></td></tr><tr><td valign="top">Disk Usage</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: When an Onyx Edge’s disk usage exceeds 70% in the last five minutes.</p><p>Clear Condition: When disk usage falls below 70%.</p></td></tr><tr><td valign="top">Memory Usage</td><td valign="top">Minor</td><td valign="top"><p>Trigger Condition: When an Onyx Edge’s RAM usage exceeds 70%.</p><p>Clear Condition: When the RAM usage falls below 70%.</p></td></tr></tbody></table>

**Onyx Edge (Core) > Provisioning Server Alerts**

<table data-header-hidden><thead><tr><th valign="top"></th><th width="149.66668701171875" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Provisioning Server Connection Failure</td><td valign="top">Warning</td><td valign="top"><p>Trigger Condition: When an Onyx Edge has not successfully checked in with the Provisioning Server within the past 35 minutes.</p><p>Clear Condition: When the Onyx Edge successfully checks in with the Provisioning Server.</p></td></tr></tbody></table>

**Orchestrator > Domain Proxy Alerts**

<table data-header-hidden><thead><tr><th valign="top"></th><th width="149.66668701171875" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">SAS Connection Failure</td><td valign="top">Critical</td><td valign="top"><p>Trigger Condition: When unable to connect to SAS for at least three times in the last 15 minutes, or when HTTP-level errors are seen in the last 15 minutes. The latter is most likely due to a misconfigured URL or a change in URL on the SAS side.</p><p>Clear Condition: When there are no SAS connection errors and no HTTP errors in the last 15 minutes.</p></td></tr></tbody></table>

### Custom Alert Rules

{% hint style="info" %}
**NOTE:** Custom alert rules are specific to each network.
{% endhint %}

{% hint style="info" %}
**NOTE:** You can create and manage custom alert rules only if you are a GXC Administrator.
{% endhint %}

#### View a Custom Alert Rule's Details

**To view a custom alert rule's details:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Alert Rules** tab.

The **Alerts** page > **Alert Rules** tab is displayed.

The **Custom Alerts** section lists the existing custom alert rules.

{% hint style="info" %}
**NOTE:** The **Custom Alerts** section is displayed only if at least one custom alert rule exists.
{% endhint %}
{% endstep %}

{% step %}
For the custom alert rule that you want to view details for, click the corresponding <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FBWKtKMY73Yj0gpF0bODb%2Fimage.png?alt=media&amp;token=b61cfe30-90bd-407f-a4db-5da74129f48b" alt="" data-size="line"> (view details) icon.
{% endstep %}

{% step %}
The **View Alert Rule** dialog box displays the rule's details.

* **Alert** – The custom alert's name.
* **Description** – Description of what the alert monitors or the condition it checks for.
* **Expression** – The expression or condition that triggers the alert.
* **Duration** – The duration for which the expression must continuously remain in effect before the alert is triggered.
* **Severity** – The alert's severity classification—Notice, Info, Warning, Minor, Major, or Critical.
* **Labels** – Metadata associated with the alert in key-value pairs.
  {% endstep %}
  {% endstepper %}

#### Create Custom Alert Rules

{% hint style="info" %}
**NOTE:** You can create custom alert rules only if you are a GXC Administrator.
{% endhint %}

You can create custom alert rules to define conditions for which alerts must be triggered. Before you create a new alert rule, check if an existing alert rule already serves the purpose or can be modified for your requirements.

**To create a custom alert rule:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Alert Rules** tab.

The **Alerts** page > **Alert Rules** tab is displayed.

The **Custom Alerts** section lists the custom alert rules.

{% hint style="info" %}
**NOTE:** The **Custom Alerts** section is displayed only if at least one custom alert rule has already been created.
{% endhint %}
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Add New**.

The **Add Alert Rule** page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0pxfL3UGwQxp3vsSeoKk%2Fimage.png?alt=media&amp;token=f06316b5-eaf8-4fb7-9e99-7da82b914502" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details:

* **Summary**:
  * **Rule Name** – (Required) The alert rule's name. Alert rule names can be a maximum of 64 characters and can contain alphanumeric and \_ (underscore) and - (hyphen) characters.
  * **Description** – (Optional) A brief explanation of what the alert monitors or the condition it checks for.
* **Conditions**:
  * **Expression** – (Required) The Prometheus expression. Contact GXC Engineering for the expression to use.\
    Link to the Prometheus Query Language (PromQL) documentation: [*https://prometheus.io/docs/prometheus/latest/querying/basics/*](https://prometheus.io/docs/prometheus/latest/querying/basics/)
  * **Duration** – (Optional) Select the duration for which the condition must continuously remain in effect before the alert is triggered. To trigger an alert immediately when a condition becomes true, enter 0.
  * **Unit** – (Optional) Select the units for the value specified in **Duration** from **Seconds**, **Minutes**, or **Hours**.
  * **Severity** – (Optional) Select the severity classification for the alert from:
    * **Notice** – A normal but important condition, not related to any error situation.
    * **Info** – General information about a specific condition.
    * **Warning** – A potential or impending condition requiring analysis and/or corrective action to prevent it from becoming a Major or a Minor condition.
    * **Minor** – A condition requiring corrective action to prevent it from becoming a Major condition.
    * **Major** – A condition requiring urgent corrective action to prevent it from becoming a Critical condition.
    * **Critical** – A significant condition requiring urgent corrective action.
* **Notifications** – Manage alert rule notifications.
  * **Enable e-mail notification** – Select to notify alert receivers when this rule triggers an alert. For information on alert receivers, see [*Manage Alert Receiver Accounts*](#manage-alert-receiver-accounts).
* **Labels** – Add labels to provide more information about the alerts.
  * **Add New Label** – (Optional) Click to create additional labels to provide more information about the alerts.
    * **Name** – The label's name. The label name must be an alphanumeric string. It cannot contain white spaces or special characters.
    * **Value** – The label's value.
    * **Action** – To delete the label, click the ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5nvdoVJAv3ABoZSdOcXI%2Fimage.png?alt=media\&token=adb4e8c6-2f55-43c7-8217-4aeea489d2d8) (delete) icon.
      {% endstep %}
      {% endstepper %}

#### Edit Custom Alert Rules

{% hint style="info" %}
**NOTE:** You can edit custom alert rules only if you are a GXC Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** You cannot edit predefined alert rules, except to enable or disable per alert rule email notifications. For more information, see [*Mute Alert Notifications per Predefined Alert Rule*](#mute-alert-notifications-per-predefined-alert-rule).
{% endhint %}

**To edit a custom alert rule:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Alert Rules** tab.

The **Alerts** page > **Alert Rules** tab is displayed.&#x20;

The **Custom Alerts** section lists the custom alert rules.

{% hint style="info" %}
**NOTE:** The **Custom Alerts** section is displayed only if at least one custom alert rule exists.
{% endhint %}
{% endstep %}

{% step %}
For the custom alert rule that you want to edit, click the corresponding <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FyG8EgEY8CMQFXceS92Ou%2Fimage.png?alt=media&amp;token=586af55f-8884-4660-9be1-676b9cd18852" alt="" data-size="line"> (edit) icon.
{% endstep %}

{% step %}
Update the custom alert rule as required. For parameter descriptions, see [*Add Custom Alert Rules section*](#create-custom-alert-rules).
{% endstep %}

{% step %}
To save your edits, in the upper-right corner of the page, click **Save Rule**.
{% endstep %}
{% endstepper %}

#### Delete Custom Alert Rules

{% hint style="info" %}
**NOTE:** You can delete custom alert rules only if you are a GXC Administrator. Predefined alert rules cannot be deleted.
{% endhint %}

{% hint style="info" %}
**NOTE:** Custom alert rules when deleted are lost for good. Before you delete a custom alert rule, review the rule to ensure it is no longer required before you delete it.
{% endhint %}

**To delete a custom alert rule:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Alert Rules** tab.

The **Alerts** page > **Alert Rules** tab is displayed. The **Custom Alerts** section lists the custom alert rules.

{% hint style="info" %}
**NOTE:** The **Custom Alerts** section is displayed only if at least one custom alert rule exists.
{% endhint %}
{% endstep %}

{% step %}
For the custom alert rule that you want to delete, click the corresponding <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FH8ko8gjyTvuFlePKYFc1%2Fimage.png?alt=media&amp;token=874f5d19-5e3d-43be-9fb1-920ba3c3cf52" alt="" data-size="line"> (delete) icon.

A confirmation dialog box is displayed.
{% endstep %}

{% step %}
To confirm deleting the custom alert rule, click **Yes**.
{% endstep %}
{% endstepper %}

### Semi-Custom Alert Rules

Semi-custom alert rules are predefined by GXC but allow limited configuration changes, such as threshold values. These rules retain their core logic as defined by GXC but can be adjusted to better fit a specific network's operational needs.

<p align="center"><strong>Semi-Custom Alert Rules</strong></p>

**Mesh Node > MCU Plane Alerts**\[1]

<table><thead><tr><th valign="top">Alert Name</th><th width="150.33331298828125" valign="top">Severity</th><th valign="top">Description</th></tr></thead><tbody><tr><td valign="top">Mesh Node &#x3C;serial number> RSRP is lower than threshold for 5 minutes</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: Triggers when RSRP is lower than threshold for 5 minutes.</p><p>Clear Condition: Clears when RSRP rises to or above the threshold for 5 minutes.</p></td></tr><tr><td valign="top">Mesh Node &#x3C;serial number> RSRQ is lower than threshold for 5 minutes</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: Triggers when RSRQ is lower than threshold for 5 minutes.</p><p>Clear Condition: Clears when RSRQ rises to or above the threshold for 5 minutes.</p></td></tr><tr><td valign="top">Mesh Node &#x3C;serial number> SINR is lower than threshold for 5 minutes</td><td valign="top">Major</td><td valign="top"><p>Trigger Condition: Triggers when SINR is lower than threshold for 5 minutes.</p><p>Clear Condition: Clears when SINR rises to or above the threshold for 5 minutes.</p></td></tr></tbody></table>

***

\[1] For information on configuring thresholds for Mesh Node semi-custom alerts, see *Add Mesh Nodes*.

## Manage Alert Receiver Accounts

You can configure the receivers to be notified when alerts are triggered. The receivers are notified by email in real-time to review the alerts and take action. As per the configuration, a receiver can be notified about all alerts or only alerts of specific severities.

{% hint style="info" %}
**NOTE:** Alert receiver configurations are specific to the selected network.
{% endhint %}

### View Summary Details of All Alert Receiver Accounts

**To view the summary details of all alert receiver accounts:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Receivers** tab.

The **Alerts** page > **Receivers** tab displays the list of alert receiver accounts configured in the selected network.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FlP5qtxJSvZojVZttM0tj%2Fimage.png?alt=media&amp;token=2aa3c768-fddc-4367-acbf-9d66c5cb8f64" alt=""><figcaption></figcaption></figure>

* **E-mail** – The alert receiver's email ID.
* **Severity of Alert** – The alert severity levels for which the receiver is notified.
* **Actions** – Options to view, edit, and delete alert receiver accounts.
  {% endstep %}
  {% endstepper %}

### Create Alert Receiver Accounts

{% hint style="info" %}
**NOTE:** You can add alert receiver accounts only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

**To create an alert receiver account:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Receivers** tab.

The **Alerts** page > **Receivers** tab displays the list of alert receiver accounts configured in the selected network.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Add Receivers**.

The **Create Receiver** page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FRduTcwfRvTRIrHJqgqIE%2Fimage.png?alt=media&amp;token=0b2623bb-084c-4d83-86f2-e7d52d8ca3b8" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details:

* **E-mail** – (Required) The alert receiver's e-mail ID to send alert notifications.
* **Severity Level** – (Required) The alert severity levels for which notifications should be sent to this receiver. Select from **Critical**, **Major**, **Minor**, or **All**.
  {% endstep %}

{% step %}
To save the alert receiver account, in the upper-right corner of the page, click **Save Receiver**.

The alert receiver account is saved and is added to the list of receivers.
{% endstep %}
{% endstepper %}

### Edit Alert Receiver Accounts

{% hint style="info" %}
**NOTE:** You can edit alert receiver accounts only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

**To edit an alert receiver account:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Receivers** tab.

The **Alerts** page > **Receivers** tab displays the list of alert receiver accounts configured in the selected network.
{% endstep %}

{% step %}
For the alert receiver account that you want to edit, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FNj3CdHQ7MBz8qjJhn1v2%2Fimage.png?alt=media&amp;token=545bd534-5601-47ad-8338-258be33b17e4" alt="" width="110"><figcaption></figcaption></figure>

The **Edit Receiver** page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FO4imo2mUn8OIfcy0HwVd%2Fimage.png?alt=media&amp;token=b3de195c-16f7-468e-a265-4e2381cb06c9" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Edit the following details field as required:

* **E-mail** – (Read only) The alert receiver's email Id.
* **Severity Level** – (Required) The alert severity levels for which notifications should be sent for this receiver. Select from **Critical**, **Major**, **Minor**, or **All**.
  {% endstep %}

{% step %}
To save your edit, in the upper-right corner of the page, click **Save Receiver**.
{% endstep %}
{% endstepper %}

### Delete Alert Receiver Accounts

{% hint style="info" %}
**NOTE:** You can delete alert receiver accounts only if you are a GXC Administrator, Partner Administrator, or a Super Administrator.
{% endhint %}

**To delete an alert receiver account:**

{% stepper %}
{% step %}
In the navigation pane, click **Alerts** > **Receivers** tab.

The **Alerts** page > **Receivers** tab displays the list of alert receiver accounts configured in the selected network.
{% endstep %}

{% step %}
For the alert receiver account that you want to delete, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Delete**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fzpxan2bJ1IIOgGwQQQm0%2Fimage.png?alt=media&amp;token=017a2169-9d0c-4f07-9f00-d9d47a7eaca3" alt="" width="110"><figcaption></figcaption></figure>

A confirmation dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F4IvV2kNyetMv5ExVRo2p%2Fimage.png?alt=media&amp;token=2ab889d0-4595-49c6-a901-21e76ce0c905" alt="" width="506"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To confirm deleting the alert receiver account, click **Yes**.
{% endstep %}
{% endstepper %}


# Administration

This section describes how to create and manage partner, customer, and user accounts, and cloud resources.

## Manage Onyx Portal Accounts

The Onyx Portal supports the following account types:

* GXC Root Account – The root account comprising of all GXC partner (and associated customer accounts) and GXC-direct customer accounts. You can switch to and manage the GXC Root account only if you are a GXC Administrator.
* GXC Partner Accounts – System Integrator (SI) or Value-added Reseller (VAR) accounts comprising associated customer accounts. If you are a Partner Administrator, you can switch to and manage your own GXC partner account. If you are a GXC Administrator, you can switch to and manage any GXC partner account.
* Customer Accounts – Individual customer accounts. If you are a Partner Administrator, you can switch to and manage your own customer accounts. If you are a GXC Administrator, you can switch to and manage any customer account.

### Support Plans

Support plans are assigned to each GXC partner and customer account outline the level of assistance and services available, including technical support hours, response times, resolution times, and access to resources such as support documentation and training materials.

* Basic – GXC provides business hours support for Tier 3 issues.
* Basic Plus – (Additional subscription) GXC provides NOC monitoring, and Tier 1 / 2 / 3 Support 24 x 7 x 365 with standard response times for a cost-effective solution.
* Platinum – (Additional subscription) Includes "Basic Plus" features with accelerated SLA response and resolution times.
* Partner Managed – GXC Partner / Customer integrates GXC Onyx to their own NOC to directly manage Tier 1 / 2 issues.

For more information regarding the entitlements associated with each of these support plans, please contact your GXC Account representative or GXC Technical Support.

### Manage Customer Accounts

{% hint style="info" %}
**NOTE:** You can create and manage customer accounts only if you are a GXC Administrator.
{% endhint %}

#### View Customer Accounts

{% hint style="info" %}
**NOTE:** You can view customer accounts only if you are a GXC Administrator.
{% endhint %}

This section describes how to:

* View Summary Details of All Customer Accounts
* View a Customer Account’s Details

**View Summary Details of All Customer Accounts**

{% hint style="info" %}
**NOTE:** You can view customer account details only if you are a GXC Administrator.
{% endhint %}

**To view the summary details of all customer accounts:**

{% stepper %}
{% step %}
Switch to the GXC Root account.

To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click **Other Accounts** > **Select GXC Root**.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Customers** tab.

The **Administration** page > **Customers** tab displays the summary details of all Onyx Portal customer accounts. All customer accounts irrespective of their partner hierarchy are listed in the **Customers** tab.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FpKuowtwIWHibnOmmW5tL%2Fimage.png?alt=media&amp;token=9bb4f25c-7385-4bad-8ee4-97b7f0600dd6" alt=""><figcaption></figcaption></figure>

* **Customer Name** – The customer account's name.
* **GXC Partner** – If the customer account is associated with a GXC partner, the GXC partner's name.
* **Email** – The Account Manager's email address.
* **Support Plan** – The support plan assigned to the customer account—Basic, Basic Plus, Platinum, or Partner Managed. For more information, see [Support Plans](#support-plans).
* **Actions** – Options to view details, edit and delete a GXC partner account.
  {% endstep %}

{% step %}
To download a CSV file listing the associated customer accounts with details including customer name, partner, GXC support plan, contact email ID, and address, click **Download**. The CSV file is downloaded to your computer.
{% endstep %}

{% step %}
To search for a customer account, in the **Search** box, enter your search term.
{% endstep %}
{% endstepper %}

**View a Customer Account's Details**

**To view a customer account's details:**

{% stepper %}
{% step %}
Switch to the GXC Root account.

To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click **Other Accounts** > **Select GXC Root**.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Customers** tab.

The **Administration** page > **Customers** tab displays the summary details of all Onyx Portal customer accounts. All customer accounts irrespective of their partner hierarchy are listed in the **Customers** tab.
{% endstep %}

{% step %}
To view the details of a particular customer account, click the customer account's name.

The ***\<customer account name>*** page displays the following details:

* **Customer Details**:
  * **E-mail** – The Account Manager's email address. The email address of the customer account's first Super Administrator user. This Super Administrator user will have the privilege to create other user accounts within the customer account.
  * **Type** – The account type—Customer.
  * **GXC Partner** – If the customer account is associated with a GXC partner, the GXC partner's name.
  * **Name** – The customer account's name.
  * **Cloud Service** – Indicates whether cloud service for the customer account is enabled or disabled. Only if enabled can you create the cloud resource groups and instances required for deploying Onyx Edge Cloud AGW in the customer's networks. For more information, see [Manage Cloud Resources for Onyx Edge Cloud AGW](#manage-cloud-resources-for-onyx-edge-cloud)*.*
  * **No. of Instances** – The maximum number of EC2 instances available for the customer account.
  * **No. of Utilized Instances** – The total number of EC2 instances utilized by the customer account.
  * **Address** – The customer's registered address.
  * **Session Timeout** – The Onyx Portal user session timeout duration for users in this customer account. If a user's session remains idle for this duration, the user is automatically logged out.
  * **Support Plan** – The support plan assigned to the customer account—Basic, Basic Plus, Platinum, and Partner Managed. For more information, see [Support Plans](#support-plans).
  * **Add SSO Config** – (Displayed only if SSO is not configured.) Click to add SSO configuration for the customer account. For more information, see [Add SSO with IdP Configuration](#configure-sso-authentication-with-idp-configuration).
  * **Edit SSO Config** – (Displayed only if SSO is already configured.) Click to edit SSO configuration for the customer account. For more information, see [Edit SSO with IdP Configuration](#configure-sso-authentication-with-idp-configuration).
* **Account ID** – The Onyx Portal cloud account ID.
  * **Resource Group ID** – The resource group's ID.
  * **Resource Group Name** – The resource group's name.
  * **Region** – The region associated with the resource group.
  * **Availability Zone** – The availability zone associated with the resource group.
  * **Status** – The resource group's status—Create Complete, etc.
  * **Host Key** – Options to view and download the host key.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FqqFEanzMbT7UzfunNG1q%2Fimage.png?alt=media&amp;token=9eac4bec-8c49-4b67-b9db-e2c565806956" alt="" data-size="original"> – Click to view EC2 instances, if provisioned.
    * **Instance ID** – The instance's ID.
    * **Instance Name** – The instance's name.
    * **Connected Onyx Edge** – The connected Onyx Edge's name.
    * **Network Name** – The network's name.
    * **Private IP** – The instance's private IP address.
    * **Public IP** – The instance's public IP address.
    * **Status** – The instance's provisioning status.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FuKHVofRVLEhEV9gROi5R%2Fimage.png?alt=media&amp;token=c1dd291e-9928-404d-b324-40e11a07a76e" alt="" data-size="line"> Green – Create Complete
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FqWZuiWPn7Xc6MZrDd4Sb%2Fimage.png?alt=media&amp;token=9d57c26d-7544-4951-8606-be4c265c5daa" alt="" data-size="line"> Red – Rollback Complete
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FPAafAXw30NyXx0ux6GfU%2Fimage.png?alt=media&amp;token=c73c2297-49f3-4919-a7f1-0e206bff9fef" alt="" data-size="line"> – Click to delete the instance.
* **Add Resource Group** – Click to create a cloud resource group. For more information, see [Create Cloud Resource Groups](#manage-cloud-resource-groups).
* **Own Users**:
  * **Name** – The user's name.
  * **E-mail** – The user's email address.
  * **Role** – The user's role.
  * **User ID** – The user's user ID.
  * **Actions** – Options to edit and delete the user account.
* **Account Managers**: This section is not applicable in this release.
  * **Add User** – Click to add a user account under the customer account. For more information, see [Create User Accounts under a Customer Account](#create-user-accounts-under-a-customer-account).
    {% endstep %}
    {% endstepper %}

#### Create User Accounts under a Customer Account

{% hint style="info" %}
**NOTE:** You can add users to customer accounts only if you are a GXC Administrator.
{% endhint %}

**To add a user to a customer account:**

{% stepper %}
{% step %}
Switch to the GXC Root account.

To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click **Other Accounts** > **Select GXC Root**.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Customers** tab.

The **Administration** page > **Customers** tab displays the summary details of all Onyx Portal customer accounts.
{% endstep %}

{% step %}
For the customer account that you want to add the user to, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **View**.

The ***\<customer name>*** page displays the customer account's details.
{% endstep %}

{% step %}
In the **Account Managers** section, click **Add User**.

The **Create User** page is displayed.
{% endstep %}

{% step %}
Enter the following details:

* **User Email** – (Required) The user's email address.
* **User Type** – (View-only field) The user's account type—Own User.
* **User Name** – (Required) The user's account name.
* **Role** – (Required) The user's role. Select from **Super Admin**, **Admin**, **Viewer**.
* **Upstream IdP User** – (Optional) If a customer's IdP cannot release user attributes such as "onyxPortalTenantId", "onyxPortalRole", etc. required for SSO user authentication to the Onyx IdP, user accounts for Onyx Portal users in the customer's organization are created in the Onyx Portal. To enable SSO authentication for such users, this toggle button must be enabled to fetch the required attributes from the user's Onyx Portal account settings. Default setting: disabled.
  {% endstep %}

{% step %}
To save the user account, in the upper-right corner of the page, click **Save User**.
{% endstep %}
{% endstepper %}

#### Configure SSO Authentication with IdP Configuration

The Onyx Portal can integrate with a customer organization's existing IdP for SSO user authentication. The customer must provide their IdP details to GXC for integration with the Onyx Portal.

All IdP-related configurations such as entity ID, IdP metadata, Single Sign-On/Single Logout URLs and certificates are configured in the Onyx IdP. The Single Sign-On and Single Logout requests are redirected from the Onyx Portal to the Onyx IdP. The Onyx IdP does the target IdP discovery based on the RequestedAuthnContext in the SAML Authentication Request and redirects the Single Sign-On/Logout request to the customer IdP.

{% hint style="info" %}
**NOTE:** Before enabling SSO for an Onyx Portal customer account, the SAML or OIDC application must be configured with the customer's IdP.
{% endhint %}

**Add SSO with IdP Configuration**

**To add SSO configuration for an existing Onyx Portal customer account:**

{% stepper %}
{% step %}
Switch to the GXC Root account.

To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click **Other Accounts** > **Select GXC Root**.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Customers** tab.

The **Administration** page > **Customers** tab displays the summary details of all Onyx Portal customer accounts.
{% endstep %}

{% step %}
In the upper-right corner of the **Customer Details** panel, click **Add SSO Config**.

The **Add SSO Config** dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FfBDZXG0z4is6QfFbDQdL%2Fimage.png?alt=media&amp;token=4ea52ba5-77f2-468c-a464-13e247743b77" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details:

* **Enable SSO** – Toggle to enable or disable SSO for the customer account.
* **Organization Name** – (Required) The organization's name.
* **IdP Entity ID** – (Required) The IdP's entity ID, a unique ID for the IdP within the SSO ecosystem. It is used by service providers to recognize and trust the IdP.
* **IdP Destination URL** – (Required) The endpoint where the IdP receives authentication requests from the service provider. This URL is used during the SSO process to authenticate users.
* **SSO Vendor** – (Required) Select the SSO solution vendor's name—**Google**, **Shibboleth**, **Okta**.
* **IDP SLO URL** – (Optional) The IDP's single logout (SLO) URL. The endpoint where the IdP handles logout requests. This URL ensures that when a user logs out from one service, the session is terminated across all connected services in the SSO environment.
* **IdP Metadata URL** – (Required) The metadata file location for the IdP. This file contains configuration information, such as entity ID, SSO URLs, SLO URLs, and certificates, which the service provider uses to establish trust and integrate with the IdP.
* **+ Upload Metadata** – Click to add a metadata file. In XML format, this metadata contains the necessary configurations and certificates required to establish trust between the IdP and service providers within the SSO environment.
* **Additional Config**:
  * **IDP Certificate** – A digital certificate issued to the IdP that is used to sign authentication assertions and encrypt communications. This certificate ensures the integrity and security of the data exchanged between the IdP and the service provider. It typically contains the public key used in the cryptographic processes.
  * **InCommon Metadata Filter** – A configuration tool or setting used within the "InCommon Federation", a trusted framework for U.S. education and research institutions. This filter allows administrators to selectively include or exclude metadata from the federation's metadata aggregate based on specific criteria. This helps manage which entities are trusted and ensures that only relevant and up-to-date metadata is processed for authentication and authorization purposes.
    {% endstep %}

{% step %}
To save the SSO config, click **Save**.
{% endstep %}
{% endstepper %}

**Edit SSO with IdP Configuration**

**To edit the SSO configuration for an Onyx Portal customer account:**

{% stepper %}
{% step %}
Switch to the GXC Root account.

To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click **Other Accounts** > **Select GXC Root**.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Customers** tab.

The **Administration** page > **Customers** tab displays the summary details of all Onyx Portal customer accounts.
{% endstep %}

{% step %}
In the upper-right corner of the **Customer Details** panel, click **Edit SSO Config**.

The **Edit SSO Config** dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FEbj6MhYnEaMuENrTceZN%2Fimage.png?alt=media&amp;token=311c2027-c099-4a07-b05a-b314f6734589" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Update the following details as required:

* **Enable SSO** – Toggle to enable or disable SSO for the customer account.
* **Organization Name** – (Required) The organization's name.
* **IdP Entity ID** – (Required) The IdP's entity ID, a unique ID for the IdP within the SSO ecosystem. It is used by service providers to recognize and trust the IdP.
* **IdP Destination URL** – (Required) The endpoint where the IdP receives authentication requests from the service provider. This URL is used during the SSO process to authenticate users.
* **SSO Vendor** – (Required) Select the SSO solution vendor's name—**Google**, **Shibboleth**, **Okta**.
* **IDP SLO URL** – (Optional) The IDP's single logout (SLO) URL. The endpoint where the IdP handles logout requests. This URL ensures that when a user logs out from one service, the session is terminated across all connected services in the SSO environment.
* **IdP Metadata URL** – (Required) The metadata file location for the IdP. This file contains configuration information, such as entity ID, SSO URLs, SLO URLs, and certificates, which the service provider uses to establish trust and integrate with the IdP.
* **+ Upload Metadata** – Click to add a metadata file. In XML format, this metadata contains the necessary configurations and certificates required to establish trust between the IdP and service providers within the SSO environment.
* **Additional Config**:
  * **IDP Certificate** – A digital certificate issued to the IdP that is used to sign authentication assertions and encrypt communications. This certificate ensures the integrity and security of the data exchanged between the IdP and the service provider. It typically contains the public key used in the cryptographic processes.
  * **InCommon Metadata Filter** – A configuration tool or setting used within the "InCommon Federation", a trusted framework for U.S. education and research institutions. This filter allows administrators to selectively include or exclude metadata from the federation's metadata aggregate based on specific criteria. This helps manage which entities are trusted and ensures that only relevant and up-to-date metadata is processed for authentication and authorization purposes.
    {% endstep %}

{% step %}
To save your edits, click **Save**.
{% endstep %}
{% endstepper %}

## Manage Onyx Portal User Accounts

The Onyx Portal supports creating and managing user accounts for users to monitor and manage their Onyx networks.

User privileges are strictly regulated by Role-based Access Control (RBAC). Users, such as Support Engineers, can be granted access to only view specific data while restricting their ability to create, modify, or delete configurations.

The Onyx Portal supports the following user roles:

* GXC Administrator – The highest level in the Onyx Portal user hierarchy. Can create and manage partner and customer accounts.
* GXC Partner Administrator – System Integrators (SI) or Value-added Resellers (VAR). Can perform all configuration and management tasks for associated customer accounts.
* Super Administrator – Can perform all configuration and management tasks within the managed network.
* Administrator – Can perform equipment-level operations and management within the managed network.
* Viewer – Can only monitor the managed network.

The privileges indicated in the following tables follows the CRUD convention:

* C – Create or add new entries.
* R – Read, retrieve, search, or view existing entries.
* U – Update or edit existing entries.
* D – Delete, deactivate, or remove existing entries.

<p align="center"><strong>User Administration Privileges</strong></p>

<table><thead><tr><th valign="top">User Role</th><th valign="top">Account</th><th valign="top">GXC Partner</th><th valign="top">Super Administrator</th><th>Administrator</th><th>Viewer</th></tr></thead><tbody><tr><td valign="top">GXC Administrator</td><td valign="top">Super CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td>CRUD</td><td>CRUD</td></tr><tr><td valign="top">GXC Partner</td><td valign="top">R for associated accounts</td><td valign="top">R</td><td valign="top">CR</td><td>CRUD</td><td>CRUD</td></tr><tr><td valign="top">Super Administrator</td><td valign="top">R for self account</td><td valign="top">CRUD for self account</td><td valign="top">R</td><td>CRUD</td><td>CRUD</td></tr><tr><td valign="top">Administrator</td><td valign="top">No</td><td valign="top">R</td><td valign="top">R</td><td>R</td><td>RUD</td></tr><tr><td valign="top">Viewer</td><td valign="top">No</td><td valign="top">R</td><td valign="top">R</td><td>R</td><td>R</td></tr></tbody></table>

The following table summarizes Onyx Portal RBAC across user roles.

<p align="center"><strong>Onyx Portal Administration Privileges</strong></p>

**Venues**

| Module | GXC Administrator | GXC Partner | Super Administrator | Administrator | Viewer |
| ------ | ----------------- | ----------- | ------------------- | ------------- | ------ |
| Venue  | CRUD              | CRUD        | CRUD                | RU            | R      |
| Floors | CRUD              | CRUD        | CRUD                | RU            | R      |

**Equipment**

<table data-header-hidden><thead><tr><th valign="top"></th><th valign="top"></th><th valign="top"></th><th valign="top"></th><th valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Onyx Edge</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">R</td></tr><tr><td valign="top">Onyx Edge Upgrade Groups</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">R</td><td valign="top">R</td></tr><tr><td valign="top">Access Point</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">R</td></tr><tr><td valign="top">Access Point Upgrade Groups</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">R</td><td valign="top">R</td></tr><tr><td valign="top">Mesh Node</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">R</td></tr><tr><td valign="top">Mesh Node Upgrade Groups</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">R</td><td valign="top">R</td></tr><tr><td valign="top">FHM</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">R</td></tr><tr><td valign="top">FHM Upgrade Groups</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">CRUD</td><td valign="top">R</td><td valign="top">R</td></tr></tbody></table>

**Subscribers**

| Subscriber Secrets                                | CRUD | Unauthorized | Unauthorized | Unauthorized | Unauthorized |
| ------------------------------------------------- | ---- | ------------ | ------------ | ------------ | ------------ |
| Subscriber Info / Traffic Policy, APN Association | RU   | RU           | RU           | RU           | R            |
| Subscriber Info - IMEI Association                | RU   | RU           | RU           | RU           | R            |
| Bulk Export / Import                              | CRUD | Unauthorized | Unauthorized | Unauthorized | Unauthorized |
| Session Monitoring                                | R    | R            | R            | R            | R            |

**Network**

| Network      | CRUD | CRUD | CRUD | R | R |
| ------------ | ---- | ---- | ---- | - | - |
| Network List | CRUD | CRUD | CRUD | R | R |

**Traffic**

| APN      | CRUD | CRUD | CRUD | CRUD | R |
| -------- | ---- | ---- | ---- | ---- | - |
| Policies | CRUD | CRUD | CRUD | CRUD | R |
| Profiles | CRUD | CRUD | CRUD | CRUD | R |

**Alerts**

| Alerts Visibility | R    | R    | R    | R   | R |
| ----------------- | ---- | ---- | ---- | --- | - |
| Rules             | CRUD | R    | R    | R   | R |
| Receivers         | CRUD | CRUD | CRUD | CRU | R |

**Analytics**

| Generate Reports | R | R | R | R | R |
| ---------------- | - | - | - | - | - |

**Audit Logs**

| Audit Logs Visibility | R | R | R | Unauthorized | Unauthorized |
| --------------------- | - | - | - | ------------ | ------------ |

### Onyx Portal User Idle Session Timeout

While users inherit partner or customer account timeout settings by default, administrators can configure custom timeouts for individual users based on their roles, operational needs, or security policies.

The custom timeout setting can be configured when adding or editing a user account.

The custom timeout setting can be configured in one of the following ranges:

* 5–59 minutes
* 1–23 hours
* 1–7 days

For SSO user accounts, idle session timeout in Onyx Portal is independent of the SSO/SAML IdP configuration. If the Onyx Portal timeout is shorter than the IdP's, users are logged out but silently reauthenticated if the IdP session is still valid. If the Onyx Portal timeout is longer, users must fully reauthenticate once the IdP session expires.

For multi-tenant user accounts, the idle session timeout is determined by the base tenant's setting.

### View User Accounts

{% hint style="info" %}
**NOTE:** If you are a GXC Administrator, when you are in the GXC Root account, you can view all Onyx Portal users irrespective of their account hierarchy.
{% endhint %}

{% hint style="info" %}
**NOTE:** If you are a GXC Partner Administrator, when you are in your own partner account, you can view all users within your own partner account and those in your direct customer accounts.
{% endhint %}

{% hint style="info" %}
**NOTE:** If you are a Super Administrator or an Administrator, you can view all users within your own customer account.
{% endhint %}

{% hint style="info" %}
**NOTE:** To view, create, and manage users in a particular Onyx Portal account, you must switch to that account.
{% endhint %}

This section describes how to:

* [View User Accounts under Non-GXC Root Accounts](#view-user-accounts-under-non-gxc-root-accounts)
* [View User Accounts under the GXC Root Account](#view-user-accounts-under-the-gxc-root-account)

#### View User Accounts under Non-GXC Root Accounts

{% hint style="info" %}
**NOTE:** You can view user accounts under non-GXC Root accounts only if you are a GXC Administrator or a Partner Administrator.
{% endhint %}

{% stepper %}
{% step %}
Switch to the required Onyx Portal account.

To switch between Onyx Portal accounts, in the upper-right corner of the page, click the current Onyx Portal account's name, then select the required account.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Users** tab.

The **Administration** page > **Users** tab displays the list of active user accounts from across all Onyx Portal accounts.

* **Users (n)** – The count and list of user accounts in the selected Onyx Portal account.
* **User Email** – The user's email address.
* **User Name** – The user's name.
* **User Role** – The user's role—Super Admin, Admin, Viewer.
* **Network** – The networks under the selected Onyx Portal customer account that the user has permission to manage.
* **Actions** – Shortcut options to edit and delete the user account.
  {% endstep %}

{% step %}
To search for a particular user account, in the **Search** field, enter your search term.
{% endstep %}
{% endstepper %}

#### View User Accounts under the GXC Root Account

{% hint style="info" %}
**NOTE:** You can view user accounts under the GXC Root account only if you are a GXC Administrator.
{% endhint %}

{% stepper %}
{% step %}
Switch to the GXC Root account.

To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click **Other Accounts** > **Select GXC Root**.
{% endstep %}

{% step %}
To view all existing user accounts under the GXC Root account:

1. Click **Administration** > **Users** tab.

   The **Administration** page > **Users** tab displays the list of active user accounts from across all Onyx Portal accounts.

   * **Name** – The user's name.
   * **Role** – The user's role—GXC Admin, Super Admin, Admin, Viewer.
   * **Email** – The user's email address.
   * **Status** – The user account's status—Verified, Verification Pending, Forgot Password.
   * **Account Name** – The Onyx Portal account that the user is associated with.
   * **Parent Account Name** – The parent account of the Onyx Portal account that the user is associated with.
   * **Actions** – Shortcut options to edit, delete, and suspend the user account.
2. To search for a particular user account, in the upper-right corner of the page, in the **Search** field, enter your search term.
   {% endstep %}

{% step %}
To view user accounts under a particular GXC partner account:

1. Click **Administration** > **Partners** tab.\
   The summary details of all GXC partner accounts are displayed.
2. Click the GXC partner account's name.\
   The ***\<partner account name>*** page is displayed. The **Own Users** section lists the user accounts under the GXC selected partner account.
   {% endstep %}

{% step %}
To view the user accounts under a particular customer account:

1. Click **Administration** > **Customers** tab. \
   The list of customer accounts is displayed.
2. Click the customer account's name.\
   The ***\<customer account name>*** page is displayed. The **Own Users** section lists the user accounts under the selected customer account.
   {% endstep %}
   {% endstepper %}

### Create User Accounts

This section describes creating the following types of user accounts:

* Create Direct Super Administrator, Administrator, or Viewer User Accounts
* Create upstream IdP user accounts

#### Create Direct Super Administrator, Administrator, or Viewer User Accounts

**To create a direct Super Administrator, Administrator, or Viewer user account under non-GXC Root accounts:**

{% hint style="info" %}
**NOTE:** If you are a GXC Administrator or a GXC Partner Administrator, you can add Super Administrator, Administrator, and Viewer user accounts. If you are a Super Administrator, you can add Administrator and Viewer user accounts.
{% endhint %}

{% stepper %}
{% step %}
Switch to the required GXC partner or customer account.

To switch between Onyx Portal accounts, in the upper-right corner of the page, click the current Onyx Portal account's name.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Users** tab.

The **Administration** page > **Users** tab displays the list of active user accounts.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Add User**.

The **Create User** page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FEb1PQKZdmusHgYiG2ZG3%2Fimage.png?alt=media&amp;token=b2bba267-804a-46be-aaf6-e6a61eb82b8a" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details:

* **User Email** – (Required) The user's email address.

{% hint style="info" %}
**NOTE:** If the email ID that you enter is already associated with a user account in another Onyx Portal customer account, the user can be invited to manage the current Onyx Portal customer account with any role.
{% endhint %}

* **Invite user to manage the current Onyx Portal customer account** – (Displayed only if the email ID is already associated with an existing user account in any other Onyx Portal customer account.) – To invite the user to manage the current Onyx Portal customer account, select the check box.
* **User Name** – (Required) The user's full name.
* **Role** – (Required) The user's role. Select from **Super Admin**, **Admin**, **Viewer**.
* **Network** – Click to select from the list of networks in the customer account, all or specific networks that the user must have access to manage. To remove access to a particular network, clear the corresponding checkbox. Default value: **All Networks**.
* **Use account-level idle session timeout setting** – To inherit the GXC partner/customer account level user idle timeout setting, select the checkbox. To configure a custom value, clear the checkbox and enter a value from one of the following ranges:
  * 5–59 minutes
  * 1–23 hours
  * 1–7 days
    {% endstep %}

{% step %}
To save the user account, in the upper-right corner of the page, click **Save User**.
{% endstep %}
{% endstepper %}

#### Create Upstream IdP Super Admin, Admin, and Viewer User Accounts

Upstream IdP users are users who authenticate and are managed via a customer's IdP service rather than being managed directly by the Onyx Portal. If a customer's IdP cannot release the user attributes required for SSO user authentication (onyxPortalTenantId and onyxPortalRole) to the Onyx IdP, user accounts for Onyx Portal users in the customer's organization are created in the Onyx Portal.

**To create an upstream IDP Super Admin, Admin, or Viewer user account:**

{% hint style="info" %}
**NOTE:** If you are a GXC Administrator or a GXC Partner Administrator, you can add Super Administrator, Administrator, and Viewer user accounts. If you are a Super Administrator, you can add Administrator and Viewer user accounts.
{% endhint %}

{% stepper %}
{% step %}
Switch to the required GXC partner or customer account.

To switch between Onyx Portal accounts, in the upper-right corner of the page, click the current Onyx Portal account's name.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Users** tab.

The **Administration** page > **Users** tab displays the list of active user accounts.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Add Upstream IdP User**.

The **Create User** page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5KkU7rVod55J8gN0Te0K%2Fimage.png?alt=media&amp;token=4678e180-cfee-4c45-8294-ff3d58ff187a" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details:

* **User Email** – (Required) The user's email address.

{% hint style="info" %}
**NOTE:** If the email ID that you enter is already associated with a user account in another Onyx Portal customer account, the user can be invited to manage the current Onyx Portal customer account with any role.
{% endhint %}

* **Invite user to manage the current Onyx Portal customer account** – (Displayed only if the email ID is already associated with an existing user account in any other Onyx Portal customer account.) – To invite the user to manage the current Onyx Portal customer account, select the check box.
* **User Name** – (Required) The user's full name.
* **Role** – (Required) The user's role. Select from **Super Admin**, **Admin**, **Viewer**.
* **Network** – Click to select from the list of networks in the customer account, all or specific networks that the user must have access to manage. To remove access to a particular network, clear the corresponding checkbox. Default value: **All Networks**.
  {% endstep %}

{% step %}
To save the user account, in the upper-right corner of the page, click **Save User**.
{% endstep %}
{% endstepper %}

### Edit User Accounts

{% hint style="info" %}
**NOTE:** If you are a GXC Administrator, you can edit Super Administrator, Administrator, and Viewer user accounts. If you are a GXC Partner or a Super Administrator, you can only edit Administrator and Viewer user accounts.
{% endhint %}

This section applies to editing both direct and upstream IdP user accounts under non-GXC Root accounts.

**To edit a user account under non-GXC Root accounts:**

{% hint style="info" %}
**NOTE:** You can edit a user account only to change the user's name. Details such as the user's email address and role are not editable.
{% endhint %}

{% stepper %}
{% step %}
Switch to the required GXC partner or customer account.

To switch between Onyx Portal accounts, in the upper-right corner of the page, click the current Onyx Portal account's name.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Users** tab.

The **Administration** page > **Users** tab > **Users** section displays the list of active user accounts.
{% endstep %}

{% step %}
For the user account that you want to edit, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FRkYgL9wZ01Hm42YYFswn%2Fimage.png?alt=media&amp;token=3ce478a3-ccb3-437c-a1c2-23b7ce8bd255" alt="" width="162"><figcaption></figcaption></figure>

The **Edit User Access** page is displayed.
{% endstep %}

{% step %}
Edit the user's name or allowed networks as required.

* **User Email** – (View-only field) The user's email address.
* **User Name** – (Required) The user's name.
* **Role** – (View-only field) The user's role.
* **Network** – Click to select from the list of networks in the customer account, all or specific networks that the user must have access to manage. To remove access to a particular network, clear the corresponding checkbox. Default value: **All Networks**.
* **Use account-level idle session timeout setting** – To inherit the GXC partner/customer account level user idle timeout setting, select the checkbox. To configure a custom value, clear the checkbox and enter a value from one of the following ranges:
  * 5–59 minutes
  * 1–23 hours
  * 1–7 days
    {% endstep %}

{% step %}
To save your edits, in the upper-right corner of the page, click **Save User**.
{% endstep %}
{% endstepper %}

**To edit user accounts under the GXC Root account:**

{% hint style="info" %}
**NOTE:** You can edit user accounts under the GXC Root account only if you are a GXC Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** You can edit a user account only to change the user's name. Details such as the user's email address and role cannot be edited.
{% endhint %}

{% stepper %}
{% step %}
Switch to the GXC Root account.

To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click **Other Accounts** > **Select GXC Root**.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Users** tab.

The **Administration** page > **Users** tab displays the list of active user accounts.
{% endstep %}

{% step %}
For the user account that you want to edit, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

The **Edit User Access** page is displayed.
{% endstep %}

{% step %}
Edit the user's details as required.

* **User Email** – (View-only field) The user's email address.
* **User Name** – (Required) The user's name.
* **Role** – (View-only field) The user's role.
* **Use account-level idle session timeout setting** – To inherit the GXC partner/customer account level user idle timeout setting, select the checkbox.

  To configure a custom value, clear the checkbox and enter a value from one of the following ranges:

  * 5–59 minutes
  * 1–23 hours
  * 1–7 days
    {% endstep %}

{% step %}
To save your edit, in the upper-right corner of the page, click **Save User**.
{% endstep %}
{% endstepper %}

### Reset User MFA Secrets

If a user's mobile phone is compromised or lost, and the user's MFA backup codes are unavailable or exhausted, you can reset the user's MFA secrets. Resetting a user's MFA secrets is equivalent to deleting the user's MFA registration, allowing the user to set up MFA again as if for a new user.

{% hint style="info" %}
**NOTE:** If a user does not have access to his/her phone temporarily, the user can use the backup codes to log in. For more information, see [*Reset Your MFA Secrets*](#reset-your-mfa-secrets).
{% endhint %}

**To reset a user's MFA secrets:**

{% stepper %}
{% step %}
Switch to the required GXC partner or customer account.

To switch between Onyx Portal accounts, in the upper-right corner of the page, click the current Onyx Portal account's name.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Users** tab.

The **Administration** page > **Users** tab displays the list of active user accounts.
{% endstep %}

{% step %}
For the user account that you want to reset MFA secrets, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Reset MFA Secrets**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FOcGC0farvZ9mSLVUfDtq%2Fimage.png?alt=media&amp;token=ee51311a-505b-4cad-b70a-7ec09092d13e" alt="" width="162"><figcaption></figcaption></figure>

A confirmation dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FrbC04oOK7SISAvpGjX4Q%2Fimage.png?alt=media&amp;token=6137789a-da09-4e90-bbab-a993b5c40323" alt="" width="430"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To confirm resetting the user's MFA secrets, click **Yes**.
{% endstep %}
{% endstepper %}

### Suspend User Accounts

**To suspend a user account:**

{% stepper %}
{% step %}
Switch to the required GXC Portal account.

To switch between Onyx Portal accounts, in the upper-right corner of the page, click the current Onyx Portal account's name, then select the required account.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Users** tab.

The **Administration** page > **Users** tab displays the list of active user accounts.
{% endstep %}

{% step %}
For the user account that you want to suspend, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Suspend Account**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fro4OyF604vWQCHW0kHoO%2Fimage.png?alt=media&amp;token=722265f6-1ab9-429e-86ca-e6425fdb0968" alt="" width="162"><figcaption></figcaption></figure>

A confirmation dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fz2ZB8ZScnzo48Ur8ks4x%2Fimage.png?alt=media&amp;token=e8670aa1-f7f1-40f1-840c-055d598c5971" alt="" width="315"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To confirm suspending the user account, click **Yes**.

The user account is suspended.
{% endstep %}
{% endstepper %}

### Activate Suspended User Accounts

**To activate a suspended user account:**

{% stepper %}
{% step %}
Switch to the required Onyx Portal account.

To switch between Onyx Portal accounts, in the upper-right corner of the page, click the current Onyx Portal account's name, then select the required account.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Users** tab.

The **Administration** page > **Users** tab displays the list of active user accounts.
{% endstep %}

{% step %}
For the suspended user account that you want to activate, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Activate Account**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXDbq5LE15YABniBpuylH%2Fimage.png?alt=media&amp;token=232cce89-47bd-48a0-896f-df724050218b" alt="" width="164"><figcaption></figcaption></figure>

A confirmation dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F9Q47al1vXdVQML2Y13VY%2Fimage.png?alt=media&amp;token=e546f0da-e047-443e-93a6-7eea3cfa901d" alt="" width="311"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To confirm activating the user account, click **Yes**.

The user account is activated.
{% endstep %}
{% endstepper %}

### Delete User Accounts

{% hint style="info" %}
**NOTE:** If you are a GXC Administrator, you can delete Super Administrator, Administrator, and Viewer user accounts. If you are a GXC Partner Administrator or a Super Administrator, you can delete Administrator and Viewer user accounts. If you are an Administrator, you can delete Viewer user accounts.
{% endhint %}

**To delete a user account from an Onyx Portal account:**

{% stepper %}
{% step %}
Switch to the required Onyx Portal account.

To switch between Onyx Portal accounts, in the upper-right corner of the page, click the current Onyx Portal account's name, then select the required account.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Users** tab.

The **Administration** page > **Users** tab displays the list of active user accounts.
{% endstep %}

{% step %}
For the user account that you want to delete, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Delete**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FBPP2b5xlzd4SNhmj5Vuy%2Fimage.png?alt=media&amp;token=de7598bc-2969-42c5-960e-c00086cd4447" alt="" width="162"><figcaption></figcaption></figure>

A confirmation dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FjOv3MRwgBSHy5RTD4jvU%2Fimage.png?alt=media&amp;token=fd333981-e3de-4aac-a80e-d79f2a9bc4f1" alt="" width="323"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To confirm deleting the user account, click **Yes**.

The user account is deleted.
{% endstep %}
{% endstepper %}

## View Onyx Portal Operations Audit Logs

{% hint style="info" %}
**NOTE:** You can view the Onyx Portal Operations Audit Logs only if you are a GXC Administrator, GXC Partner Administrator, or a Customer Super Administrator.
{% endhint %}

The Onyx Portal supports audit logging of important Onyx Portal user operations, such as user log on and log out, all create, update, and delete operations, software upgrades, equipment restarts, log and cert file downloads, etc.

The audit logs are retained for a period of 60 days and can be downloaded as a .csv file.

The audit logs record details include the operation, the timestamp at which the operation occurred, the responsible user, client IP address, operation's category and sub-category, operation's status, and so on.

**To view the Onyx Portal Operations Audit Logs:**

{% stepper %}
{% step %}
Switch to the GXC Root account.

To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click **Other Accounts** > **Select GXC Root**.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Operations Audit Logs** tab.

The **Administration** page > **Operations Audit Logs** tab displays the list of Onyx Portal Operations Audit Logs for the selected duration and customer account.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQ0QbYWnJ7chEUcqXvCew%2Fimage.png?alt=media&amp;token=70a984df-f91b-4cdf-bd9e-c705e1e33224" alt=""><figcaption></figcaption></figure>

* **Audit Logs (n)** – The total number of audit logs.
* **Timestamp** – The timestamp at which the operation occurred.
* **Email** – The email address of the user responsible for the operation. To filter logs for a particular user, in the **Search Email** box, enter the user's email address.
* **Operation Name** – The operation's name—Post, Put, Delete. To filter logs based on operation name, in the dropdown select the required operation name.
* **Operation Category** – The operation's category. To filter logs based on operation category, in the dropdown select the required operation category.
* **Operation Sub-Category** – The operation's subcategory. To filter logs based on operation sub-category, in the dropdown select the required operation sub-category.
* **Operation Status** – The operation's status—Success, Failure, Blank. To filter logs based on operation status, in the dropdown select the required operation status.
* **Client IP** – The client IP address from which the operation occurred.
* **Request Details** – Click ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FHpXIcBxBv5fH6NFk6W7f%2Fimage.png?alt=media\&token=aa23c600-6640-40df-a195-08877d3215a3) (view details) to view the object's details. The **Details** dialog box displays the object's details.
* **Request Object** – If available, click ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fw3nfautC3UmDcWD2Ik34%2Fimage.png?alt=media\&token=6b25ceb4-b222-444b-af80-3d45efb757b3) (view details) to view the request details. The **Details** dialog box displays the object's request details.
* **Additional Details** – If available, click ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FwLh7Sf3BqSkI81S5iuiK%2Fimage.png?alt=media\&token=28084956-6861-4dbb-bcab-9d5b28927a27) (view details) to view additional object details, such as Onyx Edge or AP configuration, etc. The **Details** dialog box displays additional details.
  {% endstep %}

{% step %}
By default, logs are displayed for all customer accounts. To view logs for a specific customer account, in the **Tenant** dropdown, select the customer account's name.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FgyFWmFK47PYxInRq20eS%2Fimage.png?alt=media&amp;token=a3a7eb6f-ca0d-4bc2-85aa-dcf807176d85" alt="" width="563"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To change the selected duration for which logs are displayed, select the required from and to timestamps.
{% endstep %}

{% step %}
To search for logs using keywords, enter your search term in the **Search keyword** box.
{% endstep %}

{% step %}
To download the logs as a .csv file, click **Download**, and specify where to save the file.
{% endstep %}
{% endstepper %}


# Analytics

The Analytics feature generates Key Performance Indicator (KPI) reports that provide insight into the performance and status of your networks. You can generate analytics reports for specific functions and time durations to troubleshoot and optimize your networks.

## Analytics Reports

The Analytics feature provides three report types, each providing a different view of network performance data:

* [*Performance Summary Report*](#performance-summary-report)
* [*Performance Analytics Report*](#performance-analytics-report)

### Performance Summary Report&#x20;

The Performance Summary Report presents KPIs as single numerical values, each representing an aggregate over the selected duration and equipment scope. For instructions on generating this report, see [*Generate Analytics Reports*](#generate-analytics-reports).

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXDfvLNDDtOhtvWwE6Sp7%2F4g-performance-summary.png?alt=media&amp;token=2c7c2aa5-3ba7-4b4a-aac1-f89435c091a2" alt=""><figcaption></figcaption></figure></div>

The Performance Summary Report includes the following KPIs.

<table><thead><tr><th valign="top">Metric</th><th width="100" valign="top">4G / 5G</th><th valign="top">Description</th></tr></thead><tbody><tr><td valign="top">Average Uplink Throughput</td><td valign="top">4G, 5G</td><td valign="top">Average data transmission rate in the uplink direction (UE to AP) across the selected duration.</td></tr><tr><td valign="top">Peak Uplink Throughput</td><td valign="top">4G, 5G</td><td valign="top">Peak data transmission rate in the uplink direction (UE to AP) during the selected duration.</td></tr><tr><td valign="top">Uplink Traffic Volume</td><td valign="top">4G, 5G</td><td valign="top">Total data transmitted in the uplink direction (UE to AP) over the selected duration. Excludes MeshBackhaul traffic.</td></tr><tr><td valign="top">Average Downlink Throughput</td><td valign="top">4G, 5G</td><td valign="top">Average data transmission rate in the downlink direction (AP to UE) across the selected duration.</td></tr><tr><td valign="top">Peak Downlink Throughput</td><td valign="top">4G, 5G</td><td valign="top">Peak data transmission rate in the downlink direction (AP to UE) during the selected duration.</td></tr><tr><td valign="top">Downlink Traffic Volume</td><td valign="top">4G, 5G</td><td valign="top">Total data transmitted in the downlink direction (AP to UE) over the selected duration. Excludes MeshBackhaul traffic.</td></tr><tr><td valign="top">GPS Signal Availability</td><td valign="top">4G</td><td valign="top"><p>Average percentage of time the selected AP was GPS-connected during the selected duration.</p><p>Loss of GPS timing signal can cause drift, increased interference, and reduced cell capacity.</p></td></tr><tr><td valign="top">PRB Utilization Uplink</td><td valign="top">4G, 5G</td><td valign="top"><p>Average Physical Resource Block (PRB) utilization percentage on uplink shared channels, aggregated over five-minute intervals.</p><p>Includes Mesh UE traffic. All other KPIs exclude Mesh UE traffic.</p><p>See <a href="#prb-utilization-analytics"><em>PRB Utilization Analytics</em></a>.</p></td></tr><tr><td valign="top">PRB Utilization Downlink</td><td valign="top">4G, 5G</td><td valign="top"><p>Average PRB utilization percentage on downlink shared channels, aggregated over five-minute intervals.</p><p>Includes Mesh UE traffic. All other KPIs exclude Mesh UE traffic.</p><p>See <a href="#prb-utilization-analytics"><em>PRB Utilization Analytics</em></a>.</p></td></tr><tr><td valign="top">Access Point Uptime</td><td valign="top">4G, 5G</td><td valign="top"><p>Average percentage of time the AP was in service during the selected duration.</p><p>For CA-enabled APs, only the primary cell is accounted for — 100% does not confirm secondary cells were functioning.</p><p>For DC-enabled APs, both Cell 1 and Cell 2 are accounted for.</p></td></tr><tr><td valign="top">Downlink Cell BLER</td><td valign="top">5G</td><td valign="top"><p>Average downlink Block Error Rate (BLER) as a percentage, measuring error rate after decoding.</p><p>Elevated BLER indicates retransmissions are consuming capacity, reducing effective downlink throughput.</p></td></tr><tr><td valign="top">Uplink Cell BLER</td><td valign="top">5G</td><td valign="top"><p>Average uplink BLER as a percentage, measuring error rate after decoding.</p><p>High uplink BLER indicates poor UE transmit conditions — distance, obstruction, or interference.</p></td></tr><tr><td valign="top">Cell SRS SNR</td><td valign="top">5G</td><td valign="top"><p>Average Signal-to-Noise Ratio of Sounding Reference Signals (SRS), used for uplink channel quality estimation and scheduling decisions.</p><p>Low SNR correlates with higher BLER and lower modulation order selection. Measured in decibels (dB).</p></td></tr><tr><td valign="top">RRC Success Percentage</td><td valign="top">5G</td><td valign="top"><p>Average number of RRC connection establishments for the cell, expressed as a ratio of successful to attempted setups.</p><p>Failures at this layer prevent devices reaching the core network.</p></td></tr><tr><td valign="top">RACH Attempts</td><td valign="top">5G</td><td valign="top"><p>Number of Random Access Channel attempts during the selected duration.</p><p>High RACH load with a simultaneous fall in RRC Success Percentage indicates access congestion.</p></td></tr><tr><td valign="top">UE Connection Requests</td><td valign="top">4G, 5G</td><td valign="top"><p>4G: Number of UE attach requests (NAS layer Connection Requests) for the selected equipment and duration.</p><p>5G: Number of UE registration requests (NAS layer Connection Requests) for the selected equipment and duration.</p></td></tr><tr><td valign="top">UE Connection Success</td><td valign="top">4G, 5G</td><td valign="top"><p>4G: Percentage or count of successful UE attach accepts (NAS layer Connection Responses sent to UE).</p><p>5G: Percentage or count of successful UE registration accepts (NAS layer Connection Responses sent to UE).</p><p>Toggle between % and # display modes using the icon control.</p></td></tr><tr><td valign="top">Number of Dropped Calls</td><td valign="top">4G</td><td valign="top"><p>Number of implicit UE detaches — sessions terminated because the UE went out of coverage and did not refresh its registration periodically.</p><p>Distinct from attach failures; the device was previously connected. Also, see <a href="#performance-analytics-report"><em>Performance Analytics Report</em></a> > Dropped Call Rate.</p></td></tr><tr><td valign="top">Average Number of Active UE</td><td valign="top">4G, 5G</td><td valign="top"><p>Average number of active (connected) UE for the selected equipment and duration.</p><p>Measured at the Onyx Edge level. Not available when a specific AP is selected.</p></td></tr><tr><td valign="top">Average Number of Registered UE</td><td valign="top">4G, 5G</td><td valign="top"><p>Average number of registered UE (idle and connected) for the selected equipment and duration. Always >= active UE.</p><p>Measured at the Onyx Edge level. Not available when a specific AP is selected.</p></td></tr><tr><td valign="top">Paging Success</td><td valign="top">4G, 5G</td><td valign="top"><p>Percentage or count of successful paging attempts. Used by the network to wake idle registered UE.</p><p>Toggle between % and # display modes using the icon control.</p></td></tr><tr><td valign="top">NGAP Dropped Connections</td><td valign="top">5G</td><td valign="top"><p>Percentage or count of N2 interface connections dropped due to errors between the RAN and 5G core. Excludes drops caused by user inactivity or core-initiated releases.</p><p>Indicates instability in the control-plane path between the access network and the AMF.<br>Toggle between % and # display modes using the icon control.</p></td></tr><tr><td valign="top">SAS Availability</td><td valign="top">4G, 5G</td><td valign="top"><p>Average percentage of time SAS was available for the selected equipment and duration.</p><p>Applies only to CBRS-band deployments.</p><p>If SAS becomes unavailable, the network loses its spectrum grant and must suspend transmissions — causing a complete service outage regardless of radio or core health.</p></td></tr></tbody></table>

### Performance Analytics Report

The Performance Analytics Report presents KPIs as time-series line charts over the selected duration, enabling identification of trends, anomalies, and patterns not visible in point-in-time summary values. Not all charts are displayed by default — use the Manage Reports feature to add or remove charts from the report. For instructions on generating this report, see [*Generate Analytics Reports*](#generate-analytics-reports). For known sampling behavior affecting these charts, see [*Analytics Limitations*](#analytics-limitations).

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FUy1ad41SyWAErbirfc92%2F4g-performance-analytics.png?alt=media&amp;token=3dfb709d-3d63-4c5c-8ff8-2d1db6e7fa70" alt=""><figcaption></figcaption></figure></div>

The Performance Analytics Report includes the following charts.

<table><thead><tr><th width="310.39990234375" valign="top">Chart</th><th width="100" valign="top">4G / 5G</th><th valign="top">Description</th></tr></thead><tbody><tr><td valign="top">Average Downlink Throughput</td><td valign="top">4G, 5G</td><td valign="top">Average downlink throughput across all or selected equipment at each time point.</td></tr><tr><td valign="top">Average Uplink Throughput</td><td valign="top">4G, 5G</td><td valign="top">Average uplink throughput across all or selected equipment at each time point.</td></tr><tr><td valign="top">Peak Downlink Throughput</td><td valign="top">4G, 5G</td><td valign="top">Maximum downlink throughput achieved across all or selected equipment at each time point.</td></tr><tr><td valign="top">Peak Uplink Throughput</td><td valign="top">4G, 5G</td><td valign="top">Maximum uplink throughput achieved across all or selected equipment at each time point.</td></tr><tr><td valign="top">Downlink Traffic Volume</td><td valign="top">4G, 5G</td><td valign="top">Total data sent in the downlink direction (AP to UE) for selected equipment at each time point. Excludes MeshBackhaul traffic.</td></tr><tr><td valign="top">Uplink Traffic Volume</td><td valign="top">4G, 5G</td><td valign="top">Total data sent in the uplink direction (UE to AP) for selected equipment at each time point. Excludes MeshBackhaul traffic.</td></tr><tr><td valign="top">Access Point Uptime</td><td valign="top">4G, 5G</td><td valign="top"><p>Average percentage of time the AP was in service at each time point.</p><p>Subject to the same CA/DC primary-cell accounting as the Performance Summary.</p></td></tr><tr><td valign="top">Cell Uptime</td><td valign="top">4G, 5G</td><td valign="top">Average percentage of time the cell was in service at each time point.</td></tr><tr><td valign="top">SAS Availability</td><td valign="top">4G, 5G</td><td valign="top"><p>Average percentage of time SAS was available for selected equipment at each time point.</p><p>Applies only to CBRS-band deployments.</p></td></tr><tr><td valign="top">UE Connection Requests</td><td valign="top">4G, 5G</td><td valign="top"><p>4G: Number of UE attach requests (NAS layer) for all or selected equipment at each time point.</p><p>5G: Number of UE registration requests (NAS layer) for all or selected equipment at each time point.</p></td></tr><tr><td valign="top">UE Connection Success</td><td valign="top">4G, 5G</td><td valign="top"><p>4G: Percentage or count of successful UE attach accepts at each time point.</p><p>5G: Percentage or count of successful UE registration accepts at each time point.</p><p>Toggle between % and # display modes using the icon control.</p></td></tr><tr><td valign="top">Average Number of Active UEs</td><td valign="top">4G, 5G</td><td valign="top"><p>Average number of active (connected) UE at each time point.</p><p>Not available when a specific AP is selected.</p></td></tr><tr><td valign="top">Average Number of Registered UEs</td><td valign="top">4G, 5G</td><td valign="top"><p>Average number of registered UE (idle and connected) at each time point. Always >= active UE.</p><p>Not available when a specific AP is selected.</p></td></tr><tr><td valign="top">PRB Utilization Downlink</td><td valign="top">4G, 5G</td><td valign="top"><p>Average downlink PRB utilization on shared channels aggregated over five-minute intervals at each time point.</p><p>Includes Mesh UE traffic. All other KPIs exclude Mesh UE traffic.<br>See <a href="#prb-utilization-analytics"><em>PRB Utilization Analytics</em></a>.</p></td></tr><tr><td valign="top">PRB Utilization Uplink</td><td valign="top">4G, 5G</td><td valign="top"><p>Average uplink PRB utilization on shared channels aggregated over five-minute intervals at each time point.</p><p>Includes Mesh UE traffic. All other KPIs exclude Mesh UE traffic.<br>See <a href="#prb-utilization-analytics"><em>PRB Utilization Analytics</em></a>.</p></td></tr><tr><td valign="top">Paging Success</td><td valign="top">4G, 5G</td><td valign="top"><p>Percentage or count of successful paging responses at each time point.</p><p>Toggle between % and # display modes using the icon control.</p></td></tr><tr><td valign="top">GPS Signal Availability</td><td valign="top">4G</td><td valign="top">Average percentage of time the selected AP was GPS-connected at each time point.</td></tr><tr><td valign="top">Dropped Call Rate</td><td valign="top">4G</td><td valign="top">Number of implicit UE detaches at each time point — sessions lost because the UE went out of coverage and did not refresh periodically. Also, see <a href="#performance-summary-report"><em>Performance Summary Report</em></a> > <em>Number of Dropped Calls</em>.</td></tr><tr><td valign="top">NGAP Dropped Connections</td><td valign="top">5G</td><td valign="top"><p>Percentage or count of N2 interface connections dropped due to errors at each time point. Excludes drops caused by user inactivity or core-initiated releases. A spike indicates N2/AMF interface instability.</p><p>Toggle between % and # display modes using the icon control.</p></td></tr><tr><td valign="top">Downlink Cell BLER</td><td valign="top">5G</td><td valign="top">Percentage of downlink data blocks failing decoding after error correction at each time point.</td></tr><tr><td valign="top">Uplink Cell BLER</td><td valign="top">5G</td><td valign="top">Percentage of uplink data blocks failing decoding after error correction at each time point.</td></tr><tr><td valign="top">Cell SRS SNR</td><td valign="top">5G</td><td valign="top">SNR of Sounding Reference Signals at each time point, used for uplink channel quality estimation and scheduling decisions. Measured in decibels (dB).</td></tr><tr><td valign="top">RRC Connection Establishments</td><td valign="top">5G</td><td valign="top"><p>The RRC Connection Establishments chart provides per-cell visibility into RRC connection activity over time. It displays two data series — Successful (green) and Attempted (blue) — as a grouped bar chart, with raw connection counts on the y-axis and time on the x-axis.</p><p>Use this chart to assess both connection volume and success rate simultaneously. A significant gap between the Attempted and Successful series indicates RRC establishment failures, which may point to radio coverage issues, interference, or capacity constraints.</p></td></tr><tr><td valign="top">RACH Attempts</td><td valign="top">5G</td><td valign="top"><p>Number of Random Access Channel access attempts at each time point.</p><p>A spike coinciding with falling RRC Success Percentage confirms RACH congestion.</p></td></tr></tbody></table>

## Generate Analytics Reports

{% hint style="info" %}
**NOTE:** Analytics reports may include data for equipment that no longer exist (deleted and decommissioned equipment) but were operational during the sampling period.
{% endhint %}

{% hint style="info" %}
**NOTE:** The "PRB Utilization Downlink" and "PRB Utilization Uplink" KPIs include Mesh UE traffic. All other KPIs exclude Mesh UE traffic.
{% endhint %}

**To generate Analytics Reports:**

{% stepper %}
{% step %}
If you are a GXC Partner Administrator, switch to your own partner account.

If you are a Super Administrator, Administrator, or a Viewer, start with Step 2.
{% endstep %}

{% step %}
In the navigation pane, click **Analytics**.

The **Analytics** page is displayed.
{% endstep %}

{% step %}
Select from the following filter criteria.

As you select each criterion, the options available in the next criterion dropdown updates automatically.

If only one option exists at a given hierarchy level — such as a single network, venue, or Onyx Edge — the Onyx Portal automatically selects it and advances to the next criterion, reducing the number of steps required to reach a target AP. Where multiple options exist at a level, manual selection is required as usual.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FxDeNdJ7JeEwcSUCXKVNP%2F4g-performance-summary.png?alt=media&amp;token=f3a66e92-48fe-4119-80d8-28825a850cf4" alt=""><figcaption></figcaption></figure></div>

* **Customer** – Select the Onyx Portal customer account.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> GXC Administrators, when in the GXC Root account, can select from all existing customer accounts.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> GXC Partner Administrators, when in their own partner account, can select from their own customer accounts.</p></div>
* **Network** – Select the network—**All 4G Networks**, **All 5G Networks**, or a specific network. Default value: **All 4G Networks**.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The options available in the <strong>Network</strong> drop-down correspond to the customer account selected in the <strong>Customer</strong> drop-down.</p></div>
* **Venue** – Select the venue—**All Venues** or a specific venue in the selected network. Default value: **All Venues**.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The options available in the <strong>Venue</strong> drop-down correspond to the network selected in the <strong>Network</strong> drop-down.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> In the <strong>Network</strong> drop-down, if you select <strong>All 4G Networks</strong> or <strong>All 5G Networks</strong>, the <strong>Venue</strong> drop-down displays <strong>All Venues</strong> and is disabled. To select a specific venue, in the <strong>Network</strong> drop-down, you must select a specific network.</p></div>
* **Onyx Edge** – Select the Onyx Edge—**All Onyx Edges** or a specific Onyx Edge in the selected venue. Default value: **All Onyx Edges**.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The options available in the <strong>Onyx Edge</strong> drop-down correspond to the venue selected in the <strong>Venue</strong> drop-down.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> If, in the <strong>Venue</strong> drop-down, you select <strong>All Venues</strong>, the <strong>Onyx Edge</strong> drop-down displays <strong>All Onyx Edge</strong> and is disabled. To select a specific Onyx Edge, in the <strong>Venue</strong> drop-down, you must select a specific venue.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The analytics reports may include data for Onyx Edge that do not exist (deleted and decommissioned Onyx Edge) but were operational in the selected duration.</p></div>
* **Cell** – Select the cell—**All Cells** or a specific cell. Default value: **All Cells**.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE</strong>: This filter is only available when a 5G network is selected.</p></div>
* **Access Point** – Select the AP—**All APs** or a specific AP associated with the selected Onyx Edge. Default value: **All APs**.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The options available in the <strong>Access Point</strong> drop-down correspond to the Onyx Edge selected in the <strong>Onyx Edge</strong> drop-down.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> If, in the <strong>Onyx Edge</strong> drop-down, you select <strong>All Onyx Edges</strong>, the <strong>Access Point</strong> drop-down displays <strong>All APs</strong> and is disabled. To select a specific AP, in the <strong>Onyx Edge</strong> drop-down, you must select a specific Onyx Edge.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The analytics reports may include data for APs that do not exist (deleted and decommissioned APs) but were operational in the selected duration.</p></div>
* **Duration** – Select the duration for which the summary report must be generated—**Last 15 minutes**, **Last 30 minutes**, **Last 1 hour**, **Last 3 hours**, **Last 24 hours**, **Last 1 week**, **Last 15 days**, **Last 30 days**, **Last 60 days**, **Last 90 days**, or **Custom**. Default value: **Last 3 hours**.\
  The **Custom** option is limited to a maximum range of 90 days, as only 90 days of historical data is retained.

As you select each filter criterion, the analytics reports update automatically.
{% endstep %}

{% step %}
The **Performance Summary** tab, open by default, displays the performance summary report for the selected criteria.

\<screenshot>

* For KPI descriptions, see [*Performance Summary Report*](#analytics-reports).
* To download the summary report as a CSV file, click **Download Summary**.
* To view per-subscriber KPI report, click **Per Subscriber Report**. \
  The **Per Subscriber KPIs** dialog box is displayed.

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FDGANEHKvznuUZISCDU2s%2Fimage.png?alt=media&amp;token=0607782b-a273-4d33-8832-3e61a5b84ef5" alt=""><figcaption></figcaption></figure></div>

  * **IMSI** – The subscriber's IMSI.
  * **Average DL Throughput** – The subscriber's average download data rate.
  * **Average UL Throughput** – The subscriber's average upload data rate.
  * **Peak DL Throughput** – The subscriber's maximum observed download speed.
  * **Peak UL Throughput** – The subscriber's maximum observed upload speed.
  * **DL Traffic Volume** – The subscriber's total downloaded data volume.
  * **UL Traffic Volume** – The subscriber's total uploaded data volume.
* To download the Per Subscriber Report, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FEwNftH4ullby3q9bpwOJ%2Fimage.png?alt=media&amp;token=7f6600f1-7346-4362-aaf4-59470f27f6cb" alt="" data-size="line"> (download).
  {% endstep %}

{% step %}
To view the Performance Analytics Report, click the **Performance Analytics** tab.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FzRazeoL0Ad6tCw7sbSdV%2F4g-performance-analytics.png?alt=media&amp;token=04f876bf-182e-41f5-988e-01a35c013797" alt=""><figcaption></figcaption></figure></div>

* For chart descriptions, see [*Performance Analytics Report*](#analytics-reports).
* By default, not all available charts are displayed in the Performance Analytics Report. To view or hide a specific chart in the report:
  1. Click **Manage Reports**.\
     The **Manage Report KPIs** dialog box displays available KPIs, categorized into Common and 5G groups.\
     \<screenshot>
  2. To view a specific trend chart, move it to the **Selected KPIs** list.
  3. To hide a specific trend chart, move it to the **Choose KPIs** list.
  4. To save your changes, click **Save**.
* To download the report as a PDF file, click **Download All Charts**.
  {% endstep %}
  {% endstepper %}

## Analytics Limitations

This section describes the limitations of the Analytics feature in this release.

### Last Data Point on Plots Sometimes Drops to Zero

The last data point on Performance Analytics plots may sometimes drop to zero for one of the following reasons:

* The last data point may factually be zero.
* The data point for the last minute may be delayed. Very likely since the graph's right edge is close to the current time, and there may be a delay in collecting the metric from the corresponding equipment.
* The last data point may be missing due to the equipment going offline.

It is recommended to ignore the last data point on the plots.

### PRB Utilization Analytics

This limitation applies to the PRB Utilization Uplink and PRB Utilization Downlink KPIs in both the [*Performance Summary Report*](#performance-summary-report) and [*Performance Analytics Report*](#performance-analytics-report).

The Onyx Edge collects five-minute averaged statistics from the APs every five minutes. Since the data is backfilled for the last five minutes, any queries including the sampling time will give different values before and after that time. After the five-minute sampling time, refresh the report to view the correct data.

For example:

> An AP provides data at 10:00:29 with the value x.
>
> This covers five minutes average, from 09:55:29 to 10:00:29.
>
> The Onyx Edge generates the following five samples: 09:56:00 x, 09:57:00 x, 09:58:00 x, 09:59:00 x, 10:00:00 x.
>
> Say, the Onyx Edge pushed these at 10:00:50 into the Orchestrator/Prometheus.
>
> Any query done including this 09:55:00 to 10:00:00 interval until 10:00:50 is void (as these five data points do not exist), and any query done post 10:00:50 will give the correct value (as these data points now exist). Post 10:00:50, these values will never change for that duration.

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# 4G Onyx Edge On-Premises 4.x Installation and Operations


# Introduction

This guide describes how to install Onyx Edge software on Onyx-ES hardware for 4G networks.

## Intended Audience

This document is intended for personnel responsible for installing Onyx Edge software on Onyx-ES hardware and for managing Onyx Edge On-Premises systems. Management access to the Onyx Edge is required to perform the procedures described in this document. If you do not have management access, work with your GXC Technical Support representative.

## About Onyx Edge

The Onyx Edge provides mobile device management functions in the control plane and enables data packet exchanges between user equipment (UE) and applications in the packet network on the data plane.

The 4G Onyx Edge consists of the Mobility Management Entity (MME), Home Subscriber Server (HSS), Serving Gateway (SGW), and the Packet Data Network Gateway (PGW) network elements. The MME and HSS provide mobility and device access control. The SGW and PGW are the network elements providing actual bearer data transport for mobile devices by routing data packets between your private LTE network, your local network, and any connected networks such as the public Internet. In the GXC solution, these different network elements run integrated on a single Onyx Edge.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FH1zjInAaYOyRYCyzkJOR%2Fimage7.png?alt=media&amp;token=6de4224b-16b0-499b-a8e8-022b2e76b807" alt=""><figcaption><p>GXC Private Network Architecture</p></figcaption></figure>


# Installation Requirements

This section describes the hardware, software, and other requirements for Onyx Edge On-Premises AGWs.

## Hardware Specifications

The GXC-supplied Onyx-ES hardware comes pre-installed with Onyx Edge software for Onyx Edge On-Premises deployments. For information regarding available Onyx-ES hardware options and specifications, please contact GXC Technical Support.

## Software Requirements

The GXC-supplied Onyx Edge ISO image includes all required software components for fresh Onyx Edge software installations.

## Network Interfaces

The Onyx-ES hardware has two network interfaces―eth0 and eth1.

* eth0 can get its IP address over DHCP (default) or can have its IP address statically configured. Internet access is required over this interface.
* eth1, is statically assigned 10.0.2.1/24. During a fresh installation, it is important that this interface is not connected to anything until the installation completes to avoid confusion on which is the first/Internet interface. This interface can later be connected to the switch to the radio network (or directly to an AP).

{% hint style="info" %}
**NOTE:** The Onyx Edge will start a DHCP service on the eth1 interface. Care should be taken to not have other equipment on this network segment that might be affected by this DHCP service.
{% endhint %}

{% hint style="info" %}
**NOTE:** There is no specific requirement on which physical port is designated as eth0 (Internet) and which as eth1 (radio). However, the same interface connection must be maintained right from ISO installation to deployment.
{% endhint %}

### eth1 Configuration Constraints

{% hint style="info" %}
**NOTE:** Do not configure eth1 statically. Either set it to DHCP (recommended) or disable it.
{% endhint %}

{% hint style="info" %}
**NOTE:** When configuring VLAN on eth0, disable the native/untagged eth0 interface. eth1 must be set to DHCP (recommended) or disabled.
{% endhint %}

### Identifying eth0 and eth1 Interfaces

GXC supplies Onyx-ES hardware with physical ports clearly labeled eth0 and eth1 on the chassis. If, for any reason, you have to verify which physical port is eth0 and which eth1, use one of the following methods:

{% stepper %}
{% step %}
Cable connection test:

* Plug a cable into one port at a time and check the link status:&#x20;

```
ip link show eth0 | grep "state UP"
ip link show eth1 | grep "state UP"
```

* Or monitor in real time:&#x20;

```
watch -n 1 'ip link show | grep -E "eth[0-1]"'
```

{% endstep %}

{% step %}
Use ethtool to identify ports by blinking LEDs.

* To make the LED blink on eth0 for 30 seconds:

```
 ethtool --identify eth0 30
```

* To make the LED blink on eth1 for 30 seconds:

```
ethtool --identify eth1 30
```

Watch the physical ports to see which one blinks.
{% endstep %}

{% step %}
Check MAC address mapping:

* To view network interfaces and their MAC addresses:

```
ip link show
```

* Or, use ifconfig:

```
ifconfig -a
```

* Compare with the MAC addresses printed on the physical port labels. Most Dell servers have MAC address stickers near the Ethernet ports.
  {% endstep %}

{% step %}
Check interface naming and Bus information:

* To view detailed interface information including PCI bus location:

```
ip link show eth0
ip link show eth1
```

* Or, use lshw:

```
lshw -class network -short
```

{% endstep %}
{% endstepper %}

## User Accounts and Access Credentials

This section provides information related to the onyxedge and agw\_user accounts.

### onyxedge User

{% hint style="info" %}
**NOTE:** onyxedge user credentials are available only to GXC personnel.
{% endhint %}

onyxedge user is the super user on the Onyx-ES with full sudo privileges.

onyxedge user credentials to log on to any Onyx-ES:

* Host name: onyxedge-agw
* Username: onyxedge
* Password to log on via the terminal is available only to GXC personnel.

### agw\_user

{% hint style="info" %}
**NOTE:** agw\_user credentials are available only to GXC Partner and Customer Administrators.
{% endhint %}

agw\_user is a second user on the Onyx-ES with the privileges to gather basic debug information, restart Onyx Edge services, and reset Onyx Edge back to factory settings.

agw\_user credentials to log on to Onyx-ES:

* IP address of the Onyx Edge.
* Username: agw\_user
* Password to log on via the Onyx-ES terminal.

  GXC Partner Administrators and Customer Super Administrators can change this password.
* SSH key to log on remotely.

  GXC Partner Administrators and Customer Super Administrators can add SSH keys in the Onyx Portal.

To SSH into an Onyx Edge as agw\_user, run the following command:

```
ssh agw_user@<ip_address>
```

For information on the CLI commands available to agw\_user, see Run Commands on Onyx Edge as agw\_user.

For information on configuring the agw\_user account, see the *4G Onyx Portal Operations Guide > Configure Onyx Edge agw\_user Account*.

{% hint style="info" %}
**NOTE:** If you do not have management access to the Onyx-ES, work with your GXC Technical Support representative.
{% endhint %}

## Network Connectivity and Enterprise Firewall Configuration

The Onyx Edge requires network connectivity to communicate with the Orchestrator and other GXC cloud services to operate correctly. Ensure that enterprise firewalls and network Access Control Lists (ACLs) are configured to allow the required traffic flows.

For detailed information on the required ports, protocols, and destination URLs/IPs that must be allowed through enterprise firewalls, refer to the *Onyx 4G & 5G Firewall Configuration for Onyx Networks Application Note*. This document provides the firewall rules for the Onyx Edge (eth0 and eth1 interfaces), APs, and Mesh Nodes to ensure proper communication with GXC cloud services.


# Install Onyx Edge Software

GXC supplies Onyx-ES hardware with the Onyx Edge software pre-installed and ready for deployment, so customers typically do not need to install the software themselves. However, if reinstallation is required due to hardware replacement, disk corruption, system recovery, etc. use the following procedure to perform a fresh installation of the Onyx Edge software on Onyx-ES hardware.

## Target Machine Requirements

Before beginning installation, ensure the target machine meets the following requirements:

* Boot Configuration – The target machine must be able to boot exactly once from the installation medium (USB or CD) containing the ISO, then automatically revert to hard disk boot.

{% hint style="info" %}
**NOTE:** If automatic boot revert is not possible: during Stage 1 installation, you must monitor the console, and after the first reboot, manually enter BIOS to change the boot priority to Hard Disk/SSD. Failure to do this will cause Stage 1 to repeat indefinitely. Alternatively, just remove the USB drive immediately after the first reboot to prevent Stage 1 installation repeating indefinitely.
{% endhint %}

* Network Interfaces – The target machine must have two network interfaces (eth0 and eth1). For detailed information about network interface specifications, port identification, and configuration requirements, refer to Network Interfaces.

## Installation Workflow

Workflow to install Onyx Edge software:

{% stepper %}
{% step %}
Obtain Onyx Edge Software ISO Image.
{% endstep %}

{% step %}
Create Bootable USB Drive.
{% endstep %}

{% step %}
Verify Target Machine’s Network Connectivity:

* eth0 must have Internet connectivity.
* eth1 must be disconnected during installation.
  {% endstep %}

{% step %}
Install Onyx Edge Software from Bootable USB Drive.
{% endstep %}

{% step %}
Post Installation Tasks:

1. Verify Successful Installation.
2. Get eth0 Hardware Address.
3. Label Physical Ports.
4. Connect eth1 to Radio Network.
5. Onboard the Onyx Edge in the Onyx Portal.
6. Verify Successful Onyx Edge Onboarding.
   {% endstep %}
   {% endstepper %}

### Obtain Onyx Edge Software ISO Image

To obtain the Onyx Edge ISO image, contact GXC Technical Support.

### Create Bootable USB Drive

To create a bootable USB drive with the Onyx Edge software, you will need:

* Onyx Edge ISO image.
* An empty USB drive with at least 4 GB of storage space.
* A tool to flash the Onyx Edge ISO image to the USB drive.

The Balena Etcher is a free open-source utility supported on Windows, LINUX, and Mac OS. You can obtain it from <https://www.balena.io/etcher/>.

**To create a bootable USB drive:**

{% stepper %}
{% step %}
Download the Onyx Edge ISO image to your local computer.
{% endstep %}

{% step %}
Plug in the USB drive.
{% endstep %}

{% step %}
Use the Balena Etcher utility to create the bootable USB:

1. Launch the Balena Etcher utility.
2. Click **Flash from file**, then select the Onyx Edge ISO image.
3. Select the USB drive to flash, then click **Continue**.
4. Click **Flash!** to create the bootable USB flash drive with the default settings. Flashing will take some time depending upon the size of the ISO image, and the speed supported by the USB drive. After Balena Etcher finishes creating the bootable ISO image on the USB, the “Flash Complete!” message is displayed.
5. Exit the Balena Etcher utility.
   {% endstep %}

{% step %}
Safely unplug the USB drive.
{% endstep %}
{% endstepper %}

### Install Onyx Edge Software from Bootable USB Drive

{% hint style="warning" %}
**CAUTION:** Reinstalling the Onyx Edge software will erase all existing data on the target machine. Ensure that any required data is backed up before proceeding.
{% endhint %}

To install the Onyx Edge software, you will need:

* Hardware requirements:
  * The target machine must have two network interfaces (eth0 and eth1). For complete specifications, see Network Interfaces.
    * Ensure eth0 interface has active Internet connectivity.
    * Ensure eth1 interface is physically disconnected (not connected to any network).
  * The machine must support booting from a USB drive.
* Installation materials:
  * A bootable USB drive containing the Onyx Edge ISO image.
  * Physical port labels to clearly identify network interface assignments.
* To log on to the Onyx-ES during Stage 2 and 3 of the installation, the following access credentials:
  * Host name: onyxedge-agw
  * Username: onyxedge
  * Password to log on via the terminal: (Provided by GXC Technical Support.)

{% hint style="info" %}
**NOTE:** If you do not have management access to the Onyx-ES, work with your GXC Technical Support representative.
{% endhint %}

The Onyx Edge software installation runs in three stages with three automatic reboots. The bootable USB drive must be configured to boot exactly once, after which the system should automatically revert to booting from the hard disk.

**To install the Onyx Edge software:**

{% stepper %}
{% step %}
Configure BIOS boot settings:

1. Plug in the bootable USB drive and restart the system.
2. Enter the BIOS setup as the system reboots.\
   Different machines have different BIOS entry methods. Common keys include F2, F11, F12, or Delete.
3. Set the USB device as the first boot option.\
   In the BIOS menu, locate the Boot Order or Boot Priority settings and move the USB drive to the top of the list.\
   The boot order determines which device the system checks first when loading an operating system (e.g., hard drive, USB, optical drive).
4. Save and exit the BIOS setup.\
   The system reboots and begins the installation from the USB drive.
   {% endstep %}

{% step %}
Monitor Stage 1 installation:&#x20;

The system boots from the USB drive and displays a GRUB screen for 5 seconds.&#x20;

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F6y3UfWw5sSr7hwZi6OkC%2Fimage9.png?alt=media&amp;token=c6374e27-8b30-4dfb-8a62-a4a59ffa200f" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Select the network connection configuration option:

* Option 1 - DHCP Configuration (Default):\
  If eth0 should use DHCP, accept the default option: **Install Onyxedge AGW**\
  Press Enter or wait 5 seconds to continue.
* Option 2 - Static IP Configuration:

  If eth0 requires a static IP address, select: **Install Onyxedge AGW - manual network config**.
  {% endstep %}

{% step %}
On the next screen, enter:

* **Subnet** (e.g., 192.168.123.0/24)
* **Address** (e.g., 192.168.123.45)
* **Gateway** (e.g., 192.168.123.1)
* **Name servers** (e.g., 192.168.123.1)
* **Search domains** (e.g., company.comma.separated)

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FFTtA45nBeSgfPvY7gfHE%2Fimage10.png?alt=media&amp;token=14472e12-54e1-446e-8f4f-b9118645ac19" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
VLAN configuration for SGi (if required):

1. Disable the native VLAN.
2. Add a VLAN tag. <br>

   <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FowBsOrG9mBxN4REP87Mq%2Fimage11.png?alt=media&amp;token=a6ba18f8-6097-4c36-a89e-48ce1d7f1bff" alt=""><figcaption></figcaption></figure>
3. Set the VLAN to manual mode and configure the IP details.&#x20;

   <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FhD79e9xGilwLsrCnvPJS%2Fimage12.png?alt=media&amp;token=99a0cb63-85d3-42c7-98e6-10b629eb69b8" alt=""><figcaption></figcaption></figure>
4. Disable IP address on the SGi interface.&#x20;

   <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fo2NIZAskLhERcxFXf6kC%2Fimage13.png?alt=media&amp;token=0e0e0b9a-f559-451d-b689-cdae3902dcbd" alt=""><figcaption></figcaption></figure>
5. After configuring network connections, proceed with the installation.

   Stage 1 proceeds automatically.\
   You can monitor the console/monitor to track progress.\
   After Stage 1 completes, the system performs its first automatic reboot.
   {% endstep %}

{% step %}
Immediately take one of the following actions:

{% hint style="info" %}
**NOTE:** If you fail to do this, Stage 1 will repeat indefinitely.
{% endhint %}

* Option A (Recommended): As soon as you see the system rebooting, physically remove the USB drive. This prevents the system from booting from USB again.
* Option B: Change BIOS boot priority:&#x20;

  1. Watch for the reboot to complete.
  2. Immediately enter the BIOS setup again.
  3. Change the boot priority to Hard Disk/SSD as first boot device.
  4. Save and exit BIOS.

  This first reboot completes Stage 1 of the installation.
  {% endstep %}

{% step %}
Monitor Stage 2 installation:

After the first reboot (with USB removed or BIOS changed), Stage 2 begins automatically.

1. Access the Onyx Edge:
   1. Wait for the system to boot.
   2. Log in via console/monitor using the following credentials:

      Note the IP that is briefly displayed on the screen before it scrolls off.

      * Host: onyxedge-agw (or the IP displayed on screen)
      * Username: onyxedge
      * Password: (provided by GXC Technical Support)
2. Monitor installation progress:
   1. Run the `install_progress` command.

      The output displays the current installation status.
3. Stage 2 completion:

   The system automatically reboots after Stage 2 completes.

   You will see: *"agw\_iso\_install.service configured to run on STAGE3"*

   The Onyx-ES reboots for the second time.

   This second reboot completes Stage 2 of the installation.
4. Monitor Stage 3 installation:

   After the second reboot, Stage 3 begins automatically.

   1. Log in again using the same credentials as in Step 3.a.2.
   2. Monitor installation progress:
      1. Run the `install_progress` command.

         The output displays the current installation status.
   3. Stage 3 completion:

      The system automatically reboots after Stage 3 is completed.

   This third reboot completes the Onyx Edge software installation.

   The system displays: *“Yay! Initial installation of AGW software is successful. Happy gateway'ing”*

   Note the Onyx Edge’s eth0 IP and MAC addresses.
   {% endstep %}
   {% endstepper %}

### Post Installation Tasks

This section describes the tasks to perform after installing the Onyx Edge software.

#### Verify Successful Installation

To verify successful Onyx Edge software installation:

{% stepper %}
{% step %}
After the installation is completed, log on to the Onyx Edge.
{% endstep %}

{% step %}
Confirm the login banner displays the Gateway ID, eth0 and eth1 IP addresses, and list of services with “active” status, as shown below.

```
 +------------------------------------------------------------+ 
 | OnyxEdge Access Gateway                                    |
 +------------------------------------------------------------+
 | Gateway ID: 1fa44d3f-cca5-486f-94ed-5a39e2ddf3c2           |
 +------------------------------------------------------------+
 | eth0: 192.168.122.165/24                                   |
 | eth1: 10.0.2.1/24                                          |
 | uplink_br0:                                                |
 +------------------------------------------------------------+
 | Free RAM: 2.1Gi                                            |
 | Free SWAP: 0B                                              |
 | Free storage: 2G                                           |
 +------------------------------------------------------------+
 +------------------------------------------------------------+
 | OnyxEdge AGW status                                        |
 | 1.6.1-151-gxcd-1656008356-4d15f3ed                         |
 +------------------------------------------------------------+
 | Subscribers connected: 0                                   |
 +------------------------------------------------------------+
 | control_proxy: active                                      |
 | ctraced: active                                            |
 | directoryd: active                                         |
 | dnsd: active                                               |
 | enodebd: active                                            |
 | envoy_controller: active                                   |
 | eventd: active                                             |
 | health: active                                             |
 | mme: active                                                |
 | mobilityd: active                                          |
 | monitord: active                                           |
 | pipelined: active                                          |
 | policydb: active                                           |
 | redis: active                                              |
 | sessiond: active                                           |
 | smsd: active                                               |
 | state: active                                              |
 | subscriberdb: active                                       |
 +------------------------------------------------------------+
```

Verify that all services are in active state. If any service shows a different status, contact GXC Technical Support.
{% endstep %}

{% step %}
Run the install\_progress command.

The output should display:

```
onyxedge@onyxedge-agw:$ install_progress
Yay! Initial installation of AGW software is successful.
Happy gateway'ing
onyxedge@onyxedge-agw:$
```

{% endstep %}
{% endstepper %}

#### Get eth0 Hardware Address

To onboard the Onyx Edge in the Onyx Portal, you will need its eth0 hardware address. If the eth0 hardware address is not available on the hardware label or on the shipping box, to obtain the Onyx Edge’s eth0 hardware address, log on to the Onyx Edge as agw\_user, and run the show networking links command. In the output, note the value against the eth0 parameter.

{% code overflow="wrap" %}

```
Onxyedge> show networking links
1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN mode DEFAULT group default qlen 1000 link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
2: eth1: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc htb state UP mode DEFAULT group default qlen 1000 link/ether a1:b2:345e:f5 brd ff:ff:ff:ff:ff:ff
3: eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc htb state UP mode DEFAULT group default qlen 1000 link/ether a1:b2:345e:f6 brd ff:ff:ff:ff:ff:ff 
...
```

{% endcode %}

#### Connect eth1 to Radio Network

Now that installation is complete, you can connect eth1 to the radio network:

{% stepper %}
{% step %}
Connect the eth1 port to your switch.

OR, if only one AP exists, connect to it directly.

The Onyx Edge will provide DHCP service on this interface (10.0.2.1/24).
{% endstep %}

{% step %}
Verify eth1 connectivity:

1. Run the show networking links command.
2. Verify eth1 shows as "UP" with IP address 10.0.2.1/24.
   {% endstep %}
   {% endstepper %}

#### Onboard the Onyx Edge in the Onyx Portal

After installing the Onyx Edge, you must onboard it in the Onyx Portal and verify the successful onboarding. For details, see the *4G Onyx Portal Operations Guide > Add Onyx Edge section*.


# Upgrade Onyx Edge Software

{% hint style="info" %}
**NOTE:** For any Onyx Edge software upgrade considerations, refer to the Onyx Edge Release Notes for the corresponding Onyx Edge release.
{% endhint %}

You can upgrade the Onyx Edge software on your Onyx Edge equipment using the Onyx Portal's Onyx Edge Upgrade Groups feature.

The Onyx Portal supports multiple Onyx Edge upgrade groups. Each Onyx Edge is associated with any one group. To upgrade the Onyx Edge software on all the Onyx Edge associated with a particular group, you must change that group’s Onyx Edge software version to the target version. The Onyx Edge software is automatically upgraded on all the Onyx Edge associated with that group.

For detailed information on managing Onyx Edge software upgrades, see *4G Onyx Portal Operations Guide > Manage Onyx Edge Software Upgrades*.


# Troubleshooting Information

This section describes basic Onyx Edge troubleshooting information.

## View Onyx Edge Details

**To view an Onyx Edge’s details:**

{% stepper %}
{% step %}
Open the Onyx Edge's Details page (Onyx Portal, click **Equipment** > **Onyx Edge** tab > Onyx Edge details page > **Overview** tab).

The **Overview** tab displays the selected Onyx Edge's details, including its configuration, status, and connected equipment. For detailed information, see *4G Onyx Portal Operations Guide > View Onyx Edge Details*.
{% endstep %}

{% step %}
To view Onyx Edge's events and alerts, click the **Events & Alerts** tab.

The **Events & Alerts** tab displays alerts and events generated by the Onyx Edge.

The **Alerts** panel lists device alerts with the Date, Status, Alert Name, and Severity, and includes a filter to view specific alert types.

The **Events** panel displays system events for the selected date/time and duration. The table includes the Timestamp, Module, Event Type, Entity, and Event Description, with filtering options for several fields.

For detailed information, see *4G Onyx Portal Operations Guide > View Onyx Edge Details*.
{% endstep %}

{% step %}
To view Onyx Edge's logs, click the **Logs** tab.

The **Logs** tab displays Onyx Edge logs for the selected date/time and duration, and log details including timestamp, service, tag, type, and log text are displayed.

To download the logs in .csv format, click **Download**. In the **Download Logs** dialog box, select the timestamps and the limit, which specifies the maximum number of logs to be included in the .csv file, then click **Save**. The downloaded .csv file contains log details including timestamp, service, tag, type, and log text.

For detailed information, see *4G Onyx Portal Operations Guide > View Onyx Edge Details*.
{% endstep %}
{% endstepper %}

## View Connected APs, Mesh Nodes, and Subscribers

**To view the list of active APs, Mesh nodes, and subscribers connected to an Onyx Edge:**

{% stepper %}
{% step %}
For the list of active APs, view the Onyx Edge’s details page > **Overview** tab > **Connected Access Point** section.
{% endstep %}

{% step %}
For the list of Mesh Nodes, view the Onyx Edge’s details page > **Overview** tab > **Mesh Node** section.
{% endstep %}

{% step %}
For the list of active subscribers, view the Onyx Edge’s details page > **Overview** tab > **Subscribers** section.
{% endstep %}
{% endstepper %}

For detailed information, see *4G Onyx Portal Operations Guide > View Onyx Edge Details.*

## Run Commands on the Onyx Edge

This section describes how to:

* [Run Commands on Onyx Edge from Onyx Portal](#run-commands-on-onyx-edge-from-onyx-portal)
* [Run Commands on Onyx Edge as agw\_user](#run-commands-on-onyx-edge-as-agw_user)

### Run Commands on Onyx Edge from Onyx Portal

**To run generic commands on an Onyx Edge from the Onyx Portal:**

{% stepper %}
{% step %}
In the Onyx Edge’s details page (Onyx Portal > **Equipment** > **Onyx Edge** tab > Onyx Edge details page), in the upper-right corner of the page, click **Actions**.

{% hint style="info" %}
**NOTE:** The Actions button is enabled only when the Onyx Edge is online.
{% endhint %}

* **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 the 4G Onyx Portal Operations Guide > Move an Onyx Edge from one Upgrade Group to Another section.
* **Reboot Onyx Edge** – (GXC Administrators, Super Administrators, and Administrators only.) Reboot the Onyx Edge. Services will be down while the equipment reboots.

  A confirmation dialog box is displayed. To confirm, click **Yes**.
* **Restart Services on Onyx Edge** – (GXC Administrators, Super Administrators, and Administrators only.) Restart the Onyx Edge’s core services. All active UE will be detached. Connectivity will be down until the services resume.

  A confirmation dialog box is displayed. To confirm, click **Yes**.
* **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.
* **Reboot Neighbor Updated AP** – (GXC Administrators, Super Administrators, and Administrators only.) Schedule reboots for APs with pending neighbor changes:
  * Reboot all APs with reboot pending at a chosen time, including immediately.
  * Reboot a specific AP by serial number, if it has a reboot pending, at a chosen time including immediately.
* **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 Subscriber Config Sync** – (GXC Administrators, Super Administrators, and 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 %}

### Run Commands on Onyx Edge as agw\_user

As agw\_user, you can SSH into and run the following commands on your Onyx Edge.&#x20;

To SSH into an Onyx Edge as agw\_user, run the following command:&#x20;

```
ssh agw_user@<ip_address>
```

For more information, see [agw\_user](/docs/network-configuration-and-operations-guides/5g-onyx-portal-4.x-operations).

#### Command Descriptions

<details>

<summary><strong>change_password</strong></summary>

Prompts to change the current password for agw\_user.

**Usage:** `change_password [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> change_password
```

</details>

<details>

<summary><strong>collect_tech_dump</strong></summary>

Collects system logs and diagnostic information from the Onyx Edge and creates a tech dump archive in /var/core/tech\_dump/.

**Usage:** `collect_tech_dump [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> collect_tech_dump
```

</details>

<details>

<summary><strong>gateway power-off</strong></summary>

Powers off the Onyx Edge safely.

**Usage:** `gateway power-off [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> gateway power-off
```

</details>

<details>

<summary><strong>gateway reboot</strong></summary>

Reboots the Onyx Edge.

**Usage:** `gateway reboot [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> gateway reboot
```

</details>

<details>

<summary><strong>gateway restore-factory-defaults</strong></summary>

Restores the Onyx Edge to its factory default settings.

**Usage:** `gateway restore-factory-defaults [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> gateway restore-factory-defaults
```

</details>

<details>

<summary><strong>history</strong></summary>

Manages and displays previously entered commands.

**Usage:** `history [-h] [-r] [-e] [-o FILE] [-t TRANSCRIPT_FILE] [-c] [-s] [-v] [-a] [arg]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.
* `-r, --run`: Run selected history items.
* `-e, --edit`: Edit and then run selected history items.
* `-o, --output_file`: Output commands to a script file.
* `-t, --transcript`: Output commands and results to a transcript file.
* `-c, --clear`: Clear all history.
* `-s, --script`: Output commands in script format.
* `-v, --verbose`: Display detailed command information.
* `-a, --all`: Display all commands from previous sessions.<br>

**Example:** This command runs the third command from history.

```
onyxedge> history -r 3
```

</details>

<details>

<summary><strong>ping</strong></summary>

Sends ICMP echo requests to test network connectivity.

**Usage:** **ping \[-h] \[-c COUNT] host**

**Positional Argument:**

* `host`: The host to ping.

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.
* `-c, --count COUNT`: Number of pings to send (for infinite pings use 0).

**Example:** This command sends five ping requests to the host 10.0.0.1.

```
onyxedge> ping -c 5 10.0.0.1
```

</details>

<details>

<summary><strong>quit</strong></summary>

Exits the Onyx Edge CLI application.

**Usage:** `quit [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> quit
```

</details>

<details>

<summary><strong>scp_to</strong></summary>

Securely copies files to a host using SCP.

**Usage:** `scp_to -u USER -o HOST [-h] [-d TECHDUMP] [-c CORE] [-s] [-t TARGET_PATH]`

**Required Arguments:**

* `-u, --user`: Username to use for SCP.
* `-o, --host`: The target host to SCP to.\
  Optional Arguments:
* `-h, --help`: Displays help information for the command.
* `-d, --techdump`: Specifies the tech dump file to SCP.
* `-c, --core`: Specifies the core file to SCP.
* `-s, --ssh-pubkey`: Copies the Onyx Edge’s SSH public key.
* `-t, --target-path`: Specifies the path on the target host.<br>

**Example:** This command copies the tech dump to the host at 10.0.0.2.

```
onyxedge> scp_to -u admin -o 10.0.0.2 -d /var/log/techdump.tar.gz
```

</details>

<details>

<summary><strong>show authorized-keys</strong></summary>

Displays the SSH authorized keys on the system, which can be used for secure access.

**Usage:** `show authorized-keys`

**Example:**

```
onyxedge> show authorized-keys
```

</details>

<details>

<summary><strong>show files</strong></summary>

Lists available system files such as core dumps and tech dumps.

**Usage:** `show files {cores, tech-dumps}`

**Positional Arguments:**

* `cores`: Lists core dump files (if any).
* `tech-dumps`: Lists tech dump files.

**Example:** Lists all available tech dump files.

```
onyxedge> show files tech-dumps
```

</details>

<details>

<summary><strong>show gateway-info</strong></summary>

Displays detailed Onyx Edge information, including hardware ID and challenge key.

**Usage:** `show gateway-info [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:** Displays the Onyx Edge’s hardware ID and challenge key.

```
onyxedge> show gateway-info
```

</details>

<details>

<summary><strong>show networking</strong></summary>

Displays information about the network interfaces and IPs of the Onyx Edge system.

**Usage:** `show networking [-h] {links, ipv4}`

**Positional Arguments:**

* `links`: Displays the network interface details (e.g., link status, MTU, etc.).
* `ipv4`: Shows the IPv4 addresses associated with network interfaces.\
  Optional Arguments:
* `-h, --help`: Displays help information for the command.

**Examples:**

* Displays detailed information for all network interfaces (e.g., eth0, eth1).

```
onyxedge> show networking links
```

* Displays the IPv4 addresses assigned to interfaces like eth0, eth1, etc.

```
onyxedge> show networking ipv4
```

</details>

<details>

<summary><strong>show services</strong></summary>

Displays the status of all services on the Onyx Edge system.

**Usage:** `show services [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:** Displays the status (e.g., active/inactive) of all services running on the system.

```
onyxedge> show services
```

</details>

<details>

<summary><strong>show ssh-key</strong></summary>

Displays the Onyx Edge’s SSH public key, which can be used for SCP file transfers.

**Usage:** `show ssh-key [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:** Displays the Onyx Edge’s SSH public key to be added to other hosts for secure transfers.

```
onyxedge> show ssh-key
```

</details>

## Related Documentation

* *4G Onyx Portal Operations Guide*
* *GXC Glossary*

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# 5G Onyx Portal 4.x Alerts Reference

This reference describes Onyx Portal 5G predefined alerts listed in order of type, module, and name in alphabetical order.

<p align="center"><strong>Onyx Portal 5G Alerts</strong></p>

<table><thead><tr><th width="163.166748046875">Type</th><th width="148.5">Module</th><th width="325.3331298828125">Alert Name</th><th width="110">Severity</th></tr></thead><tbody><tr><td>Access Point</td><td>Control Plane</td><td><a href="#neighbor-tables-incomplete">Neighbor Tables Incomplete</a></td><td>Major</td></tr><tr><td>Access Point</td><td>CU-Plane</td><td><a href="#cell-service-down">Cell Service Down</a></td><td>Major</td></tr><tr><td>Access Point</td><td>CU-Plane</td><td><a href="#insufficient-sas-power">Insufficient SAS Power</a></td><td>Major</td></tr><tr><td>Access Point</td><td>CU-Plane</td><td><a href="#multiport-cell-service-down">Multiport Cell Service Down</a></td><td>Major</td></tr><tr><td>Access Point</td><td>Domain Proxy</td><td><a href="#cbsd-lesser-bw-granted">CBSD Lesser BW Granted</a></td><td>Major</td></tr><tr><td>Access Point</td><td>Domain Proxy</td><td><a href="#cbsd-new-grant">CBSD New Grant</a></td><td>Warning</td></tr><tr><td>Access Point</td><td>Domain Proxy</td><td><a href="#cbsd-preferred-frequency-unavailable">CBSD Preferred Frequency Unavailable</a></td><td>Warning</td></tr><tr><td>Access Point</td><td>Domain Proxy</td><td><a href="#cbsd-registration-failure">CBSD Registration Failure</a></td><td>Major</td></tr><tr><td>Access Point</td><td>M-Plane</td><td><a href="#access-point-offline">Offline</a></td><td>Major</td></tr><tr><td>Access Point</td><td>MCU-Plane</td><td><a href="#cell-unwarranted-transmission">Cell Unwarranted Transmission</a></td><td>Major</td></tr><tr><td>Access Point</td><td>MCU-Plane</td><td><a href="#mesh-filter-frequency-mismatch">Mesh Filter-Frequency Mismatch</a></td><td>Major</td></tr><tr><td>Access Point</td><td>S-Plane</td><td><a href="#timing-out-of-sync">Timing Out of Sync</a></td><td>Major</td></tr><tr><td>FHM</td><td>C-Plane</td><td><a href="#packet-loss-detected">Packet Loss Detected</a></td><td>Major</td></tr><tr><td>FHM</td><td>M-Plane</td><td><a href="#fhm-offline">Offline</a></td><td>Major</td></tr><tr><td>Mesh Node</td><td>Domain Proxy</td><td><a href="#cpe-cbsd-new-grant">CPE CBSD New Grant</a></td><td>Warning</td></tr><tr><td>Mesh Node</td><td>Domain Proxy</td><td><a href="#cpe-cbsd-preferred-frequency-or-bandwidth-unavailable">CPE CBSD Preferred Frequency or Bandwidth Unavailable</a></td><td>Warning</td></tr><tr><td>Mesh Node</td><td>Domain Proxy</td><td><a href="#cpe-cbsd-registration-failure">CPE CBSD Registration Failure</a></td><td>Major</td></tr><tr><td>Mesh Node</td><td>Management Plane</td><td><a href="#mesh-node-offline">Offline</a></td><td>Critical</td></tr><tr><td>Mesh Node</td><td>MCU-Plane</td><td><a href="#tunnel-down">Tunnel Down</a></td><td>Major</td></tr><tr><td>Mesh Node</td><td>MCU-Plane</td><td><a href="#watchdog-powercycle">Watchdog Powercycle</a></td><td>Minor</td></tr><tr><td>Mesh Node</td><td>Platform</td><td><a href="#mesh-node-cpu-usage">CPU Usage</a></td><td>Minor</td></tr><tr><td>Mesh Node</td><td>Platform</td><td><a href="#mesh-node-disk-usage">Disk Usage</a></td><td>Major</td></tr><tr><td>Mesh Node</td><td>Platform</td><td><a href="#mesh-node-memory-usage">Memory Usage</a></td><td>Minor</td></tr><tr><td>Mesh Node</td><td>Provisioning Server</td><td><a href="#mesh-node-provisioning-server-connection-failure">Provisioning Server Connection Failure</a></td><td>Warning</td></tr><tr><td>Onyx Edge (Core)</td><td>C-Plane</td><td><a href="#dhcp-server-failed">DHCP Server Failed</a></td><td>Major</td></tr><tr><td>Onyx Edge (Core)</td><td>C-Plane</td><td><a href="#ng-setup-failure">NG Setup Failure</a></td><td>Major</td></tr><tr><td>Onyx Edge (Core)</td><td>C-Plane</td><td><a href="#sctp-outbound-stalled">SCTP Outbound Stalled</a></td><td>Major</td></tr><tr><td>Onyx Edge (Core)</td><td>C-Plane</td><td><a href="#ue-imsi-imei-validation-failure">UE IMSI-IMEI Validation Failure</a></td><td>Warning</td></tr><tr><td>Onyx Edge (Core)</td><td>C-Plane</td><td><a href="#ue-registration-failure">UE Registration Failure</a></td><td>Warning</td></tr><tr><td>Onyx Edge (Core)</td><td>CU Plane</td><td><a href="#ha-peer-down">HA Peer Down</a></td><td>Major</td></tr><tr><td>Onyx Edge (Core)</td><td>M-Plane</td><td><a href="#onyx-edge-core-offline">Offline</a></td><td>Critical</td></tr><tr><td>Onyx Edge (Core)</td><td>MCU-Plane</td><td><a href="#onyx-edge-core-service-down">Service Down</a></td><td>Critical</td></tr><tr><td>Onyx Edge (Core)</td><td>Platform</td><td><a href="#onyx-edge-core-cpu-usage">CPU Usage</a></td><td>Minor</td></tr><tr><td>Onyx Edge (Core)</td><td>Platform</td><td><a href="#onyx-edge-core-disk-usage">Disk Usage</a></td><td>Major</td></tr><tr><td>Onyx Edge (Core)</td><td>Platform</td><td><a href="#onyx-edge-core-memory-usage">Memory Usage</a></td><td>Minor</td></tr><tr><td>Onyx Edge (Core)</td><td>Provisioning Server</td><td><a href="#onyx-edge-core-provisioning-server-connection-failure">Provisioning Server Connection Failure</a></td><td>Warning</td></tr><tr><td>Onyx Edge (NR)</td><td>C-Plane</td><td><a href="#f1-setup-failure">F1 Setup Failure</a></td><td>Critical</td></tr><tr><td>Onyx Edge (NR)</td><td>C-Plane</td><td><a href="#rrc-security-mode-failure">RRC Security Mode Failure</a></td><td>Warning</td></tr><tr><td>Onyx Edge (NR)</td><td>C-Plane</td><td><a href="#rrc-setup-failure">RRC Setup Failure</a></td><td>Warning</td></tr><tr><td>Onyx Edge (NR)</td><td>M-Plane</td><td><a href="#onyx-edge-nr-offline">Offline</a></td><td>Critical</td></tr><tr><td>Onyx Edge (NR)</td><td>MCU-Plane</td><td><a href="#onyx-edge-nr-service-down">Service Down</a></td><td>Critical</td></tr><tr><td>Onyx Edge (NR)</td><td>Platform</td><td><a href="#onyx-edge-nr-cpu-usage">CPU Usage</a></td><td>Minor</td></tr><tr><td>Onyx Edge (NR)</td><td>Platform</td><td><a href="#onyx-edge-nr-disk-usage">Disk Usage</a></td><td>Major</td></tr><tr><td>Onyx Edge (NR)</td><td>Platform</td><td><a href="#onyx-edge-nr-memory-usage">Memory Usage</a></td><td>Minor</td></tr><tr><td>Onyx Edge (NR)</td><td>Provisioning Server</td><td><a href="#onyx-edge-nr-provisioning-server-connection-failure">Provisioning Server Connection Failure</a></td><td>Warning</td></tr><tr><td>Onyx Edge (NR)</td><td>S-Plane</td><td><a href="#gps-signal-not-available">GPS Signal Not Available</a></td><td>Major</td></tr><tr><td>Onyx Edge (NR)</td><td>S-Plane</td><td><a href="#phc2sys-offset-is-too-high">PHC2SYS Offset Is Too High</a></td><td>Warning</td></tr><tr><td>Onyx Edge (NR)</td><td>S-Plane</td><td><a href="#ts2phc-offset-is-too-high">TS2PHC Offset Is Too High</a></td><td>Warning</td></tr><tr><td>Onyx Edge (NR)</td><td>User Plane</td><td><a href="#cell-high-dl-bler">Cell High DL BLER</a></td><td>Warning</td></tr><tr><td>Onyx Edge (NR)</td><td>User Plane</td><td><a href="#cell-high-ul-bler">Cell High UL BLER</a></td><td>Warning</td></tr><tr><td>Onyx Edge (NR)</td><td>User Plane</td><td><a href="#early-ecpri-packets">Early eCPRI Packets</a></td><td>Warning</td></tr><tr><td>Onyx Edge (NR)</td><td>User Plane</td><td><a href="#late-ecpri-packets">Late eCPRI Packets</a></td><td>Warning</td></tr><tr><td>Onyx Edge (NR)</td><td>User Plane</td><td><a href="#ecpri-rx-down">eCPRI Rx Down</a></td><td>Warning</td></tr><tr><td>Orchestrator</td><td>Domain Proxy</td><td><a href="#sas-connection-failure">SAS Connection Failure</a></td><td>Critical</td></tr></tbody></table>

***

## Common Indications

### Alerts Counter Panel Indication

The Onyx Portal Alerts Counter panel presents dedicated counters for Critical, Major, and Minor alerts. All other active alerts are grouped under the "Other" counter.

When an alert is triggered, the corresponding counter's value increases by one.

Clicking the Alerts Counter panel takes you to the **Alerts** > "**Active Alerts**" page.

To view an alert's details, click the alert's name.

### Cell Transmission Down Indications

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Access Point** tile > **Service Status** icon: Depending on the percentage of affected APs, the icon will be ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FMAz57Ik4b346ClNaZTwC%2Ficon-service-status-amber.png?alt=media\&token=374562e6-68cd-4177-a70f-5919de0b2081) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0UKJd1nToitCqjeKcDpy%2Ficon-service-status-red.png?alt=media\&token=6bc4e4e9-3874-44d4-9e05-e7323704786f) red.
* Onyx Portal > **Dashboard** > **Subscribers** tile: If the AP results in loss of online subscribers, the connected subscribers count will change.
* Onyx Portal > **Dashboard** > **Downlink/Uplink Traffic** tile: The traffic reduces as the AP is no longer serving.
* Onyx Portal > **Dashboard** > **Data Usage** tile: The usage reduces as the AP is no longer serving.
* Onyx Portal > **Dashboard** > **Access Point SAS Status** tile: Authorized AP count may be reduced if this is due to a grant issue. Other counts may increase depending on the issue.
* Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Overview** tab > **Access Point Details** tile > **Service Status** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Folh5kTB9B1MkNFDmL0mA%2Ficon-service-status-red.png?alt=media\&token=2b8cfe45-3ad0-4263-97fd-5e275521159c) red.

***

## Predefined Alerts

{% hint style="info" %}
Predefined alert rules are delivered preconfigured with the Onyx Solution and can only be created, modified, or deleted by GXC.
{% endhint %}

## Access Point Alerts

### Access Point Control Plane Alerts

#### Neighbor Tables Incomplete

**Trigger Condition**

Not all eligible neighbor gNBs could be populated in the AP's neighbor table, and this condition persists for at least 15 minutes while the AP remains connected for management.

**Clear Condition**

All eligible neighbor gNBs are successfully populated in the neighbor table.

**Severity**

Major

***

### Access Point CU-Plane Alerts

#### Cell Service Down

**Trigger Condition**

When an AP cell does not transmit for at least 15 minutes.

**Probable Causes**

The grant is either unavailable or unauthorized, preventing the AP from transmitting.

**Clear Condition**

When the cell starts transmitting again.

**Severity**

Major

**System Impact**

The AP stops transmitting.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* See [Cell Transmission Down Indications](#cell-transmission-down-indications).

**Corrective Actions**

1. Check if any maintenance activity is currently in progress. (Onyx Portal > header > <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FTEfejR8ZxSUPt2v7wro3%2Fimage.png?alt=media&amp;token=d0f525c5-7be8-4a76-9a25-5ce479425ec9" alt="" data-size="line"> Notifications icon.)
2. Check if SAS grants are available. (Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Overview** tab >![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FIfBRw6SNOgPe14nzqN2V%2Ficon-sas-authorized-green.png?alt=media\&token=15fa2e0d-4ebd-4104-8520-0b0eca747545) SAS Status.)
3. Check if PTP sync is locked in the AP status. (Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Overview** tab > **Access Point Details** tile > **Sync Status** icon > ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fp3m1OCpXjUqVZA2XRnm3%2Ficon-ipsec-status-green.png?alt=media\&token=54339a76-c2b1-4d1f-868d-3194d1643003) green.)
4. Ensure that the ECPRI status reported by L1 (NR server) is good. (Onyx Portal > **Equipment** > **Onyx Edge (Core + NR)** tab / **Onyx Edge** tab > view Onyx Edge's details > **Overview** tab > **Onyx Edge Details** tile > **Interface Status** icon > ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FiHpD3enfL8FhYTj6L3zw%2Ficon-interface-status-green.png?alt=media\&token=017804ad-c643-464b-8158-1d9d26d29f65) green.)
5. If the issue persists after completing the above steps, reboot the AP.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

***

#### Insufficient SAS Power

**Trigger Condition**

SAS has granted the CBSD(s) associated with this AP a maximum transmit power that is below the AP's configured hardware minimum power, and the AP has force-disabled transmission as a result.

**Probable Causes**

* SAS is unable to grant sufficient power due to spectrum congestion or interference near the deployment location.
* The AP's configured minimum power threshold does not match the actual hardware/deployment requirement.

**Clear Condition**

SAS grants a maximum transmit power at or above the AP's configured hardware minimum power.

**Severity**

Major

**System Impact**

The AP will stop transmitting.

**Indications**

See [Cell Transmission Down Indications](#cell-transmission-down-indications).

**Corrective Actions**

1. Check to see if any maintenance activity is in progress.
2. Check the SAS granted power for the CBSD(s) associated with the AP (Onyx Portal > **Equipment** > **Access Point** tab > AP details page > SAS Status Display).
3. In the AP's DP logs, check the granted power against the expected minimum (Onyx Portal > **Equipment** > **Access Point** tab > AP details page > **Logs** tab > **DP Logs** section).
4. If the granted power is consistently below the minimum, contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

**Related Alerts**

* [Access Point Cell Service Down](#cell-service-down)
* [Access Point Multiport Cell Service Down](#multiport-cell-service-down)

***

#### Multiport Cell Service Down

**Trigger Condition**

When a cell with Multiport enabled is not transmitting for at least 5 minutes.

**Probable Causes**

Grant for all Multiport antennas is unavailable or unauthorized.

**Clear Condition**

When the cell is transmitting again.

**Severity**

Major

**System Impact**

The AP will stop transmitting.

**Indications**

See [Cell Transmission Down Indications](#cell-transmission-down-indications).

**Corrective Actions**

1. Check if any scheduled maintenance activity is in progress.
2. Verify grants are available and authorized for all antennas to transmit:
   * Check SAS status (Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > SAS Status display).
   * Check the AP's DP logs for failures on each antenna and take required action (Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Logs** tab > **DP Logs** section).
   * If grants are not available or not authorized, adjust the preferences to obtain grants (Onyx Portal > **Equipment** > **Access Point** tab > edit AP's details > **RAN** tab).
   * If grants are still not available for the minimum acceptable preferences, transmission will not be possible until resources become available with SAS again.
3. Verify synchronization and connectivity:
   * Check if PTP sync is locked in the AP's details page.
   * Check if the eCPRI status reported by L1 (NR server) shows as connected.
4. If the issue persists after completing the above steps, reboot the AP.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

***

### Access Point Domain Proxy Alerts

#### CBSD Lesser BW Granted

**Trigger Condition**

When a CBSD has been granted less bandwidth than desired, and it continues to be in this state for at least five minutes.

**Clear Condition**

When either of the following conditions occur:

* CBSD gets the desired bandwidth in a grant.
* CBSD loses the grant.

**Severity**

Major

**System Impact**

The network capacity is reduced from what was planned.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Downlink/Uplink Traffic** tile: Traffic will reduce as bandwidth is reduced.
* Onyx Portal > **Dashboard** > **Data Usage** tile: Usage will not increase at the expected rate due to reduced bandwidth.

**Corrective Actions**

1. Check if any maintenance activity is currently in progress.
2. In the AP's DP logs, check Spectrum Inquiry Response to determine available frequencies (Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Logs** tab > **DP Logs** section).
3. If Strict Preference is enabled, disable it, if possible (Onyx Portal > **Equipment** > **Access Point** tab > edit AP's details > **RAN** tab > **Strict Preference** parameter), or change the frequency preference to obtain frequency with higher bandwidth (Onyx Portal > **Equipment** > **Access Point** tab > edit AP's details > **RAN** tab).
4. Contact GXC Technical Support.

**Resolution Verification**

1. All tiles have returned to their pre-incident conditions.
2. In the AP's details, verify the granted bandwidth (Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Overview** tab > **RAN** tile > **Bandwidth (MHz)** parameter).

**Related Alerts**

Access Point Domain Proxy [CBSD New Grant](#cbsd-new-grant) Alert — Triggered in conjunction with the Access Point Domain Proxy "CBSD Lesser BW Granted" alert.

***

#### CBSD New Grant

**Trigger Condition**

When new grants have been received within the last one hour.

**Clear Condition**

When no new grants have been received for at least one hour.

**Severity**

Warning

**System Impact**

This alert indicates a new grant has been received from SAS. For an AP that is already transmitting, it could change the transmission frequency, bandwidth, power, etc. The operator should verify the new grant will not affect the required KPIs.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Access Point** tile > **Service Status** icon — Depending on grant authorization state and previous transmission state of the AP, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F9Xj1RCcna36ncj4MAnQk%2Ficon-service-status-green.png?alt=media\&token=f1721cd0-5d7e-4754-b9e5-a5c4409a2cee) green or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fj2vEu7tuneLlhAS1KGgh%2Ficon-service-status-amber.png?alt=media\&token=8f0028ea-ef81-4f67-b8ae-296bd82093b0) amber.
* Onyx Portal > **Dashboard** > **Subscribers** tile:
  * If the new grant comes with a lower power level, subscribers at the edge may lose connection.
  * If the AP was not previously transmitting, and the grant got authorized as well, previously unconnected subscribers in the coverage area can get connected.
* Onyx Portal > **Dashboard** > **Downlink/Uplink Traffic** tile: The traffic may change depending on AP's previous transmission state, grant authorization, and UE behavior. For example, a reduced bandwidth will not transmit as much data as before.
* Onyx Portal > **Dashboard** > **Data Usage** tile: The usage may change depending on the AP's previous transmission state, grant authorization, and UE behavior.
* Onyx Portal > **Dashboard** > **Access Point SAS Status** tile: Granted/Authorized CBSDs count may change depending on the CBSD's previous state.
* Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Overview** tab > **RAN** tile: SAS Status will move to Granted and generally to Authorized if no previous grants were available.
* Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Overview** tab > **Access Point Details** tile > **Service Status** icon: If the AP was not transmitting previously, the icon can be ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F7CNYA8tJ1uO7yEAdTYK3%2Ficon-service-status-green.png?alt=media\&token=ba0aab84-33aa-46d8-9bc0-31b5c95c4c47) green.

**Corrective Actions**

None.

**Resolution Verification**

None required for initial alert for an AP.

**Related Alerts**

Access Point Domain Proxy [CBSD Lesser BW Granted](#cbsd-lesser-bw-granted) Alert — Triggered if the new grant does not have the desired bandwidth.

**Additional Information**

* This alert simply indicates that a new grant has been received from SAS.
* As each grant change is a separate grant success, this alert can also be used to track grant changes. However, note that the very first grant is also tracked.

***

#### CBSD Preferred Frequency Unavailable

**Trigger Condition**

* In SC/DC mode, none of the frequencies in the preferred list are available with SAS.
* In CA mode, no non-overlapping frequency pair from the preferred list is available with SAS.

**Clear Condition** When any of the following conditions occur:

* Preferred frequencies become available again.
* CBSD is deregistered.

**Severity**

Warning

**System Impact**

* Network radio transmissions may not occur as planned, potentially causing interference from neighboring cells.
* This alert indicates that transmission on preferred frequencies is not fully possible. If Strict Preference is enabled, the AP will stop transmitting.
* In other cases, the AP will continue transmitting on whatever frequency is received via SAS grant.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* In case Strict Preference is disabled (Onyx Portal > **Equipment** > **Access Point** tab > view AP's details), the granted frequency would not be part of the preferred list.
* In case Strict Preference is enabled, see [Cell Transmission Down Indications](#cell-transmission-down-indications).

**Corrective Actions**

1. Change the preference list (Onyx Portal > **Equipment** > **Access Point** tab > edit AP's details > **RAN** tab).
2. The available frequency can be found in the "Spectrum Inquiry Response" log type (Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Logs** tab > **DP Logs** section > "Spectrum Inquiry Response" log type). Filter for "From SAS To DP logs".

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

***

#### CBSD Registration Failure

**Trigger Condition**

When one or more CBSD registration attempts have failed within the last one hour.

**Clear Condition**

When no CBSD registration failures occur for at least one hour.

**Severity**

Major

**System Impact**

The AP becomes non-functional, as it cannot obtain any grants to transmit.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > SAS Status: Will show Registered in red ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5VA3M9ZwBJh7YrexuiLG%2Ficon-sas-status-registered-red.png?alt=media\&token=af7c983a-c74d-4245-9652-9943a04f4d1c).
* See [Cell Transmission Down Indications](#cell-transmission-down-indications).

**Corrective Actions**

1. Check the AP's DP logs for the failure reason and take necessary action (Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Logs** tab > **DP Logs** section).
2. The most probable cause is a parameter mismatch between the Onyx Portal and the SAS Portal. Verify the CBSD registration on the Federated Wireless Portal has the correct information. Verify the FCC ID, Serial Number, CBSD Type and Category, Location, and Antenna parameters.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

***

### Access Point M-Plane Alerts

#### Offline <a href="#access-point-offline" id="access-point-offline"></a>

**Trigger Condition**

When no M-Plane messages have been received for the past 10 minutes (five minutes in alert condition + five minutes for changing the metric). This may occur, for example, if the AP is powered off.

**Clear Condition**

When M-Plane connection is re-established with the AP.

**Severity**

Major

**System Impact**

* Management access to the AP will be down. Configurations, alerts, events, metrics, etc. between the Onyx Portal and the AP will not be in sync.
* User traffic may be unavailable depending on the mode of failure.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Access Point** tile > **Online** icon: This AP is offline. Depending on other APs in the network, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FOpLAHi39XG7cmPa8PVBp%2Ficon-online-status-red.png?alt=media\&token=db230380-fae7-4af9-b9ea-41af4ebd0acc) red or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FCq8PoUs57k0L9CJlclNY%2Ficon-online-status-amber.png?alt=media\&token=d61e8c6b-e22f-4d2b-a700-147f0f2e3169) amber. Hover information shows the offline APs.
* Onyx Portal > **Dashboard** > **Access Point** tile > **Service Status** icon: Depending on other APs in the network, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fj4VaMAVgYG04xOIyQ8bx%2Ficon-service-status-grey.png?alt=media\&token=16c769cf-8fd0-497f-a5cc-0f43c401fd75) grey or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FVAPdOm8Yoxng44CLRySF%2Ficon-service-status-amber.png?alt=media\&token=82683c65-e89c-4392-bbf8-dde8b06988fc) amber.
* Onyx Portal > **Dashboard** > **Subscribers** tile: If the AP results in loss of online subscribers, the connected subscribers count will change.
* Onyx Portal > **Dashboard** > **Downlink/Uplink Traffic** tile: If S1 is down, the traffic will commensurately reduce.
* Onyx Portal > **Dashboard** > **Data Usage** tile: If S1 is down, the usage will commensurately reduce.
* Onyx Portal > **Dashboard** > **Access Point SAS Status** tile: For SAS-enabled APs that are not online for the last four hours:
  * If unregistered, it will not get registered until it is online.
  * Any grants will be relinquished, and the AP will move to Registered state.
* Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Overview** tab > **Access Point Details** tile > **Online** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQpJ4jTuXNFxzzRXMuque%2Ficon-online-status-red.png?alt=media\&token=c2ec23a8-92e6-4fa9-b18c-0ce78f5ef419) red. All other statuses will turn grey.

**Corrective Actions**

1. Check if any maintenance activity is currently in progress.
2. Check for any power outages at the equipment's location.
3. Verify the AP is associated with the correct Onyx Edge.
4. Verify network connectivity between the AP and Onyx Edge.
5. Contact a local technician for physical AP inspection.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

**Related Alerts**

Onyx Edge (Core) MCU-Plane [Service Down](#onyx-edge-core-service-down) Alert — Triggered if all APs connected to the Onyx Edge are offline.

***

### Access Point MCU-Plane Alerts

#### Cell Unwarranted Transmission

**Trigger Condition**

When even though transmission is disabled, an AP's cell transmits for at least 15 minutes.

**Clear Condition**

When the cell stops transmission.

**Severity**

Major

**System Impact**

* The AP cell may transmit when not expected, potentially causing interference to neighboring radio equipment.
* This may result in a violation of federal spectrum regulations.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Access Point** tile > **Service Status** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJwRIT1UKs8iq0TNNL1gd%2Ficon-service-status-amber.png?alt=media\&token=cecdcf87-dc11-4cd4-847a-3182ad0fe699) amber.

**Corrective Actions**

1. Check if any maintenance activity is currently in progress.
2. Check the AP's events and alerts and resolve any faults (Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Events & Alerts** tab). Any faults will be represented as "unexpected\_fault\_received" event, and new alerts as "enb\_alarm\_raised" event.
3. Check the AP's logs and resolve any errors (Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Logs** tab).
4. If the issue persists after completing the above steps, reboot the AP.
5. If the condition does not clear, contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

***

#### Mesh Filter-Frequency Mismatch

**Trigger Condition**

The Mesh Node's filter configuration and the attached AP's frequency are mismatched, and this condition persists for at least five minutes.

**Clear Condition**

The Mesh Node's filter configuration and the AP's frequency are aligned again.

**Severity**

Major

***

### Access Point S-Plane Alerts

#### Timing Out of Sync

**Trigger Condition**

When a 5G AP fails to obtain a PTP lock.

**Clear Condition**

When the AP successfully receives the PTP signal and synchronizes with it.

**Severity**

Major

**System Impact**

The AP will stop transmitting.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Overview** tab > **Access Point Details** section > **Sync Status** icon: If PTP is not locked, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FF7FMl7EuB6nZBaQJonfB%2Ficon-ipsec-status-red.png?alt=media\&token=c75a0a18-6fe9-4193-9f96-067174db1471) red.

**Corrective Actions**

Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert count has returned to its pre-incident state.
* Onyx Portal > **Dashboard**: All dashboard tiles have returned to their pre-incident state.

***

## FHM Alerts

### FHM C-Plane Alerts

#### Packet Loss Detected

**Trigger Condition**

When "Radio Unit Loss of Signal Detection" (RU-los-detect) is triggered on FHM RU ports due to early/late packets at least three times in five minutes.

**Clear Condition**

When RU-los-detect is not triggered more than two times in the last five minutes, and no early/late packets are detected between the FHM and RU.

**Severity**

Major

**System Impact**

* The network is affected due to the RU not being able to function correctly.
* User traffic may be unavailable depending on the mode of failure.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* An alert is raised for the specific FHM port number and the serial number of the RU attached to this port.

**Corrective Actions**

1. Check if any maintenance activity is in progress.
2. Verify network connectivity between the FHM, RU, and Onyx Edge.
3. Verify timing/sync status on all NR components.
4. Contact a local technician for physical FHM inspection.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Confirm that packet loss is no longer occurring between the FHM and RU. (Onyx Portal > **Equipment** > **FHM** tab > check port status.)

***

### FHM M-Plane Alerts

#### Offline <a href="#fhm-offline" id="fhm-offline"></a>

**Trigger Condition**

When no M-plane messages have been received for the past 15 minutes. This can happen, for example, due to the FHM being powered off.

**Clear Condition**

When the M-plane connection is established again with the AP.

**Severity**

Major

**System Impact**

Management access to the FHM will be unavailable. Configurations, alerts, events, and metrics between the Onyx Portal and the FHM will not be in sync. User traffic may be unavailable depending on the mode of failure.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **FHM** tile > **Online** icon: The online status icon will display in ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FZtqu29eqONFb9jPmyNn0%2Ficon-online-status-red.png?alt=media\&token=c9a2e5a7-3b17-455f-bbb5-c9080245e14f) red indicating the FHM is offline. Hover tooltip displays the offline FHMs.
* Onyx Portal > **Equipment** > **FHM** tab > view FHM's details > **Overview** tab > **Online** icon: The **Online** icon will display in ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FcuWxY4m9jp7vurnxlqRB%2Ficon-online-status-red.png?alt=media\&token=0b7df0e1-9045-49b8-b0a7-83301fd5f66b) red, and all other statuses will display in grey.

**Corrective Actions**

1. Check if any maintenance activity is in progress.
2. Check for power outages at the device location.
3. Verify the FHM is associated with the correct Onyx Edge (Onyx Portal > **Equipment** > **FHM** tab > view FHM's details > **FHM Details** section > **Onyx Edge** parameter).
4. Verify network connectivity between the FHM and Onyx Edge. Ping the FHM from Onyx Edge.
5. Contact a local technician for physical FHM inspection.

**Resolution Verification**

* Verify that the alert has cleared.
* Verify that all Dashboard tiles have returned to pre-incident conditions.
* Check FHM details (Onyx Portal > **Equipment** > **FHM** tab > view FHM details > **Overview** tab > **Online** icon). The **Online** icon should display in green.

***

## Mesh Node Alerts

### Mesh Node Domain Proxy Alerts

#### CPE CBSD New Grant

**Trigger Condition**

When using the GM03 Mesh Node, one or more new grants have been received within the last hour.

**Clear Condition**

When no new grants are received within the last one hour.

**Severity**

Warning

**System Impact**

* This alert is triggered upon receiving a new grant from SAS. For a Mesh Node that is already in transmission, it may result in a change in transmission power.
* Operators should verify that the new grant will not affect the required KPIs.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Access Point** tile > **Service Status** icon: Based on grant authorization state and previous transmission state of the Mesh Node, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FOHNDqXplsIgLtKeBXaQL%2Ficon-service-status-green.png?alt=media\&token=b5ec69f6-5d1c-4a53-8a7a-fdac383601d5) green or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FytQM2MHvSYpVZ5GipljL%2Ficon-service-status-amber.png?alt=media\&token=7bc8c920-e4ae-4828-982f-4a035decd410) amber.
* Onyx Portal > **Dashboard** > **Access Point SAS Status** tile: Granted/Authorized CBSDs count may change depending on the CBSD's previous state.
* Onyx Portal > **Equipment** > **Mesh Node** tab > view Mesh Node's details > **Overview** tab: If no previous grants were available, SAS Status will move to Granted state and generally to Authorized state.
* Onyx Portal > **Equipment** > **Mesh Node** tab > view Mesh Node's details > **Overview** tab > **Mesh Node Details** tile > **Service Status** icon: If the Mesh Node was not transmitting previously, it can change to ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fx9TB9XIgCo80mg2MZJq0%2Ficon-service-status-green.png?alt=media\&token=5ac9ddcf-fa77-49e0-8961-a56bfbe27c88) green.

**Corrective Actions**

None.

**Resolution Verification**

None required for initial alert.

***

#### CPE CBSD Preferred Frequency or Bandwidth Unavailable

**Trigger Condition**

When using the GM03 Mesh Node, if the configured backhaul frequency or bandwidth to which the Mesh Node is connected becomes unavailable.

**Clear Condition**

When the preferred frequencies or bandwidth become available again.

**Severity**

Warning

**System Impact**

The Mesh Node is transmitting at reduced capacity and power and will not support any data traffic.

**Indications**

The GM03 Mesh Node will be online but does not have a grant.

**Corrective Actions**

1. Change the Mesh Node's backhaul frequency or bandwidth and reconnect.
2. The available frequency can be found in the "Spectrum Inquiry Response" log type (Onyx Portal > **Equipment** > **Mesh Node** tab > view Mesh Node's details > **Logs** tab > **DP Logs** section > "Spectrum Inquiry Response" log type). Filter for "From SAS To DP logs".

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to their pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

***

#### CPE CBSD Registration Failure

**Trigger Condition**

When using the GM03 Mesh Node, if one or more CPE CBSD registration attempts have failed within the last one hour.

**Clear Condition**

When no CPE CBSD registration failures occur for at least one hour.

**Severity**

Major

**System Impact**

The Mesh Node will become non-functional, as it cannot obtain any grants to transmit.

**Indications**

* Onyx Portal > **Equipment** > **Mesh Node** tab > view Mesh Node's details > **Overview** tab > SAS Status will show **Registered** in red ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FzLj4bB4Do1fn85XiYSFv%2Fimage.png?alt=media\&token=f749cbdc-3cae-4990-980d-24faf473eb44).
* The Mesh Node will be reported offline. See the Mesh Node M-Plane [Offline](#mesh-node-offline) alert.

**Corrective Actions**

1. Check the Mesh Node's DP logs for the failure reason and take necessary action (Onyx Portal > **Equipment** > **Mesh Node** tab > view Mesh Node's details > **Logs** tab > **DP Logs** section).
2. The most probable cause is a parameter mismatch between the Onyx Portal and the SAS Portal. Verify the CPE CBSD registration on the Federated Wireless Portal has the correct information. Verify the FCC ID, Serial Number, CBSD Type and Category, Location, and Antenna parameters.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to their pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

***

### Mesh Node M-Plane Alerts

#### Offline <a href="#mesh-node-offline" id="mesh-node-offline"></a>

**Trigger Condition**

When a Mesh Node has remained offline for at least 10 minutes.

**Clear Condition**

When the Mesh Node comes back online.

**Severity**

Critical

**System Impact**

Configurations, alerts, events, metrics, etc. between the Onyx Portal and Mesh Node will not be in sync.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Mesh Node** tile > **Online** icon: Depending on whether other Mesh Nodes are offline, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FaG2Nh6ANp7rfrIv9hWP0%2Ficon-online-status-amber.png?alt=media\&token=b3bf2124-4a80-4725-998f-243aa070aeae) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FU3shYkxRCNaxLKs5WZWL%2Ficon-online-status-red.png?alt=media\&token=31d58312-8a68-4447-a53c-707b962d9745) red.
* Onyx Portal > **Dashboard** > **Mesh Node** tile > **Service Status** icon: Depending on whether other Mesh Nodes are offline, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FeTm7hjL3leOH7dqo0Emx%2Ficon-service-status-amber.png?alt=media\&token=9a27f1e5-9eba-4370-8ff7-d058fd623716) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FDYn8wFL6Teltxq7R1pUp%2Ficon-service-status-grey.png?alt=media\&token=894fec5a-5592-4b06-8e67-23a219afb84e) grey.
* Onyx Portal > **Equipment** > **Mesh Node** tab > Mesh Nodes list > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FdNHyf7MRU1e6f2Gx1Kaz%2Ficon-compute-resource-status-red.png?alt=media\&token=5dfd2390-c349-47da-b253-9bf7e1c43fe6) red.
* Onyx Portal > **Equipment** > **Mesh Node** tab > view Mesh Node's details > **Overview** tab > **Mesh Node Details** tile > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FykxNnTdhG9ThAxt0zMUR%2Ficon-compute-resource-status-red.png?alt=media\&token=403396d5-b350-4d38-8975-69948bcc4b9f) red.

**Corrective Actions**

1. Check the Mesh Node's Internet connectivity.
2. Verify that the subscriber associated with the Mesh Node is connected and active.
3. If Internet connectivity is confirmed, ensure the Mesh Node is properly provisioned. Log on to the Mesh Node and run the `checkin_cli.py` command. Investigate and resolve any errors in the output.
4. Verify power supply to the Mesh Node equipment.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Onyx Portal > **Dashboard**: All tiles return to their pre-incident states.

***

### Mesh Node MCU-Plane Alerts

#### Tunnel Down

**Trigger Condition**

When the Mesh Tunnel between the Mesh Node and the Onyx Edge remains down for at least five minutes.

**Clear Condition**

When the Mesh Tunnel between the Mesh Node and the Onyx Edge is restored.

**Severity**

Major

**System Impact**

The Mesh AP behind the Mesh Node will not be configured, preventing UE from attaching to it.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Equipment** > **Mesh Node** tab > Mesh Nodes list > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FzHCm2Xw9fqaBO5ZxAlyD%2Ficon-compute-resource-status-red.png?alt=media\&token=f9547d7e-5625-492b-88a9-d33f58bc3787) red.
* Onyx Portal > **Equipment** > **Mesh Node** tab > view Mesh Node's details > **Overview** tab > **Mesh Node Details** tile > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXmwuQOkxa2YCkY98JQuC%2Ficon-compute-resource-status-red.png?alt=media\&token=7c216fbd-b314-4892-9822-0c8f92cf092e) red.

**Corrective Actions**

1. Check the Mesh Node's Internet connectivity.
2. Check if the subscriber associated with the Mesh Node is connected and active.
3. Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Onyx Portal > **Dashboard**: All tiles return to their pre-incident states.

***

#### Watchdog Powercycle

**Trigger Condition**

When the Mesh Node is power cycled by the Watchdog service within the last 10 minutes.

**Clear Condition**

When the Mesh Node Watchdog service has not triggered a power cycle on the Mesh Node for at least 10 minutes.

**Severity**

Minor

**System Impact**

* The mesh network will be affected until the Mesh Node reconnects and comes back online.
* UE will be unable to attach to the Mesh AP.

**Indications**

Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).

**Corrective Actions**

* Watchdog is triggered due to issues with the "cpe\_controller" service or modem identification. If the alert persists, contact GXC Technical Support.
* Check the alert's details for the cause.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to their pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

***

### Mesh Node Platform Alerts

#### CPU Usage <a href="#mesh-node-cpu-usage" id="mesh-node-cpu-usage"></a>

**Trigger Condition**

When a Mesh Node's CPU usage exceeds 70% of capacity in the last five minutes.

**Clear Condition**

When the Mesh Node's CPU usage drops below 70% of capacity.

**Severity**

Minor

**System Impact**

* Delays may occur in signaling and data processing at the Mesh Node.
* If CPU usage continues to rise, unexpected system behavior may occur.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Equipment** > **Mesh Node** tab > Mesh Nodes list > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FRUxC3pkamaLwjIVFv0Cc%2Ficon-compute-resource-status-red.png?alt=media\&token=5b38d343-8631-4dca-b6b5-a5652b141d9b) red.
* Onyx Portal > **Equipment** > **Mesh Node** tab > view Mesh Node's details > **Overview** tab > **Mesh Node Details** tile > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FLzx10kYUXsuhzjGpgngW%2Ficon-compute-resource-status-red.png?alt=media\&token=341872cd-21cf-4459-b7fe-2323e9211917) red.

**Corrective Actions**

Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Onyx Portal > **Dashboard**: All tiles return to their pre-incident states.
* Onyx Portal > **Equipment** > **Mesh Node** tab > view Mesh Node's details > **Overview** tab > **Mesh Node Details** tile > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKooyzRw3V8hH9uhQijgW%2Ficon-compute-resource-status-green.png?alt=media\&token=f322ccad-d3ef-4216-84d0-d67e384ab7f5) green.

***

#### Disk Usage <a href="#mesh-node-disk-usage" id="mesh-node-disk-usage"></a>

**Trigger Condition**

When a Mesh Node's disk usage exceeds 70% of capacity.

**Clear Condition**

When the Mesh Node's disk usage drops below 70% of capacity.

**Severity**

Major

**System Impact**

Delays in signaling and data processing at the Mesh Node.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Equipment** > **Mesh Node** tab > **Mesh Node** list > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FZGq9itSvORArJjDX4Ayl%2Ficon-compute-resource-status-red.png?alt=media\&token=eb84ed92-14b9-440a-99a2-fe1808b452ca) red.
* Onyx Portal > **Equipment** > **Mesh Node** tab > view Mesh Node's details > **Overview** tab > **Mesh Node Details** tile > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FFuLjvcsLqDuc39C61OuL%2Ficon-compute-resource-status-red.png?alt=media\&token=5da8109b-2fb8-41d1-9459-190e538f8c91) red.

**Corrective Actions**

Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Onyx Portal > **Dashboard**: All tiles return to their pre-incident states.
* Onyx Portal > **Equipment** > **Mesh Node** tab > view Mesh Node's details > **Overview** tab > **Mesh Node Details** tile > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fu0gFIJ722dP8FkBMXs2J%2Ficon-compute-resource-status-green.png?alt=media\&token=7050e286-81fb-4c6e-8e9b-b2826e554242) green.

***

#### Memory Usage <a href="#mesh-node-memory-usage" id="mesh-node-memory-usage"></a>

**Trigger Condition**

When a Mesh Node's memory usage exceeds 70% of capacity.

**Clear Condition**

When the Mesh Node's memory usage drops below 70% of capacity.

**Severity**

Minor

**System Impact**

Delays in signaling and data processing at the Mesh Node.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Equipment** > **Mesh Node** tab > Mesh Nodes list > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F3ESxDiBr0KD4kRrzSUBq%2Ficon-compute-resource-status-red.png?alt=media\&token=17c30002-f9d0-47ae-8396-5b3700a0ebef) red.
* Onyx Portal > **Equipment** > **Mesh Node** tab > view Mesh Node's details > **Overview** tab > **Mesh Node Details** tile > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F3NgezXZyfwk7wXO1KlAH%2Ficon-compute-resource-status-red.png?alt=media\&token=4e3aa68d-d0df-4920-8ca2-929a3c8253a5) red.

**Corrective Actions**

Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to their pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles return to their pre-incident states.
* Onyx Portal > **Equipment** > **Mesh Node** tab > view Mesh Node's details > **Overview** tab > **Mesh Node Details** tile > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fimtud18CpycnvdYwQSas%2Ficon-compute-resource-status-green.png?alt=media\&token=1765a66a-4ae6-4d93-9c19-cf42b671499d) green.

***

### Mesh Node Provisioning Server Alerts

#### Provisioning Server Connection Failure <a href="#mesh-node-provisioning-server-connection-failure" id="mesh-node-provisioning-server-connection-failure"></a>

**Trigger Condition**

When a Mesh Node has not successfully checked in with the Provisioning Server within the past 35 minutes.

**Clear Condition**

When the Mesh Node successfully checks in with the Provisioning Server.

**Severity**

Warning

**System Impact**

* A new Mesh Node will be unable to connect to the Onyx Portal or begin operations.
* For an existing Mesh Node:
  * If the keys have changed, it will be unable to get the updated keys from the Provisioning Server and will be unable to connect to the Onyx Portal.
  * If the keys have not changed, there will be no impact.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Mesh Node** tile > **Online** icon:
  * If the Mesh Node's unique keys have changed, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FioI0gPMznykfImkccoOb%2Ficon-online-status-red.png?alt=media\&token=7317c6b6-2ee7-4cda-b02b-f2688b49430c) red.
  * If the Mesh Node's unique keys have not changed, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FlNIcVQFtsQAByMbPNKHm%2Ficon-online-status-green.png?alt=media\&token=72e44ad1-b16d-42e4-b480-1c2efc50a6e1) green.

**Corrective Actions**

Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to their pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

***

## Onyx Edge (Core) Alerts

### Onyx Edge (Core) C-Plane Alerts

#### DHCP Server Failed

**Trigger Condition**

When the DHCP server, responsible for assigning IP addresses to UE, has been unavailable for five minutes.

**Clear Condition**

When the DHCP server becomes available.

**Severity**

Major

**System Impact**

* UE may not be able to obtain IP addresses for data connectivity.
* New data sessions will be impacted while existing sessions may continue to function.

**Indication**

Onyx Portal > **Dashboard** > common counter indications.

**Corrective Actions**

Check the DHCP server health in the network.

**Resolution Verification**

Onyx Portal > Alerts Counter Panel: Alert counts revert to pre-incident levels.

***

#### NG Setup Failure

**Trigger Condition**

When an NG Setup Request failure is detected within the last five minutes.

**Clear Condition**

When no NG Setup Request failures occur within the last five minutes.

**Severity**

Major

**System Impact**

All APs connected to the Onyx Edge (Core) will stop transmission if setup fails.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Onyx Edge** tile > **Service Status** icon: If failures are persistent, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FYMxmNSDX4VP1NwNeiVXz%2Ficon-service-status-red.png?alt=media\&token=cc1d601d-cd7c-43ec-a1f8-82d589c8397f) red.
* Onyx Portal > **Dashboard** > **Access Point** tile > **Service Status** icon: If failures are persistent, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8ysSXtAaw4CNhFJpbR33%2Ficon-service-status-red.png?alt=media\&token=b2e06aba-8f05-4881-8dd4-98a4e08f4e60) red.
* Onyx Portal > **Dashboard** > **Subscribers** tile: Subscribers impacted by the Onyx Edge will move to **Unknown** state.
* Onyx Portal > **Dashboard** > **Downlink/Uplink Traffic** tile: Traffic will reduce to the extent of the traffic handled by the Onyx Edge.
* Onyx Portal > **Dashboard** > **Data Usage** tile: Data Usage will reduce to the extent of the traffic handled by the Onyx Edge.
* Onyx Portal > **Dashboard** > **Backhaul (SGi) Health** tile: May reduce to the extent of traffic handled by the Onyx Edge.

**Corrective Actions**

Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

***

#### SCTP Outbound Stalled

**Trigger Condition**

SCTP inbound ordered chunks have been increasing over the last 15 minutes while SCTP outbound ordered chunks have remained flat.

**Clear Condition**

Outbound SCTP chunks resume normal flow, indicating the core is processing and responding to signaling messages again.

**Severity**

Major

**System Impact**

* The NGAP/NAS signaling layer on the Onyx Edge core is stalled — SCTP packets are arriving from the access network but the core is not sending any responses back.
* New UE procedures (attach, registration, handover, PDU session establishment) will fail because signaling responses are not being sent.
* Existing sessions may continue to pass user-plane traffic for a time, but any control-plane operation (e.g., service request, paging response, session modification) will time out.
* If the condition persists, APs may tear down their SCTP associations and trigger S1/NG Setup failures, leading to a broader service outage.

**Indications**

* Onyx Portal > **Dashboard** > common counter indications
* Onyx Portal > **Dashboard** > **Onyx Edge** tile > **Service Status** — May change to Red if the stall persists and signaling associations are lost
* Onyx Portal > **Dashboard** > **Subscribers** — Active subscriber count may begin to decline as UE procedures fail
* Onyx Portal > **Dashboard** > **Downlink/Uplink Traffic** — Control-plane stall may eventually impact data traffic as sessions cannot be established or modified

**Corrective Actions**

Contact GXC Support. There is no automatic recovery action for this condition.

**Resolution Verification**

From the Dashboard:

* The alerts count has returned to the condition prior to the incident.
* SCTP outbound chunk counters are incrementing normally.
* UE attach/registration procedures are succeeding again.

***

#### UE IMSI-IMEI Validation Failure

**Trigger Condition**

When attach requests for a UE have been rejected in the last 15 minutes because the UE IMEI does not match the configured IMSI-IMEI mapping.

**Clear Condition**

When no attach requests for the UE have failed in the last 15 minutes due to IMSI-IMEI validation.

**Severity**

Warning

**System Impact**

Any of the following:

* Legitimate UE cannot attach to the network due to incorrect configuration.
* Illegal attempt to use the network.

**Indications**

* Onyx Portal > **Dashboard** > common counter indications.
* Onyx Edge Control Plane Transaction Status shows attach failures.
* Onyx Edge events list displays IMEI mismatch failures (Onyx Portal > **Equipment** > **Onyx Edge (Core)** tab > view Onyx Edge's details > **Events & Alerts** tab).

**Corrective Actions**

1. Identify the offending IMSI and IMEI: In the Onyx Edge events view, filter with stream "mme" and look for Attach Reject events to identify the offending IMSI and IMEI. (Onyx Portal > **Equipment** > **Onyx Edge (Core)** tab > view Onyx Edge's details > **Events & Alerts** tab.)
2. Determine the appropriate action:
   * If the IMEI is not authorized for the IMSI, no further action is required in Onyx Portal. The operator can investigate who is attempting to attach with the unauthorized UE.
   * If the IMEI mapping is incorrectly configured, correct it in the subscriber configuration (Onyx Portal > **Subscribers**).

**Resolution Verification**

* Verify that the alert has cleared.
* Confirm that the UE can successfully attach to the network.

***

#### UE Registration Failure

**Trigger Condition**

When registration requests for a UE have failed for reasons other than unknown user or IMEI validation failures in the past 15 minutes.

**Clear Condition**

When no registration requests for a UE have failed for reasons other than unknown user or IMEI validation failures for at least 15 minutes.

**Severity**

Warning

**System Impact**

UE cannot attach to the network.

**Indications**

* Onyx Portal > **Dashboard** > common counter indications.
* Onyx Portal > **Equipment** > **Onyx Edge (Core)** tab > view Onyx Edge's details: Control Plane Transaction Status shows registration failures.

**Corrective Actions**

1. Ensure the subscriber/IMSI is configured in the Onyx Portal (Onyx Portal > **Subscribers** > **Subscriber** tab).
2. Ensure the subscriber's service status is set to Active (Onyx Portal > **Subscribers** > **Subscriber** tab > view subscriber's details > **Subscriber Details** section > **Service** parameter).
3. Contact GXC Technical Support.

**Resolution Verification**

* Verify that the alert has cleared.
* Confirm that the affected UE can attach successfully and pass data traffic.

***

### Onyx Edge (Core) CU-Plane Alerts

#### HA Peer Down

**Trigger Condition**

When, in an Onyx Edge pool, the Primary Onyx Edge detects a peer Onyx Edge is down. A peer Onyx Edge can be marked as "down" for the following reasons:

* NG interface is down
* N6 interface is down
* Both NG and N6 interfaces are down
* The peer Onyx Edge is powered down

The Primary Onyx Edge detects a peer is down within 10 minutes of it going down.

**Clear Condition**

When the Primary Onyx Edge detects that the peer Onyx Edge is operational.

**Severity**

Major

**System Impact**

When a peer Onyx Edge is reported as down, if the NG/N6 interface is also down, it will not be able to handle any UE traffic and is flagged as non-operational. A complete blackout will occur if all the Onyx Edge in a pool become non-operational.

**Indications**

Common Dashboard indications.

**Corrective Actions**

1. Check the Onyx Edge pool's status (Onyx Portal > **Equipment** > **Onyx Edge** tab > **Onyx Edge Pool** tile > view pool's details > **HA Connectivity Status** icon):
   * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQBHBnEOIonV6n1L1UpRC%2Ficon-interface-status-green.png?alt=media\&token=d6fce60f-e836-4299-a4b1-fd2d4ae4a386) green — One Onyx Edge is functioning as the Primary, and the others as Standby.
   * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F3ujIEqcoYEtUFyCGwXUR%2Ficon-interface-status-amber.png?alt=media\&token=2cd08986-7738-4a85-a4b2-5ee93736f0f5) amber — One Onyx Edge is functioning as the Primary, but one or more of the other Onyx Edge are non-functional.
   * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FxLQLnX7NvrNF8KnYmctO%2Ficon-service-status-red.png?alt=media\&token=43d4d5a9-8fd0-4792-9ae2-8314a968f57e) red — All Onyx Edge are non-functional, or their status is not available.
   * &#x20;![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmkURSMVfyvixm51SQVym%2Ficon-service-status-grey.png?alt=media\&token=1ff38e69-050c-4436-98e9-18c7a11f29ee) grey — All Onyx Edge are offline.
2. Check if all the Onyx Edge in the pool are online (Onyx Portal > **Equipment** > **Onyx Edge** tab > **Onyx Edge Pool** tile > view pool's details > **Associated Onyx Edge** tile > **Online** column > **Online** icon):
   * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FOPqx90HIHOAK2mWzFW67%2Ficon-online-status-green.png?alt=media\&token=1610ad96-889b-488a-a89c-a97e92a22a92) green — The Onyx Edge has checked in with the Onyx Portal in the last five minutes.
   * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQKgsPs4abw9SX69P9NFH%2Ficon-online-status-red.png?alt=media\&token=de13ad48-a3d9-4d46-b0db-ee797bcdf35a) red — The Onyx Edge has not checked in with the Onyx Portal in the last five minutes.
3. If the NG interface is down, check the NG connection between the peer Onyx Edge and APs. In a healthy NG interface, the Onyx Edge should be able to ping each AP (Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge's details > **Actions** > **Ping**). Verify physical connections, switch configuration, and VLAN assignments for both the Onyx Edge and APs.
4. If the N6 interface is down, check Internet connectivity. In a healthy N6 interface, the Onyx Edge should be able to ping the Internet (8.8.8.8) (Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge's details > **Actions** > **Ping**). Verify physical connections, switch configuration, and VLAN assignments.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Onyx Portal > **Dashboard**: All tiles return to their pre-incident states.

***

### Onyx Edge (Core) M-Plane Alerts

#### Offline <a href="#onyx-edge-core-offline" id="onyx-edge-core-offline"></a>

**Trigger Condition**

When an Onyx Edge (Core) remains offline for at least 10 minutes.

**Clear Condition**

When the Onyx Edge (Core) comes back online.

**Severity**

Critical

**System Impact**

Configurations, alerts, events, metrics, etc. between the Onyx Portal and the Onyx Edge (Core) will be out of sync.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Onyx Edge** tile > **Online** icon: Depending on whether other Onyx Edge are offline, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FDt2Fc6N4qm63OnkTXz9z%2Ficon-online-status-amber.png?alt=media\&token=ab8d407e-eb17-4739-9b8a-2940bdb70bb3) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FnAots6ovjHbRjY0sRqqM%2Ficon-online-status-red.png?alt=media\&token=d8b3e245-09f2-4120-953a-b7a6d0b8a265) red.
* Onyx Portal > **Dashboard** > **Onyx Edge** tile > **Service Status** icon: Depending on whether other Onyx Edge are offline, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fp2wOW6LuDcQZG5IxHlHK%2Ficon-service-status-amber.png?alt=media\&token=6ea9aa26-8f38-4eaf-8e6b-a04df14db603) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FAU0ICqHJXWliJguUhIYi%2Ficon-service-status-grey.png?alt=media\&token=7dfb8ac2-ece9-4402-9b89-0427e693bd49) grey.
* Onyx Portal > **Dashboard** > **Access Point** tile > **Online** icon: Depending on whether other Onyx Edge are offline, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FCx397HCxwdm6z0cSVopb%2Ficon-online-status-amber.png?alt=media\&token=5c955262-41a1-4030-9a3a-fbf461b01ef2) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FR7Mm4Fs9aoUzCPjEAXdO%2Ficon-online-status-grey.png?alt=media\&token=f0d7e2c4-367a-4625-8fd4-3c2e7b1b9092) grey.
* Onyx Portal > **Dashboard** > **Access Point** tile > **Service Status** icon: Depending on whether other Onyx Edge are offline, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fq8lrwkMrcEmDX6XWcLNa%2Ficon-service-status-amber.png?alt=media\&token=f6964b7d-a655-4b2d-90b2-78c21c20433c) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FsI6hOTf0TEeQyJARs3Am%2Ficon-service-status-grey.png?alt=media\&token=4234e891-a688-40ef-8aae-1ff904d64248) grey.
* Onyx Portal > **Dashboard** > **Subscribers** tile: Total subscribers impacted by this Onyx Edge will change to Unknown.
* Onyx Portal > **Dashboard** > **Downlink/Uplink Traffic** tile: Reduces by the extent of traffic handled by the Onyx Edge.
* Onyx Portal > **Dashboard** > **Data Usage** tile: Reduces by the extent of traffic handled by the Onyx Edge.
* Onyx Portal > **Dashboard** > **Backhaul (SGi) Health** tile: Reduces by the extent of traffic handled by the Onyx Edge.

**Corrective Actions**

1. Check the Onyx Edge (Core)'s Internet connectivity on the N6 interface. This cannot be done from the Onyx Portal when the Onyx Edge (Core) is offline. If some other system, such as a remote laptop in the local network is accessible, ping the Onyx Edge (Core) to check if there is a local network issue, and then log on to the Onyx Edge (Core) to verify Internet connectivity.
2. At the Onyx Edge (Core)'s location, verify power and connectivity to the equipment.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

***

### Onyx Edge (Core) MCU-Plane Alerts

#### Service Down <a href="#onyx-edge-core-service-down" id="onyx-edge-core-service-down"></a>

**Trigger Condition**

When any of the following conditions occur:

* All APs remain offline for five minutes.
* All APs are S1-disconnected for five minutes.
* Any critical service has restarted more than three times in the last five minutes.
* Any critical service remains down for five minutes.

**Clear Condition**

When the trigger condition is resolved.

**Severity**

Critical

**System Impact**

The Onyx Edge may be offline or may not function as expected, potentially causing UE to lose service.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Onyx Edge** tile > **Service Status** icon: Depending on how other APs are connected to this and other Onyx Edge, and how they are affected, the icon will change to ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FHeG6Gta9XQPnFAwBdk7P%2Ficon-service-status-amber.png?alt=media\&token=37db14be-80d0-46f1-9d0b-e4f948497c7f) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJP01Q9WBDsBHCF6C8XA0%2Ficon-service-status-red.png?alt=media\&token=155e88aa-368c-4e86-82fa-d12d57931032) red.
* Onyx Portal > **Dashboard** > **Access Point** tile > **Online** icon: Depending on if the APs are affected, the icon may change to ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FYtsbboq6WYPIUKNdNpIq%2Ficon-online-status-amber.png?alt=media\&token=1e4a3f79-d559-4f70-b0b7-c94ca5179e2d) amber.
* Onyx Portal > **Dashboard** > **Access Point** tile > **Service Status** icon: Depending on if the APs are affected, the icon will change to ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FhEeVeG775VoNzgKscnON%2Ficon-service-status-amber.png?alt=media\&token=72b02bf2-2da5-470e-9d36-cbf17fe49376) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FdhDnlsQ30i7OKJ4Ug5FQ%2Ficon-service-status-red.png?alt=media\&token=d41bc711-b4ca-43c7-9548-ea0accd75ee0) red.
* Onyx Portal > **Dashboard** > **Subscribers** tile: Subscribers impacted by the Onyx Edge may move to **Unregistered** state.
* Onyx Portal > **Dashboard** > **Downlink/Uplink Traffic** tile: Traffic will decrease proportionately to the volume previously handled by the Onyx Edge.
* Onyx Portal > **Dashboard** > **Data Usage** tile: May decrease proportionately to the traffic previously handled by the Onyx Edge.
* Onyx Portal > **Dashboard** > **Backhaul (SGi) Health** tile: May reduce to the extent of traffic handled by the Onyx Edge.

**Corrective Actions**

1. Check if the Onyx Edge is properly provisioned.
2. If an AP is offline and the [Access Point M-Plane Offline](#access-point-offline) alert has triggered:
   * Check for network connectivity issues between the AP and the Onyx Edge.
   * Check if the AP is associated with the correct Onyx Edge.
3. If an AP is S1-disconnected, and the "CBRS AP S1 Disconnected" alert has triggered:
   * Check the AP's IPSec status.
   * Check for any CBRS AP faults and alarm events (**Events and Alerts** tab).
4. If neither of the above alerts has triggered, restart Onyx Edge services (Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge (Core)'s details > **Actions** > **Restart Services**).

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Onyx Portal > **Dashboard**: All tiles return to their pre-incident states.

**Related Alerts**

* Access Point Management Plane [Offline](#access-point-offline) Alert
* Onyx Edge (Core) Management Plane [Offline](#onyx-edge-core-offline) Alert

***

### Onyx Edge (Core) Platform Alerts

#### CPU Usage <a href="#onyx-edge-core-cpu-usage" id="onyx-edge-core-cpu-usage"></a>

**Trigger Condition**

When an Onyx Edge (Core)'s CPU usage exceeds 70% of capacity in the last five minutes.

**Clear Condition**

When the Onyx Edge (Core)'s CPU usage drops below 70% of capacity in the last five minutes.

**Severity**

Minor

**System Impact**

* Possible delays in signaling and data processing at the Onyx Edge (Core).
* If CPU usage continues to rise, unexpected behaviors may be seen.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Equipment** > **Onyx Edge** tab > **Onyx Edge** list > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FbiOXFzU9RIPETMZ8Uv9J%2Ficon-compute-resource-status-red.png?alt=media\&token=49618b87-76c8-4d73-85a4-3720e02cda24) red.
* Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge's details > **Overview** tab > **Onyx Edge Details** tile > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FnBdbqRydBng5nFm2Zcns%2Ficon-compute-resource-status-red.png?alt=media\&token=b0d609ee-f18a-48b1-8681-50995e83dab4) red.

**Corrective Actions**

Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to pre-incident levels.
* Onyx Portal > **Equipment** > **Onyx Edge** tab > **Onyx Edge** list > **Compute Resource** icon: Depending on the usage, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FwIw3uUnzDcOKutqpSgjb%2Ficon-compute-resource-status-amber.png?alt=media\&token=f1453d13-5039-4376-8360-4f7cf9df33eb) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FuPvyQwCsTRIGja1N6i6y%2Ficon-compute-resource-status-green.png?alt=media\&token=c50d8573-4ef7-47e6-9220-301e1b967f19) green.
* Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge (Core)'s details > **Overview** tab > **Onyx Edge Details** tile > **Compute Resource** icon: Depending on the usage, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FtddPlaFl8eKDds8FbOaw%2Ficon-compute-resource-status-amber.png?alt=media\&token=6bbad3bc-864e-4bb8-b80d-c76a64312978) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FfU231Uh6NxoGGAmOjaXG%2Ficon-compute-resource-status-green.png?alt=media\&token=a3770869-ae17-4795-b0bb-72ddd05d4e77) green.

***

#### Disk Usage <a href="#onyx-edge-core-disk-usage" id="onyx-edge-core-disk-usage"></a>

**Trigger Condition**

When an Onyx Edge (Core)'s disk usage exceeds 70% of capacity in the last five minutes.

**Clear Condition**

When the Onyx Edge (Core)'s disk usage drops below 70% of capacity in the last five minutes.

**Severity**

Major

**System Impact**

* If the disk usage continues to rise, it may eventually cause downtime on the Onyx Edge (Core).
* The Onyx Edge (Core) may stop collecting critical logs required for debugging issues.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Equipment** > **Onyx Edge** tab > **Onyx Edge** list > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FUhz6tK9Z49fh8hRGzqXk%2Ficon-compute-resource-status-red.png?alt=media\&token=fe13211d-52a4-428d-953f-f12456bcbb80) red.
* Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge (Core)'s details > **Overview** tab > **Onyx Edge Details** tile > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F3cHlt9sDSCM2GRk8WluZ%2Ficon-compute-resource-status-red.png?alt=media\&token=8665c615-f422-4d22-814e-7865494ad646) red.

**Corrective Actions**

Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to pre-incident levels.
* Onyx Portal > **Equipment** > **Onyx Edge** tab > **Onyx Edge** list > **Compute Resource** icon: Depending on the usage, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F6PvYocsZ9YPJ3kHJ2pTc%2Ficon-compute-resource-status-amber.png?alt=media\&token=dc9d03b6-ac94-4076-9ecd-2f97b9f007aa) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fb12PBGCdpZ9w01H6aqtx%2Ficon-compute-resource-status-green.png?alt=media\&token=da0334c7-97e6-4545-871e-740bec76d091) green.
* Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge (Core)'s details > **Overview** tab > **Onyx Edge Details** tile > **Compute Resource** icon: Depending on the usage, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FwpVvTVc4pt506giGwB8h%2Ficon-compute-resource-status-amber.png?alt=media\&token=b7a6de7d-1d9a-44b6-ab6a-505e6ff6cf0a) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FNAf4Px2QZpxC7oVjchQH%2Ficon-compute-resource-status-green.png?alt=media\&token=61bda5a8-469f-4929-9b38-d5d9691f9f23) green.

***

#### Memory Usage <a href="#onyx-edge-core-memory-usage" id="onyx-edge-core-memory-usage"></a>

**Trigger Condition**

When an Onyx Edge (Core)'s memory usage exceeds 70% of capacity.

**Clear Condition**

When the Onyx Edge (Core)'s memory usage drops below 70% of capacity.

**Severity**

Minor

**Indications**

Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).

**Corrective Actions**

Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to pre-incident levels.
* Onyx Portal > **Equipment** > **Onyx Edge** tab > **Onyx Edge** list > **Compute Resource** icon: Depending on the usage, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FBDVYmL3fMUUmt63HGCUk%2Ficon-compute-resource-status-amber.png?alt=media\&token=467a9c02-cfcd-4f6e-bec6-759ba4a35c84) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fxfm0uJZYfjeLMSop3XmT%2Ficon-compute-resource-status-green.png?alt=media\&token=43301e38-ea2f-44c0-a1da-65f84014f23b) green.
* Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge (Core)'s details > **Overview** tab > **Onyx Edge Details** tile > **Compute Resource** icon: Depending on the usage, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKmFb8BYR7wnesNDNWbIA%2Ficon-compute-resource-status-amber.png?alt=media\&token=a520f4c1-5c3c-4719-bbc4-c8e1b2239042) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FDziNgO37RDoyAsSqr7fM%2Ficon-compute-resource-status-green.png?alt=media\&token=3007dfe7-3027-4c96-b5f8-071c991260c2) green.

***

### Onyx Edge (Core) Provisioning Server Alerts

#### Provisioning Server Connection Failure <a href="#onyx-edge-core-provisioning-server-connection-failure" id="onyx-edge-core-provisioning-server-connection-failure"></a>

**Trigger Condition**

When an Onyx Edge (Core) has not successfully checked in with the Provisioning Server within the past 35 minutes.

**Clear Condition**

When the Onyx Edge (Core) successfully checks in with the Provisioning Server.

**Severity**

Warning

**System Impact**

* A new Onyx Edge (Core) will be unable to connect to the Onyx Portal or begin operations.
* For an existing Onyx Edge (Core):
  * If the keys have changed, it will be unable to get the updated keys from the Provisioning Server and will be unable to connect to the Onyx Portal.
  * If the keys have not changed, there will be no impact.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Onyx Edge** tile > **Online** icon:
  * If the Onyx Edge (Core)'s unique keys have changed: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJz7V89fhQ1g3rFBmQg3m%2Ficon-online-status-red.png?alt=media\&token=cb53c767-ebb2-4cfe-ab40-c1e2c5f9dfb5) red.
  * If the Onyx Edge (Core)'s unique keys have not changed: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FvAxfWbJefdHPboh4RMSU%2Ficon-online-status-green.png?alt=media\&token=dc6d0629-a9ee-4bac-af6c-0b250dcafa2c) green.

**Corrective Actions**

Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

***

## Onyx Edge (NR) Alerts

### Onyx Edge (NR) C-Plane Alerts

#### F1 Setup Failure

**Trigger Condition**

When an F1 Setup Request failure occurs within the last five minutes.

**Clear Condition**

When no F1 Setup Request failures occur within the last five minutes.

**Severity**

Critical

**System Impact**

All APs connected to the Onyx Edge may stop transmission if the setup fails.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Onyx Edge** tile > **Service Status** icon: If failures are persistent, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FUai0GWMtErEUsEgui7EN%2Ficon-service-status-red.png?alt=media\&token=5720c24c-981d-49e6-8c0e-ec1346648fa4) red.
* Onyx Portal > **Dashboard** > **Access Point** tile > **Service Status** icon: If failures are persistent, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FITze4rXIZ8cHjjLPPpen%2Ficon-service-status-red.png?alt=media\&token=b9057a0a-7670-4d65-97b5-28a100023919) red.
* Onyx Portal > **Dashboard** > **Subscribers** tile: Subscribers impacted by the Onyx Edge will move to **Unknown** state.
* Onyx Portal > **Dashboard** > **Downlink/Uplink Traffic** tile: Traffic will reduce to the extent of the traffic handled by the Onyx Edge.
* Onyx Portal > **Dashboard** > **Data Usage** tile: Data Usage will reduce to the extent of the traffic handled by the Onyx Edge.

**Corrective Actions**

1. Check if any maintenance activity is currently in progress.
2. Check if any recent configuration changes have been made.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

***

#### RRC Security Mode Failure

**Trigger Condition**

When at least one RRC Security Mode failure occurs within the last five minutes.

**Clear Condition**

When no RRC Security Mode failures occur within the last five minutes.

**Severity**

Warning

**System Impact**

Affected UE may experience issues connecting to the system.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Subscribers** tile: Subscribers impacted by this issue will move to **Unknown** state.

**Corrective Actions**

Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

***

#### RRC Setup Failure

**Trigger Condition**

When more than 25% of RRC Connection Setup attempts in the last 15 minutes have failed, and this condition has persisted for at least the last three minutes.

**Clear Condition**

When more than 75% of RRC Connection Setup attempts in the last 15 minutes completed successfully.

**Severity**

Warning

**System Impact**

Failures may result from UE being in poor coverage areas or a larger underlying system issue preventing UE from establishing an RRC connection.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Subscribers** tile: Subscribers impacted by this issue will move to **Unknown** state.

**Corrective Actions**

1. Check if any maintenance activity is currently in progress.
2. Check if any recent configuration changes have been made.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

***

### Onyx Edge (NR) M-Plane Alerts

#### Offline <a href="#onyx-edge-nr-offline" id="onyx-edge-nr-offline"></a>

**Trigger Condition**

When an Onyx Edge (NR) remains offline for at least 10 minutes.

**Clear Condition**

When the Onyx Edge (NR) comes back online.

**Severity**

Critical

**System Impact**

Configurations, alerts, events, metrics, etc. between the Onyx Portal and the Onyx Edge (NR) will not be in sync.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Onyx Edge** tile > **Online** icon: Depending on whether other Onyx Edge are offline, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FDGrgz6vy8G2U1pDUHKNu%2Ficon-online-status-amber.png?alt=media\&token=a481e596-e073-460a-a248-cdd50c59ba39) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FTOXrmCJoeBC2ZnCx0bc7%2Ficon-online-status-red.png?alt=media\&token=e9ddf8e5-fc73-4665-8941-fabf15450846) red.
* Onyx Portal > **Dashboard** > **Onyx Edge** tile > **Service Status** icon: Depending on whether other Onyx Edge are offline, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FMMuswcCVLUpYxed6jOeL%2Ficon-service-status-amber.png?alt=media\&token=b834d395-a9ac-4197-9a42-fd6e7b4db179) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FTPiZAagWyWmIi0hrZR7w%2Ficon-service-status-grey.png?alt=media\&token=8f37bdeb-9d3e-439c-ac9a-132d559f1268) grey.
* Onyx Portal > **Dashboard** > **Access Point** tile > **Online** icon: Depending on whether other Onyx Edge are offline, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fd47ax8RhHu1OCTe73dG8%2Ficon-online-status-amber.png?alt=media\&token=b28e1fbb-106a-44fd-95e8-cf9f227fcd3c) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FOcJ7pFvXribYU5TddBhp%2Ficon-online-status-grey.png?alt=media\&token=c0c757d8-4854-4d73-acc3-c807702e4fac) grey.
* Onyx Portal > **Dashboard** > **Access Point** tile > **Service Status** icon: Depending on whether other Onyx Edge are offline, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F86yAOaWRq3GGSFXmeUFW%2Ficon-service-status-amber.png?alt=media\&token=ddfdcc1d-ab12-4ed1-8b42-f111292fab19) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FOXA4Sgd3rZ7cLfe3l8AL%2Ficon-service-status-grey.png?alt=media\&token=c522ec5f-d4a4-4d37-bb79-2584e5d65feb) grey.
* Onyx Portal > **Dashboard** > **Subscribers** tile: Subscribers impacted by the Onyx Edge will move to **Unknown** state.
* Onyx Portal > **Dashboard** > **Downlink/Uplink Traffic** tile: Traffic will reduce to the extent of traffic handled by the Onyx Edge.
* Onyx Portal > **Dashboard** > **Data Usage** tile: Data Usage will reduce to the extent of traffic handled by the Onyx Edge.
* Onyx Portal > **Dashboard** > **Backhaul (SGi) Health** tile: Will reduce to the extent of traffic handled by the Onyx Edge.

**Corrective Actions**

1. Check the Onyx Edge's Internet connectivity on the SGi/N6 interface.
   * This cannot be done from the Onyx Portal when the Onyx Edge is offline.
   * If another system, such as a remote laptop in the local network is accessible, try pinging the Onyx Edge to check if there is a local network issue.
   * If the Onyx Edge is reachable, log in to verify Internet connectivity.
2. At the Edge location, verify power and connectivity to the equipment.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

***

### Onyx Edge (NR) MCU-Plane Alerts

#### Service Down <a href="#onyx-edge-nr-service-down" id="onyx-edge-nr-service-down"></a>

**Trigger Condition**

When any of the following conditions occur:

* F1c connection is down for five minutes.
* NGc connection is down for five minutes.
* Any critical Edge services have unexpectedly restarted more than three times within the last five minutes.
* Any critical Edge services remain down for five minutes.
* gNB services have restarted due to failures in the last five minutes.

**Clear Condition**

When the trigger condition is resolved.

**Severity**

Critical

**System Impact**

The Onyx Edge may be offline or not functioning as expected, potentially preventing UE from receiving service.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Onyx Edge** tile > **Service Status** icon: Depending on whether other Onyx Edge are also experiencing failures, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8z9UrIGomP7W2xvfYbtx%2Ficon-service-status-amber.png?alt=media\&token=f23bc113-3a33-4035-860b-80d75bac571a) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FjPvZF9KHCFWEtNSz7ejZ%2Ficon-service-status-red.png?alt=media\&token=366a1659-a1c8-4893-9dfb-119ea9300f91) red.
* Onyx Portal > **Dashboard** > **Access Point** tile > **Online** icon: Depending on whether the APs are affected, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F7KrVwkJGbqsjP1mFtP5f%2Ficon-online-status-amber.png?alt=media\&token=0b0c768d-f434-414d-80c2-1bc7d88ae9c0) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FgUMRPD5vwT4WFd3kJqUe%2Ficon-online-status-red.png?alt=media\&token=a02abb33-b73f-45c2-add5-b01095f62291) red.
* Onyx Portal > **Dashboard** > **Access Point** tile > **Service Status** icon: Depending on whether the APs are affected, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FgzZ8sxSBpE0T30qZgNdn%2Ficon-service-status-amber.png?alt=media\&token=16672bec-e3f2-4a48-906f-1b460beed803) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FagnvjT5gnSczSg4Hl7Bm%2Ficon-service-status-red.png?alt=media\&token=c9a47f31-0c83-4f37-b209-ac9b1680e3ea) red.
* Onyx Portal > **Dashboard** > **Subscribers** tile: Subscribers impacted by the Onyx Edge may move to **Unregistered** state.
* Onyx Portal > **Dashboard** > **Downlink/Uplink Traffic** tile: Traffic will reduce to the extent of the traffic handled by the Onyx Edge.
* Onyx Portal > **Dashboard** > **Data Usage** tile: Data Usage will reduce to the extent of the traffic handled by the Onyx Edge.
* Onyx Portal > **Dashboard** > **Backhaul (SGi) Health** tile: May reduce to the extent of traffic handled by the Onyx Edge.

**Corrective Actions**

1. Check if the Onyx Edge (NR) is provisioned properly.
2. Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

**Related Alerts**

* Onyx Edge (NR) Control Plane [F1 Setup Failure](#f1-setup-failure) Alert — Can trigger the Onyx Edge (NR) MCU-Plane "Service Down" alert.
* Onyx Edge (Core) Control Plane [NG Setup Failure](#ng-setup-failure) Alert — Can trigger the Onyx Edge (NR) MCU-Plane "Service Down" alert.

***

### Onyx Edge (NR) Platform Alerts

#### CPU Usage <a href="#onyx-edge-nr-cpu-usage" id="onyx-edge-nr-cpu-usage"></a>

**Trigger Condition**

When an Onyx Edge (NR)'s CPU usage exceeds 80% of capacity in the last five minutes.

**Clear Condition**

When the Onyx Edge (NR)'s CPU usage drops below 80% of capacity in the last five minutes.

**Severity**

Minor

**System Impact**

* Potential delays in signaling and data processing at the Onyx Edge (NR).
* If CPU usage continues to rise, unexpected behaviors may be seen.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Equipment** > **Onyx Edge** tab > **Onyx Edge (n)** tile > **Compute Resource** column, and Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge's details > **Overview** tab > **Onyx Edge Details** tile: The Compute Resource icon will change to ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5G7q7imwnlje3nVdbXBh%2Ficon-compute-resource-status-red.png?alt=media\&token=63ca7e90-36ab-4e2a-aabd-012cd0beef46) red.

**Corrective Actions**

Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to pre-incident levels.
* Onyx Portal > **Equipment** > **Onyx Edge** tab > **Onyx Edge (n)** tile > **Compute Resource** column, and Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge's details > **Overview** tab > **Onyx Edge Details** tile: Depending on the usage level, the Compute Resource icon will change to ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fz1BeHpF2arI0Am80i0jl%2Ficon-compute-resource-status-amber.png?alt=media\&token=f6f91af6-0744-4763-8d62-e8c90c7b06b8) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FlcevYbH112BxZFEAAfCZ%2Ficon-compute-resource-status-green.png?alt=media\&token=2c24e4a3-f963-44d5-86ab-0f7909ae16e0) green.

***

#### Disk Usage <a href="#onyx-edge-nr-disk-usage" id="onyx-edge-nr-disk-usage"></a>

**Trigger Condition**

When an Onyx Edge (NR)'s disk usage exceeds 70% of capacity in the last five minutes.

**Clear Condition**

When the Onyx Edge (NR)'s disk usage drops below 70% of capacity in the last five minutes.

**Severity**

Major

**System Impact**

* If disk usage continues to rise, it may eventually cause downtime on the Onyx Edge.
* The Onyx Edge (NR) may stop collecting critical logs needed for debugging issues.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Equipment** > **Onyx Edge** tab > **Onyx Edge (n)** tile > **Compute Resource** column, and Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge's details > **Overview** tab > **Onyx Edge Details** tile: The Compute Resource icon will change to ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FeyQCXPXr6SuloaAirJH4%2Ficon-compute-resource-status-red.png?alt=media\&token=a7b9727c-208e-4b15-9ef3-98bf1180f042) red.

**Corrective Actions**

Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to pre-incident levels.
* Onyx Portal > **Equipment** > **Onyx Edge** tab > **Onyx Edge (n)** tile > **Compute Resource** column, and Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge's details > **Overview** tab > **Onyx Edge Details** tile: Depending on the usage level, the Compute Resource icon will change to ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FrofSSZ3FhT7HXWTDGBRK%2Ficon-compute-resource-status-amber.png?alt=media\&token=606327de-7260-409e-9b36-69f17481412a) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FMFdbegnUYx1dy9KvbIlc%2Ficon-compute-resource-status-green.png?alt=media\&token=c18772a6-54c6-4667-858d-4881c9cb1ed2) green.

***

#### Memory Usage <a href="#onyx-edge-nr-memory-usage" id="onyx-edge-nr-memory-usage"></a>

**Trigger Condition**

When an Onyx Edge (NR)'s memory usage exceeds 80% of capacity.

**Clear Condition**

When the Onyx Edge (NR)'s memory usage drops below 80% of capacity.

**Severity**

Minor

**System Impact**

If memory usage continues to rise, it could lead to downtime on the Onyx Edge.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Equipment** > **Onyx Edge** tab > **Onyx Edge (n)** tile > **Compute Resource** column, and Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge's details > **Overview** tab > **Onyx Edge Details** tile: The Compute Resource icon changes to ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FCbk1FxgW6tdNxBx6iz9y%2Ficon-compute-resource-status-red.png?alt=media\&token=6dd48c62-1dce-47a4-9f3f-77965b232120) red.

**Corrective Actions**

Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to pre-incident levels.
* Onyx Portal > **Equipment** > **Onyx Edge** tab > **Onyx Edge (n)** tile > **Compute Resource** column, and Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge's details > **Overview** tab > **Onyx Edge Details** tile: Depending on the usage level, the Compute Resource icon changes to ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKPnM5uuRSDh2FDcSTmvb%2Ficon-compute-resource-status-amber.png?alt=media\&token=098cd5cd-5501-477b-8ff0-3e51636a4898) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fm8r3ANodzDsycrrtssu5%2Ficon-compute-resource-status-green.png?alt=media\&token=3eb197db-401e-4ec1-8330-2a851f1e61c6) green.

***

### Onyx Edge (NR) Provisioning Server Alerts

#### Provisioning Server Connection Failure <a href="#onyx-edge-nr-provisioning-server-connection-failure" id="onyx-edge-nr-provisioning-server-connection-failure"></a>

**Trigger Condition**

When an Onyx Edge (NR) has not successfully checked in with the Provisioning Server within the past 35 minutes.

**Clear Condition**

When the Onyx Edge (NR) successfully checks in with the Provisioning Server.

**Severity**

Warning

**System Impact**

* A new Onyx Edge (NR) will be unable to connect to the Onyx Portal or begin operations.
* For an existing Onyx Edge (NR):
  * If the keys have changed, it will be unable to get the updated keys from the Provisioning Server and will be unable to connect to the Onyx Portal.
  * If the keys have not changed, there will be no impact.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Onyx Edge** tile > **Online** icon:
  * If the Onyx Edge (NR)'s unique keys have changed: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FAT1Ag4dv8862wKFwW6Ib%2Ficon-online-status-red.png?alt=media\&token=3a4a355d-eca8-4a8a-a370-42bc2b745142) red.
  * If the Onyx Edge (NR)'s unique keys have not changed: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fm7BrtKpLZ8XJ2op1JwiJ%2Ficon-online-status-green.png?alt=media\&token=61e8708d-186e-4878-907a-b423460ec590) green.

**Corrective Actions**

Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

***

### Onyx Edge (NR) S-Plane Alerts

#### GPS Signal Not Available

**Trigger Condition**

When the Onyx Edge timing service has a high time difference between external timestamp signals (GPS) and the PTP hardware clock, and is unable to sync the hardware clock to GPS timing.

**Clear Condition**

When the Onyx Edge timing service successfully syncs the hardware clock to GPS timing.

**Severity**

Major

**System Impact**

The Onyx Edge Cell service may not function as expected. UE may be unable to obtain service.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* **Dashboard** > **Onyx Edge** tile > **Sync Status** icon: Will display as ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FsOINUJHatWICSbUvzKDQ%2Ficon-ipsec-status-red.png?alt=media\&token=4765e4c6-4027-40b3-bfd1-67d0e1a639c3) red; hover tooltip shows error details.
* **Dashboard** > **Onyx Edge** tile > **Service Status** icon: Will display as amber or red depending on whether other Onyx Edge are also failing.
* **Dashboard** > **Access Point** tile > **Service Status** icon: Will display as ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FH0iCpaslMYdAcGfrcQUe%2Ficon-service-status-amber.png?alt=media\&token=25c6d6ec-5bc3-4bbc-909d-be4ab45f791f) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FeVvRPLji4x6wGZeYNpzL%2Ficon-service-status-red.png?alt=media\&token=f7710d5f-1dd8-4aa2-9e1c-bd604b8c3b79) red depending on whether they are affected.
* **Dashboard** > **Subscribers** tile: Total subscribers impacted by this Onyx Edge may become unregistered.

**Corrective Actions**

1. Check if the Onyx Edge (NR) is provisioned properly.
2. Check the physical connections and if GPS mode is selected, verify GPS signal.
3. After the GPS signal is restored, restart all NR services to return to GPS mode.
4. Contact GXC Technical Support.

**Resolution Verification**

* Verify that all Dashboard tiles have returned to pre-incident states.
* Verify that the alert has cleared.

***

#### PHC2SYS Offset Is Too High

**Trigger Condition**

When the Onyx Edge timing service has a high time difference between the system clock and PTP hardware clock, and is unable to sync the system clock to the hardware clock.

**Clear Condition**

When the Onyx Edge timing service successfully syncs the system clock to the hardware clock.

**Severity**

Warning

**System Impact**

The Onyx Edge cell service may not function as expected. UE may be unable to obtain service.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* **Dashboard** > **Onyx Edge** tile > **Sync Status** icon: Will display as ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FzxEA5MdTcafxAmGblEod%2Ficon-ipsec-status-red.png?alt=media\&token=7495124f-c891-41be-b8cc-de9f3f76aa02) red; hover tooltip shows error details.
* **Dashboard** > **Onyx Edge** tile > **Service Status** icon: Will display as ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FWxi6plXmg0R0gkDxOyGo%2Ficon-service-status-amber.png?alt=media\&token=d97d2dbb-4324-45d2-a363-b56c138aa7b1) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FpPbPtVKmITyCWSkFdyDy%2Ficon-service-status-red.png?alt=media\&token=a6c26cb2-b800-4468-9e88-b35466dec058) red depending on whether other Onyx Edges are also failing.
* **Dashboard** > **Access Point** tile > **Service Status** icon: Will display as ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0AsxWZk3X3yRs881cyYo%2Ficon-service-status-amber.png?alt=media\&token=0a09a602-742b-4dcd-a2ac-1347b19981e5) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FBinMJMR3wQtcc104zPmN%2Ficon-service-status-red.png?alt=media\&token=ee8af2f6-f961-4647-9186-bd8eafa81152) red depending on whether they are affected.
* **Dashboard** > **Subscribers**: Total subscribers impacted by this Onyx Edge may become unregistered.

**Corrective Actions**

1. Check if the Onyx Edge (NR) is provisioned properly.
2. Check the physical connections and verify GPS signal if GPS mode is selected.
3. Contact GXC Technical Support.

**Resolution Verification**

* Verify that the alert has cleared.
* Verify all Dashboard tiles have returned to pre-incident states.

***

#### TS2PHC Offset Is Too High

**Trigger Condition**

When the Onyx Edge timing service has a high time difference between external timestamp signals (GPS) and the PTP hardware clock and is unable to sync the hardware clock to GPS timing.

**Clear Condition**

When the Onyx Edge timing service successfully syncs the hardware clock to GPS timing.

**Severity**

Warning

**System Impact**

The Onyx Edge cell service may not function as expected. UE may be unable to obtain service.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* **Dashboard** > **Onyx Edge** tile > **Sync Status** icon: Will display as ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FAftzxZSQmj70eFXwu5Ew%2Ficon-ipsec-status-red.png?alt=media\&token=3dd0918f-1570-46ed-ab0d-1232ec53ddfc) red; hover tooltip shows error details.
* **Dashboard** > **Onyx Edge** tile > **Service Status** icon: Will display as ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FLzG0HrjgfE9WrK31cv4P%2Ficon-service-status-amber.png?alt=media\&token=c8974b46-9d7c-40de-bae4-7c3dbe55ba23) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FaYQcS3Qv6pCAcVre41YO%2Ficon-service-status-red.png?alt=media\&token=ecaa9bd8-518c-4a42-9197-7efe68ce9e61) red depending on whether other Onyx Edges are also failing.
* **Dashboard** > **Access Point** tile > **Service Status** icon: Will display as ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Flzty6iooADdWeY2L3r93%2Ficon-service-status-amber.png?alt=media\&token=7b9b71d2-aa2f-474b-b2d3-32d804085fea) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FoMKQze70iQvYIIOtkKGa%2Ficon-service-status-red.png?alt=media\&token=d1867ec8-70b3-40a0-b745-e437e384c2d7) red depending on whether they are affected.
* **Dashboard** > **Subscribers**: Total subscribers impacted by this Onyx Edge may become unregistered.

**Corrective Actions**

1. Check if the Onyx Edge (NR) is provisioned properly.
2. Check the physical connections and verify GPS signal if GPS mode is selected.
3. Contact GXC Technical Support.

**Resolution Verification**

* Verify that the alert has cleared.
* Confirm that all Dashboard tiles have returned to their pre-incident states.

***

### Onyx Edge (NR) User Plane Alerts

#### Cell High DL BLER

**Trigger Condition**

Downlink BLER (Block Error Rate) for the cell exceeds 50% for at least 15 minutes.

**Clear Condition**

Downlink BLER for the cell falls to or below 50%.

**Severity**

Warning

***

#### Cell High UL BLER

**Trigger Condition**

Uplink BLER for the cell exceeds 50% for at least 15 minutes.

**Clear Condition**

Uplink BLER for the cell falls to or below 50%.

**Severity**

Warning

***

#### Early eCPRI Packets

**Trigger Condition**

More than 50% of eCPRI packets received for the cell in the last 15 minutes are classified as early.

**Clear Condition**

The proportion of early eCPRI packets falls to or below 50%.

**Severity**

Warning

***

#### Late eCPRI Packets

**Trigger Condition**

More than 50% of eCPRI packets received for the cell in the last 15 minutes are classified as late.

**Clear Condition**

The proportion of late eCPRI packets falls to or below 50%.

**Severity**

Warning

***

#### eCPRI Rx Down

**Trigger Condition**

No eCPRI Rx packets are received for the cell for at least 10 minutes, even though the RU's RF Tx is enabled/desired.

**Clear Condition**

eCPRI Rx packets resume being received while Tx remains enabled.

**Severity**

Warning

***

## Orchestrator Alerts

### Orchestrator Domain Proxy Alerts

#### SAS Connection Failure

**Trigger Condition**

When any of the following conditions occur:

* Could not connect to SAS at least three times in the last 15 minutes.
* At least one HTTP error from SAS in the last 15 minutes.

**Clear Condition**

When there are no SAS connection errors and no HTTP errors for at least 15 minutes.

**Severity**

Critical

**System Impact**

This could potentially mean the entire network is down, at least those APs that are dependent on SAS for their grants.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* In case of constant connection errors, the transmit timer could expire and result in the cells going down. See [Cell Transmission Down Indications](#cell-transmission-down-indications).
* Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > SAS status: The SAS state may not progress if not authorized, and the Authorized state may eventually revert to Granted on timer expiry.

**Corrective Actions**

Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

**Additional Information**

* There are two kinds of errors:

  * **HTTP errors** — Should not occur under normal conditions; typically indicate an SAS-side issue or fundamental breakage in Domain Proxy.
  * **Transport-level errors** — May occur due to connectivity issues (unable to reach SAS) or security issues (server-side or client-side authentication failures).

  The error type can be determined from the alert labels.
* SAS Connection Failure alerting generates a single consolidated alert at the network level instead of individual alerts per AP.

## Related Documentation

* *5G Onyx Portal Operations Guide*
* *GXC Glossary*

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# 4G Onyx Portal 4.x Alerts Reference

This reference describes Onyx Portal 4G alerts listed in order of type, module, and name in alphabetical order.

<p align="center"><strong>Onyx Portal 4G Predefined Alerts</strong></p>

<table><thead><tr><th width="162.8333740234375">Type</th><th width="150">Module</th><th width="324.5">Alert Name</th><th>Severity</th></tr></thead><tbody><tr><td>Access Point</td><td>C-Plane</td><td><a href="#neighbor-tables-incomplete">Neighbor Tables Incomplete</a></td><td>Major</td></tr><tr><td>Access Point</td><td>C-Plane</td><td><a href="#s1-disconnected">S1 Disconnected</a></td><td>Major</td></tr><tr><td>Access Point</td><td>CU-Plane</td><td><a href="#cell-service-down">Cell Service Down</a></td><td>Major</td></tr><tr><td>Access Point</td><td>CU-Plane</td><td><a href="#das-associated-access-point-cell-service-down">DAS Associated Access Point Cell Service Down</a></td><td>Major</td></tr><tr><td>Access Point</td><td>CU-Plane</td><td><a href="#ipsec-certificate-expiry">IPSec Certificate Expiry</a></td><td>Minor</td></tr><tr><td>Access Point</td><td>CU-Plane</td><td><a href="#ipsec-connection-down">IPSec Connection Down</a></td><td>Major</td></tr><tr><td>Access Point</td><td>Domain Proxy</td><td><a href="#cbsd-lesser-bw-granted">CBSD Lesser BW Granted</a></td><td>Major</td></tr><tr><td>Access Point</td><td>Domain Proxy</td><td><a href="#ap-cbsd-new-grant">CBSD New Grant</a></td><td>Warning</td></tr><tr><td>Access Point</td><td>Domain Proxy</td><td><a href="#ap-cbsd-preferred-frequency-unavailable">CBSD Preferred Frequency Unavailable</a></td><td>Warning</td></tr><tr><td>Access Point</td><td>Domain Proxy</td><td><a href="#ap-cbsd-registration-failure">CBSD Registration Failure</a></td><td>Major</td></tr><tr><td>Access Point</td><td>M-Plane</td><td><a href="#access-point-offline">Offline</a></td><td>Major</td></tr><tr><td>Access Point</td><td>M-Plane</td><td><a href="#tr-069-session-stuck">TR-069 Session Stuck</a></td><td>Major</td></tr><tr><td>Access Point</td><td>M-Plane</td><td><a href="#unexpected-tr-069-fault">Unexpected TR-069 Fault</a></td><td>Minor</td></tr><tr><td>Access Point</td><td>MCU-Plane</td><td><a href="#cell-unwarranted-transmission">Cell Unwarranted Transmission</a></td><td>Major</td></tr><tr><td>Access Point</td><td>MCU-Plane</td><td><a href="#mesh-filter-frequency-mismatch">Mesh Filter-Frequency Mismatch</a></td><td>Major</td></tr><tr><td>DAS</td><td>Domain Proxy</td><td><a href="#das-tp-cbsd-new-grant">TP CBSD New Grant</a></td><td>Warning</td></tr><tr><td>DAS</td><td>Domain Proxy</td><td><a href="#das-tp-cbsd-preferred-frequency-unavailable">TP CBSD Preferred Frequency Unavailable</a></td><td>Warning</td></tr><tr><td>DAS</td><td>Domain Proxy</td><td><a href="#cbsd-preferred-max-power-unavailable">TP CBSD Preferred Max Power Unavailable</a></td><td>Warning</td></tr><tr><td>DAS</td><td>Domain Proxy</td><td><a href="#das-tp-cbsd-registration-failure">TP CBSD Registration Failure</a></td><td>Major</td></tr><tr><td>Mesh Node</td><td>Domain Proxy</td><td><a href="#cpe-cbsd-new-grant">CPE CBSD New Grant</a></td><td>Warning</td></tr><tr><td>Mesh Node</td><td>Domain Proxy</td><td><a href="#cpe-cbsd-preferred-frequency-or-bandwidth-unavailable">CPE CBSD Preferred Frequency or Bandwidth Unavailable</a></td><td>Warning</td></tr><tr><td>Mesh Node</td><td>Domain Proxy</td><td><a href="#cpe-cbsd-registration-failure">CPE CBSD Registration Failure</a></td><td>Major</td></tr><tr><td>Mesh Node</td><td>M-Plane</td><td><a href="#mesh-node-offline">Offline</a></td><td>Critical</td></tr><tr><td>Mesh Node</td><td>MCU-Plane</td><td><a href="#tunnel-down">Tunnel Down</a></td><td>Major</td></tr><tr><td>Mesh Node</td><td>MCU-Plane</td><td><a href="#watchdog-powercycle">Watchdog Powercycle</a></td><td>Minor</td></tr><tr><td>Mesh Node</td><td>Platform</td><td><a href="#mesh-node-cpu-usage">CPU Usage</a></td><td>Minor</td></tr><tr><td>Mesh Node</td><td>Platform</td><td><a href="#mesh-node-disk-usage">Disk Usage</a></td><td>Major</td></tr><tr><td>Mesh Node</td><td>Platform</td><td><a href="#mesh-node-memory-usage">Memory Usage</a></td><td>Minor</td></tr><tr><td>Mesh Node</td><td>Provisioning Server</td><td><a href="#mesh-node-provisioning-server-connection-failure">Provisioning Server Connection Failure</a></td><td>Warning</td></tr><tr><td>Onyx Edge (Core)</td><td>C-Plane</td><td><a href="#authentication-failure">Authentication Failure</a></td><td>Warning</td></tr><tr><td>Onyx Edge (Core)</td><td>C-Plane</td><td><a href="#dhcp-server-failed">DHCP Server Failed</a></td><td>Major</td></tr><tr><td>Onyx Edge (Core)</td><td>C-Plane</td><td><a href="#s1-setup-failure">S1 Setup Failure</a></td><td>Major</td></tr><tr><td>Onyx Edge (Core)</td><td>C-Plane</td><td><a href="#sctp-outbound-stalled">SCTP Outbound Stalled</a></td><td>Major</td></tr><tr><td>Onyx Edge (Core)</td><td>C-Plane</td><td><a href="#ue-attach-failure">UE Attach Failure</a></td><td>Warning</td></tr><tr><td>Onyx Edge (Core)</td><td>C-Plane</td><td><a href="#ue-imsi-imei-validation-failure">UE IMSI-IMEI Validation Failure</a></td><td>Warning</td></tr><tr><td>Onyx Edge (Core)</td><td>C-Plane</td><td><a href="#ue-session-failure">UE Session Failure</a></td><td>Warning</td></tr><tr><td>Onyx Edge (Core)</td><td>CU-Plane</td><td><a href="#ha-peer-down">HA Peer Down</a></td><td>Major</td></tr><tr><td>Onyx Edge (Core)</td><td>CU-Plane</td><td><a href="#ipsec-service-down">IPSec Service Down</a></td><td>Critical</td></tr><tr><td>Onyx Edge (Core)</td><td>CU-Plane</td><td><a href="#ipsec-service-restarting-frequently">IPSec Service Restarting Frequently</a></td><td>Major</td></tr><tr><td>Onyx Edge (Core)</td><td>M-Plane</td><td><a href="#onyx-edge-core-offline">Offline</a></td><td>Critical</td></tr><tr><td>Onyx Edge (Core)</td><td>MCU-Plane</td><td><a href="#service-down">Service Down</a></td><td>Critical</td></tr><tr><td>Onyx Edge (Core)</td><td>Platform</td><td><a href="#onyx-edge-core-cpu-usage">CPU Usage</a></td><td>Minor</td></tr><tr><td>Onyx Edge (Core)</td><td>Platform</td><td><a href="#onyx-edge-core-disk-usage">Disk Usage</a></td><td>Major</td></tr><tr><td>Onyx Edge (Core)</td><td>Platform</td><td><a href="#onyx-edge-core-memory-usage">Memory Usage</a></td><td>Minor</td></tr><tr><td>Onyx Edge (Core)</td><td>Provisioning Server</td><td><a href="#onyx-edge-core-provisioning-server-connection-failure">Provisioning Server Connection Failure</a></td><td>Warning</td></tr><tr><td>Orchestrator</td><td>Domain Proxy</td><td><a href="#sas-connection-failure">SAS Connection Failure</a></td><td>Critical</td></tr></tbody></table>

<p align="center"><strong>Onyx Portal 4G Semi-Custom Alerts</strong></p>

<table><thead><tr><th width="162.8333740234375">Type</th><th width="150">Module</th><th width="325.3333740234375">Alert Name</th><th>Severity</th></tr></thead><tbody><tr><td>Mesh Node</td><td>MCU-Plane</td><td><a href="#mesh-node-rsrp-lower-than-threshold">Mesh Node &#x3C;serial number> RSRP is Lower than Configured Threshold for 5 Minutes</a></td><td>Major</td></tr><tr><td>Mesh Node</td><td>MCU-Plane</td><td><a href="#mesh-node-rsrq-lower-than-threshold">Mesh Node &#x3C;serial number> RSRQ is Lower than Configured Threshold for 5 Minutes</a></td><td>Major</td></tr><tr><td>Mesh Node</td><td>MCU-Plane</td><td><a href="#mesh-node-sinr-lower-than-threshold">Mesh Node &#x3C;serial number> SINR is Lower than Configured Threshold for 5 Minutes</a></td><td>Major</td></tr></tbody></table>

***

## Common Indications

### Alerts Counter Panel Indication

The Onyx Portal Alerts Counter panel displays separate counters for active Critical, Major, and Minor alerts. All other active alerts are grouped under the "Other" counter.

When an alert is triggered, the corresponding counter's value increases by one.

Clicking the Alerts counter panel takes you to the **Alerts** > "Active Alerts" page.

To view an alert's details, click the alert's name.

### Cell Transmission Down Indications

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Access Point** tile > **Service Status** icon: Depending on the percentage of affected APs, the icon will be ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FWe1lF03eEjxcTrN0F08O%2Ficon-service-status-amber.png?alt=media\&token=837ad470-9142-40ea-837a-c3b6ea0a043c) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKdErmYpT8GAMAOmc35de%2Ficon-service-status-red.png?alt=media\&token=ef7101e6-d2dc-4de1-adda-7b85373c2ab3) red.
* Onyx Portal > **Dashboard** > **Subscribers** tile: If the AP results in loss of online subscribers, the connected subscribers count will change.
* Onyx Portal > **Dashboard** > **Downlink/Uplink Traffic** tile: The traffic reduces as the AP is no longer serving.
* Onyx Portal > **Dashboard** > **Data Usage** tile: The usage reduces as the AP is no longer serving.
* Onyx Portal > **Dashboard** > **Access Point SAS Status** tile: Authorized AP count may reduce if this is due to a grant issue. Other counts may increase depending on the issue.
* Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Overview** tab > **Access Point Details** tile > **Service Status** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FHDym4RYJ1k0KqdOA4zaQ%2Ficon-service-status-red.png?alt=media\&token=b1381a35-efb9-4206-9050-5f861fd14c58) red.

***

## Predefined Alerts

{% hint style="info" %}
Predefined alert rules are delivered preconfigured with the Onyx Solution and can only be created, modified, or deleted by GXC.
{% endhint %}

## Access Point Alerts

### Access Point C-Plane Alerts

#### Neighbor Tables Incomplete

**Trigger Condition**

When the AP is unable to populate all Neighbor Frequency Entries or Neighbor Cell Table Entries. The AP has a limit of 8 Neighbor Frequency Entries and 16 Neighbor Cell Table Entries.

**Probable Causes**

Number of discovered neighbors exceeds the AP's table capacity limits.

**Clear Condition**

When all neighbor entries are successfully populated within the table limits.

**Severity**

Major

**System Impact**

Handovers to neighboring cells may fail, potentially causing dropped connections or service degradation for UE moving between coverage areas.

**Indications**

The AP Events page will log an event identifying which Neighbor Frequency Entries or Neighbor Cell Table Entries could not be populated.

**Corrective Actions**

Configure explicit neighbors in the network settings and limit the neighbor count to only the actual neighboring cells to which handover is expected.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Onyx Portal > **Alerts** > **Active Alerts** tab: The alert has cleared.

***

#### S1 Disconnected

**Trigger Condition**

When an AP reports that it is not S1-connected via TR-069 for at least 15 minutes.

**Probable Causes**

* The AP has an issue.
* On the Onyx Edge, the MME/SCTP services are down.

**Clear Condition**

When the AP reports that it is S1-connected.

**Severity**

Major

**System Impact**

The AP stops transmitting.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Access Point** tile > **Service Status** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fm1p4m8quSwwCDVZzrq9S%2Ficon-service-status-red.png?alt=media\&token=1235ab65-85e0-4d13-8890-9f0dadcd1e44) red, although it may take some time to change.
* Onyx Portal > **Dashboard** > **Mesh Node** tile > **Online** icon: If a Mesh Node is connected via this AP, depending on the percentage of Mesh Nodes affected, the **Online** icon will turn ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FLIx5hT9nbOazfz5ejp1L%2Ficon-online-status-red.png?alt=media\&token=7957a723-25a0-4d71-8a51-a18fd9043e7b) red or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fbk4y8swJJ1nqdmAVrpKq%2Ficon-online-status-amber.png?alt=media\&token=fb82e757-16f2-43d7-aac2-45c0c6901f63) amber, although it may take some time.
* Onyx Portal > **Dashboard** > **Subscribers** tile: If the AP results in loss of online subscribers, the connected subscribers count will change.
* Onyx Portal > **Dashboard** > **Downlink/Uplink Traffic** tile: The traffic will reduce as this AP is no longer serving.
* Onyx Portal > **Dashboard** > **Data Usage** tile: The usage will reduce as this AP is no longer serving.
* Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Overview** tab > **Service Status** and **Interface Status** icons: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FildlFpLVdN53RD6cZKnT%2Ficon-service-status-red.png?alt=media\&token=6d1f9041-788d-4b06-b64f-446f9abbdcfa) / ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FYbjfrpRDkj9a42ElvBvt%2Ficon-interface-status-red.png?alt=media\&token=a38dda7c-25d8-4fe3-877d-50147021db6a) red, although it may take some time for the **Service Status** icon to change.
* Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge's details > **Overview** tab > **Onyx Edge Details** tile > **Interface Status** icon: Depending on the number of APs that disconnected, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0tPOPvuovncha5EUJHm7%2Ficon-interface-status-red.png?alt=media\&token=3a74b244-b5cb-46a6-97ca-39659db7ad99) red or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Far4xPhlgZYVYSoxtNR4L%2Ficon-interface-status-amber.png?alt=media\&token=2cdbf3e5-7691-414f-91f7-87b5eee5e774) amber.
* Onyx Portal > **Equipment** > **Mesh Node** tab > view Mesh Node's details > **Overview** tab > **Mesh Node Details** tile > **Online** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmQnXwgnmSvUTsr9uEB5G%2Ficon-online-status-red.png?alt=media\&token=6c5d575b-f98f-440a-bb73-d5ed6f3ff1f8) red, if it is connected via the affected AP.

**Corrective Actions** (perform in order)

1. Check if the Onyx Edge's services are healthy. If the services are restarting, contact GXC Technical Support.
2. Check if any maintenance activity is currently in progress.
3. Check the AP's IPSec status (if applicable).
4. Check the AP's events and alerts and resolve any faults (Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Events & Alerts** tab). Any faults will be represented as "unexpected\_fault\_received" event, and new alerts as "enb\_alarm\_raised" event.
5. Check the AP's logs and resolve any errors (Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Logs** tab).
6. Reboot the AP.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Onyx Portal > **Dashboard**: All tiles return to their pre-incident states.

**Related Alerts**

* Onyx Edge (Core) MCU-Plane [Service Down](#service-down) Alert — Triggered if all APs connected to the Onyx Edge are S1 Disconnected.

***

### Access Point CU-Plane Alerts

#### Cell Service Down

**Trigger Condition**

When an AP cell does not transmit for at least 15 minutes.

**Probable Causes**

The grant is either unavailable or unauthorized, preventing the AP from transmitting.

**Clear Condition**

When the cell starts transmitting again.

**Severity**

Major

**System Impact**

The AP stops transmitting.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* See [Cell Transmission Down Indications](#cell-transmission-down-indications).

**Corrective Actions**

1. Check if any maintenance activity is currently in progress.
2. Check the AP's IPSec status (if used).
3. Check the AP's events and alerts and resolve any faults (Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Events & Alerts** tab). Any fault will be represented as an "unexpected\_fault\_received" event, and new alert as an "enb\_alarm\_raised" event.
4. Check the AP's logs and resolve any errors (Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Logs** tab).
5. If SAS is enabled, check if grants are available and authorized for the AP to transmit (Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Overview** tab > SAS Status display).
6. Check the AP's DP logs for any failures and take necessary action (Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Logs** tab > **DP Logs** section).
7. If grants are not available or not authorized, if possible, change the preferences to obtain grants (Onyx Portal > **Equipment** > **Access Point** tab > edit AP's details > **RAN** tab).
8. If grants are still not available for the minimum acceptable preferences, transmission will not be possible until resources become available with SAS again.
9. Reboot the AP.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Onyx Portal > **Dashboard**: All tiles return to their pre-incident states.

***

#### DAS Associated Access Point Cell Service Down

**Trigger Condition**

Cell associated with a DAS has not transmitted for at least five minutes.

**Probable Causes**

Grants for all DAS Transmission Points (TPs) are unavailable or unauthorized.

**Clear Condition**

When the cell resumes transmission.

**Severity**

Major

**System Impact**

The AP and all associated DAS TPs stop transmitting.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* See [Cell Transmission Down Indications](#cell-transmission-down-indications).
* The power granted for DAS TPs is lower than what can be configured on the associated AP.

**Corrective Actions** (perform in order)

1. Check if any maintenance activity is in progress.
2. Check the AP's IPSec status (if applicable).
3. Review the AP's events and alerts and resolve any faults (Onyx Portal > **Equipment** > **Access Points** tab > view AP's details > **Events & Alerts** tab). Faults will appear as "unexpected\_fault\_received"; new alerts will appear as "enb\_alarm\_raised".
4. Review AP logs and resolve any errors (Onyx Portal > **Equipment** > **Access Points** tab > view Access Point details > **Logs** tab).
5. Check if grants are available and authorized for all associated DAS TPs to transmit (Onyx Portal > **Equipment** > **DAS** > view DAS's details > SAS Status display).
   1. Check DP logs for per-TP failures (Onyx Portal > **Equipment** > **DAS** > view DAS's details > **Logs** tab > **DP Logs**).
   2. If grants are missing or not authorized, adjust preferences, if possible, to obtain grants (Onyx Portal > **Equipment** > **Access Points** tab > edit AP's details > **RAN** tab).
   3. If grants remain unavailable for the minimum acceptable preferences, transmission will not resume until SAS resources become available.
6. Reboot the AP.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Onyx Portal > **Dashboard**: All tiles return to their pre-incident states.

**Related Alerts**

* DAS TP [CBSD Registration Failure](#das-tp-cbsd-registration-failure)

***

#### IPSec Certificate Expiry

**What Does This Alert Mean?**

* The IPSec certificate for the AP is expiring soon. This will result in the AP losing S1 connectivity with the MME/Onyx Edge.
* Note that this alert only captures the certificate as maintained by the Orchestrator. It is the user's responsibility to upload the current certificate on the AP. This alert does not track the actual certificate in the AP.

**Trigger Condition**

When an AP's IPSec certificate is expiring in three days or less or has already expired.

**Clear Condition**

When a new IPSec certificate is generated and uploaded to the AP.

**Severity**

Minor

**Corrective Actions**

Regenerate a new certificate and upload it to the AP.

***

#### IPSec Connection Down

**What Does This Alert Mean?**

The AP has not yet established a successful IPSec connection with the Onyx Edge. As a result, S1 signaling activity is unlikely to occur.

**Trigger Condition**

IPSec tunnel between AP and Onyx Edge is not yet up or has gone down.

**Clear Condition**

When the IPSec tunnel between the AP and Onyx Edge is up.

**Severity:** Major

***

### Access Point Domain Proxy Alerts

#### CBSD Lesser BW Granted

**Trigger Condition**

When a CBSD has been granted less bandwidth than desired, and it continues to be in this state for at least five minutes.

**Clear Condition**

When either of the following conditions occur:

* The CBSD gets the desired bandwidth in a grant.
* The CBSD loses the grant.

**Severity**

Major

**System Impact**

The network capacity is reduced from what was planned.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Downlink/Uplink Traffic** tile: Traffic will reduce as bandwidth is reduced.
* Onyx Portal > **Dashboard** > **Data Usage** tile: Usage will not increase at the expected rate due to reduced bandwidth.

**Corrective Actions**

1. Check if any maintenance activity is currently in progress.
2. In the AP's DP logs, check Spectrum Inquiry Response to determine available frequencies (Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Logs** tab > **DP Logs** section).
3. If Strict Preference is enabled, disable it, if possible (Onyx Portal > **Equipment** > **Access Point** tab > edit AP's details > **RAN** tab > **Strict Preference** parameter), or change the frequency preference to obtain frequency with higher bandwidth (Onyx Portal > **Equipment** > **Access Point** tab > edit AP's details > **RAN** tab).
4. Contact GXC Technical Support.

**Resolution Verification**

1. All tiles have returned to their pre-incident state.
2. In the AP's details, verify the granted bandwidth (Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Overview** tab > **RAN** tile > **Bandwidth (MHz)** parameter).

**Related Alerts**

Access Point Domain Proxy [CBSD New Grant](#ap-cbsd-new-grant) Alert — Triggered in conjunction with the "CBSD Lesser BW Granted" alert.

***

#### CBSD New Grant <a href="#ap-cbsd-new-grant" id="ap-cbsd-new-grant"></a>

**Trigger Condition**

When new grants have been received within the last one hour.

**Clear Condition**

When no new grants have been received for at least one hour.

**Severity**

Warning

**System Impact**

This alert indicates a new grant has been received from SAS. For an AP that is already transmitting, it could change the transmission frequency, bandwidth, power, etc. The operator should verify the new grant will not affect the required KPIs.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Access Point** tile > **Service Status** icon: Depending on the grant authorization and previous transmission state of the AP, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F2xxlqY2KuMufXQuKW3FC%2Ficon-service-status-green.png?alt=media\&token=db1f821f-7450-405b-be9f-461d2dfbef9d) green or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FM1NxR5hHsBqHgbivnbJU%2Ficon-service-status-amber.png?alt=media\&token=33c8f18f-2627-4e1b-abed-e7af8f2ad5ae) amber.
* Onyx Portal > **Dashboard** > **Subscribers** tile:
  * If the new grant comes with a lower power level, subscribers at the edge may lose connection.
  * If the AP was not previously transmitting and the grant got authorized as well, previously unconnected subscribers in the coverage area can get connected.
* Onyx Portal > **Dashboard** > **Downlink/Uplink Traffic** tile: The traffic may change depending on AP's previous transmission state, grant authorization, and UE behavior. For example, a reduced bandwidth will not transmit as much data as before.
* Onyx Portal > **Dashboard** > **Data Usage** tile: The usage may change depending on the AP's previous transmission state, grant authorization, and UE behavior.
* Onyx Portal > **Dashboard** > **Access Point SAS Status** tile: Granted/Authorized CBSDs count may change depending on the CBSD's previous state.
* Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Overview** tab > **RAN** tile: SAS Status will move to Granted and generally to Authorized if no previous grants were available.
* Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Overview** tab > **Access Point Details** tile > **Service Status** icon: If the AP was not transmitting previously, the icon can be ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FcnCwMXwkQWe9TgqAvG9G%2Ficon-service-status-green.png?alt=media\&token=b08e1eb6-d057-4310-85e2-e30839cc9dce) green.

**Corrective Actions**

None.

**Resolution Verification**

None required for initial alert for an AP.

**Related Alerts**

Access Point Domain Proxy [CBSD Lesser BW Granted](#cbsd-lesser-bw-granted) Alert — Triggered if the new grant does not have the desired bandwidth.

**Additional Information**

* This is a notification when a new grant is received from SAS.
* As each grant change is a separate grant success, this alert can also be used to track grant changes. However, note that the very first grant is also tracked.

***

#### CBSD Preferred Frequency Unavailable <a href="#ap-cbsd-preferred-frequency-unavailable" id="ap-cbsd-preferred-frequency-unavailable"></a>

**Trigger Condition**

* In SC/DC mode, none of the frequencies in the preferred list are available with SAS.
* In CA mode, no non-overlapping frequency pair from the preferred list is available with SAS.

**Clear Condition**

Any of the following:

* Preferred frequencies are available again.
* CBSD is deregistered.

**Severity**

Warning

**System Impact**

* Network radio transmissions may not occur as planned, potentially causing interference from neighboring cells.
* This alert indicates that transmission on preferred frequencies is not fully possible. If Strict Preference is enabled, the AP will stop transmitting.
* In other cases, the AP will continue transmitting on whatever frequency is received via SAS grant.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* In case Strict Preference is disabled (Onyx Portal > **Equipment** > **Access Point** tab > view AP's details), the granted frequency would not be part of the preferred list.
* In case Strict Preference is enabled, see [Cell Transmission Down Indications](#cell-transmission-down-indications).

**Corrective Actions**

1. Change the preference list (Onyx Portal > **Equipment** > **Access Point** tab > edit AP's details > **RAN** tab).
2. The available frequency can be found in the "Spectrum Inquiry Response" log type (Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Logs** tab > **DP Logs** section > "Spectrum Inquiry Response" log type). Filter for "From SAS To DP logs".

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to their pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

***

#### CBSD Registration Failure <a href="#ap-cbsd-registration-failure" id="ap-cbsd-registration-failure"></a>

**Trigger Condition**

CBSD registrations have failed within the past hour.

**Clear Condition**

No CBSD registrations have failed for at least an hour.

**Severity**

Major

**System Impact**

The AP becomes non-functional, as it cannot obtain any grants to transmit.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > SAS Status: Will show Registered in red ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXQ7Izs9N5vXoAqD0664M%2Fimage.png?alt=media\&token=750c63fc-94be-4035-8440-9a738790219b). It may show amber in the case of Dual Carrier mode and one CBSD is registered.
* See [Cell Transmission Down Indications](#cell-transmission-down-indications).

**Corrective Actions**

1. Check the AP's DP logs for the failure reason and take necessary action (Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Logs** tab > **DP Logs** section).
2. The most probable cause is a mismatch of parameters between the Onyx Portal and the SAS Portal. Verify the CBSD registration on the Federated Wireless Portal has the correct information. Verify the FCC ID, Serial Number, CBSD Type and Category, Location, and Antenna parameters.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to their pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

***

### Access Point M-Plane Alerts

#### Offline <a href="#access-point-offline" id="access-point-offline"></a>

**Trigger Condition**

When no TR-069 Inform messages have been received for the past 20 minutes (15 minutes in alert condition + five minutes for changing the metric). This may occur, for example, if the AP is powered off.

**Clear Condition**

When TR-069 connection is re-established with the AP.

**Severity**

Major

**System Impact**

* Management access to the AP will be down. Configurations, alerts, events, metrics, etc. between the Onyx Portal and the AP will not be in sync.
* User traffic may be unavailable depending on the mode of failure.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Access Point** tile > **Online** icon: This AP is offline. Depending on other APs in the network, the **Online** icon may change to ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FygQOSD4mSOeelAB3dDgV%2Ficon-online-status-red.png?alt=media\&token=d5d793a9-9200-409f-841f-2aac11dc66c8) red or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQ1nsY8k3m48Xkz9wri5C%2Ficon-online-status-amber.png?alt=media\&token=a9964ef2-be34-4e9a-929c-cf6249ef975c) amber. Hover information shows the offline APs.
* Onyx Portal > **Dashboard** > **Access Point** tile > **Service Status** icon: Depending on other APs in the network, the **Service Status** icon may change to ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FWO5yHRDvhWoRGHigRe1R%2Ficon-service-status-grey.png?alt=media\&token=56a09e37-b11f-4cc9-bac1-761b1bd66df8) grey or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FflOL1yikiMpbNSKJjPUk%2Ficon-service-status-amber.png?alt=media\&token=a1913748-63b0-4b9b-8f70-ac003069c22c) amber.
* Onyx Portal > **Dashboard** > **Mesh Node** tile: If the AP service is down and it provides connection for the Mesh Node, the Mesh Node will also go offline.
* Onyx Portal > **Dashboard** > **Subscribers** tile: If the AP results in loss of online subscribers, the connected subscribers count will change.
* Onyx Portal > **Dashboard** > **Downlink/Uplink Traffic** tile: If S1 is down, the traffic will commensurately reduce.
* Onyx Portal > **Dashboard** > **Data Usage** tile: If S1 is down, the usage will commensurately reduce.
* Onyx Portal > **Dashboard** > **Access Point SAS Status** tile: For SAS-enabled APs that are not online for the last four hours:
  * If unregistered, it will not get registered until it is online.
  * Any grants will be relinquished, and the AP will move to Registered state.
* Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Overview** tab > **Access Point Details** tile > **Online** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FGwVfxQAGVZzuKxutX8sk%2Ficon-online-status-red.png?alt=media\&token=f9a063df-d045-47eb-8f76-02da9b5d4fe7) red. All other statuses will turn grey.

**Corrective Actions**

1. Check if any maintenance activity is currently in progress.
2. Check for any power outages at the equipment's location.
3. Verify that the AP is associated with the correct Onyx Edge.
4. Verify network connectivity between the AP and the Onyx Edge.
5. Get assistance from local AP technician.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Onyx Portal > **Dashboard**: All tiles return to their pre-incident states.

**Related Alerts** Onyx Edge (Core) MCU-Plane [Service Down](#service-down) Alert — Triggered if all APs connected to the Onyx Edge are offline.

***

#### TR-069 Session Stuck

**Trigger Condition**

The Access Point TR-069 session has started but not completed for more than 15 minutes, indicating the session is stuck in an error loop.

**Clear Condition**

The TR-069 session completes successfully.

**Severity**

Major

**System Impact**

* Configuration between the AP and the Onyx Portal will not be in sync; as a result, the AP will not function as expected.
* Potential loss of traffic.

**Indications**

* Onyx Portal > Dashboard > common counter indications.
* AP Details page:
  * AP Properties section:
    * **Config/FSM State** parameter will show **STUCK**
    * Hover over Config/FSM State to see Engineering Debug Info:
      * **Last Session Start Time** — Confirms when the session got stuck
      * **Last Session End Time** — Will be old or --, confirming the session did not complete

**Corrective Actions**

Check enodebd logs for errors related to the stuck TR-069 session.

**Resolution Verification**

* From the Dashboard:
  * The Alerts count has returned to the condition prior to the incident.
  * All tiles have returned to the condition prior to the incident.

**Related Alerts**

* [Access Point Offline](#access-point-offline)
* [Access Point Unexpected TR-069 Fault](#unexpected-tr-069-fault)

***

#### Unexpected TR-069 Fault

**Trigger Condition**

When unexpected TR-069 faults are received from AP in the last one hour.

**Probable Causes**

* One or more of the commands issued by the Onyx Edge (enodebd-service) was rejected by the AP.
* This alert could also trigger when grant details and the AP neighbor configurations are not compatible.

**Clear Condition**

When no unexpected TR-069 faults are received from the AP for at least one hour.

**Severity**

Minor

**System Impact**

* Configuration between the AP and the Onyx Portal will be out of sync; as a result, the AP will not be functioning as expected.
* Potential loss of traffic.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Access Point** tile > **Online** icon: If the problem causes the AP to go offline, depending on other APs, the **Online** icon may be ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXwq1q80kbPjoWszKlxeB%2Ficon-online-status-red.png?alt=media\&token=08f931ec-593d-48d8-afaa-b8f54ede0c9f) red or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F4ak6MIPYSCgh53z5mtQd%2Ficon-online-status-amber.png?alt=media\&token=7a187c1c-1876-43dc-bdea-c9b882ed9552) amber. Hover information shows the offline APs.
* Onyx Portal > **Dashboard** > **Access Point** tile > **Service Status** icon: If the problem repeats on every TR-069 session, the **Service Status** icon can fluctuate between ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FIGaIrd2Y1iTOjmnaIug0%2Ficon-service-status-red.png?alt=media\&token=0521d7df-c57d-4d03-8e01-70c3d58dfc30) red and ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F2OsP0Mzo8ewzEtVd3IAj%2Ficon-service-status-green.png?alt=media\&token=cd914d11-6e72-4281-a301-5e0045cbf0c6) green, or stay red, depending on the point in session at which the fault happens.
* Onyx Portal > **Dashboard** > **Mesh Node** tile > **Online** icon: If the fault is preventing enabling transmission in a currently non-transmitting AP, the Mesh Node will go offline ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FYhejSkYN5EWzHEhkT6PF%2Ficon-online-status-red.png?alt=media\&token=99aa2737-dc10-4206-8e09-f2b32723ae80).
* Onyx Portal > **Dashboard** > **Subscribers** tile: If the AP results in loss of online subscribers, the connected subscribers count will change.
* Onyx Portal > **Dashboard** > **Downlink/Uplink Traffic** tile: If S1 is down, the traffic will commensurately reduce.
* Onyx Portal > **Dashboard** > **Data Usage** tile: If S1 is down, the usage will commensurately reduce.
* Onyx Portal > **Dashboard** > **Access Point SAS Status** tile: For SAS-enabled APs having recurrent faults for the last four hours:
  * If unregistered, the AP will not get registered until it becomes free of faults.
  * If the AP has grants, they will be relinquished, and the AP will move to Registered state.
* Onyx Portal > **Dashboard** > **Backhaul (SGi) Health** tile: Only affected when AP is already in a non-transmitting state and fault is preventing the Onyx Edge from enabling transmission.

**Corrective Actions**

1. Check if any maintenance activity is currently in progress.
2. Navigate to the Events view (Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Events & Alerts** tab > **Events** section). The event associated with the fault typically provides additional details. It is possible that the fault is due to misconfiguration, and the event details usually identify the specific misconfigured parameter.
3. Check the AP's logs and resolve any errors (Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Logs** tab).
4. Check and update the specific parameter in the Onyx Portal and the AP equipment.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Onyx Portal > **Dashboard**: All tiles return to their pre-incident states.

**Related Alerts**

Access Point M-Plane [Offline](#access-point-offline) Alert

***

### Access Point MCU-Plane Alerts

#### Cell Unwarranted Transmission

**Trigger Condition**

When even though transmission is disabled, an AP's cell transmits for at least 15 minutes.

**Clear Condition**

When the cell stops transmission.

**Severity**

Major

**System Impact**

* The AP cell may transmit when not expected, potentially causing interference to neighboring radio equipment.
* This may result in a violation of federal spectrum regulations.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Access Point** tile > **Service Status** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fo8hqgv3fZAZuCcS4UGPX%2Ficon-service-status-amber.png?alt=media\&token=5f461f67-c74c-4c02-90a7-d922ff9f173f) amber.

**Corrective Actions**

1. Check if any maintenance activity is currently in progress.
2. Check the AP's events and alerts and resolve any faults (Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Events & Alerts** tab). Any faults will be represented as "unexpected\_fault\_received" event, and new alerts as "enb\_alarm\_raised" event.
3. Check the AP's logs and resolve any errors (Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Logs** tab).
4. Reboot the AP.
5. If the condition does not clear, contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Onyx Portal > **Dashboard**: All tiles return to their pre-incident states.

***

#### Mesh Filter-Frequency Mismatch

**Trigger Condition**

* The Mesh Node filter and frequency of its attached Mesh AP are in an incompatible state for at least five minutes.
* The frequency for Mesh AP attached to the Mesh Node is not compatible with filter settings on the Mesh Node. The filter setting is determined by the frequency of the Gateway AP to which the Mesh Node is attached.

**Clear Condition**

The Mesh Node filter and frequency of its attached Mesh AP become compatible.

**Severity**

Major

**System Impact**

* The Mesh system will not work, and the user may not get much feedback.
* The Mesh Node small cell filter will reject frequencies used by the Mesh AP, perhaps generating a VSWR fault on the AP, or the small cell hardware may not fault and instead simply fail to connect to any UE in the area (UE signal will be filtered out).
* Some devices can be damaged by Tx energy being returned.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).

**Corrective Actions**

* Check the frequency of the Gateway AP to which the Mesh Node is connected.
  * The frequencies of the Gateway AP and the Mesh Node's Mesh AP must be in opposite halves of the CBRS band (3550–3700 MHz).
  * The CBRS band is divided at 3625 MHz, where Low Band refers to the 3550–3625 MHz range, and High Band refers to the 3625–3700 MHz range.
* If the Mesh AP is in the same half of the CBRS band as the Gateway AP, move the Mesh AP to the opposite half.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to their pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

***

## DAS TP Alerts

### DAS TP Domain Proxy Alerts

#### CBSD New Grant <a href="#das-tp-cbsd-new-grant" id="das-tp-cbsd-new-grant"></a>

**Trigger Condition**

When new grants have been received from SAS in the last hour.

**Clear Condition**

When no new grants have been received for at least an hour.

**Severity**

Warning

**System Impact**

* For a DAS TP that is already transmitting, a new grant may change the transmission frequency, bandwidth, or power level.
* If sufficient power is not granted, transmission may be affected.
* Operators should verify that the new grant parameters will not adversely affect required KPIs.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Dashboard: Common Dashboard Counter Indication.
* DAS details page > SAS Status: Status will change to green or amber based on grant authorization state and the previous transmission state of the DAS TP.
* Subscribers tile:
  * If the new grant comes with a lower power level, subscribers at the edge may lose connection.
  * If the AP was not previously transmitting and the DAS grant got authorized as well, previously unconnected subscribers in the coverage area can get connected.
* CBRS SAS Status tile: The Granted/Authorized CBSDs count may change depending on the CBSD's previous state.
* DAS overview: SAS status will move to Granted and generally to Authorized if no previous grants were available.

**Corrective Actions**

None required. This is an informational alert.

**Resolution Verification**

None required for initial alert.

**Related Alerts**

* DAS TP [CBSD Registration Failure](#das-tp-cbsd-registration-failure)
* DAS TP [CBSD Preferred Frequency Unavailable](#das-tp-cbsd-preferred-frequency-unavailable)

**Additional Information**

* This alert serves as a notification when a new grant is received from SAS.
* Each grant change triggers this alert, allowing operators to track all grant modifications.
* The initial grant for a DAS TP also triggers this alert.

***

#### CBSD Preferred Frequency Unavailable <a href="#das-tp-cbsd-preferred-frequency-unavailable" id="das-tp-cbsd-preferred-frequency-unavailable"></a>

**Trigger Condition**

For DAS TPs, when the preferred frequency selected for the associated AP is unavailable from SAS.

**Clear Condition**

When any of the following occurs:

* The preferred frequency becomes available again.
* The CBSD is deregistered.

**Severity**

Warning

**System Impact**

* The associated AP and DAS TP will stop transmitting because the preferred frequency is not available from SAS.
* Subscribers in the coverage area will lose connectivity.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* DAS Associated AP Overview (Onyx Portal > **Equipment** > **Access Points** tab > view AP's details): The AP's configured frequency will not appear in the available SAS spectrum.

**Corrective Actions**

Change the AP frequency to an available frequency (Onyx Portal > **Equipment** > **Access Points** tab > edit AP > **RAN** tab).

To identify available frequencies:

* View the Available Spectrum graph for the DAS TP (Onyx Portal > **Equipment** > **DAS** tab > view DAS's details), or
* Check the Spectrum Inquiry Response log (Onyx Portal > **Equipment** > **DAS** tab > view DAS's details > **Logs** tab > **DP Logs** section > **Spectrum Inquiry Response** log type, filter for "From SAS To DP" logs).

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to their pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

***

#### CBSD Preferred Max Power Unavailable

**Trigger Condition**

When the preferred maximum power configured for the DAS TP is unavailable from SAS.

**Clear Condition**

When any of the following occurs:

* The preferred maximum power becomes available again.
* The CBSD is deregistered.

**Severity**

Warning

**System Impact**

* Radio transmissions are not operating as planned, potentially due to interference from neighboring cells.
* This alert indicates reduced transmission coverage caused by lower transmit power granted by the SAS.

**Indications**

DAS Associated AP Overview (Onyx Portal > **Equipment** > **DAS** tab > view DAS's details): The **Preferred Max Power** and **Granted Power** values will differ.

**Corrective Actions**

1. Identify available power levels: Check the Spectrum Inquiry Response log (Onyx Portal > **Equipment** > **DAS** tab > view DAS's details > **Logs** tab > **DP Logs** section > **Spectrum Inquiry Response** log type, filter for "From SAS To DP" logs).
2. Change the Preferred Max Power to an available value (Onyx Portal > **Equipment** > **DAS** tab > edit DAS's details > Transmission Point Details).

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Verify from the Dashboard that the alert has cleared.
* Confirm that the **Preferred Max Power** and **Granted Power** values match on the DAS details page (Onyx Portal > **Equipment** > **DAS** tab > view DAS's details).

***

#### CBSD Registration Failure <a href="#das-tp-cbsd-registration-failure" id="das-tp-cbsd-registration-failure"></a>

**Trigger Condition**

When CBSD registrations have failed within the past hour.

**Clear Condition**

When no CBSD registrations have failed for at least an hour.

**Severity**

Major

**System Impact**

The DAS TP is not transmitting because it cannot obtain grants from SAS without successful registration.

**Indications**

DAS Details Page (Onyx Portal > **Equipment** > **DAS** tab > view DAS's details > SAS Status): SAS State will display as Registered in red ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FHQaeqNJGmjHvnpBCD4Uj%2Ficon-sas-status-authorized-red.png?alt=media\&token=3a82933f-954d-4d39-9217-72b1478bb128) for the affected DAS TP.

**Corrective Actions** (perform in order)

1. Check the DAS DP logs for the failure reason and take the required action (Onyx Portal > **Equipment** > **DAS** tab > view DAS's details > **Logs** tab > **DP Logs** section).
2. The most probable cause is a parameter mismatch between the Onyx Portal and the SAS Portal.
3. Verify that the CBSD registration on the Federated Wireless portal has correct information. Verify FCC ID, serial number, CBSD type and category, location, and antenna parameters.

**Resolution Verification**

* Verify from the Dashboard that the alert has cleared.
* Confirm in the DAS details page (Onyx Portal > **Equipment** > **DAS** tab > view DAS's details > SAS Status) that the SAS State displays Registered in green ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FAnZbWCv9fd9UhZe6TuRp%2Fimage.png?alt=media\&token=43c39166-dff7-4e79-8538-63515311c3f0).

***

## Mesh Node Alerts

### Mesh Node Domain Proxy Alerts

#### CPE CBSD New Grant

**Trigger Condition**

When using the GM02 Mesh Node, one or more new grants have been received within the last hour.

**Clear Condition**

When no new grants are received within the last one hour.

**Severity**

Warning

**System Impact**

* This alert is triggered upon receiving a new grant from SAS. For a Mesh Node that is already in transmission, it may result in a change in transmission power.
* Operators should verify that the new grant will not affect the required KPIs.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Access Point** tile > **Service Status** icon: Based on grant authorization state and previous transmission state of the Mesh Node, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FOHNDqXplsIgLtKeBXaQL%2Ficon-service-status-green.png?alt=media\&token=b5ec69f6-5d1c-4a53-8a7a-fdac383601d5) green or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FytQM2MHvSYpVZ5GipljL%2Ficon-service-status-amber.png?alt=media\&token=7bc8c920-e4ae-4828-982f-4a035decd410) amber.
* Onyx Portal > **Dashboard** > **Access Point SAS Status** tile: Granted/Authorized CBSDs count may change depending on the CBSD's previous state.
* Onyx Portal > **Equipment** > **Mesh Node** tab > view Mesh Node's details > **Overview** tab: If no previous grants were available, SAS Status will move to Granted state and generally to Authorized state.
* Onyx Portal > **Equipment** > **Mesh Node** tab > view Mesh Node's details > **Overview** tab > **Mesh Node Details** tile > **Service Status** icon: If the Mesh Node was not transmitting previously, it can change to ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fx9TB9XIgCo80mg2MZJq0%2Ficon-service-status-green.png?alt=media\&token=5ac9ddcf-fa77-49e0-8961-a56bfbe27c88) green.

**Corrective Actions**

None.

**Resolution Verification**

None required for initial alert for a Mesh Node.

***

#### CPE CBSD Preferred Frequency or Bandwidth Unavailable

**Trigger Condition**

When using the GM02 Mesh Node, if the configured backhaul frequency or bandwidth to which the Mesh Node is connected becomes unavailable.

**Clear Condition**

When the preferred frequencies or bandwidth become available again.

**Severity**

Warning

**System Impact**

The Mesh Node is transmitting at reduced capacity and power and will not support any data traffic.

**Indications**

The GM02 Mesh Node will be online but does not have a grant.

**Corrective Actions**

1. Change the Mesh Node's backhaul frequency or bandwidth and reconnect.
2. The available frequency can be found in the "Spectrum Inquiry Response" log type (Onyx Portal > **Equipment** > **Mesh Node** tab > view Mesh Node's details > **Logs** tab > **DP Logs** section > "Spectrum Inquiry Response" log type). Filter for "From SAS To DP logs".

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to their pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

***

#### CPE CBSD Registration Failure

**Trigger Condition**

When using the GM02 Mesh Node, if one or more CPE CBSD registration attempts have failed within the last one hour.

**Clear Condition**

When no CPE CBSD registration failures occur for at least one hour.

**Severity**

Major

**System Impact**

The Mesh Node will become non-functional, as it cannot obtain any grants to transmit.

**Indications**

* Onyx Portal > **Equipment** > **Mesh Node** tab > view Mesh Node's details > **Overview** tab > SAS Status will show **Registered** in red ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FzLj4bB4Do1fn85XiYSFv%2Fimage.png?alt=media\&token=f749cbdc-3cae-4990-980d-24faf473eb44).
* The Mesh Node will be reported offline. See the Mesh Node M-Plane [Offline](#mesh-node-offline) alert.

**Corrective Actions**

1. Check the Mesh Node's DP logs for the failure reason and take necessary action (Onyx Portal > **Equipment** > **Mesh Node** tab > view Mesh Node's details > **Logs** tab > **DP Logs** section).
2. The most probable cause is a parameter mismatch between the Onyx Portal and the SAS Portal. Verify the CPE CBSD registration on the Federated Wireless Portal has the correct information. Verify the FCC ID, Serial Number, CBSD Type and Category, Location, and Antenna parameters.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to their pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

***

### Mesh Node M-Plane Alerts

#### Offline <a href="#mesh-node-offline" id="mesh-node-offline"></a>

**Trigger Condition**

When a Mesh Node has remained offline for at least 10 minutes.

**Clear Condition**

When the Mesh Node comes back online.

**Severity**

Critical

**System Impact**

Configurations, alerts, events, metrics, etc. between the Onyx Portal and Mesh Node will not be in sync.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Mesh Node** tile > **Online** icon: Depending on whether other Mesh Nodes are offline, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FaG2Nh6ANp7rfrIv9hWP0%2Ficon-online-status-amber.png?alt=media\&token=b3bf2124-4a80-4725-998f-243aa070aeae) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FU3shYkxRCNaxLKs5WZWL%2Ficon-online-status-red.png?alt=media\&token=31d58312-8a68-4447-a53c-707b962d9745) red.
* Onyx Portal > **Dashboard** > **Mesh Node** tile > **Service Status** icon: Depending on whether other Mesh Nodes are offline, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FeTm7hjL3leOH7dqo0Emx%2Ficon-service-status-amber.png?alt=media\&token=9a27f1e5-9eba-4370-8ff7-d058fd623716) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FDYn8wFL6Teltxq7R1pUp%2Ficon-service-status-grey.png?alt=media\&token=894fec5a-5592-4b06-8e67-23a219afb84e) grey.
* Onyx Portal > **Equipment** > **Mesh Node** tab > Mesh Nodes list > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FdNHyf7MRU1e6f2Gx1Kaz%2Ficon-compute-resource-status-red.png?alt=media\&token=5dfd2390-c349-47da-b253-9bf7e1c43fe6) red.
* Onyx Portal > **Equipment** > **Mesh Node** tab > view Mesh Node's details > **Overview** tab > **Mesh Node Details** tile > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FykxNnTdhG9ThAxt0zMUR%2Ficon-compute-resource-status-red.png?alt=media\&token=403396d5-b350-4d38-8975-69948bcc4b9f) red.

**Corrective Actions**

1. Check the Mesh Node's Internet connectivity.
2. Verify that the subscriber associated with the Mesh Node is connected and active.
3. If Internet connectivity is confirmed, ensure the Mesh Node is properly provisioned. Log on to the Mesh Node and run the `checkin_cli.py` command. Investigate and resolve any errors in the output.
4. Verify power supply to the Mesh Node equipment.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Onyx Portal > **Dashboard**: All tiles return to their pre-incident states.

***

### Mesh Node MCU-Plane Alerts

#### Tunnel Down

**Trigger Condition**

When the Mesh Tunnel between the Mesh Node and the Onyx Edge remains down for at least five minutes.

**Clear Condition**

When the Mesh Tunnel between the Mesh Node and the Onyx Edge is restored.

**Severity**

Major

**System Impact**

The Mesh AP behind the Mesh Node will not be configured, preventing UE from attaching to it.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Equipment** > **Mesh Node** tab > Mesh Nodes list > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FzHCm2Xw9fqaBO5ZxAlyD%2Ficon-compute-resource-status-red.png?alt=media\&token=f9547d7e-5625-492b-88a9-d33f58bc3787) red.
* Onyx Portal > **Equipment** > **Mesh Node** tab > view Mesh Node's details > **Overview** tab > **Mesh Node Details** tile > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXmwuQOkxa2YCkY98JQuC%2Ficon-compute-resource-status-red.png?alt=media\&token=7c216fbd-b314-4892-9822-0c8f92cf092e) red.

**Corrective Actions**

1. Check the Mesh Node's Internet connectivity.
2. Check if the subscriber associated with the Mesh Node is connected and active.
3. Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Onyx Portal > **Dashboard**: All tiles return to their pre-incident states.

***

#### Watchdog Powercycle

**Trigger Condition**

When the Mesh Node is power cycled by the Watchdog service within the last 10 minutes.

**Clear Condition**

When the Mesh Node Watchdog service has not triggered a power cycle on the Mesh Node for at least 10 minutes.

**Severity**

Minor

**System Impact**

* The mesh network will be affected until the Mesh Node reconnects and comes back online.
* UE will be unable to attach to the Mesh AP.

**Indications**

Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).

**Corrective Actions**

* Watchdog is triggered due to issues with the "cpe\_controller" service or modem identification. If the alert persists, contact GXC Technical Support.
* Check the alert's details for the cause.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to their pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

***

### Mesh Node Platform Alerts

#### CPU Usage <a href="#mesh-node-cpu-usage" id="mesh-node-cpu-usage"></a>

**Trigger Condition**

When a Mesh Node's CPU usage exceeds 70% of capacity in the last five minutes.

**Clear Condition**

When the Mesh Node's CPU usage drops below 70% of capacity.

**Severity**

Minor

**System Impact**

* Delays may occur in signaling and data processing at the Mesh Node.
* If CPU usage continues to rise, unexpected system behavior may occur.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Equipment** > **Mesh Node** tab > Mesh Nodes list > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FRUxC3pkamaLwjIVFv0Cc%2Ficon-compute-resource-status-red.png?alt=media\&token=5b38d343-8631-4dca-b6b5-a5652b141d9b) red.
* Onyx Portal > **Equipment** > **Mesh Node** tab > view Mesh Node's details > **Overview** tab > **Mesh Node Details** tile > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FLzx10kYUXsuhzjGpgngW%2Ficon-compute-resource-status-red.png?alt=media\&token=341872cd-21cf-4459-b7fe-2323e9211917) red.

**Corrective Actions**

Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Onyx Portal > **Dashboard**: All tiles return to their pre-incident states.
* Onyx Portal > **Equipment** > **Mesh Node** tab > view Mesh Node's details > **Overview** tab > **Mesh Node Details** tile > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKooyzRw3V8hH9uhQijgW%2Ficon-compute-resource-status-green.png?alt=media\&token=f322ccad-d3ef-4216-84d0-d67e384ab7f5) green.

***

#### Disk Usage <a href="#mesh-node-disk-usage" id="mesh-node-disk-usage"></a>

**Trigger Condition**

When a Mesh Node's disk usage exceeds 70% of capacity.

**Clear Condition**

When the Mesh Node's disk usage drops below 70% of capacity.

**Severity**

Major

**System Impact**

Delays in signaling and data processing at the Mesh Node.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Equipment** > **Mesh Node** tab > **Mesh Node** list > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FZGq9itSvORArJjDX4Ayl%2Ficon-compute-resource-status-red.png?alt=media\&token=eb84ed92-14b9-440a-99a2-fe1808b452ca) red.
* Onyx Portal > **Equipment** > **Mesh Node** tab > view Mesh Node's details > **Overview** tab > **Mesh Node Details** tile > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FFuLjvcsLqDuc39C61OuL%2Ficon-compute-resource-status-red.png?alt=media\&token=5da8109b-2fb8-41d1-9459-190e538f8c91) red.

**Corrective Actions**

Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Onyx Portal > **Dashboard**: All tiles return to their pre-incident states.
* Onyx Portal > **Equipment** > **Mesh Node** tab > view Mesh Node's details > **Overview** tab > **Mesh Node Details** tile > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fu0gFIJ722dP8FkBMXs2J%2Ficon-compute-resource-status-green.png?alt=media\&token=7050e286-81fb-4c6e-8e9b-b2826e554242) green.

***

#### Memory Usage <a href="#mesh-node-memory-usage" id="mesh-node-memory-usage"></a>

**Trigger Condition**

When a Mesh Node's memory usage exceeds 70% of capacity.

**Clear Condition**

When the Mesh Node's memory usage drops below 70% of capacity.

**Severity**

Minor

**System Impact**

Delays in signaling and data processing at the Mesh Node.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Equipment** > **Mesh Node** tab > Mesh Nodes list > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F3ESxDiBr0KD4kRrzSUBq%2Ficon-compute-resource-status-red.png?alt=media\&token=17c30002-f9d0-47ae-8396-5b3700a0ebef) red.
* Onyx Portal > **Equipment** > **Mesh Node** tab > view Mesh Node's details > **Overview** tab > **Mesh Node Details** tile > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F3NgezXZyfwk7wXO1KlAH%2Ficon-compute-resource-status-red.png?alt=media\&token=4e3aa68d-d0df-4920-8ca2-929a3c8253a5) red.

**Corrective Actions**

Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to their pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles return to their pre-incident states.
* Onyx Portal > **Equipment** > **Mesh Node** tab > view Mesh Node's details > **Overview** tab > **Mesh Node Details** tile > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fimtud18CpycnvdYwQSas%2Ficon-compute-resource-status-green.png?alt=media\&token=1765a66a-4ae6-4d93-9c19-cf42b671499d) green.

***

### Mesh Node Provisioning Server Alerts

#### Provisioning Server Connection Failure <a href="#mesh-node-provisioning-server-connection-failure" id="mesh-node-provisioning-server-connection-failure"></a>

**Trigger Condition**

When a Mesh Node has not successfully checked in with the Provisioning Server within the past 35 minutes.

**Clear Condition**

When the Mesh Node successfully checks in with the Provisioning Server.

**Severity**

Warning

**System Impact**

* A new Mesh Node will be unable to connect to the Onyx Portal or begin operations.
* For an existing Mesh Node:
  * If the keys have changed, it will be unable to get the updated keys from the Provisioning Server and will be unable to connect to the Onyx Portal.
  * If the keys have not changed, there will be no impact.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Mesh Node** tile > **Online** icon:
  * If the Mesh Node's unique keys have changed, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FioI0gPMznykfImkccoOb%2Ficon-online-status-red.png?alt=media\&token=7317c6b6-2ee7-4cda-b02b-f2688b49430c) red.
  * If the Mesh Node's unique keys have not changed, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FlNIcVQFtsQAByMbPNKHm%2Ficon-online-status-green.png?alt=media\&token=72e44ad1-b16d-42e4-b480-1c2efc50a6e1) green.

**Corrective Actions**

Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to their pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

***

## Onyx Edge (Core) Alerts

### Onyx Edge (Core) C-Plane Alerts

#### Authentication Failure

**Trigger Condition**

When one or more UE authentication failures (excluding "unknown user") occur within the last five minutes.

**Clear Condition**

When no UE authentication failures (excluding "unknown user") occur for at least five consecutive minutes.

**Severity**

Warning

**System Impact**

UE will not be able to connect to the network.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Equipment** > **Onyx Edge** tab > **Control Plane Transaction Status** tile: Shows Auth Request failures.

**Corrective Actions**

1. Typically, the cause is misconfiguration on the UE's SIM with its auth parameters (Onyx Portal > **Subscribers** > view subscriber's details > **AuthKey/Auth OPC**).
2. Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Affected UE attach as required and pass data traffic.

***

#### DHCP Server Failed

**Trigger Condition**

When the DHCP server, responsible for assigning IP addresses to UE, has been unavailable for five minutes.

**Clear Condition**

When the DHCP server becomes available.

**Severity**

Major

**System Impact**

* UE may not be able to obtain IP addresses for data connectivity.
* New data sessions will be impacted while existing sessions may continue to function.

**Indication**

Onyx Portal > **Dashboard** > common counter indications.

**Corrective Actions**

Check the DHCP server health in the network.

**Resolution Verification**

Onyx Portal > Alerts Counter Panel: Alert counts revert to pre-incident levels.

***

#### S1 Setup Failure

**Trigger Condition**

When there is an S1 Setup Request failure in the last five-minute window.

**Clear Condition**

When there are no S1 Setup Request failures in the last five-minute window.

**Severity**

Major

**System Impact**

AP will not be able to connect with the Onyx Edge.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Onyx Edge** tile > **Service Status** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXZC0y1BYRTqlKRPl1vlR%2Ficon-service-status-amber.png?alt=media\&token=4a9882de-1f18-4883-8cab-7ee3254a21ee) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FvLG2DAFqXSm0H4wlYxGr%2Ficon-service-status-red.png?alt=media\&token=d7d5b288-91f3-420a-9e69-761c70ee17e0) red, depending on how other APs are connected both in this and other Onyx Edge.
* Onyx Portal > **Dashboard** > **Access Point** tile > **Online** icon: May change to ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FCpCjyeXnCqLU5jE5AWLv%2Ficon-service-status-amber.png?alt=media\&token=d1ea1991-38bb-403b-b5e2-d93d728b9255) amber depending on whether the affected AP is a donor AP resulting in loss of connectivity to a Mesh AP.
* Onyx Portal > **Dashboard** > **Access Point** tile > **Service Status** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FarterMmLIZxS4sz808gc%2Ficon-service-status-amber.png?alt=media\&token=4c71f8b8-f5c8-4bb0-b0ee-c529e9ed2323) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fy7T5EaFjiYKHugIL4bJQ%2Ficon-service-status-red.png?alt=media\&token=afc64271-928f-42bc-b199-433e717c8a05) red depending on other AP statuses.
* Onyx Portal > **Dashboard** > **Mesh Node** tile > **Online** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FIVYzlZSlo3WcN6akHE7g%2Ficon-online-status-amber.png?alt=media\&token=4fa12b0a-4380-4fa4-8fc6-c9f827ad7b96) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FyNJnjttRJUmBmQCJW24s%2Ficon-online-status-red.png?alt=media\&token=5c54ea53-efe8-4aca-b961-cf94d89e8c9c) red depending on if this is a donor AP going offline.
* Onyx Portal > **Dashboard** > **Mesh Node** tile > **Service Status** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXisV01YUqxxMjIfFIAJ2%2Ficon-service-status-amber.png?alt=media\&token=b35470e8-1ade-4288-b0f6-218b17508724) amber or grey depending on whether other Onyx Edge are offline.
* Onyx Portal > **Dashboard** > **Subscribers** tile: Total subscribers impacted by this Onyx Edge will change to unknown.
* Onyx Portal > **Dashboard** > **Downlink/Uplink Traffic** tile: Reduces by the extent of traffic handled by the Onyx Edge.
* Onyx Portal > **Dashboard** > **Data Usage** tile: Reduces by the extent of traffic handled by the Onyx Edge.
* Onyx Portal > **Dashboard** > **Backhaul (SGi) Health** tile: Reduces by the extent of traffic handled by the Onyx Edge.

**Corrective Actions**

1. Check if any maintenance activity is currently in progress.
2. Check if any recent configuration changes have been made.
3. Check the AP's IPSec status (if used).
4. Verify that the TAC configuration between the Network and AP are the same (Onyx Portal > **Network** > **EPC** section > **TAC** parameter) and (Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > **Overview** tab > **RAN** tile > **TAC** parameter).

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Onyx Portal > **Dashboard**: All tiles return to their pre-incident states.

***

#### **SCTP Outbound Stalled**

**Trigger Condition**

SCTP inbound ordered chunks have been increasing over the last 15 minutes while SCTP outbound ordered chunks have remained flat.

**Clear Condition**

Outbound SCTP chunks resume normal flow, indicating the core is processing and responding to signaling messages again.

**Severity**

Major

**System Impact**

* The NGAP/NAS signaling layer on the Onyx Edge core is stalled — SCTP packets are arriving from the access network but the core is not sending any responses back.
* New UE procedures (attach, registration, handover, PDU session establishment) will fail because signaling responses are not being sent.
* Existing sessions may continue to pass user-plane traffic for a time, but any control-plane operation (e.g., service request, paging response, session modification) will time out.
* If the condition persists, APs may tear down their SCTP associations and trigger S1/NG Setup failures, leading to a broader service outage.

**Indications**

* Onyx Portal > **Dashboard** > common counter indications
* Onyx Portal > **Dashboard** > **Onyx Edge** tile > **Service Status** — May change to Red if the stall persists and signaling associations are lost
* Onyx Portal > **Dashboard** > **Subscribers** — Active subscriber count may begin to decline as UE procedures fail
* Onyx Portal > **Dashboard** > **Downlink/Uplink Traffic** — Control-plane stall may eventually impact data traffic as sessions cannot be established or modified

**Corrective Actions**

Contact GXC Support. There is no automatic recovery action for this condition.

**Resolution Verification**

From the Dashboard:

* The alerts count has returned to the condition prior to the incident.
* SCTP outbound chunk counters are incrementing normally.
* UE attach/registration procedures are succeeding again.

***

#### UE Attach Failure

**Trigger Condition**

When UE attach requests failed for reasons other than unknown user/IMEI validations in the last 15 minutes.

**Clear Condition**

When no UE attach requests fail for reasons other than unknown user/IMEI validations for at least 15 minutes.

**Severity**

Warning

**System Impact**

UE will be unable to attach to the network.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Equipment** > **Onyx Edge** tab > **Control Plane Transaction Status** tile: Shows Attach Request failures.

**Corrective Actions**

1. Verify the subscriber/IMSI is configured in the Onyx Portal (Onyx Portal > **Subscribers**).
2. Verify the subscriber's service status is set to Active (Onyx Portal > **Subscribers** > view subscriber's details > **Subscriber Details** section > **Service** parameter).
3. Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Affected UE attach as required and pass data traffic.

***

#### UE IMSI-IMEI Validation Failure

**Trigger Condition**

When a UE attach failure occurs due to IMSI-IMEI validation failure in the last 15 minutes.

**Clear Condition**

When there are no UE attach failures due to IMSI-IMEI validation failures in the last 15 minutes.

**Severity**

Warning

**System Impact**

Any of the following:

* Genuine UE are not able to attach to the network due to incorrect configuration.
* Illegal attempt to use the network.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Equipment** > **Onyx Edge** tab > **Control Plane Transaction Status** tile: Displays Attach Request failures.
* Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge's details > **Events & Alerts** tab: Displays IMEI-mismatch failures.

**Corrective Actions**

1. Check the Onyx Edge's Events (Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge's details > **Events & Alerts** tab > **Events**). Filter with "*stream: mme*" and look for "*Attach Reject*" events. This will show the offending IMSI and IMEI.
2. If the IMEI is not acceptable against the IMSI, there is nothing further to be done in the Onyx Portal. The user can check who is trying to attach with the wrong device.
3. If the IMEI is configured incorrectly, correct it (Onyx Portal > **Subscribers** > edit subscriber's details > **Subscriber** tab > **IMEI Verification** > **IMEI** parameter).

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Affected UE, if genuine, attach as required and pass data traffic.

***

#### UE Session Failure

**Trigger Condition**

When there are UE PDU Session Creation failures in the past five minutes.

**Clear Condition**

When there are no UE PDU Session Creation failures for at least five minutes.

**Severity**

Warning

**System Impact**

UE will not be able to access data services through CBRS.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Equipment** > **Onyx Edge** tab > **Control Plane Transaction Status** tile: Shows Create Session Request failures.

**Corrective Actions**

1. Check if the same APNs are configured in the subscriber and UE configurations (Onyx Portal > **Subscribers** > view subscriber's details > **Traffic Policy** section > **Active APNs**).
2. Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Affected UE attach as required and pass data traffic.

***

### Onyx Edge (Core) CU-Plane Alerts

#### HA Peer Down

**Trigger Condition**

When, in an Onyx Edge pool, the Primary ACS Onyx Edge detects a peer Onyx Edge is down. A peer Onyx Edge can be marked as "down" for the following reasons:

* S1 interface is down
* SGi interface is down
* Both S1 and SGi interfaces are down
* The peer Onyx Edge is powered down

The Primary ACS Onyx Edge detects a peer is down within 10 minutes of it going down.

**Clear Condition**

When the Primary ACS Onyx Edge detects that the peer Onyx Edge is operational.

**Severity**

Major

**System Impact**

When a peer Onyx Edge is reported as down, if the S1/SGi interface is also down, it will not be able to handle any UE traffic and is flagged as non-operational. A complete blackout will occur if all the Onyx Edge in a pool become non-operational.

**Indications**

Common Dashboard indications.

**Corrective Actions**

1. Check the Onyx Edge pool's status (Onyx Portal > **Equipment** > **Onyx Edge** tab > **Onyx Edge Pool** tile > view pool's details > **HA Connectivity Status** icon):
   * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQBHBnEOIonV6n1L1UpRC%2Ficon-interface-status-green.png?alt=media\&token=d6fce60f-e836-4299-a4b1-fd2d4ae4a386) green — One Onyx Edge is functioning as the Primary ACS, and the others as Standby ACS.
   * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F3ujIEqcoYEtUFyCGwXUR%2Ficon-interface-status-amber.png?alt=media\&token=2cd08986-7738-4a85-a4b2-5ee93736f0f5) amber — One Onyx Edge is functioning as the Primary ACS, but one or more of the other Onyx Edge are non-functional.
   * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FxLQLnX7NvrNF8KnYmctO%2Ficon-service-status-red.png?alt=media\&token=43d4d5a9-8fd0-4792-9ae2-8314a968f57e) red — All Onyx Edge are non-functional, or their status is not available.
   * &#x20;![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmkURSMVfyvixm51SQVym%2Ficon-service-status-grey.png?alt=media\&token=1ff38e69-050c-4436-98e9-18c7a11f29ee) grey — All Onyx Edge are offline.
2. Check if all the Onyx Edge in the pool are online (Onyx Portal > **Equipment** > **Onyx Edge** tab > **Onyx Edge Pool** tile > view pool's details > **Associated Onyx Edge** tile > **Online** column > **Online** icon):
   * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FOPqx90HIHOAK2mWzFW67%2Ficon-online-status-green.png?alt=media\&token=1610ad96-889b-488a-a89c-a97e92a22a92) green — The Onyx Edge has checked in with the Onyx Portal in the last five minutes.
   * ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQKgsPs4abw9SX69P9NFH%2Ficon-online-status-red.png?alt=media\&token=de13ad48-a3d9-4d46-b0db-ee797bcdf35a) red — The Onyx Edge has not checked in with the Onyx Portal in the last five minutes.
3. If the S1 interface is down, check the S1 connection between the peer Onyx Edge and APs. In a healthy S1 interface, the Onyx Edge should be able to ping each AP (Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge's details > **Actions** > **Command** > **Ping**). Verify physical connections, switch configuration, and VLAN assignments for both the Onyx Edge and APs.
4. If the SGi interface is down, check Internet connectivity. In a healthy SGi interface, the Onyx Edge should be able to ping the Internet (8.8.8.8) (Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge's details > **Actions** > **Command** > **Ping**). Verify physical connections, switch configuration, and VLAN assignments.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Onyx Portal > **Dashboard**: All tiles return to their pre-incident states.

***

#### IPSec Service Down

**Trigger Condition**

IPSec endpoint in the Onyx Edge is down and is not listening for new IPSec connection requests from APs.

**Clear Condition**

IPSec service is ready and is listening for connection requests from the APs.

**Severity**

Critical

**System Impact**

The network is down as the Onyx Edge is not ready to receive AP connections.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge's details > **Overview** tab > **Onyx Edge Details** tile > **IPSec Status** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8BE9is61hyk8G0nGyhIt%2Ficon-ipsec-status-red.png?alt=media\&token=faaca8d6-42f5-4add-ae32-87335ad8bc3a) red.

**Corrective Actions**

Contact GXC Technical Support.

**Resolution Verification**

Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.

***

#### IPSec Service Restarting Frequently

**Trigger Condition**

When the IPSec service on the Onyx Edge is restarting too frequently.

**Clear Condition**

When the IPSec service remains stable.

**Severity**

Major

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge's details > **Overview** tab > **Onyx Edge Details** tile > **IPSec Status** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FHIoUrWZBS8tgt90PlVyL%2Ficon-ipsec-status-red.png?alt=media\&token=83c7a953-bfd5-40ea-83e5-62f250aee867) red or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXMU6Oso1PDXfJMuFPmuX%2Ficon-ipsec-status-amber.png?alt=media\&token=31a478bb-b5f9-4df3-81ed-bd00c1c2bbf6) amber.

**Corrective Actions**

Contact GXC Technical Support.

**Resolution Verification**

Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.

***

### Onyx Edge (Core) M-Plane Alerts

#### Offline <a href="#onyx-edge-core-offline" id="onyx-edge-core-offline"></a>

**Trigger Condition**

When an Onyx Edge remains offline for at least 10 minutes.

**Clear Condition**

When the Onyx Edge comes back online.

**Severity**

Critical

**System Impact**

Configurations, alerts, events, metrics, etc. between the Onyx Portal and the Onyx Edge will be out of sync.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Onyx Edge** tile > **Online** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FrsluxL74zLTf4VXZ41gY%2Ficon-online-status-amber.png?alt=media\&token=ac3e2e42-7e5f-4ff8-ae16-c2f70fd9ead3) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FDMYkeRtKJeWaspB5jttx%2Ficon-online-status-red.png?alt=media\&token=774300ba-70d3-44ec-b7cc-350883bdad4b) red, depending on whether other Onyx Edge are offline.
* Onyx Portal > **Dashboard** > **Onyx Edge** tile > **Service Status** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F2taHWf85URpdtQ5k6WXy%2Ficon-service-status-amber.png?alt=media\&token=cfb3d3ee-b585-4fa0-a909-561148fc9ddf) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fizn57Ad9iK3xscRKvJSm%2Ficon-service-status-grey.png?alt=media\&token=239e5dd9-6ba1-44f7-bdf2-cab113524b54) grey, depending on whether other Onyx Edge are offline.
* Onyx Portal > **Dashboard** > **Access Point** tile > **Online** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FdgkyllbDd3KCwtFISz2T%2Ficon-online-status-amber.png?alt=media\&token=9f896acc-b2b7-47d8-99c2-365d65e0888f) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FrVlz7Llth1dgJP5a4FQe%2Ficon-online-status-grey.png?alt=media\&token=cfe001e0-7d02-4b57-9525-7bfd211c3465) grey, depending on whether other Onyx Edge are offline.
* Onyx Portal > **Dashboard** > **Access Point** tile > **Service Status** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F2f7WvGohnh6rBU99ctLv%2Ficon-service-status-amber.png?alt=media\&token=1d329960-59a1-4cee-8b65-2df2ea1640b1) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FIUd2JmBUnSYSMx5K1cji%2Ficon-service-status-grey.png?alt=media\&token=a13fc857-15b5-41b9-90a0-e34c3e12b995) grey, depending on whether other Onyx Edge are offline.
* Onyx Portal > **Dashboard** > **Mesh Node** tile > **Online** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FvIwS24nKBKC5Szhtstmr%2Ficon-online-status-amber.png?alt=media\&token=f89af9c3-4aff-48a6-9680-7f192b7e43a9) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F2mR1pTXaQ9Eo8NcVNUU8%2Ficon-online-status-grey.png?alt=media\&token=8cfb45b5-b189-410f-b745-ee33ba8be026) grey, depending on whether other Onyx Edge are offline.
* Onyx Portal > **Dashboard** > **Mesh Node** tile > **Service Status** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F7ETvGheTGF4EKVlJzfXo%2Ficon-service-status-amber.png?alt=media\&token=ec541987-0bcf-4ec7-ab0e-5bbf7e4a27a5) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FRPz0iBrgBT3hQlMrk7ji%2Ficon-service-status-grey.png?alt=media\&token=02a86c0b-651a-486f-9550-4b957f7a92b2) grey, depending on whether other Onyx Edge are offline.
* Onyx Portal > **Dashboard** > **Subscribers** tile: Total subscribers impacted by this Onyx Edge will change to Unknown.
* Onyx Portal > **Dashboard** > **Downlink/Uplink Traffic** tile: Reduces by the extent of traffic handled by the Onyx Edge.
* Onyx Portal > **Dashboard** > **Data Usage** tile: Reduces by the extent of traffic handled by the Onyx Edge.
* Onyx Portal > **Dashboard** > **Backhaul (SGi) Health** tile: Reduces by the extent of traffic handled by the Onyx Edge.

**Corrective Actions**

1. Check the Onyx Edge's Internet connectivity on the SGi interface. This cannot be done from the Onyx Portal when the Onyx Edge is offline. If another system, such as a remote laptop in the local network is accessible, ping the Onyx Edge to check if there is a local network issue, and then log on to the Onyx Edge to verify Internet connectivity.
2. At the Onyx Edge's location, verify power and connectivity to the equipment.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Onyx Portal > **Dashboard**: All tiles return to their pre-incident states.

***

### Onyx Edge (Core) MCU-Plane Alerts

#### Service Down

**Trigger Condition**

When any of the following is true:

* All APs are offline for five minutes.
* All APs are S1-disconnected for five minutes.
* Any critical services have restarted more than three times in the last five minutes.
* Any critical services are down for five minutes.

**Clear Condition**

When the trigger condition is resolved.

**Severity**

Critical

**System Impact**

The Onyx Edge may be offline or may not be functioning as expected, potentially causing UE to be unable to obtain service.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Onyx Edge** tile > **Service Status** icon: Depending on how other APs are connected both in this and other Onyx Edge, and how they are affected, will change to ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F4mIshEGGZWXHm9wtHGUW%2Ficon-service-status-amber.png?alt=media\&token=952cabbe-323f-456b-be21-97136d402169) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FbupKZnGTUABPY7NKMk7x%2Ficon-service-status-red.png?alt=media\&token=87ec7f4f-84a5-4309-bfda-eeca5f6c1c6a) red.
* Onyx Portal > **Dashboard** > **Access Point** tile > **Online** icon: Depending on whether APs are affected, may change to ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FaLe87X2fY6x92emTLxO8%2Ficon-online-status-amber.png?alt=media\&token=a4e60b64-ca9b-41f9-a4de-28f9c09c30b1) amber.
* Onyx Portal > **Dashboard** > **Access Point** tile > **Service Status** icon: Depending on whether APs are affected, will change to ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5OnIXZbJJvVHakZvNuZS%2Ficon-service-status-amber.png?alt=media\&token=101f65c5-5c3c-407f-8ede-b582a777df38) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fku8IcyfN6z2Y7YPreT6G%2Ficon-service-status-red.png?alt=media\&token=28d23c87-75a7-40c3-9e0d-6771114ea295) red.
* Onyx Portal > **Dashboard** > **Mesh Node** tile > **Online** icon: Depending on whether Mesh Nodes are affected, will change to ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FaGSrHwnBASSdXvFleWRD%2Ficon-online-status-amber.png?alt=media\&token=62cf9da4-af65-427f-83a7-655e3bd8127e) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FfJJpcf5bAiBRLp0pADPg%2Ficon-online-status-red.png?alt=media\&token=38ba2886-1895-4418-bef5-106966602e7e) red.
* Onyx Portal > **Dashboard** > **Mesh Node** tile > **Service Status** icon: Depending on whether Mesh Nodes are offline, will change to ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FBOKiVfn2u4FGamk6eYcR%2Ficon-service-status-amber.png?alt=media\&token=2c63f55a-56cb-45ab-88dd-c5be3beb7623) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fr3eGEqU6WD41A9Iya9EZ%2Ficon-service-status-grey.png?alt=media\&token=4c06ce41-8ef4-40bc-ab34-8f67ca10bbcc) grey.
* Onyx Portal > **Dashboard** > **Subscribers** tile: Total subscribers impacted by this Onyx Edge may change to Unregistered.
* Onyx Portal > **Dashboard** > **Downlink/Uplink Traffic** tile: Reduces by the extent of traffic handled by the Onyx Edge.
* Onyx Portal > **Dashboard** > **Data Usage** tile: Reduces by the extent of traffic handled by the Onyx Edge.
* Onyx Portal > **Dashboard** > **Backhaul (SGi) Health** tile: Reduces by the extent of traffic handled by the Onyx Edge.

**Corrective Actions**

1. Check if the Onyx Edge is properly provisioned.
2. If an AP is offline and the Access Point M-Plane [Offline](#access-point-offline) alert has triggered:
   1. Check for network connectivity issues between the AP and the Onyx Edge.
   2. Check if the AP is associated with the correct Onyx Edge.
3. If an AP is S1-disconnected and the Access Point C-Plane [S1 Disconnected](#s1-disconnected) alert has triggered:
   1. Check the AP's IPSec status.
   2. Check for any Access Point faults and alarm events (**Events & Alerts** tab).
4. If the above alerts have not been triggered, restart the Onyx Edge's services (Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge's details > **Actions** > **Restart Services**).

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Onyx Portal > **Dashboard**: All tiles return to their pre-incident states.

**Related Alerts**

* Access Point M-Plane [Offline](#access-point-offline) Alert
* Access Point C-Plane [S1 Disconnected](#s1-disconnected) Alert
* Onyx Edge (Core) M-Plane [Offline](#onyx-edge-core-offline) Alert

***

### Onyx Edge (Core) Platform Alerts

#### CPU Usage <a href="#onyx-edge-core-cpu-usage" id="onyx-edge-core-cpu-usage"></a>

**Trigger Condition**

When an Onyx Edge's CPU usage exceeds 70% of capacity in the last five minutes.

**Clear Condition**

When the Onyx Edge's CPU usage drops below 70% of capacity in the last five minutes.

**Severity**

Minor

**System Impact**

* Possible delays in signaling and data processing at the Onyx Edge.
* If CPU usage continues to rise, unexpected behaviors may be seen.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Equipment** > **Onyx Edge** tab > **Onyx Edge** list > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FeiahheeTwlSQ1SMV4FZH%2Ficon-compute-resource-status-red.png?alt=media\&token=151ef5b5-d6b7-4c07-a8bc-9ad344b75397) red.
* Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge's details > **Overview** tab > **Onyx Edge Details** tile > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FnyNM5yYImxHiDJ9ytHEi%2Ficon-compute-resource-status-red.png?alt=media\&token=ccee9bdb-dd75-4269-ba06-f0c2d72327ec) red.

**Corrective Actions**

Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Onyx Portal > **Equipment** > **Onyx Edge** tab > **Onyx Edge** list > **Compute Resource** icon: Depending on usage, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fk9NDLnm2orGFvQRnv3yR%2Ficon-compute-resource-status-amber.png?alt=media\&token=1581c993-415c-44fb-b79f-e80e779b8ba8) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FfjRW83XJTYEe4YF15kRG%2Ficon-compute-resource-status-green.png?alt=media\&token=95704eb4-6b75-4319-a462-e2ab551103ad) green.
* Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge's details > **Overview** tab > **Onyx Edge Details** tile > **Compute Resource** icon: Depending on usage, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fb79iplwW4OWs0urSoX2q%2Ficon-compute-resource-status-amber.png?alt=media\&token=7b87a840-a924-4d2b-86e7-8b7c68f4964c) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Ft0gvtrglgu49fRSAHVVU%2Ficon-compute-resource-status-green.png?alt=media\&token=687faf0a-ed81-49c7-96da-a0e8ef28219e) green.

***

#### Disk Usage <a href="#onyx-edge-core-disk-usage" id="onyx-edge-core-disk-usage"></a>

**Trigger Condition**

When an Onyx Edge's disk usage exceeds 70% of capacity in the last five minutes.

**Clear Condition**

When the Onyx Edge's disk usage drops below 70% of capacity in the last five minutes.

**Severity**

Major

**System Impact**

* If the disk usage continues to rise, it will eventually cause downtime on the Onyx Edge.
* The Onyx Edge might stop collecting critical logs that will be necessary to debug issues.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Equipment** > **Onyx Edge** tab > **Onyx Edge** list > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F6fTNa5zPBmqubCsw4Wqx%2Ficon-compute-resource-status-red.png?alt=media\&token=e795531f-afc7-427f-8ce0-7566d7d85200) red.
* Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge's details > **Overview** tab > **Onyx Edge Details** tile > **Compute Resource** icon: ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FG5CmDsdjDq5iQOsNHEP4%2Ficon-compute-resource-status-red.png?alt=media\&token=692f0433-8540-4702-8a75-a83db3cf91fa) red.

**Corrective Actions**

Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Onyx Portal > **Equipment** > **Onyx Edge** tab > **Onyx Edge** list > **Compute Resource** icon: Depending on usage, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FAQ6gVdq0fjrJpC2XPai4%2Ficon-compute-resource-status-amber.png?alt=media\&token=3a3a3a75-3e36-43be-acf9-5e2f46095d0d) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fr4OUPoYadON0xiPu68lj%2Ficon-compute-resource-status-green.png?alt=media\&token=462247c6-40de-489f-840f-4f4f83acdb54) green.
* Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge's details > **Overview** tab > **Onyx Edge Details** tile > **Compute Resource** icon: Depending on usage, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F4ISemHbOH2iGf3Sn95Xk%2Ficon-compute-resource-status-amber.png?alt=media\&token=79c3e6ee-d9d4-4515-a6eb-b7780e62a20e) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fho1xfND7uNSmcGHLRxY7%2Ficon-compute-resource-status-green.png?alt=media\&token=acaa612d-c699-4063-9f54-f05797571469) green.

***

#### Memory Usage <a href="#onyx-edge-core-memory-usage" id="onyx-edge-core-memory-usage"></a>

**Trigger Condition**

When an Onyx Edge's memory usage exceeds 70% of capacity.

**Clear Condition**

When the Onyx Edge's memory usage drops below 70% of capacity.

**Severity**

Minor

**System Impact**

If memory usage continues to rise, it could lead to downtime on the Onyx Edge.

**Indications**

Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).

**Corrective Actions**

If a significant portion of memory is being consumed by a few processes, try restarting the corresponding systemd services to see if memory usage recovers.

1. To sort processes by memory usage, run the following command:

   ```
   top -o RES
   ```
2. To find the corresponding systemd service, run the following command:

   ```
   systemctl status <PID>
   ```
3. To restart a service, run the following command:

   ```
   systemctl restart <service name>
   ```

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Onyx Portal > **Equipment** > **Onyx Edge** tab > **Onyx Edge** list > **Compute Resource** icon: Depending on usage, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5HK4ZgVuWUMDKNTLfWtT%2Ficon-compute-resource-status-amber.png?alt=media\&token=3330998b-bb6e-40d8-a9ac-42a4dbccfc8f) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FCuvIFYfk5bngZTiKuSzz%2Ficon-compute-resource-status-green.png?alt=media\&token=a54f6ea5-c90c-4b00-93fd-9d512813b463) green.
* Onyx Portal > **Equipment** > **Onyx Edge** tab > view Onyx Edge's details > **Overview** tab > **Onyx Edge Details** tile > **Compute Resource** icon: Depending on usage, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F6eFrOMt2JcNKpXKioYpV%2Ficon-compute-resource-status-amber.png?alt=media\&token=90b9459f-d859-485e-bcb1-76f3bc628ea0) amber or ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F3IrVgiuNC0UnJT3kihDl%2Ficon-compute-resource-status-green.png?alt=media\&token=8c173fb8-cc4b-4c10-a2d8-df352d723849) green.

***

### Onyx Edge (Core) Provisioning Server Alerts

#### Provisioning Server Connection Failure <a href="#onyx-edge-core-provisioning-server-connection-failure" id="onyx-edge-core-provisioning-server-connection-failure"></a>

**Trigger Condition**

When an Onyx Edge has not successfully checked in with the Provisioning Server within the past 35 minutes.

**Clear Condition**

When the Onyx Edge successfully checks in with the Provisioning Server.

**Severity**

Warning

**System Impact**

* A new Onyx Edge will be unable to connect to the Onyx Portal or begin operations.
* For an existing Onyx Edge:
  * If the keys have changed, it will be unable to get the updated keys from the Provisioning Server and will be unable to connect to the Onyx Portal.
  * If the keys have not changed, there will be no impact.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* Onyx Portal > **Dashboard** > **Onyx Edge** tile > **Online** icon:
  * If the Onyx Edge's unique keys have changed, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FSFfPWBQHv45X4ZC1gXWt%2Ficon-online-status-red.png?alt=media\&token=124f363c-77f7-4b5e-a365-1aef752e7b1e) red.
  * If the Onyx Edge's unique keys have not changed, ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FTOwchH1Zx9ewSGrKHlXe%2Ficon-online-status-green.png?alt=media\&token=b35dfd52-c22d-4df5-b8b6-ee92ac96bd22) green.

**Corrective Actions**

Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Alert counts revert to their pre-incident levels.
* Onyx Portal > **Dashboard**: All tiles revert to their pre-incident states.

***

## Orchestrator Alerts

### Orchestrator Domain Proxy Alerts

#### SAS Connection Failure

**Trigger Condition**

Any of the following:

* Could not connect to SAS for at least three times in the last 15 minutes.
* At least one HTTP error from SAS in the last 15 minutes.

**Clear Condition**

When there are no SAS connection errors and no HTTP errors for at least 15 minutes.

**Severity**

Critical

**System Impact**

This could potentially mean the entire network is down, at least those APs that are dependent on SAS for their grants.

**Indications**

* Onyx Portal > [Alerts Counter Panel Indication](#alerts-counter-panel-indication).
* In case of constant connection errors, the transmit timer could expire and result in the cells going down. See [Cell Transmission Down Indications](#cell-transmission-down-indications).
* Onyx Portal > **Equipment** > **Access Point** tab > view AP's details > SAS status: The SAS state may not progress if not authorized, and the Authorized state may eventually revert back to Granted state on timer expiry.

**Corrective Actions**

Contact GXC Technical Support.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Onyx Portal > **Dashboard**: All tiles return to their pre-incident states.

**Additional Information**

* There are two kinds of errors:

  * **HTTP errors** — Should not occur under normal conditions; typically indicate an SAS-side issue or fundamental breakage in DP.
  * **Transport-level errors** — May occur due to connectivity issues (unable to reach SAS) or security issues (server-side or client-side authentication failures).

  The type of error can be determined from the alert labels.
* SAS Connection Failure alerting generates a single consolidated alert at the network level instead of individual alerts per AP.

***

## Semi-Custom Alerts

Semi-custom alert rules are predefined by GXC but allow limited configuration changes, such as threshold values. These rules retain their core logic as defined by GXC but can be adjusted to better fit a specific network's operational needs.

### Semi-Custom Mesh Node MCU-Plane Alerts

#### **Mesh Node&#x20;*****\<serial number>*****&#x20;RSRP is Lower than Configured Threshold for 5 Minutes**

**Trigger Condition**

When a Mesh Node's RSRP remains below its configured RSRP threshold continuously for five minutes.

**Clear Condition**

When the Mesh Node's RSRP rises to or above its configured threshold and remains stable for five minutes.

**Severity**

Major

**System Impact**

Indicates weak signal coverage or degraded connectivity between the Mesh Node and serving cell, which can lead to reduced throughput or service drops.

**Indications**

* RSRP metric on the Mesh Node details page is below the configured limit (default: -100 dBm).
* End devices may experience reduced link stability.

**Corrective Actions**

* Check the Mesh Node's placement and antenna alignment.
* Investigate physical obstructions or environmental changes affecting signal propagation.
* Validate serving cell configuration and parameters.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Confirm the Mesh Node's RSRP is above threshold in real-time monitoring.

**Related Alerts**

* [Mesh Node \<serial number> RSRQ is Lower than Configured Threshold for 5 Minutes](#mesh-node-rsrq-lower-than-threshold)
* [Mesh Node \<serial number> SINR is Lower than Configured Threshold for 5 Minutes](#mesh-node-sinr-lower-than-threshold)

***

#### **Mesh Node&#x20;*****\<serial number>*****&#x20;RSRQ is Lower than Configured Threshold for 5 Minutes**

**Trigger Condition**

When a Mesh Node's RSRQ remains below its configured RSRQ threshold continuously for five minutes.

**Clear Condition**

When the Mesh Node's RSRQ rises above the configured threshold and remains stable for five minutes.

**Severity**

Major

**System Impact**

Indicates poor signal quality and/or high interference, potentially causing reduced spectral efficiency and degraded user experience.

**Indications**

* RSRQ metric on the Mesh Node's details page is below the configured limit (default: -15 dB).
* Throughput and session stability may be impacted even if RSRP is acceptable.

**Corrective Actions**

1. Identify and mitigate interference sources.
2. Check cell neighbor relations and handover parameters.
3. Verify antenna configuration and sector assignments.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Confirm the Mesh Node's RSRQ is above threshold in real-time monitoring.

**Related Alerts**

* [Mesh Node \<serial number> RSRP is Lower than Configured Threshold for 5 Minutes](#mesh-node-rsrp-lower-than-threshold)
* [Mesh Node \<serial number> SINR is Lower than Configured Threshold for 5 Minutes](#mesh-node-sinr-lower-than-threshold)

***

#### **Mesh Node&#x20;*****\<serial number>*****&#x20;SINR is Lower than Configured Threshold for 5 Minutes**

**Trigger Condition**

When a Mesh Node's SINR remains below the configured SINR threshold continuously for five minutes.

**Clear Condition**

When the Mesh Node's SINR rises above the configured threshold and remains stable for five minutes.

**Severity**

Major

**System Impact**

Indicates low signal-to-interference-plus-noise ratio, which can lead to reduced modulation schemes, slower data rates, and increased error rates.

**Indications**

* SINR metric on the Mesh Node's details page is below the configured limit (default: 13 dB).
* Possible increase in retransmissions and packet errors.

**Corrective Actions**

1. Investigate interference sources in the serving frequency band.
2. Optimize antenna orientation and tilt.
3. Adjust frequency plan or channel allocation if persistent.

**Resolution Verification**

* Onyx Portal > Alerts Counter Panel: Returns to pre-incident alert counts.
* Confirm the Mesh Node's SINR is above threshold in real-time monitoring.

**Related Alerts**

* [Mesh Node \<serial number> RSRP is Lower than Configured Threshold for 5 Minutes](#mesh-node-rsrp-lower-than-threshold)
* [Mesh Node \<serial number> RSRQ is Lower than Configured Threshold for 5 Minutes](#mesh-node-rsrq-lower-than-threshold)

## Related Documentation

* *4G Onyx Portal Operations Guide*
* *GXC Glossary*

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# 4G & 5G Firewall Configuration for Onyx Networks

Firewall configuration requirements for GXC Onyx 4G and 5G deployments is available upon request.

To obtain the appropriate firewall configuration details for your deployment, submit a request using the link below. A GXC representative will respond with the relevant information.

<p align="center"><a href="https://gxc.io/contact-us" class="button primary" data-icon="up-right-from-square">gxc.io/contact-us</a></p>

**What to include in your request:**

* Organization name
* Deployment type — 4G, 5G, or both
* Onyx Platform components being deployed: Onyx Edge, Access Points, FHM, Mesh Node


# 4G & 5G Onyx CBRS SAS Registration

## Introduction

The Citizens Broadband Radio Service (CBRS) is a shared spectrum service operating in the 3550–3700 MHz band (Band n48), regulated by the Federal Communications Commission (FCC) under *47 CFR Part 96*. The FCC established CBRS to expand access to mid-band spectrum by enabling federal and commercial users to share the band through a three-tier spectrum access model.

Before a CBSD can transmit on CBRS spectrum, it must register with an FCC-approved Spectrum Access System (SAS) and receive authorization to operate. The SAS coordinates spectrum access by authorizing spectrum grants, protecting higher-priority users from interference, and continuously managing spectrum availability throughout CBSD operation.

### **CBRS Spectrum Sharing**

The CBRS uses a three-tier spectrum access model to enable efficient spectrum sharing while protecting higher-priority users from interference. The SAS enforces this priority model by authorizing spectrum access according to the priority assigned to each tier.

<p align="center"><strong>Figure: Three-Tier Spectrum Access Model</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fkxu9YzfVv8fd81D5ibyU%2Fsas-3-tier.png?alt=media&#x26;token=f2f77ec6-cc1d-4bf1-85fd-192d5870b353" alt="" width="563"><figcaption></figcaption></figure></div>

* Tier 1 — Incumbents. The highest-priority tier, consisting primarily of U.S. Navy radar systems, Fixed Satellite Service (FSS) earth stations, and other federally authorized users. Incumbents receive full interference protection, when incumbent activity is detected, all lower-tier users must vacate spectrum.
* Tier 2 — Priority Access Licensees (PAL). Licensed users that acquire exclusive spectrum usage rights through FCC auctions. PAL users receive interference protection within their licensed geographic area but must yield to incumbent users when required.
* Tier 3 — General Authorized Access (GAA) users. License-by-rule access, available after incumbent and PAL users have been protected. GAA users operate on a shared, non-exclusive basis. Most private LTE and 5G CBRS deployments, including GXC Onyx deployments, use GAA spectrum.

The SAS continuously evaluates spectrum availability and authorizes spectrum access according to the CBRS priority model. As spectrum availability changes, the SAS may modify or revoke spectrum grants to protect higher-priority users.

### **Spectrum Access System**

The SAS is an FCC-approved cloud service that coordinates spectrum access for CBRS deployments. It authorizes spectrum operation by evaluating spectrum availability, enforcing the CBRS priority model, and protecting incumbent and licensed users.

The SAS performs four key functions:

* Registers and authenticates every CBSD before it may transmit
* Determines available frequencies at a given location and issues spectrum grants
* Enforces Exclusion Zones and Dynamic Protection Areas (DPAs) to protect federal incumbents
* Protects PAL holders from GAA interference on an ongoing basis

During normal operation, the SAS continuously monitors spectrum availability. When required, it may modify, suspend, or terminate active spectrum grants to maintain regulatory compliance and protect higher-priority users.

Environmental Sensing Capability (ESC) sensors complement the SAS by detecting federal incumbent activity in the 3550–3700 MHz band and adjacent frequencies. When incumbent activity is detected within a DPA, the SAS automatically reconfigures affected CBSDs by reassigning frequencies, reducing transmit power, or suspending transmissions until the incumbent ceases operation. This is normal SAS behavior and is handled automatically by the GXC Onyx platform.

### Domain Proxy

The Domain Proxy (DP) provides the communication interface between GXC Onyx and the SAS. Rather than requiring individual CBSDs to communicate directly with the SAS, the DP manages all communication with the SAS on behalf of every managed CBSD.

The DP performs two key functions:

* Registration and grant management — Submits CBSD registration and grant requests to the SAS on behalf of each CBSD.
* Heartbeat management — Sends periodic heartbeat messages to maintain grant authorization. If the SAS responds with a suspended grant, the DP flushes cached spectrum data, performs a new spectrum inquiry, and automatically attempts to obtain a replacement grant.

Because all SAS communication is performed through the DP, network operators manage CBSD registration and spectrum operations from the Onyx Portal without requiring direct communication between individual CBSDs and the SAS.

{% hint style="info" %}
**NOTE**: The DP facilitates communication with the SAS but does not make spectrum allocation decisions. Spectrum authorization and grant management remain the responsibility of the SAS.
{% endhint %}

### **SAS Provider**

GXC has chosen Federated Wireless as its primary SAS provider. However, the GXC Onyx platform is architecturally vendor-agnostic and is designed to integrate with any FCC-approved SAS.

The SAS portal procedures described in this guide are based on the Federated Wireless SAS portal. While portal interfaces and terminology may vary between SAS providers, the underlying CBSD registration, spectrum grant, and authorization workflow is standardized and functionally consistent across all FCC-approved SAS platforms.

### Certified Professional Installer

The FCC requires certain CBSD installation parameters to be verified and certified by a Certified Professional Installer (CPI) before they can be submitted for SAS registration. This requirement helps ensure that the SAS receives accurate installation information when authorizing spectrum operation.

A CPI is an individual who has successfully completed an FCC-recognized CBRS certification program and holds valid CPI credentials. Before certifying an installation, the CPI verifies that the installation parameters accurately represent the physical deployment. Installation parameters verified by the CPI include geographic location, installation height, antenna height above ground level (AGL), antenna azimuth, antenna downtilt (when applicable), antenna gain, deployment category (Category A or Category B), and any other installation parameters required for SAS registration.

After completing the verification, the CPI digitally certifies the installation record using their CPI credentials.

{% hint style="info" %}
**NOTE**: CPI certification is issued to an individual, not an organization. The individual CPI is responsible for the accuracy of every installation record they certify. See [*Roles & Responsibilities*](#roles-and-responsibilities) for a complete summary of CPI duties and authorization scope.
{% endhint %}

### Spectrum Grant Lifecycle

After a CBSD successfully registers, the SAS authorizes operation by issuing one or more spectrum grants. Each grant specifies the operating frequency range, bandwidth, maximum transmit power, and grant duration.

To maintain an active grant, the CBSD must periodically send heartbeat requests through the DP. If a heartbeat is not received within the required interval, or if spectrum availability changes, the SAS may suspend, modify, or terminate the grant.

This dynamic grant management enables efficient spectrum sharing while ensuring compliance with FCC regulations and protecting higher-priority users.

{% hint style="info" %}
**NOTE**: The SAS may modify or revoke an active spectrum grant at any time if incumbent activity is detected or spectrum must be reassigned to protect higher-priority users.
{% endhint %}

### **Scope of this Guide**

This guide describes the complete CBSD registration workflow for GXC Onyx deployments operating on CBRS Band n48, from pre-registration requirements through CPI certification, SAS portal configuration, Onyx Portal configuration, spectrum grant verification, and troubleshooting.

{% hint style="info" %}
**NOTE**: This guide assumes that the GXC Onyx network has already been deployed, powered on, commissioned, and verified as operational before CBSD registration begins.
{% endhint %}

{% hint style="info" %}
**NOTE:** For definitions of technical terms and acronyms used in this guide, refer to the *GXC Glossary*.
{% endhint %}

### Intended Audience

This guide is intended for the following roles involved in CBSD registration on Onyx CBRS deployments. Detailed task ownership for each stage of the workflow is described in [*Roles & Responsibilities*](#roles-and-responsibilities).

<p align="center"><strong>Table: Intended Audience</strong></p>

<table><thead><tr><th width="300">Role</th><th>Responsibilities</th></tr></thead><tbody><tr><td>Operator / Technical Staff</td><td>Manages the GXC Onyx network and equipment, configures RAN/SAS settings, and monitors grant status. Cannot register, modify, or delete CBSDs — a CPI is required.</td></tr><tr><td>CPI</td><td>Registers, modifies, deletes, and signs CBSD records in the SAS portal.</td></tr><tr><td>GXC / System Integrator</td><td>Provides platform support. Does not perform CPI duties on behalf of the operator by default.</td></tr></tbody></table>

## Prerequisites

Before registering CBSDs with the SAS, verify that the GXC Onyx deployment has been fully installed, commissioned, and validated. All required hardware, software, network connectivity, and regulatory prerequisites must be satisfied before registration can begin.

The following prerequisites apply to all GXC Onyx CBRS deployments.

### SAS Portal Account

The CPI must have an active SAS portal account with a validated CPI role, and a current CPI certification issued by an FCC-approved training provider.

The following CPI credentials must be available at the time of CBSD record signing.

<table><thead><tr><th width="250">CPI Credential</th><th>Description</th></tr></thead><tbody><tr><td>CPI ID</td><td>Unique identifier assigned by the CPI training and certification authority. The SAS uses this identifier to verify the certified installer.</td></tr><tr><td>CPI Name</td><td>The CPI's full name as it appears on the CPI certificate.</td></tr><tr><td>CPI Certificate (.p12)</td><td>A PKCS#12 certificate file containing the CPI's digital certificate and private key. It is used to cryptographically sign CBSD installation records.</td></tr><tr><td>Certificate Password</td><td>Password protecting the .p12 file, required at the time of signing.</td></tr></tbody></table>

{% hint style="info" %}
**NOTE**: CPI identity must be validated in the SAS portal at account setup — not during CBSD registration. Complete CPI validation when the account is created. If the certificate has expired, revalidate before attempting any CBSD registration or modification.
{% endhint %}

### Onyx Portal Account

The operator must have an active Onyx Portal account with administrator-level access.

### Network Requirements

Ensure that the Onyx Edge has been deployed, is reachable on the network, and has been verified as operational. The Onyx Edge must have outbound Internet access on port 443 (HTTPS) to the SAS endpoint. Firewall rules must permit DNS resolution and TCP connections to the SAS domain. For firewall requirements, see the *GXC Firewall Config Application Note*.

### Site Survey Data

For each CBSD to be registered, collect the following installation parameters during site survey prior to registration.

{% hint style="info" %}
**NOTE:** Site survey data may be collected by the operator, the CPI, or both working together. Regardless of who collects the data, the CPI is legally responsible for the accuracy of all parameters submitted to the SAS and must verify them against the physical installation before signing.
{% endhint %}

<p align="center"><strong>Table: Site Survey Data</strong></p>

<table><thead><tr><th width="200">Parameter</th><th width="200">Format / Units</th><th>Notes</th></tr></thead><tbody><tr><td>GPS Latitude / Longitude</td><td>Decimal degrees (WGS-84)</td><td>Use surveyed coordinates. The SAS uses these for interference calculations. Approximate values are not acceptable.</td></tr><tr><td>Antenna Height</td><td>Meters (AGL or AMSL)</td><td>Must be in meters, not feet. Above Ground Level (AGL) is the most common measurement.<br><strong>NOTE</strong>: Incorrect antenna height is one of the most common causes of registration failure.</td></tr><tr><td>Height Type</td><td>AGL or AMSL</td><td>AGL or Above Mean Sea Level (AMSL). Verify against site documentation.</td></tr><tr><td>Indoor Deployment</td><td>True / False</td><td>Determines CBSD category and maximum Equivalent Isotropic Radiated Power (EIRP) limits. Setting this incorrectly results in regulatory non-compliance.</td></tr><tr><td>Antenna Azimuth</td><td>0–359° (degrees)</td><td>Horizontal pointing direction of the antenna, measured clockwise from true north (0° = North, 90° = East, 180° = South, 270° = West).</td></tr><tr><td>Antenna Downtilt</td><td>Degrees</td><td>Mechanical and/or electrical downtilt angle.</td></tr><tr><td>Antenna Gain</td><td>dBi</td><td>Fixed per AP model. Do not estimate. See <a href="#onyx-cbrs-ap-reference"><em>Onyx CBRS AP Reference table</em></a>.</td></tr><tr><td>Max EIRP</td><td>dBm</td><td>Must not exceed CBSD category limits: Cat A ≤30 dBm, Cat B ≤47 dBm. See <a href="#onyx-cbrs-ap-reference"><em>Onyx CBRS AP Reference table</em></a> for model-specific limits.</td></tr></tbody></table>

### Onyx CBRS AP Reference

The following table provides the identity and CBSD classification for all GXC Onyx APs supporting CBRS band n48. Refer to this table when entering CBSD parameters in either portal.

<p align="center"><strong>Table: Onyx CBRS AP Reference</strong></p>

<table><thead><tr><th width="120">Model</th><th width="220">FCC ID</th><th width="100">Band</th><th width="109">Category</th><th width="100">Max EIRP</th><th width="129">Deployment</th><th>Antenna Gain</th></tr></thead><tbody><tr><td>G100</td><td>2AZH6GXI44XENBB1AA</td><td>n48 (4G)</td><td>Cat A</td><td>24 dBm</td><td>Indoor</td><td>4 dBi (internal, fixed)</td></tr><tr><td>G101</td><td>2AZH6GXO44XENBB1AA</td><td>n48 (4G)</td><td>Cat A / B*</td><td>24 dBm</td><td>Outdoor</td><td>13 dBi (external, fixed)</td></tr><tr><td>G501</td><td>2AZH6GXO44XENBB</td><td>n48 (4G)</td><td>Cat B</td><td>47 dBm</td><td>Outdoor</td><td>−5 to 30 dBi (variable)</td></tr><tr><td>G105-n48F</td><td>2AQ68RPQN4800</td><td>n48 (5G)</td><td>Cat A</td><td>24 dBm</td><td>Indoor</td><td>0–24 dBi (default: 24)</td></tr><tr><td>G105-n48P</td><td>VUIPR1450-48</td><td>n48 (5G)</td><td>Cat A</td><td>20 dBm</td><td>Indoor</td><td>0–20 dBi (default: 20)</td></tr><tr><td>G505-n48P</td><td>2AZULRS8682</td><td>n48 (5G)</td><td>Cat A</td><td>37 dBm</td><td>Outdoor</td><td>0–37 dBi (default: 37)</td></tr></tbody></table>

{% hint style="info" %}
**NOTE**: \* The G101 AP may be registered as Category A or Category B CBSD depending on its installed height and Height Above Average Terrain (HAAT). The FCC threshold for an outdoor Category B deployment is >6m HAAT. Verify the deployment category using the site survey before selecting the CBSD category.
{% endhint %}

### Roles & Responsibilities

Successful CBSD registration requires coordination between the Operator, the CPI, and GXC/System Integrator. Each participant has distinct responsibilities throughout the registration process.

The following table summarizes the primary responsibilities for each role.

{% hint style="info" %}
**NOTE**: Only a CPI may register, modify, or delete CBSD records in the SAS portal. This requirement is defined by *FCC Part 96 and WInnForum WINNF-TS-0016*. Operator accounts alone are insufficient — a CPI must validate and digitally sign every CBSD installation record.
{% endhint %}

<p align="center"><strong>Table: Roles &#x26; Responsibilities</strong></p>

<table><thead><tr><th width="214.5556640625">Role</th><th width="350.4444580078125">Responsibilities</th><th>Who Performs It</th></tr></thead><tbody><tr><td>Operator / Organization</td><td>• Owns the CBRS network and SAS account • Sets up the network deployment in the SAS portal • Configures Onyx Portal (RAN/SAS settings) • Monitors spectrum grant status • Cannot register, modify, or delete CBSDs without a CPI</td><td>Network operator or their designated team</td></tr><tr><td>CPI</td><td>• Only role authorized to register, modify, or delete CBSDs • Validates and digitally signs CBSD installation parameters • Must verify CPI credentials in the SAS portal before any CBSD work • Required for all CBSD registrations on GXC Onyx. Because GXC Onyx uses Multi-Step Registration exclusively, every record — including indoor Category A CBSDs — must be CPI-signed.</td><td>FCC-certified individual with active CPI credentials</td></tr><tr><td>GXC / System Integrator</td><td>• Provides Onyx platform and DP integration • Assists with portal configuration and troubleshooting • Does not perform CPI duties on behalf of the operator by default</td><td>GXC or certified integration partner</td></tr></tbody></table>

## CBRS Registration Overview

This section describes the two-portal CBRS registration process, including how it works, who is involved at each stage, and what is required before registration can begin. Detailed procedures and responsibilities are described in the following sections.

### How CBRS Registration Works

CBRS registration in GXC Onyx deployments uses Multi-Step Registration as defined by WInnForum *(WINNF-TS-0016, Section 10)*. This is a two-portal, two-actor process.

<table><thead><tr><th width="200">System</th><th>Description</th><th width="150">Actor</th></tr></thead><tbody><tr><td>SAS Portal</td><td>Receives and stores CPI-signed installation parameters, validates the CBSD record, and issues spectrum grants.</td><td>CPI + Operator</td></tr><tr><td>GXC Onyx Portal</td><td>Configures the AP/cell with RAN and SAS settings. The DP submits the registration request to the SAS on behalf of the CBSD.</td><td>Operator</td></tr></tbody></table>

### Multi-Step vs. Single-Step Registration

GXC Onyx deployments use Multi-Step Registration exclusively. Understanding this registration model because it defines the dependency between the SAS portal and the Onyx Portal throughout this guide.

* Multi-Step Registration (used by GXC Onyx) — The CPI pre-enters the installation parameters in the SAS portal and digitally signs the CBSD record before the CBSD submits its registration request. When the Onyx Portal initiates registration, the SAS cross-validates the CPI-signed record stored in the SAS portal with the registration request received from the CBSD through the DP. If either input is missing, incomplete, or does not match, the SAS rejects the registration request.
* Single-Step Registration — The CBSD submits all installation parameters directly in its registration request without a previously signed CPI record. This method is permitted only for certain indoor Category A CBSDs and is not used in standard GXC Onyx deployments.

## CBSD Registration Workflow

The following workflow must be completed in sequence. Performing steps out of sequence will result in registration failure.

<p align="center"><strong>Figure: CBSD Registration Workflow</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5AgY2Sit1OAA9aePmlhz%2Fsas-cbsd-registration-workflow.png?alt=media&#x26;token=7784e408-ec4f-4c3b-b494-b38bc8663c81" alt=""><figcaption></figcaption></figure></div>

{% stepper %}
{% step %}
Pre-Registration:

* Operator: Gather site survey data for each CBSD. See [*Site Survey Data*](#site-survey-data).
* CPI: Verify that CPI certification is current, CPI credentials are available, and CPI identity has been validated in the SAS portal.
* Operator: Confirm access to Onyx Portal and verify that the Onyx Edge is reachable on the network.
  {% endstep %}

{% step %}
SAS Portal: Create Network Deployment and CBSD Records:

1. Operator: Create a network deployment in the SAS portal if one does not already exist.
2. Operator: Add each CBSD to the deployment and enter all installation parameters.
3. CPI: Review and validate all installation parameters, then digitally sign each CBSD record.
4. SAS: Signed CBSDs display a "Pending Registration" status and are ready to receive registration requests from the DP.
   {% endstep %}

{% step %}
GXC Onyx Portal: Configure and Register:

1. Operator: Add APs/cells to the Onyx Portal and configure the required RAN and SAS settings.
2. Onyx: Automatically submits CBSD registration requests to the SAS after the AP/cell configuration is saved.
3. SAS: Validates the CPI-signed CBSD record in the SAS portal against the registration request received from the CBSD.
4. SAS: If validation succeeds, issues one or more spectrum grants.
   {% endstep %}

{% step %}
Verify:

* Operator: In the Onyx Portal, verify that all CBSDs show an Authorized status.
* Operator: In the SAS portal, verify that all CBSDs show a Registered status.
* Operator: Confirm that spectrum grants are active and CBSDs are transmitting.
* Operator: Verify that there are no active SAS-related alerts in the Onyx Portal. See [*Troubleshooting > Onyx Portal SAS-Related Alerts*](#onyx-portal-sas-related-alerts).
  {% endstep %}
  {% endstepper %}

### SAS Portal Procedures

The SAS Portal procedures prepare CBSD records for registration with the SAS. The following workflow diagram summarizes the sequence of tasks and the responsibility for each step.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fl40Df9TwBVVLE0lWgeuQ%2Fsas-workflow-sas-portal-procedures.png?alt=media&#x26;token=d40f8ab7-d61c-46f1-8ec8-c4f7dd64199f" alt="" width="563"><figcaption></figcaption></figure></div>

{% hint style="info" %}
**NOTE**: This guide uses the Federated Wireless SAS portal for all procedures, screenshots, and navigation examples. Other FCC-approved SAS platforms follow the same CBSD registration workflow, although user interfaces and navigation may differ.
{% endhint %}

#### CPI Account Setup (One-Time)

Before a CPI can certify CBSD installation records, the CPI must associate their WInnForum-issued CPI credentials with their SAS account. This one-time configuration enables the SAS to validate digital signatures submitted during CBSD registration.

Only the CPI can complete this procedure because the CPI's digital certificate and private key remain under their exclusive control and are used to generate digitally signed certification records. This step cannot be delegated to another user.

After the CPI credentials have been successfully associated with the SAS account, the account is authorized to digitally certify CBSD installation records. Each digital signature cryptographically binds the CPI's identity to the certified installation parameters submitted during CBSD registration.

{% hint style="info" %}
**NOTE**: A CPI must successfully validate their credentials before signing CBSD installation records. Until CPI validation is complete, the SAS will not authorize the account to certify installation parameters for CBSD registration.
{% endhint %}

{% hint style="info" %}
**NOTE**: CPI credentials are associated with the SAS account only once. They remain available for future CBSD registrations unless they are removed, replaced, or expire.
{% endhint %}

{% hint style="info" %}
**NOTE**: The CPI certificate (.p12) contains the CPI's digital certificate and private key. The private key is used to generate digital signatures and must remain under the CPI's control.
{% endhint %}

**To configure CPI credentials:**

{% stepper %}
{% step %}
Log in to the SAS portal using your CPI account.
{% endstep %}

{% step %}
Navigate to the **Profile** or **CPI Settings** page.
{% endstep %}

{% step %}
Configure the required CPI information, including:

* CPI Registration ID (CPIR-ID)
* CPI Certification ID
* FCC FRN (if required)
* CPI certificate (`.p12`)
* Certificate password

See [*Prerequisites > SAS Portal Account*](#sas-portal-account) for more information.
{% endstep %}

{% step %}
Complete the verification/activation process.

A confirmation message indicates your credentials are active and the account has CPI signing privileges.
{% endstep %}
{% endstepper %}

#### Create a Network Deployment

This step is performed by the operator or personnel responsible for managing the organization's SAS account.

Before adding CBSDs, create a network deployment in the Spectrum Access System (SAS) portal. The deployment represents the physical site where the CBSDs will be installed and provides the location context used during CBSD registration and spectrum management. A deployment is typically created once for each site and can contain one or more CBSDs.

Each deployment is associated with the operator's SAS account, which governs spectrum access permissions and billing for all CBSDs within the deployment.

**To create a network deployment:**

{% stepper %}
{% step %}
Log into the SAS portal.

The home screen displays a summary of all existing CBSD deployments across your organization.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FbTyZY64UWmJ2VayGx2yU%2F01_dashboard.png?alt=media&#x26;token=934eb3fd-2398-4fb7-b0ba-3b590a30ba19" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the left navigation, click **Installation**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FfLj03hLk5d3M4AG7pVHW%2F02_installation-menu.png?alt=media&#x26;token=f7e777d1-8b60-413a-a8c7-a435702295dd" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click **New Deployment**.
{% endstep %}

{% step %}
Enter the deployment name, operator account, and geographic region.
{% endstep %}

{% step %}
Click **Save**.

The new deployment appears in the Installation list, ready to receive CBSD records.
{% endstep %}
{% endstepper %}

#### Add CBSD Records

This step is performed by the operator using installation parameters provided by, or verified with, the CPI.

After creating the deployment, add a CBSD record for each AP or radio that will operate at the site. Each CBSD record contains the installation parameters that the CPI reviews and digitally signs before the device can be registered.

While operators may enter and manage CBSD records in the portal, the accuracy of physical parameters — location, height, azimuth, gain, Equivalent Isotropic Radiated Power (EIRP) capability, and category — is the CPI's legal responsibility.

**To add a CBSD record, for each CBSD at the site:**

{% stepper %}
{% step %}
In the SAS portal's left navigation, click **Installation**.

The **Installation** screen displays all existing CBSD records on a map and in a list view.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F4NcKhEZjV9mxZGwKEe7N%2F03_home-installation-screen.png?alt=media&#x26;token=10f0bd69-1db5-4d40-bf94-5f6901bacc26" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the toolbar, click<img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FB02dyUN7s1GUUw9bK5ex%2Fimage.png?alt=media&#x26;token=e2171bcb-c263-4975-9770-ac9d18ca9014" alt="" data-size="line"> (Add New CBSD Config) icon.

The configuration form opens alongside the map.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F2TAdfihbSk4mF39aFyrn%2F05_cbsd-information-installation-parameters-1.png?alt=media&#x26;token=5b9af235-9436-46ce-af7a-ccf81d6a473c" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the installation parameters. Required fields are marked **\***.

Refer to the [*Onyx CBRS AP Reference table*](#onyx-cbrs-ap-reference) for device information and your site survey data for location information (see [*Site Survey Data table*](#site-survey-data)*)*.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FLFMyxVV135DQdQioPm7E%2Fcbsd-information-installation-parameters.png?alt=media&#x26;token=5da7d54b-dd73-43f1-b73c-cc0ebc1e2e40" alt="" width="491"><figcaption></figcaption></figure></div>

{% hint style="info" %}
**NOTE**: Enter all installation parameters accurately. The SAS compares the CPI-signed CBSD record stored in the SAS portal with the registration request submitted later by the DP. Any missing or mismatched parameters will cause registration to fail.
{% endhint %}
{% endstep %}

{% step %}
To save the CBSD record, click **Submit**.

The CBSD appears on the map with **Unregistered** status.
{% endstep %}

{% step %}
To mark the record as ready for CPI review and signing, click **Ready for CPI**.

{% hint style="info" %}
**NOTE**: The Onyx Portal automatically submits the CBSD registration request to the SAS as soon as the SAS-enabled AP or cell configuration is saved. Ensure every CBSD record has been reviewed and signed by the CPI in the SAS portal before saving that configuration in the Onyx Portal. If the configuration is saved while CPI signing is still incomplete, Onyx will submit the registration attempt automatically anyway, and the SAS will reject it.
{% endhint %}

{% hint style="info" %}
**NOTE**: If any installation parameters are updated after CPI signing, the SAS portal will flag the CBSD as requiring re-registration. The CPI must re-sign the record before registration can be re-triggered.
{% endhint %}

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FjPW19zLPt8mDAj7NQXkm%2F11_confirmation-message.png?alt=media&#x26;token=947ffc06-e79c-49ea-b138-c504900fcb07" alt=""><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}

#### Sign CBSD Records

After installation parameters have been entered, a CPI must review and digitally certify the information before the CBSD can be registered with the SAS.

Only the CPI associated with the verified SAS account can perform this operation. During signing, the SAS uses the CPI's validated credentials to generate a digital signature that cryptographically associates the CPI's identity with the installation parameters.

Before signing a CBSD record, the CPI is responsible for independently verifying that all installation information accurately reflects the physical deployment. This includes, as applicable, the device location, antenna configuration, installation height, azimuth, and other installation parameters required for SAS registration. By digitally signing the record, the CPI certifies the accuracy of the installation data and assumes responsibility for the information in accordance with FCC Part 96 requirements.

**To sign CBSD installation records:**

{% stepper %}
{% step %}
Log in to the SAS portal using your verified CPI account.
{% endstep %}

{% step %}
In the left navigation, click **Installation**.
{% endstep %}

{% step %}
Locate the CBSD that requires CPI certification.
{% endstep %}

{% step %}
Open the CBSD installation record.
{% endstep %}

{% step %}
Verify that all installation parameters are complete and accurate.
{% endstep %}

{% step %}
Click **Sign** to digitally certify the installation record.
{% endstep %}

{% step %}
Confirm that the CBSD status indicates the record has been signed and is ready for SAS registration.

After the record has been signed, the Onyx Portal can submit the CBSD registration request to the SAS.
{% endstep %}
{% endstepper %}

{% hint style="info" %}
**NOTE**: Any modification to CPI-signed installation parameters invalidates the existing digital signature. Before the CBSD can be registered with the SAS, the CPI must review the updated information and re-sign the installation record.
{% endhint %}

### GXC Onyx Portal Procedures

The GXC Onyx Portal procedures configure the SAS-related settings required before CBSD registration. Technology-specific differences for 4G and 5G deployments are documented in the respective subsections. The following workflow diagram summarizes the configuration steps for each deployment type.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FNIOwBJ5hsNYxMhzmdpmj%2Fsas-workflow-gxc-op-procedure.png?alt=media&#x26;token=2d448aba-f142-4c5c-8d2b-0e1635cca504" alt="" width="563"><figcaption></figcaption></figure></div>

#### Common SAS Configuration Parameters

The following table describes the SAS-related parameters configured in the Onyx Portal. These parameters apply to both 4G and 5G deployments and are referenced in the configuration steps below.

<p align="center"><strong>Table: Common SAS Configuration Parameters</strong></p>

<table><thead><tr><th width="200">Parameter</th><th>Description</th><th>Guidance</th></tr></thead><tbody><tr><td><strong>Operation Mode</strong></td><td><strong>SAS</strong> enables CBRS spectrum access via the Spectrum Access System.</td><td><strong>Manual,</strong> the default mode, disables SAS integration entirely; must never be used for CBRS.</td></tr><tr><td><strong>User ID</strong></td><td>SAS account's user ID for CBSD registration and authentication.</td><td>Must match exactly what's in the SAS portal — a mismatch causes MISSING_PARAM/INVALID_VALUE rejection.</td></tr><tr><td><strong>CBSD Category</strong></td><td>FCC power class for the CBSD.</td><td>Cat A ≤30 dBm EIRP (typically indoor/short-range), Cat B ≤47 dBm EIRP (typically outdoor). Must match what's certified for the Device Class and what the CPI signs in the SAS portal. For device-specific limits, see <a href="#onyx-cbrs-ap-reference"><em>Onyx CBRS AP Reference table</em></a>.</td></tr><tr><td><strong>Antenna Gain (dBi)</strong></td><td>Gain of the installed antenna.</td><td>Do not estimate — use spec values. See <a href="#onyx-cbrs-ap-reference"><em>Onyx CBRS AP Reference table</em></a>.</td></tr><tr><td><strong>Preferred Max Pwr (dBm)</strong></td><td>Maximum transmit EIRP requested for this CBSD.</td><td>Must not exceed the CBSD Category limit — for Cat A, ≤30 dBm. See <a href="#onyx-cbrs-ap-reference"><em>Onyx CBRS AP Reference table</em></a>.</td></tr><tr><td><strong>Preferred BW (MHz)</strong></td><td>Requested channel bandwidth: 10 or 20 MHz.</td><td>10 MHz is recommended for most indoor deployments; 20 MHz for higher-capacity outdoor cells. If the preferred bandwidth isn't available, the Domain Proxy will automatically fall back to a narrower one unless Strict Freq Preference is enabled.</td></tr><tr><td><strong>Preferred Freq (MHz) in priority order</strong></td><td>The CBSD's preferred operating frequencies within the CBRS band, in priority order.</td><td>5 MHz increments. Within 3555–3695 MHz for 10 MHz BW, or 3560–3690 MHz for 20 MHz BW. Default: Auto.</td></tr><tr><td><strong>Strict Freq Preference</strong></td><td><strong>True</strong>: The CBSD only accepts a grant on one of the preferred frequencies.<br><strong>False</strong>: The SAS may assign any available frequency.</td><td>Set True for Shared Cell / multi-CBSD groups that must operate on the same channel. Set False for standalone CBSDs where operating on a non-preferred frequency is acceptable. When False, the DP will first attempt preferred frequencies; if none are available, it will select any available frequency from the SAS response.</td></tr><tr><td><strong>Transmit</strong></td><td><strong>Enabled</strong>/<strong>Disabled</strong> — administratively controls whether this CBSD is allowed to transmit once authorized.</td><td>When <strong>Disabled</strong>, even after a successful grant the AP will not radiate until switched to <strong>Enabled</strong>.</td></tr></tbody></table>

#### 4G Configuration

{% hint style="info" %}
**NOTE**: This section describes only the SAS-related configuration required for 4G APs. For complete instructions on adding and managing 4G APs, refer to *4G Onyx Portal Operations Guide* > *Manage Access Points*.
{% endhint %}

**To add a 4G AP:**

{% stepper %}
{% step %}
In the Onyx Portal, click **Equipment** > **Access Point** tab.
{% endstep %}

{% step %}
In the upper-right corner, click **Add Node** > **Add Access Point.**
{% endstep %}

{% step %}
In the **Create Access Point** page > **Access Point** tab, enter the AP's details.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F6vnC6UISbCtDIwCvQQ51%2Fimage.png?alt=media&#x26;token=aa7b3342-e27f-48e7-bbd5-8170750b9cbd" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the **RAN** tab, configure the required fields referring to the [*Common SAS Configuration Parameters table*](#common-sas-configuration-parameters).

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FIpQJgizToBR0vpa9c1Py%2Fimage.png?alt=media&#x26;token=b44d5b03-4d8b-430d-a311-13f5e82b4189" alt=""><figcaption></figcaption></figure></div>

{% hint style="info" %}
**NOTE**: Dual Carrier and Carrier Aggregation deployments require separate frequency grants for each carrier. Plan your preferred frequency list carefully to avoid grant conflicts between carriers on the same AP.
{% endhint %}
{% endstep %}

{% step %}
Save the AP.

After the AP is saved, registration begins automatically if SAS is enabled and the corresponding CBSD record has already been digitally signed by the CPI in the SAS portal.
{% endstep %}
{% endstepper %}

#### 5G Configuration

5G APs use an O-RAN 7-2x split architecture. SAS registration is managed at the cell level through the Onyx Edge CU/DU, not directly at the AP level.

{% hint style="info" %}
**NOTE**: This section describes only the SAS-related configuration required for 5G APs. For complete instructions on adding and managing 5G APs, see 5*G Onyx Portal Operations Guide* > *Manage Access Points*.
{% endhint %}

**To configure SAS for a 5G deployment:**

{% stepper %}
{% step %}
Add the AP.

1. In the Onyx Portal, click **Equipment**.
2. In the upper-right corner, click **Add Node** > **Add Access Point**.

   The **Create Access Point** page is displayed.<br>

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FGIgw7WF94nv5oRnTt7Sd%2Fimage.png?alt=media&#x26;token=6fd5c487-81ad-4d96-b061-7087ca95921d" alt=""><figcaption></figcaption></figure></div>
3. Enter the AP's details.
4. In the upper-right corner, click **Save Access Point**.
   {% endstep %}

{% step %}
Add a cell.

1. Click **Equipment** > **Onyx Edge** tab.
2. In the list of Onyx Edge, in the **Actions** column, click the corresponding Options icon, then click **Edit**.\
   The **Edit Onyx Edge (<*****onyx-edge-name*****>)** page is displayed.<br>

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fve7N3CmTBEnxnQdj7uPX%2Fimage.png?alt=media&#x26;token=87a4fabe-39e0-4d34-8b91-d11a52af504e" alt=""><figcaption></figcaption></figure></div>
3. Click the **RAN** tab.<br>

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FGEgUc631Fdur2Ml6f10k%2Fimage.png?alt=media&#x26;token=beb4847c-3572-49f8-b05d-f042836dd6bb" alt=""><figcaption></figcaption></figure></div>
4. If the Onyx Edge contains any SAS-enabled cells, delete all of them before continuing:
   1. For each SAS-enabled cell, click the corresponding ⋮ (options) icon, then click **Delete**.<br>

      <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FdBzFZtiMoSA0prWyKmRu%2Fimage.png?alt=media&#x26;token=ef10a7b2-20f5-4745-a2bb-8faf1bd6a10d" alt=""><figcaption></figcaption></figure></div>
   2. To save the Onyx Edge, in the upper-right corner, click **Save Onyx Edge**.
   3. To continue to the next step, once again edit the Onyx Edge and return to the **RAN** tab.
5. To add a cell, click **Add Cell**.<br>

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FICoAphVL8fdubDo5IStM%2Fimage.png?alt=media&#x26;token=f728a56d-d1b2-44da-8f32-f552a1fc72a8" alt=""><figcaption></figcaption></figure></div>
6. The **Add Cell** dialog box is displayed.
   * In case of Multi-Port Attach disabled:<br>

     <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F7vOJgStnIGUY9myqng2T%2F5g-add-cell-2%20-%20Copy.png?alt=media&#x26;token=0cebf57e-6759-4709-9ae8-9df6061bd345" alt=""><figcaption></figcaption></figure></div>
   * In case of Multi-Port Attach enabled:

     <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FqRZ4oWKnQceH4BDzXHld%2F5g-add-cell%20-%20Copy.png?alt=media&#x26;token=96eea620-cff7-4e76-8c12-c8600e110d41" alt=""><figcaption></figcaption></figure></div>
7. Enter the following details:
   1. **SAS Enabled**: On.
   2. **User ID**, **Preferred BW (MHz)**, **Preferred Freq (MHz) in Priority Order**, **Strict Freq Preference**: Per the [*Common SAS Configuration Parameters table*](#common-sas-configuration-parameters).
   3. **PSS**: (Physical Synchronization Signal index, 0–2). Sets the Physical Cell ID. Ensure no two adjacent cells share the same PSS value.
   4. **Associated AP/FHM**: Select the AP/FHM added in Step 1.
   5. **CBSD Category** and **Antenna Gain**: Per the [*Onyx CBRS AP Reference table*](#onyx-cbrs-ap-reference)*.*
      * When Multi-Port Attach is disabled:
        * **Antenna Gain (dBi)**: Configure a single antenna gain.
        * **No. of Antenna Ports**: Select the number of antenna ports.
      * When Multi-Port Attach is enabled:
        * **Antenna Gain (n) (dBi)**: Add one entry per antenna port using the ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FlirRG2GUQgodytjOyiBd%2Fimage.png?alt=media\&token=ee3c55e1-0a57-4b68-9ca3-43c8129c70f5) button.
        * **CBSD Category:** Auto-selected based on **Associated AP/FHM**.
8. To save the cell, click **Submit**.
9. To save the Onyx Edge, click **Save Onyx Edge**.

{% hint style="info" %}
**NOTE**: In Multi-Cell / Shared Cell deployments where multiple APs belong to the same cell, all CBSDs must receive a spectrum grant on the same frequency before any CBSD begins transmitting. Enable Strict Freq Preference to keep the group synchronized. If any CBSD fails to obtain a grant, transmission is held off for the entire group.
{% endhint %}

{% hint style="info" %}
**NOTE**: In Multi-Port Attach deployments, a single AP serving multiple antennas requires a separate CBSD registration for each antenna. The maximum EIRP for each antenna must be calculated individually using the following formula:

`P(dBm) = EIRP(dBm) − Antenna_Gain(dBi) + 10×log₁₀(BW_MHz / number_of_ports)`

Because the effective EIRP depends on the antenna configuration, bandwidth, and port allocation, GXC recommends verifying the calculated values before submitting CBSD registrations. For assistance with deployment-specific EIRP calculations, contact GXC Technical Support.
{% endhint %}
{% endstep %}
{% endstepper %}

### Bulk Registration (DAS / Large Deployments)

For Distributed Antenna System (DAS) and other large-scale deployments, CBSD registration can be performed in bulk instead of creating and signing each CBSD record individually. Bulk registration reduces the time required to provision large numbers of CBSDs while maintaining the same SAS registration workflow and CPI certification requirements.

**Bulk Registration Workflow:**

1. In the Onyx Portal, download the preformatted bulk CBSD registration template.
2. Populate the template for each CBSD: CBSD ID/Name, Latitude/Longitude, Antenna Height (meters), Azimuth, Indoor/Outdoor flag, Antenna Gain, EIRP, FCC ID, Serial Number, and any other required parameters.
3. Review and validate all entries. Errors in bulk files can cause simultaneous registration failures across multiple CBSDs.
4. Upload the completed template file to the SAS portal.\
   The system creates a CBSD record for each entry.

   <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE</strong>: CPI signing is not bypassed by bulk upload. After upload, a CPI must review and sign each CBSD record (or batch-sign if supported by the SAS portal) before any registration requests are submitted. Bulk upload only populates parameters; it does not replace CPI validation.</p></div>
5. CPI reviews and signs all CBSD records.
6. Save or enable the bulk-uploaded AP/cell configuration in the Onyx Portal. Registration requests for all CBSDs in the batch are submitted to the SAS automatically once CPI signing is complete for each record — no separate manual trigger is required.
7. Monitor each CBSD for Authorized status.
8. Address any individual failures using the error codes in [*SAS Response Codes*](#sas-response-codes) and [*Common Failures*](#common-failures).

## Verify CBSD Status

This section describes the CBSD registration and grant lifecycle, from initial registration through to the Authorized state — the target operational state in which CBSDs are permitted to transmit.

### **CBSD Registration and Grant Lifecycle**

The following diagram and workflow illustrate the complete CBSD registration and grant lifecycle.

<p align="center"><strong>Figure: CBSD Registration and Grant Lifecycle</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FMOfmV6ZLpWlR5ktvDjIS%2Fsas-cbsd-status-transitions.png?alt=media&#x26;token=273ab5ea-3097-48d1-9731-dc2880b75f27" alt=""><figcaption></figcaption></figure></div>

1\. Unregistered

* The initial state of every CBSD.
* The CBSD has no contact with the SAS and is not permitted to transmit.
* The CBSD sends a registration request to the SAS through the DP.
* If registration succeeds, the SAS validates the CBSD identity and installation parameters, assigns a CBSD ID, and the CBSD transitions to the Registered state.
* The CBSD returns to the Unregistered state when:
  * The registration request is rejected.
  * The operator explicitly deregisters the CBSD.
  * Installation parameters are modified after CPI signing.
* In these cases, all active grants are removed, and the CBSD must be fully re-registered, including CPI re-signing in the SAS portal.

2\. Registered

* The CBSD has successfully completed registration and received a CBSD ID.
* The SAS has validated the CBSD identity and installation parameters.
* The CBSD does not yet hold a spectrum grant and cannot transmit.
* The CBSD automatically transitions to the Idle state.

3\. Idle

* The CBSD is registered but does not hold an active spectrum grant.
* The CBSD enters the Idle state:
  * Immediately after successful registration.
  * When a spectrum grant is terminated, relinquished, or expires.
* The CBSD automatically submits a grant request to the SAS.
* If the SAS returns Grant Request: Success, the CBSD transitions to the Granted state.

4\. Granted

* The SAS has assigned spectrum resources.
* The CBSD has not yet received transmit authorization and must not transmit.
* The CBSD sends heartbeat requests to the SAS.
* If the SAS returns Heartbeat Response: Transmit, the CBSD transitions to the Authorized state.

5\. Authorized (Normal Operating State)

* The CBSD has:
  * Successfully registered with the SAS.
  * Obtained a spectrum grant.
  * Received transmit authorization through a successful heartbeat response.
* The CBSD is permitted to transmit on its assigned spectrum.
* To maintain authorization, the CBSD sends periodic heartbeat requests.
* As long as the SAS continues to return Heartbeat Response: Transmit, the CBSD remains in the Authorized state.

#### Fallback State Transitions

During normal operation, the CBSD may temporarily transition to an earlier state based on SAS responses.

* Heartbeat does not extend transmit authorization (Response Code 400) — If the SAS does not extend transmit authorization during a heartbeat exchange, the CBSD returns to the Granted state.
  * The spectrum grant is retained, but transmit authorization is temporarily suspended.
  * The Onyx Portal automatically continues sending heartbeat requests.
  * When the SAS again authorizes transmission, the CBSD returns to the Authorized state.
  * No operator action is required for transient heartbeat failures.
* Grant is no longer valid (Response Code 401) — If the SAS indicates that the current spectrum grant is no longer valid (for example, because it has expired, been relinquished, or been terminated), the CBSD returns to the Idle state.
  * The existing spectrum grant is released.
  * The CBSD automatically requests a new spectrum grant from the SAS.
  * Once a new grant is approved and transmit authorization is restored, the CBSD returns to the Authorized state.
* Deregistration or configuration changes — If the operator explicitly deregisters the CBSD, or if installation parameters are modified after CPI signing, the CBSD returns to the Unregistered state.
  * All active spectrum grants are removed.
  * The CBSD must be fully re-registered, including CPI re-signing in the SAS portal, before the CBSD can obtain a new grant and resume transmission.

### Verify CBSD Status in Onyx Portal

Monitor the CBSD status in the Onyx Portal to confirm that registration, spectrum grant acquisition, and transmit authorization have completed successfully.

**To verify the CBSD status in the Onyx Portal:**

{% stepper %}
{% step %}
Navigate to in **Equipment** > **Access Point** tab > AP details page > **Overview** tab > **RAN** section.
{% endstep %}

{% step %}
Verify that all three status indicators—**Registered**, **Granted**, and **Authorized**—are displayed in green.

When all three indicators are green, the CBSD is successfully registered with the SAS, has an active spectrum grant, and is authorized to transmit.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FGxfDBXSMxQYMjQZo1pIg%2Fimage.png?alt=media&#x26;token=c0ac5308-fe79-41de-b392-46141124c86b" alt="" width="563"><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}

<p align="center"><strong>Table: CBSD Status Descriptions</strong></p>

<table><thead><tr><th width="150">Status</th><th width="125">Color</th><th>Description</th></tr></thead><tbody><tr><td>Registered</td><td>Green</td><td>All CBSDs are registered with SAS.</td></tr><tr><td></td><td>Amber</td><td>Some CBSDs are registered, some not yet.</td></tr><tr><td></td><td>Red</td><td>No CBSDs are registered.</td></tr><tr><td>Granted</td><td>Green</td><td>Required number of spectrum grants are active.</td></tr><tr><td></td><td>Amber</td><td>Some grants are active, but not the full required number.</td></tr><tr><td></td><td>Red</td><td>No grants are available.</td></tr><tr><td></td><td>Grey</td><td>No CBSDs are registered.</td></tr><tr><td>Authorized</td><td>Green</td><td>CBSDs are authorized to transmit (normal operating state).</td></tr><tr><td></td><td>Amber</td><td>Some CBSDs authorized, partial coverage.</td></tr><tr><td></td><td>Red</td><td>No authorizations. CBSDs cannot transmit.</td></tr><tr><td></td><td>Grey</td><td>No grants are available.</td></tr></tbody></table>

### Verify CBSD Status in SAS Portal

Verify the CBSD status in the SAS portal to confirm that the CBSD is registered, has received a spectrum grant, and is authorized to transmit.

**To verify the CBSD status in the SAS portal:**

1. Log in to the SAS portal.
2. On the **Installation** page, locate the CBSD in either the **Installation Map** or **List View**.
3. Verify that the CBSD displays an **AUTHORIZED** status.\
   \
   A green **AUTHORIZED** badge indicates that the CBSD has an active spectrum grant and is authorized to transmit.<br>

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FX3N5cj5Mu7sJUwpKE4xG%2F12_cbsd-status.png?alt=media&#x26;token=b0ea2209-4497-4b46-a614-bf99627ee507" alt=""><figcaption></figcaption></figure></div>
4. Click **More Info** to view detailed CBSD information.
5. Review the following tabs as needed:
   * **Grant Information** — Displays active spectrum grants, assigned GAA channels, EIRP, and grant expiration times.<br>

     <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FlOTyPcxpgetTzWQc3yLt%2F13_more-info-1.png?alt=media&#x26;token=2fa5b63e-6e3f-46bf-8687-f2946fc48134" alt=""><figcaption></figcaption></figure></div>
   * **CBSD Information** — Displays the CBSD state (**AUTHORIZED**), category, GAA grant count, serial number, and FCC ID registered with the SAS.<br>

     <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fdv4qfQamMBrSZbIm89Be%2F15_more-info-3.png?alt=media&#x26;token=3165617d-d0fb-4d43-90d8-748ba0a98953" alt=""><figcaption></figcaption></figure></div>
   * **Logs Information** — Displays message types, timestamps, and SAS response codes.<br>

     <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fgo2X9y0QutlqMKufNqDy%2F14_more-info-2.png?alt=media&#x26;token=8807b4a6-15c5-4307-81a7-e842a297b764" alt=""><figcaption></figcaption></figure></div>
   * **State Changes** — Displays the CBSD state transition history.
   * **CBSD Configuration Changes** — Displays the configuration change history for the CBSD.

## Troubleshooting

Use this section to diagnose and resolve CBSD registration, grant, and authorization issues across the GXC Onyx and Federated Wireless SAS ecosystem.

Begin with the [*Troubleshooting Workflow*](#troubleshooting-workflow), then consult the Onyx Portal SAS-related alerts, SAS response codes, and common failures sections as directed for detailed diagnostics and corrective actions.

### Troubleshooting Workflow

Use the following workflow to identify and resolve CBSD registration, spectrum grant, and transmit authorization issues.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fm8zX2mQOTxD4yddMfJz5%2Fsas-troubleshooting.png?alt=media&#x26;token=94e9981c-772e-4c1e-a139-66b56a8d7d26" alt=""><figcaption></figcaption></figure></div>

{% stepper %}
{% step %}
Check Onyx Portal alerts.

* In the Onyx Portal, check the Alerts Counter Panel.
* If active alerts are present, navigate to **Alerts** > **Active Alerts** tab and check for SAS-related alerts.
* See [*Onyx Portal SAS-Related Alerts*](#onyx-portal-sas-related-alerts) for alert details and recommended corrective actions.
  {% endstep %}

{% step %}
Verify the CBSD SAS status and review DP/SAS logs.

* In the Onyx Portal, navigate to **Equipment** > **Access Point** tab > AP details page > **Overview** tab > **RAN** section to verify the CBSD status. See [*Verify CBSD Status in Onyx Portal*](#verify-cbsd-status-in-onyx-portal).
* Review the DP logs in **Equipment** > **Access Point** tab > AP details page > **Logs** tab > **DP Logs** section. The DP logs record all registration, spectrum grant, heartbeat, and error responses.
* In the Federated Wireless SAS portal, on the **Installation** screen, locate the CBSD, and click **More Info**, then select the **Logs Information** tab. This tab displays all message types with timestamps, response codes, and transmit expiration times.
* A SAS response code of 0 indicates success. For any non-zero response code, refer to [*SAS Response Codes table*](#sas-response-codes).
  {% endstep %}

{% step %}
Identify the failure stage.

Compare the observed Onyx Portal alerts, CBSD status, and SAS response codes against the following table to identify the most likely failure stage and the appropriate resolution workflow.

| What you see                                         | Failure stage                           | Start here                                                                                                                                                                            |
| ---------------------------------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| CBSD shows "Unregistered" / no change                | Domain Proxy to SAS connectivity        | Check firewall, DNS, and Onyx Edge network access to SAS endpoint.                                                                                                                    |
| SAS portal shows "Pending Registration" (no advance) | CBSD not sending registration request   | Verify AP is powered; confirm Serial No. and FCC ID match; confirm Onyx Edge is reachable.                                                                                            |
| SAS portal shows "Ready for CPI" (no advance)        | CPI signing incomplete                  | CPI must sign the CBSD record before any registration request is sent.                                                                                                                |
| Registration rejected (codes 104, 105, 106, 501)     | Parameter or certificate error          | Review error code in [*SAS Response Codes*](#sas-response-codes). Correct the parameter and re-trigger registration.                                                                  |
| Registered, no grant (codes 200, 300)                | Spectrum availability or EIRP issue     | Review error code in [*SAS Response Codes*](#sas-response-codes). Check frequency range, EIRP limits, ESC/incumbent activity.                                                         |
| Grant suspended / terminated (codes 400, 401)        | Incumbent protection event              | Review error code in [*SAS Response Codes*](#sas-response-codes). Normal SAS behavior. Onyx auto-retries. If persistent, contact SAS vendor support.                                  |
| SAS Connection Failure alert active                  | Domain Proxy cannot reach SAS           | Check Onyx Edge connectivity to SAS on port 443. See [*Onyx Portal SAS-Related Alerts*](#onyx-portal-sas-related-alerts).                                                             |
| CBSD Registration Failure alert active               | Parameter mismatch or CPI signing issue | Check DP logs. Verify FCC ID, serial number, category, location, and antenna parameters across both portals. See [*Onyx Portal SAS-Related Alerts*](#onyx-portal-sas-related-alerts). |
| {% endstep %}                                        |                                         |                                                                                                                                                                                       |

{% step %}
If the CBSD is Unregistered, verify the CBSD parameters are consistent across Onyx Portal and SAS portal.

Parameter mismatches between the Onyx Portal and SAS portal are the most common cause of registration failures. Before retrying registration, verify that:

* The serial number is identical in both portals and matches the physical AP label.
* The FCC ID exactly matches the [*Onyx CBRS AP Reference table*](#onyx-cbrs-ap-reference).
* Antenna height is entered in meters (not in feet).
* Height Type (AGL or AMSL) matches the configured height.
* The Indoor/Outdoor flag is set correctly (affects CBSD category and EIRP limits).
* CPI signing is complete and the record shows "Pending Registration" in the SAS portal.
  {% endstep %}

{% step %}
If the CBSD is not Authorized, verify spectrum availability. If the configured values are not available, consider switching to other available center frequencies and bandwidth.

1. Navigate to **Equipment** > **Access Point** tab > AP details page > **Overview** tab > **RAN** section > **SAS Configuration** section and note values set for **Preferred Freq (MHz)** and **Preferred BW (MHz)**.
2. To verify available spectrum, on the same AP details page, under the **SAS Status** section, click **View Available Spectrum**. The graph shows spectrum availability per 5 MHz steps — confirm that the preferred frequencies and bandwidth are shown as available.<br>

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FBEN4g200H4v39dIzUFIz%2Fimage.png?alt=media&#x26;token=9463506f-d133-456e-bc00-50660fc373c4" alt=""><figcaption></figcaption></figure></div>

   <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE</strong>: Each bar represents a 5 MHz spectrum segment. To verify bandwidth availability, confirm that the number of consecutive green bars covering your center frequency equals your bandwidth divided by 5 (for example, a 20 MHz bandwidth requires 4 consecutive green bars centered on your preferred frequency).</p></div>

{% endstep %}

{% step %}
Escalate if the issue persists.

* GXC Technical Support (*<support@gxc.io>*) — Provide the AP serial numbers, FCC IDs, SAS response codes from the DP logs, and screenshots from both the Onyx Portal and the SAS portal to expedite troubleshooting.
* SAS Vendor Support — For SAS-side issues (grant availability, ESC events, blacklisting), contact the SAS Vendor Support directly.
  {% endstep %}
  {% endstepper %}

### Onyx Portal SAS-Related Alerts

The Onyx Portal generates predefined alerts for SAS and DP events. The following alerts are directly relevant to CBRS registration and spectrum grant operation. These alerts are applicable to both 4G and 5G networks.

To monitor Onyx Portal alerts:

* Monitor the Alerts Counter Panel in the Onyx Portal's header.
* Navigate to **Alerts** > **Active Alerts** tab.

#### **CBSD Registration Failure**

<table data-header-hidden><thead><tr><th width="199.5555419921875"></th><th></th></tr></thead><tbody><tr><td><strong>Trigger Condition</strong></td><td>When one or more CBSD registration attempts fail within the last hour.</td></tr><tr><td><strong>Clear Condition</strong></td><td>When no registration failures occur for at least one hour.</td></tr><tr><td><strong>Severity</strong></td><td>Major</td></tr><tr><td><strong>System Impact</strong></td><td>The AP becomes non-functional — it cannot obtain grants or transmit.</td></tr><tr><td><strong>Where to Look</strong></td><td><strong>Equipment</strong> > <strong>Access Point</strong> tab > AP details page > <strong>Overview</strong> > SAS status — shows Registered indicator in red. The <strong>Dashboard</strong> > <strong>Access Point/DAS SAS Status</strong> tile will also reflect the failure.</td></tr><tr><td><strong>Resolution</strong></td><td><ol><li>Check the AP's DP logs for failure reason (<strong>Equipment</strong> > <strong>Access Point</strong> tab > AP details page > <strong>Logs</strong> tab > <strong>DP Logs</strong> section).</li><li>The most common cause is a parameter mismatch between the Onyx Portal and the SAS portal. Verify parameters across both portals.</li><li>Refer to the <a href="https://www.claudeusercontent.com/?domain=claude.ai&#x26;parentOrigin=https%3A%2F%2Fclaude.ai&#x26;errorReportingMode=parent&#x26;formattedSpreadsheets=true&#x26;routeHandlerPdf=true#sas-response-codes"><em>SAS Response Codes</em></a> table for code details and next steps.</li></ol></td></tr><tr><td><strong>Resolution Verification</strong></td><td>The Alerts Counter Panel reverts to pre-incident levels, and all Dashboard tiles return to their pre-incident states.</td></tr></tbody></table>

#### **CBSD Lesser BW Granted**

<table data-header-hidden><thead><tr><th width="199.5555419921875"></th><th></th></tr></thead><tbody><tr><td><strong>Trigger Condition</strong></td><td>When a CBSD has been granted less bandwidth than configured, and this condition persists for at least five minutes.</td></tr><tr><td><strong>Clear Condition</strong></td><td>When the CBSD receives the desired bandwidth or loses the grant.</td></tr><tr><td><strong>Severity</strong></td><td>Major</td></tr><tr><td><strong>System Impact</strong></td><td>Network capacity is reduced from what was planned. Dashboard <strong>Downlink/Uplink Traffic</strong> and <strong>Data Usage</strong> tiles will reflect the reduction.</td></tr><tr><td><strong>Resolution</strong></td><td><ol><li>Check if any maintenance activity is currently in progress.</li><li>In the AP's DP logs, check the Spectrum Inquiry Response to identify available frequencies (<strong>Equipment > Access Point</strong> tab > AP details page > <strong>Logs</strong> tab > <strong>DP Logs</strong> section).</li><li>If Strict Preference is enabled, consider disabling it or adjusting the preferred frequency to one with higher available bandwidth (<strong>Equipment</strong> > <strong>Access Point</strong> tab > AP details page > <strong>RAN</strong> tab > <strong>Strict Preference</strong>).</li><li>If unresolved, contact GXC Technical Support.</li></ol></td></tr><tr><td><strong>Resolution Verification</strong></td><td><ul><li>All Dashboard tiles return to pre-incident states.</li><li>Confirm the granted bandwidth (<strong>Equipment</strong> > <strong>Access Point</strong> tab > AP details page > <strong>Overview</strong> tab > <strong>RAN</strong> tile > <strong>BW (MHz)</strong> parameter).</li></ul></td></tr><tr><td><strong>Related Alert</strong></td><td><a href="#cbsd-new-grant"><em>CBSD New Grant</em></a> may trigger alongside CBSD Lesser BW Granted.</td></tr></tbody></table>

#### **CBSD New Grant**

This is an informational alert — no corrective action is required.

<table data-header-hidden><thead><tr><th width="199.5555419921875"></th><th></th></tr></thead><tbody><tr><td><strong>Trigger Condition</strong></td><td>When a new grant is received from the SAS within the last hour.</td></tr><tr><td><strong>Clear Condition</strong></td><td>When no new grants are received for at least one hour.</td></tr><tr><td><strong>Severity</strong></td><td>Warning</td></tr><tr><td><strong>System Impact</strong></td><td>For an AP already transmitting, a new grant may change the transmission frequency, bandwidth, or power level. Verify the new grant parameters do not adversely affect required KPIs. If the new grant carries less bandwidth than configured, a <a href="#cbsd-lesser-bw-granted"><em>CBSD Lesser BW Granted</em></a> alert may also trigger.</td></tr><tr><td><strong>Additional Information</strong></td><td>Each grant change generates this alert, making it useful for tracking all grant modifications. The initial grant for an AP also triggers this alert.</td></tr></tbody></table>

#### **CBSD Preferred Frequency Unavailable**

<table data-header-hidden><thead><tr><th width="199.5555419921875"></th><th></th></tr></thead><tbody><tr><td><strong>Trigger Condition</strong></td><td>When none of the preferred frequencies configured for the CBSD are available from the SAS.</td></tr><tr><td><strong>Clear Condition</strong></td><td>When a preferred frequency becomes available again or the CBSD is deregistered.</td></tr><tr><td><strong>Severity</strong></td><td>Warning</td></tr><tr><td><strong>System Impact</strong></td><td>If Strict Preference is enabled, the AP stops transmitting. If Strict Preference is disabled, the AP continues transmitting on whatever frequency the SAS grants — but that frequency will not be in the preferred list.</td></tr><tr><td><strong>Resolution</strong></td><td><ol><li>Change the preferred frequency list (<strong>Equipment</strong> > <strong>Access Point</strong> tab > edit AP details > <strong>RAN</strong> tab).</li><li>To identify available frequencies, check the Spectrum Inquiry Response log (<strong>Equipment</strong> > <strong>Access Point</strong> tab > AP details page > <strong>Logs</strong> tab > <strong>DP Logs</strong> section > <strong>Spectrum Inquiry Response</strong>), filtering for "From SAS To DP" logs.</li></ol></td></tr></tbody></table>

#### **SAS Connection Failure**

<table data-header-hidden><thead><tr><th width="199.5555419921875"></th><th></th></tr></thead><tbody><tr><td><strong>Trigger Condition</strong></td><td>When the Domain Proxy cannot reach the SAS — specifically, when connection attempts fail at least three times within 15 minutes, or when at least one HTTP error from the SAS is received within 15 minutes.</td></tr><tr><td><strong>Clear Condition</strong></td><td>When no connection errors or HTTP errors occur for at least 15 minutes.</td></tr><tr><td><strong>Severity</strong></td><td>Critical</td></tr><tr><td><strong>System Impact</strong></td><td>This alert indicates a potential network-wide outage for all APs dependent on SAS for spectrum grants. If the connection failure persists, transmit timers will expire and cells will go down.</td></tr><tr><td><strong>Where to Look</strong></td><td><strong>Equipment</strong> > <strong>Access Point</strong> tab > AP details page > <strong>Overview</strong> tab > SAS Status — the SAS state will stop progressing, and Authorized status may revert to Granted as the transmit timer expires.</td></tr><tr><td><strong>Resolution</strong></td><td><p>Contact GXC Technical Support.</p><p>Two error types appear in alert labels:</p><ul><li>HTTP errors — Typically indicate an SAS-side issue or fundamental failure in the Domain Proxy.</li><li>Transport-level errors — May indicate connectivity issues (unable to reach SAS) or TLS authentication failures.</li></ul><p>Also verify Onyx Edge outbound connectivity to the SAS endpoint on port 443. See <em>GXC Firewall Config Application Note</em>.</p></td></tr><tr><td><strong>Additional Information</strong></td><td>SAS Connection Failure generates a single consolidated alert at the network level, not individual alerts per AP.</td></tr></tbody></table>

### SAS Response Codes

Every request exchanged between a CBSD and the SAS returns a standardized response code, as defined in the *WInnForum SAS-CBSD Technical Specification (WINNF-TS-0016)*. When a request fails, the SAS may also include additional information to help identify the cause of the failure.

**To view SAS response codes in the Onyx Portal:**

{% stepper %}
{% step %}
Navigate to **Equipment** > **Access Point** tab > AP details page > **Logs** tab > **DP Logs** section.
{% endstep %}

{% step %}
Review the SAS transaction logs. Each transaction includes the corresponding SAS response code.
{% endstep %}

{% step %}
Use the **SAS Response Codes** table to interpret the response code and determine the appropriate corrective action.
{% endstep %}
{% endstepper %}

<p align="center"><strong>Table: SAS Response Codes</strong></p>

<table><thead><tr><th width="113">Response Code</th><th width="200">Name</th><th>Meaning / Likely Cause</th><th>Resolution</th></tr></thead><tbody><tr><td>0</td><td>SUCCESS</td><td>Request succeeded.</td><td>No action needed.</td></tr><tr><td>102</td><td>VERSION</td><td>Protocol version mismatch.</td><td>Verify Onyx firmware supports current WInnForum spec version.</td></tr><tr><td>103</td><td>BLACKLISTED</td><td>CBSD is blacklisted by SAS.</td><td>Contact SAS provider support.</td></tr><tr><td>104</td><td>MISSING_PARAM</td><td>Required parameter absent from registration request.</td><td>Review all required fields in the Onyx Portal RAN/SAS settings. Check for empty User ID, FCC ID, or serial number.</td></tr><tr><td>105</td><td>INVALID_VALUE</td><td>A parameter value is out of range or format is incorrect.</td><td>Verify antenna height (must be meters, not feet), GPS coordinates format, EIRP values within category limits.</td></tr><tr><td>106</td><td>CERT_ERROR</td><td>CPI certificate error.</td><td>CPI must re-validate identity in SAS portal. Certificate may be expired or incorrectly uploaded.</td></tr><tr><td>200</td><td>INTERFERENCE</td><td>Grant denied due to incumbent or PAL protection.</td><td>Move to a different frequency or reduce EIRP. Check ESC sensor activity in your area.</td></tr><tr><td>300</td><td>UNSUPPORTED_SPECTRUM</td><td>Requested frequency is outside the CBRS band.</td><td>Verify preferred frequency is within 3555–3695 MHz (10 MHz BW) or 3560–3690 MHz (20 MHz BW).</td></tr><tr><td>400</td><td>SUSPENDED_GRANT</td><td>SAS has temporarily suspended the grant.</td><td>CBSD must stop transmitting. Onyx Portal will automatically attempt reauthorization via heartbeat. Monitor for resumption.</td></tr><tr><td>401</td><td>TERMINATED_GRANT</td><td>SAS has permanently terminated the grant.</td><td>CBSD must stop transmitting. Re-initiate grant request. If persistent, check for incumbent activity or interference in the area.</td></tr><tr><td>500</td><td>DEREGISTERED</td><td>CBSD was deregistered by SAS.</td><td>Re-register the CBSD. Investigate whether parameters changed or a delete was inadvertently triggered.</td></tr><tr><td>501</td><td>INVALID_PARAM</td><td>Invalid installation parameter in signed record.</td><td>CPI must correct and re-sign the affected CBSD record. Common cause: Parameter mismatch between SAS portal and Onyx Portal entries.</td></tr></tbody></table>

### Common Failures

The *Common Failures* table summarizes the most frequently encountered CBSD registration, spectrum grant, and transmit authorization issues, along with their likely causes and recommended corrective actions to help restore normal SAS operation.

<p align="center"><strong>Table: Common Failures</strong></p>

| Symptom                                                                   | Most Likely Cause                                                                                                                                                                                                                                                                             | Check / Resolution                                                                                                                                                                                                                                                                                                              |
| ------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| CBSD stuck in Unregistered state                                          | <p>Domain Proxy cannot reach SAS endpoint<br><br>The Onyx Edge functions as the Domain Proxy for all CBSDs at a site. A connectivity issue between the Onyx Edge and the SAS can affect registration, grant management, and heartbeat processing for all CBSDs managed by that Onyx Edge.</p> | Verify firewall rules. Onyx Edge must reach the SAS FQDN on HTTPS (443). See *GXC Firewall Config Application Note*.                                                                                                                                                                                                            |
| SAS portal shows "Pending Registration" indefinitely                      | AP not powered on or not connected to Onyx Edge; serial number or FCC ID mismatch                                                                                                                                                                                                             | Confirm AP is online in Onyx Portal. Verify that the AP serial number and FCC ID in both portals exactly match those printed on the physical AP label.                                                                                                                                                                          |
| SAS portal shows "Ready for CPI" — does not advance                       | CPI signing not completed                                                                                                                                                                                                                                                                     | CPI must log in, review parameters, and click Sign. Registration request will not be sent until signing is complete.                                                                                                                                                                                                            |
| Registration rejected — MISSING\_PARAM or INVALID\_VALUE (codes 104, 105) | Parameter mismatch or missing field between portals                                                                                                                                                                                                                                           | Cross-check all fields: height in meters (not feet), GPS to 6 decimal places, correct EIRP for category, FCC ID matches AP label.                                                                                                                                                                                               |
| Registration rejected — CERT\_ERROR (code 106)                            | Invalid or expired CPI signature                                                                                                                                                                                                                                                              | CPI re-validates identity in SAS portal and re-signs the CBSD record.                                                                                                                                                                                                                                                           |
| Registration rejected — INVALID\_PARAM (code 501)                         | Invalid installation parameter in the signed record; parameter mismatch between portals after signing                                                                                                                                                                                         | This requires CPI action, not an operator retry. The CPI must correct the affected parameter and re-sign the CBSD record before registration can be re-triggered.                                                                                                                                                               |
| CBSD registers but receives no grant                                      | Frequency conflict or EIRP exceeds limits                                                                                                                                                                                                                                                     | Verify preferred frequency is within valid range. Confirm Max EIRP does not exceed category limits. Check for incumbent/ESC activity in area.                                                                                                                                                                                   |
| Grant SUSPENDED or TERMINATED (codes 400, 401)                            | Incumbent activity or interference detected by SAS                                                                                                                                                                                                                                            | <p>This is normal SAS behavior protecting incumbents.</p><p>Response Code 400 (grant suspended): Onyx auto-retries heartbeat. No operator action required unless persistent.</p><p>Response Code 401 (grant terminated): CBSD returns to Idle state and must re-request a grant. If persistent, contact SAS vendor support.</p> |
| Multi-Port: group fails to authorize                                      | One CBSD missing parameters or EIRP calculation error                                                                                                                                                                                                                                         | Each antenna CBSD needs a complete, independent parameter set. Verify per-antenna EIRP using the multi-port formula. All CBSDs in group must be authorized before any transmits.                                                                                                                                                |

## References

* [*GXC Glossary*](https://docs.gxc.io/glossary)
* [*4G & 5G Onyx Design Guide*](https://docs.gxc.io/docs/onyx-design-guide/onyx-design-guide)
* [*Onyx Portal Specification*](https://docs.gxc.io/docs/onyx-software/onyx-portal-specification)
* [*5G Onyx Shared Cell /* Super Cell *Architecture Solution Brief*](https://docs.gxc.io/docs/solution-briefs/5g-onyx-shared-cell-super-cell-architecture-solution-brief)
* [*5G Onyx Portal Operations Guide*](https://docs.gxc.io/docs/network-configuration-and-operations-guides/5g-onyx-portal-4.x-operations) / [*4G Onyx Portal Operations Guide*](https://docs.gxc.io/docs/network-configuration-and-operations-guides/4g-onyx-portal-4.x-operations)
* [*5G Onyx Portal Alerts Reference*](https://docs.gxc.io/docs/network-configuration-and-operations-guides/5g-onyx-portal-4.x-alerts-reference) / [*4G Onyx Portal Alerts Reference*](https://docs.gxc.io/docs/network-configuration-and-operations-guides/4g-onyx-portal-4.x-alerts-reference)
* [*GXC Firewall Config Application Note*](https://docs.gxc.io/docs/application-notes/4g-and-5g-firewall-configuration-for-onyx-networks)
* *Federated Wireless SAS Portal — SAS* Portal documentation provided by Federated Wireless
* *WInnForum SAS-CBSD Technical Specification (WINNF-TS-0016)* — registration protocol, response codes, CPI installation parameters
* *FCC CBRS Rules (47 CFR Part 96)* — FCC regulatory framework for Citizens Broadband Radio Service

## Contact GXC <a href="#contact-gxc" id="contact-gxc"></a>

To get in touch with GXC, please visit [*https://gxc.io/contact-us/*](https://gxc.io/contact-us/).


# 4G & 5G Onyx Networking Modes

## Introduction

This document explains the networking modes supported by the GXC 4G and 5G Onyx Platforms and their applicability to different enterprise network architectures. This application note focuses on Onyx Edge On-Premises deployments.

The Onyx Platform is a flexible system designed to support multiple deployment modes, enabling enterprises to integrate private cellular networks with their existing infrastructure. Understanding these networking modes is essential to ensure proper connectivity, maintain security, and achieve seamless integration with enterprise networks.

## Networking Modes

The Onyx Platform supports multiple networking modes that determine how the Onyx Edge integrates with enterprise networks and how it manages UE and AP/FHM traffic. Each mode varies in its balance of security, visibility, operational complexity, and integration requirements. Selecting the correct mode allows enterprises to meet their architectural, security, scalability, and management objectives.

The networking modes described in this document align with standard 3GPP EPC (4G) and 5GC (5G) architectures and common deployment practices.

### 4G Networking Modes

The Onyx 4G Platform supports the following networking modes:

* [*4G NAT Modes*](#4g-nat-modes)
  * [*4G NAT Classic Mode*](#4g-nat-classic-mode)
  * [*4G NAT Flat Mode*](#4g-nat-flat-mode)
* [*4G Bridge (APN-on-VLAN) Modes*](#4g-bridge-apn-on-vlan-modes)
  * [*4G Bridge (APN-on-VLAN) Classic Mode*](#4g-bridge-apn-on-vlan-classic-mode)
  * [*4G Bridge (APN-on-VLAN) Flat Mode*](#4g-bridge-apn-on-vlan-flat-mode)

#### 4G NAT Modes

In the 4G NAT modes, the Onyx Edge acts as a secure gateway and applies Network Address Translation (NAT) to UE traffic before forwarding it to the enterprise network. The Onyx Edge assigns private IP addresses to UE from its local pool, while the enterprise network sees only the Onyx Edge's NAT IP address. This mode provides simple IP management and strong isolation between enterprise systems and UE. NAT modes are ideal for enterprises prioritizing security and privacy over direct device visibility.

**4G NAT Classic Mode**

<p align="center"><strong>4G NAT Classic Mode Topology</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F3NA10YBDFIUyjagkTcNH%2F4g-nat-classic-mode.png?alt=media&amp;token=82ac31c7-67de-447e-85d3-e6607e33dc24" alt=""><figcaption></figcaption></figure></div>

In the 4G NAT Classic mode, APs connect to the Onyx Edge via a dedicated private interface (eth1), isolated from the enterprise network. The Onyx Edge assigns IP addresses to both UE (from its local pool) and APs (via its DHCP service). NAT applied on the SGi interface (eth0) provides strong network isolation — the enterprise LAN sees only the Onyx Edge's NAT IP address and cannot directly access APs or UE. This dual-interface architecture ensures separation between RAN and enterprise traffic.

**4G NAT Flat Mode**

<p align="center"><strong>4G NAT Flat Mode Topology</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fgu18AnwAwSLOgCcdCCXw%2F4g-nat-flat-mode.png?alt=media&amp;token=5c2852b6-98fc-4aa4-b66e-6b76f420e6e4" alt=""><figcaption></figcaption></figure></div>

In the 4G NAT Flat mode, APs connect to the Onyx Edge via the enterprise LAN. The Onyx Edge assigns IP addresses to UE from its local pool and applies NAT to UE traffic before forwarding to the enterprise network. Enterprise DHCP service assigns IP addresses to APs. The Onyx Edge uses a single interface (eth0) for both SGi and S1 traffic. This mode uses a single-interface topology where both S1 control and SGi user-plane traffic share eth0. This simplifies small-site deployments where enterprise switch VLAN support may not be available. However, network isolation is weaker compared to Classic mode as APs reside on the enterprise subnet. NAT provides protection for UE, which are not directly accessible from the enterprise network without additional configuration.

**4G NAT Modes Comparison**

Each mode offers different trade-offs between ease of deployment, visibility, isolation, and enterprise integration. The following table summarizes their characteristics for deployment considerations.

<p align="center"><strong>Onyx 4G NAT Modes Comparison</strong></p>

<table><thead><tr><th width="200" valign="top"></th><th valign="top">4G NAT Classic Mode</th><th valign="top">4G NAT Flat Mode</th></tr></thead><tbody><tr><td valign="top"><strong>Architecture</strong></td><td valign="top">NAT gateway model with dual-interface design. Onyx Edge acts as secure gateway, applying NAT to all UE traffic before forwarding to the enterprise network. AP traffic terminates at the Onyx Edge. Provides complete isolation between RAN and enterprise networks.</td><td valign="top">NAT gateway model with single-interface design. Onyx Edge acts as gateway for UE traffic only, applying NAT before forwarding to enterprise network. APs share enterprise network infrastructure.</td></tr><tr><td valign="top"><strong>Traffic Flow</strong></td><td valign="top"><p>UE traffic: UE > AP > Onyx Edge (NAT applied) > enterprise network via eth0.</p><p>AP traffic: APs > Onyx Edge eth1 (private interface) > Onyx Edge eth0 > enterprise network. Complete separation of RAN and enterprise traffic paths.</p></td><td valign="top"><p>UE traffic: UE > AP > Onyx Edge (NAT applied) > enterprise network via eth0.</p><p>AP traffic: APs > enterprise network > Onyx Edge eth0. Both UE and AP traffic share a single interface (eth0), doubling interface load.</p></td></tr><tr><td valign="top"><strong>IP Address Management</strong></td><td valign="top">Onyx Edge assigns IP addresses to UE from its local pool. Onyx Edge assigns IP addresses to APs via its DHCP service. Enterprise network sees only the Onyx Edge's NAT IP address.</td><td valign="top">Onyx Edge assigns IP addresses to UE from its local pool. Enterprise DHCP service assigns IP addresses to APs. Enterprise network sees only the Onyx Edge's NAT IP address for UE traffic.</td></tr><tr><td valign="top"><strong>Network Isolation</strong></td><td valign="top">Strong isolation. APs and UE are completely isolated from the enterprise network behind NAT. APs can only communicate with the Onyx Edge via dedicated private interface. Enterprise devices cannot directly access RAN infrastructure or UE.</td><td valign="top">Weaker isolation. UE are hidden behind NAT, but APs reside on enterprise subnet where they can be accessed by other enterprise devices. Creates higher security risk for RAN infrastructure. Enterprise cannot directly access UE.</td></tr><tr><td valign="top"><strong>Interfaces</strong></td><td valign="top">Dual interfaces provide physical separation: eth1 (dedicated private interface for S1/AP connections) and eth0 (SGi interface connecting to enterprise network). Ensures predictable and controlled traffic separation.</td><td valign="top">Single interface handles all traffic: eth0 handles both SGi (UE traffic) and S1 (AP control) traffic. Simplifies cabling but combines RAN control and user plane traffic.</td></tr><tr><td valign="top"><strong>APN/VLAN Integration</strong></td><td valign="top">No APN-to-VLAN mapping. All UE traffic from different APNs is collapsed behind NAT and appears as single Onyx Edge IP address on the enterprise network. No VLAN segmentation required.</td><td valign="top">Same as 4G NAT Classic Mode.</td></tr><tr><td valign="top"><strong>Deployment Complexity</strong></td><td valign="top">Straightforward setup with clear network boundaries. Requires basic IP planning and dual network interfaces on the Onyx Edge. No enterprise VLAN coordination required.</td><td valign="top">Requires coordination with enterprise networking team to ensure APs can access enterprise DHCP and routing services. May need firewall rules to allow AP connectivity.</td></tr><tr><td valign="top"><strong>Best For</strong></td><td valign="top">Recommended for most deployments. Ideal for enterprises prioritizing security, isolation, and predictable performance. Suitable for medium to large sites. Provides best balance of control, security, and scalability.</td><td valign="top">Small sites or "quick-start" deployments where enterprise switch VLAN support is not available. Suitable for temporary installations or pilot programs where simplified cabling is prioritized over security.</td></tr><tr><td valign="top"><strong>Cautions</strong></td><td valign="top">Requires proper IP address planning to avoid conflicts. UE remain invisible to enterprise monitoring and management tools. Inbound access to UE is not possible without port forwarding configuration.</td><td valign="top">eth0 must carry both S1 control and SGi user-plane traffic, which may reduce effective throughput under high load. Capacity planning should account for combined traffic on a single interface. APs exposed on enterprise subnet. Harder to isolate RAN infrastructure.</td></tr></tbody></table>

#### 4G Bridge (APN-on-VLAN) Modes

The 4G Bridge modes provide direct enterprise integration by bridging UE traffic into enterprise VLANs without NAT. Each APN is mapped to a dedicated VLAN, enabling the enterprise network to assign IP addresses and apply security, QoS, and routing policies per VLAN. Unlike the NAT modes where UE are hidden behind the Onyx Edge IP address, Bridge modes make UE directly accessible as native enterprise devices, with IP addresses assigned by the enterprise DHCP service per VLAN. Bridge modes are ideal for enterprises requiring per-APN traffic segregation, full device visibility, and integrated policy enforcement.

**4G Bridge (APN-on-VLAN) Classic Mode**

<p align="center"><strong>4G Bridge Classic Mode Topology</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FGiVR31oubHIR4U1snQbz%2F4g-bridge-classic-mode.png?alt=media&amp;token=b1bb15d3-c1d7-4fc5-934f-b671b100efc5" alt=""><figcaption></figcaption></figure></div>

In the 4G Bridge Classic mode, APs connect to the Onyx Edge via a dedicated private interface (eth1), isolated from the enterprise network. The Onyx Edge bridges UE data traffic directly into enterprise VLANs without applying NAT. Each APN is mapped to a dedicated VLAN, allowing traffic segregation and policy enforcement. Enterprise DHCP service assigns IP addresses to UE per VLAN, making them directly accessible as native enterprise devices. The Onyx Edge assigns IP addresses to APs via its own DHCP service on eth1. The eth0 interface is configured as a VLAN trunk to carry tagged UE traffic to the enterprise network. This architecture provides strong RAN isolation while enabling full enterprise visibility and control over UE.

**4G Bridge (APN-on-VLAN) Flat Mode**

<p align="center"><strong>4G Bridge Flat Mode Topology</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FpbDSBpxW5GCXS0pq7IXs%2F4g-bridge-flat-mode.png?alt=media&amp;token=885abaaf-123b-4ed2-93a7-858c20d80e82" alt=""><figcaption></figcaption></figure></div>

In the 4G Bridge Flat mode, APs connect to the Onyx Edge via the enterprise LAN. The Onyx Edge bridges UE traffic directly into enterprise VLANs with each APN mapped to a specific VLAN. Enterprise DHCP service assigns IP addresses to both UE (per VLAN) and APs. The Onyx Edge uses a single trunk interface (eth0) for both SGi and S1 traffic, with UE data and AP control traffic sharing the same physical link. However, network isolation is weaker compared to Bridge Classic mode — APs reside on the enterprise subnet where they can be accessed by other enterprise devices — and the eth0 interface must handle both S1 (AP control) and SGi (UE data) traffic, doubling the bandwidth requirements. This mode is suitable for sites requiring APN-to-VLAN mapping where operational simplicity and single-interface architecture are preferred.

**4G Bridge (APN-on-VLAN) Modes Comparison**

Each mode offers different trade-offs between ease of deployment, visibility, isolation, and enterprise integration. The following table summarizes their characteristics for deployment considerations.

<p align="center"><strong>4G Bridge (APN-on-VLAN) Modes Comparison</strong></p>

<table><thead><tr><th width="200" valign="top"></th><th valign="top">4G Bridge Classic Mode</th><th valign="top">4G Bridge Flat Mode</th></tr></thead><tbody><tr><td valign="top"><strong>Architecture</strong></td><td valign="top">VLAN bridge model with dual-interface design. Onyx Edge bridges UE traffic directly into enterprise VLANs without NAT. Each APN maps to a dedicated VLAN, enabling enterprise to apply per-APN policies. APs isolated on private interface.</td><td valign="top">VLAN bridge model with single-interface design. Onyx Edge bridges UE traffic directly into enterprise VLANs without NAT. Each APN maps to a dedicated VLAN. APs share enterprise network infrastructure.</td></tr><tr><td valign="top"><strong>Traffic Flow</strong></td><td valign="top"><p>UE traffic: UE > AP > Onyx Edge (bridged to VLAN) > Enterprise VLANs via eth0 trunk port.</p><p>AP traffic: APs > Onyx Edge eth1 (private interface). VLAN-tagged UE traffic separated from AP control traffic.</p></td><td valign="top"><p>UE traffic: UE > AP > Onyx Edge (bridged to VLAN) > Enterprise VLANs via eth0 trunk port.</p><p>AP traffic: APs > Enterprise network > Onyx Edge eth0. VLAN-tagged UE traffic and AP control traffic share single interface.</p></td></tr><tr><td valign="top"><strong>IP Address Management</strong></td><td valign="top">Enterprise DHCP service assigns IP addresses to UE per VLAN. The Onyx Edge assigns IP addresses to APs via its own DHCP service. UE appear as native devices on enterprise subnets.</td><td valign="top">Enterprise DHCP service assigns IP addresses to both UE (per VLAN) and APs. UE appear as native devices on enterprise subnets. APs appear as standard enterprise network devices.</td></tr><tr><td valign="top"><strong>Network Isolation</strong></td><td valign="top">Strong per-APN VLAN isolation. Each APN is tied to a dedicated VLAN with isolation maintained by enterprise switch/router policies. APs completely isolated on a dedicated private interface. Enterprise IT has full visibility and control over UE while RAN infrastructure remains protected.</td><td valign="top">Strong per-APN VLAN isolation for UE traffic. Each APN is tied to a dedicated VLAN with isolation maintained by enterprise switch/router policies. However, APs reside on enterprise subnet where they can be accessed by other devices, reducing RAN infrastructure isolation.</td></tr><tr><td valign="top"><strong>Interfaces</strong></td><td valign="top">Dual interfaces handle traffic: eth0 (VLAN trunk port carrying tagged UE traffic to enterprise) and eth1 (dedicated private interface for AP connections). Provides clean separation between user plane and RAN control.</td><td valign="top">Single interface handles all traffic: eth0 (VLAN trunk port carrying both tagged UE traffic and AP control traffic). Simplifies cabling and switch configuration but doubles interface load.</td></tr><tr><td valign="top"><strong>APN/VLAN Integration</strong></td><td valign="top">Full APN-to-VLAN mapping. Each APN is mapped to a unique VLAN. Enterprise can apply distinct firewall, QoS, and routing policies per VLAN. Scales for multiple network slices with granular control.</td><td valign="top">Same as 4G Bridge Classic Mode.</td></tr><tr><td valign="top"><strong>Deployment Complexity</strong></td><td valign="top">Requires comprehensive planning: VLAN design per APN, enterprise DHCP/DNS coordination per VLAN, trunk port configuration on enterprise switches, and IT integration for policy enforcement. Requires significant enterprise networking team involvement.</td><td valign="top">Requires the same VLAN planning, DHCP/DNS coordination, and policy configuration as Classic mode. Simplified physical cabling (single interface) but increased configuration complexity to ensure proper traffic separation. Requires careful enterprise network capacity planning.</td></tr><tr><td valign="top"><strong>Best For</strong></td><td valign="top">Enterprises requiring maximum security with per-APN isolation, direct UE device access, and advanced network policies. Ideal for mission-critical deployments where RAN infrastructure must remain isolated while UE require full enterprise integration. Suitable for large-scale, permanent installations.</td><td valign="top">Enterprises requiring per-APN isolation and direct UE device access but lacking infrastructure for dedicated AP connections. Suitable for sites with limited switching capacity or where running separate AP network is not feasible. Good for cost-sensitive deployments prioritizing UE visibility over RAN isolation.</td></tr><tr><td valign="top"><strong>Cautions</strong></td><td valign="top">Heavily dependent on enterprise DHCP and routing infrastructure. Misconfigurations can result in broadcast storms, VLAN leakage, or inter-VLAN routing issues. UE are fully exposed on the enterprise network requiring appropriate security controls and network segmentation policies.</td><td valign="top">Same as 4G Bridge Classic Mode, plus additional risks: APs fully exposed on enterprise network create RAN security vulnerability. Single interface doubles traffic load and creates potential performance degradation. Enterprise network issues affect both UE and AP connectivity simultaneously.</td></tr></tbody></table>

#### 4G Networking Mode Selection

The following figure outlines the decision-making process for selecting the appropriate 4G networking mode for your network.

<p align="center"><strong>4G Networking Mode Selection</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F4Z6VFEJVXblkgBT9H9of%2Fimage.png?alt=media&amp;token=a86915cd-415f-4db0-85bf-563e734c57b3" alt=""><figcaption></figcaption></figure></div>

### 5G Networking Modes

The Onyx 5G Platform supports two primary networking modes that determine how the Onyx Edge integrates with enterprise networks and manages UE traffic.

* 5G NAT Mode
* 5G Bridge (APN-on-VLAN) Mode

Unlike 4G, there are no Flat modes in 5G as fronthaul connections to RUs/FHMs must always remain private as they are highly time sensitive. The 5G NAT and Bridge modes provide flexibility between fully isolated, NAT-protected networks and slice-aware VLAN-integrated networks where enterprise IT retains control of addressing and policies.

#### 5G NAT Mode

<p align="center"><strong>5G NAT Mode Topology</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F71XsgR24iq3i2hqw7XwT%2F5g-nat-mode.png?alt=media&amp;token=2faebaa3-fdaf-464c-b545-7baa977d4ce9" alt=""><figcaption></figcaption></figure>

In the 5G NAT mode, the Onyx Edge functions as a secure gateway between the private 5G RAN and the enterprise network (N6 interface). APs and FHMs connect to the Onyx Edge via dedicated private fronthaul link, isolated from the enterprise LAN. The Onyx Edge assigns IP addresses to UE (from its local pool) and to APs and FHMs (via its DHCP service on the fronthaul network). NAT applied on the N6 interface ensures strong isolation — the enterprise LAN sees only the Onyx Edge's NAT IP address and cannot directly access APs, FHMs, or UE. This mode provides simplified IP management and complete control over RAN infrastructure, ideal for security- and privacy-focused deployments where enterprises do not require direct access to individual UE.

#### 5G Bridge (APN-on-VLAN) Mode

<p align="center"><strong>5G Bridge Mode Topology</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F6IPv8t4fGGfT4GG43bVa%2F5g-bridge-mode.png?alt=media&amp;token=1c89f859-771b-414e-b3d4-f17b07c8d280" alt=""><figcaption></figcaption></figure></div>

In the 5G Bridge mode, the Onyx Edge bridges UE traffic directly into enterprise VLANs without applying NAT. APs/FHMs connect to the Onyx Edge via dedicated private fronthaul links, isolated from the enterprise LAN. The Onyx Edge assigns IP addresses to APs and FHMs via its DHCP service on the fronthaul network. Each APN is mapped to a dedicated VLAN by the Onyx Edge, allowing traffic segregation and policy enforcement. Enterprise DHCP service assigns IP addresses to UE per VLAN, making them directly accessible as native enterprise devices. The N6 interface is configured as a VLAN trunk to carry tagged UE traffic to the enterprise network. Unlike NAT mode — where UE are hidden behind the Onyx Edge IP address — Bridge mode provides complete enterprise visibility and policy control over connected UE while maintaining strong RAN isolation and per-APN traffic segregation through VLAN isolation. This mode is recommended for organizations seeking deep integration with enterprise routing, security, and management tools.

#### 5G Networking Modes Comparison

<p align="center"><strong>Onyx 5G Deployment Modes Comparison</strong></p>

<table><thead><tr><th width="200" valign="top"></th><th valign="top">5G NAT Mode</th><th valign="top">5G Bridge (APN-on-VLAN) Mode</th></tr></thead><tbody><tr><td valign="top"><strong>Architecture</strong></td><td valign="top">NAT gateway model with dedicated fronthaul. Onyx Edge functions as secure gateway between private 5G RAN and enterprise network (N6 interface). All UE traffic NAT-translated before enterprise entry. APs/FHMs are always on dedicated private fronthaul links due to timing requirements.</td><td valign="top">VLAN bridge model with dedicated fronthaul. Onyx Edge bridges UE traffic directly into enterprise VLANs without NAT. Each APN maps to dedicated VLAN for granular enterprise policy control. APs/FHMs are always on dedicated private fronthaul links due to timing requirements.</td></tr><tr><td valign="top"><strong>Traffic Flow</strong></td><td valign="top"><p>UE traffic: UE > AP/FHM > Onyx Edge (NAT applied) > Enterprise network via N6 interface. </p><p>AP/FHM traffic: APs/FHMs > Onyx Edge via dedicated fronthaul links (point-to-point, timing-sensitive). Complete isolation of RAN infrastructure from enterprise.</p></td><td valign="top"><p>UE traffic: UE > AP/FHM > Onyx Edge (bridged to VLAN) > Enterprise VLANs via N6 trunk port.</p><p>AP/FHM traffic: Same as 5G NAT Mode. Complete isolation of RAN infrastructure from enterprise. Only UE backhaul handling differs from NAT mode.</p></td></tr><tr><td valign="top"><strong>IP Address Management</strong></td><td valign="top">Onyx Edge assigns IP addresses to UE from its local pool. Onyx Edge assigns IP addresses to APs and FHMs via its DHCP service. Enterprise network sees only the Onyx Edge's NAT IP address.</td><td valign="top">Enterprise DHCP service assigns IP addresses to UE per VLAN. Onyx Edge assigns IP addresses to APs and FHMs via its DHCP service. UE appear as native devices on enterprise subnets with enterprise-controlled addressing.</td></tr><tr><td valign="top"><strong>Network Isolation</strong></td><td valign="top">Maximum isolation. APs/FHMs can only communicate with Onyx Edge via private fronthaul (no intermediate switches). UE are hidden behind NAT. Enterprise cannot directly access any RAN infrastructure or UE. Complete security boundary between 5G network and enterprise.</td><td valign="top">Strong per-APN VLAN isolation for UE traffic. Each APN is bridged into a dedicated VLAN with enterprise-controlled policies. APs/FHMs remain isolated on private fronthaul. UE are fully visible and manageable by enterprise IT. RAN infrastructure is protected while UE are integrated into the enterprise security framework.</td></tr><tr><td valign="top"><strong>Interfaces</strong></td><td valign="top"><p>Fronthaul: 10G+ point-to-point links between APs/FHMs and Onyx Edge (no switches, timing-critical).</p><p>N6 (backhaul): Connects to enterprise network with NAT applied.</p></td><td valign="top"><p>Fronthaul: Same as 5G NAT Mode.</p><p>N6 (backhaul): Configured as VLAN trunk port connecting to enterprise network. RAN elements are isolated; only UE traffic reaches enterprise via tagged VLANs.</p></td></tr><tr><td valign="top"><strong>APN/VLAN Integration</strong></td><td valign="top">No APN-to-VLAN mapping at enterprise level. All APN traffic is collapsed behind NAT. APN distinction is not visible to the enterprise network.</td><td valign="top">Full APN-to-VLAN mapping. Each APN maps to a unique VLAN. Enterprise can apply distinct firewall rules, QoS priorities, and routing policies per VLAN. Enables enterprise policy enforcement per slice.</td></tr><tr><td valign="top"><strong>Deployment Complexity</strong></td><td valign="top">NAT simplifies IP management and reduces enterprise coordination. Requires proper IP address planning for local pools. Fronthaul requires high-speed point-to-point links with no intermediate switches. Less enterprise networking team involvement. Faster deployment.</td><td valign="top">Requires comprehensive VLAN-per-APN design, enterprise DHCP/DNS coordination per VLAN, N6 trunk port configuration, and deep enterprise IT integration. Fronthaul requirements are same as NAT mode. Significant planning and coordination required. Longer deployment timeline.</td></tr><tr><td valign="top"><strong>Best For</strong></td><td valign="top">Enterprises needing maximum security and isolation where UE are completely shielded from the enterprise LAN. Ideal for high-security environments, quick deployments, or scenarios where the enterprise IT team has limited 5G expertise. Suitable when UE traffic patterns do not require enterprise-level differentiation.</td><td valign="top">Enterprises needing direct UE access, deep IT/security integration, and per-APN network policies. Ideal for complex deployments with multiple network slices (e.g., separate policies for video surveillance, IoT sensors, voice communications). Suitable for organizations with advanced enterprise networking capabilities.</td></tr><tr><td valign="top"><strong>Cautions</strong></td><td valign="top">Requires proper IP address planning to avoid conflicts. Enterprise cannot directly access UE for management or monitoring. UE traffic patterns are not visible at the enterprise level. May not meet compliance requirements for device visibility in regulated industries.</td><td valign="top">Heavily dependent on enterprise DHCP, routing, and VLAN infrastructure. Misconfigurations can expose UE to unauthorized access or break VLAN isolation. Requires skilled network administrators familiar with both 5G and enterprise networking. UE are directly accessible on enterprise VLANs, requiring appropriate security controls and network segmentation policies.</td></tr></tbody></table>

#### 5G Networking Mode Selection

The following figure outlines the decision-making process for selecting the appropriate 5G networking mode for your network.

<p align="center"><strong>5G Networking Mode Selection</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJBsQXvlzt0KHMx2fGS1Y%2Fimage.png?alt=media&amp;token=ee5bf325-d60d-49ed-aafc-7a9ea95bee2e" alt=""><figcaption></figcaption></figure></div>

## Networking Mode Configuration

{% hint style="info" %}
**NOTE**: This section covers only the essential configuration steps for each networking mode. For complete configuration instructions, refer to the *Onyx Portal Operations Guide*.
{% endhint %}

**The networking mode configuration follows this workflow:**

The networking mode configuration follows this workflow:

1. Configure Network for NAT or Bridge Mode Support.
2. Add APNs.
3. Add/edit the Onyx Edge.
4. Add/edit subscriber groups / subscribers and associate them to APNs and VLANs.

### Configure Network for NAT or Bridge Mode Support

**To enable NAT or Bridge mode at the network level:**

{% stepper %}
{% step %}
In the header area, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FBPOlQeWN9WyjGCnltmwx%2Fimage.png?alt=media&amp;token=6ed6dd1b-e7b6-4f86-8628-2737c943987d" alt="" data-size="line"> (switch network).

The **Networks** page displays the summary details of all networks configured under the selected Onyx Portal account.
{% endstep %}

{% step %}
For the network that you want to edit, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

The **Edit Network** page > **Network** tab is displayed.
{% endstep %}

{% step %}
In the **Core/RAN** tab:

* To enable NAT mode, turn off the **APN on a VLAN** toggle switch.
* To enable Bridge mode, turn on the **APN on a VLAN** toggle switch.

<p align="center"><strong>Network-Level Configuration to Enable NAT or Bridge Mode</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FStJUwAZZXdkDsHU6nSIM%2Fimage.png?alt=media&amp;token=3d263cca-c43f-4aec-91c5-63aabfae9c25" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To save your edits, in the upper-right corner of the page, click **Save Network**.
{% endstep %}
{% endstepper %}

### Add APNs

**To add APNs:**

{% stepper %}
{% step %}
In the Onyx Portal navigation pane, click **Traffic**.

The **Traffic** page > **APNs** tab displays the list of APNs configured in the network.
{% endstep %}

{% step %}
To add an APN, in the upper-right corner of the page, click **Add APN**.

The **Add APN** page > **Add APN** tab is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FpIVBjzTjXeojfsdyTRTA%2F4g-apn-add-add-apn-tab.png?alt=media&amp;token=cd7133e8-794c-4bc7-bf95-5ef0d9bb80bd" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the **Add APN** tab, configure the APN's details.
{% endstep %}

{% step %}
In the **Add Per APN Per Onyx Edge Config** tab, configure the per APN per Onyx Edge details for each Onyx Edge in the network.

{% hint style="info" %}
**NOTE**: This tab is only applicable after the Onyx Edge has been added to the network. If you are adding an APN before addig the Onyx Edge, this tab will be completed during the Onyx Edge configuration step.
{% endhint %}

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F65QIO0rWiPDaMNl7ajaK%2F4g-apn-add-per-apn-tab.png?alt=media&amp;token=24ee7654-1983-48d4-b3c4-7e1d7f7c780f" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To save the APN, in the upper-right corner of the page, click **Save APN**.
{% endstep %}
{% endstepper %}

## 4G Onyx Edge Configuration

{% hint style="info" %}
This section covers only the key configurations to set up Onyx Edge for each 4G networking mode. For detailed configuration instructions, refer to the *4G Onyx Portal Operations Guide*.
{% endhint %}

This section covers the following configurations:

* [*Configure 4G Onyx Edge for NAT Classic Mode*](#configure-4g-onyx-edge-for-nat-classic-mode)
* [*Configure 4G Onyx Edge for NAT Flat Mode*](#configure-4g-onyx-edge-for-nat-flat-mode)
* [*Configure 4G Onyx Edge for Bridge Classic Mode*](#configure-4g-onyx-edge-for-bridge-classic-mode)
* [*Configure 4G Onyx Edge for Bridge Flat Mode*](#configure-4g-onyx-edge-for-bridge-flat-mode)

### Configure 4G Onyx Edge for NAT Classic Mode

**To configure a 4G Onyx Edge for NAT Classic mode:**

{% stepper %}
{% step %}
Confirm that the 4G network is configured in NAT mode.

See [*Configure Network for NAT or Bridge Mode Support*](#configure-network-for-nat-or-bridge-mode-support).
{% endstep %}

{% step %}
Add or edit the Onyx Edge for NAT Classic mode.

1. In the **Onyx Edge** tab, add/verify the Onyx Edge configuration.

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FgpzbXAdXjfXPHlMLGUU7%2F4g-oe-add-nat-classic-mode-onyx-edge-tab.png?alt=media&amp;token=e3c79f62-79db-47bb-a46a-73c2fb16d2fb" alt=""><figcaption></figcaption></figure></div>
2. In the **Core** tab, configure the following parameters.

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FU8MCAKWHm79DbxiFmkss%2F4g-oe-add-nat-classic-mode-core-tab.png?alt=media&amp;token=bc55346f-23fd-4cfc-9d9d-2e9f5279de53" alt=""><figcaption></figcaption></figure></div>

   * **LTE-UE-IP-Assignment**:
     * **IP Block**: The IP address pool from which the Onyx Edge will allocate IP addresses to UE. Default value: 192.168.128.0/24.
     * **Onyx Edge-as-DNS-Server**: On.
       * **Second Server**: Off.
   * **SGi Interface**:
     * **Static/DHCP** — Select the IP assignment mode for the SGi interface (eth0). Choose **Static** to manually configure IP settings, or **DHCP** to automatically obtain IP address, gateway, and DNS settings from the enterprise network's DHCP server. Default: DHCP.
       * **Static**: When On, configure the following. Default: Off.
         * **IP/Subnet**: The static IP address and subnet mask for the Onyx Edge's SGi interface (eth0), used for management connectivity to the enterprise network and Internet access. This is the IP address from which NATed UE traffic will originate as seen by the enterprise network. Default value: 1.1.1.1/24.
         * **Gateway**: The IP address of the enterprise network's default gateway router for the SGi interface. This gateway enables the Onyx Edge to route traffic to other networks and the Internet. Must be reachable within the IP/Subnet range configured above. Default value: 1.1.1.0.
         * **DNS Primary**: Primary DNS server's IP address. Default value: 8.8.8.8.
         * **DNS Secondary**: Secondary DNS server's IP address. Default value: 8.8.4.4.
       * **DHCP**: Default: On.
3. In the **RAN** tab, configure the following parameters:

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FA7rk5UCVh8ig1I550r4s%2F4g-oe-add-nat-classic-mode-ran-tab.png?alt=media&amp;token=cd766020-154a-4930-85d8-d0c1a39f5ffe" alt=""><figcaption></figcaption></figure></div>

   * **S1 Interface**:
     * **Static**: On.
       * **IP/Subnet**: Default value: 10.0.2.1/24.

         <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> This IP must be different than <strong>Start IP</strong> (see below) but must be from the same subnet.</p></div>
   * **Access Point DHCP Service**: On.
     * **Start IP**: Default value: 10.0.2.240.
     * **No. of IPs**: Default value: 15.
4. To save your edits, in the upper-right corner of the page, click **Save Onyx Edge**.
   {% endstep %}

{% step %}
Create/configure subscriber groups / subscriber accounts.

For detailed information, see the *4G Onyx Portal Operations Guide*.
{% endstep %}
{% endstepper %}

### Configure 4G Onyx Edge for NAT Flat Mode

**To configure a 4G Onyx Edge for NAT Flat mode:**

{% stepper %}
{% step %}
Confirm that the 4G network is configured in NAT mode.

See [*Configure Network for NAT or Bridge Mode Support*](#configure-network-for-nat-or-bridge-mode-support).
{% endstep %}

{% step %}
Add or edit the Onyx Edge for NAT Flat mode.

1. In the **Onyx Edge** tab, add/verify the Onyx Edge configuration.

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FTZ5EAYsl678OX7txUiOg%2F4g-oe-add-nat-flat-mode-onyx-edge-tab.png?alt=media&amp;token=a399e7ad-74e0-4a7c-b912-c2528ee43b05" alt=""><figcaption></figcaption></figure></div>
2. In the **Core** tab, configure the following parameters:

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F16d5bY3JUd3ZJxkkZwBl%2F4g-oe-add-nat-flat-mode-core-tab.png?alt=media&amp;token=b25ded38-c63f-4e8f-9bf0-61135c1910df" alt=""><figcaption></figcaption></figure></div>

   * **LTE-UE-IP-Assignment**:
     * **IP Block**: The IP address pool from which the Onyx Edge will allocate IP addresses to UE. Default value: 192.168.128.0/24.
     * **Onyx Edge-as-DNS-Server**: On.
       * **Second Server**: Off.
   * **SGi Interface**:
     * **Static/DHCP** — Select the IP assignment mode for the SGi interface (eth0). Choose **Static** to manually configure IP settings, or **DHCP** to automatically obtain IP address, gateway, and DNS settings from the enterprise network's DHCP server. Default: DHCP.
       * **Static**: When On, configure the following. Default: Off.
         * **IP/Subnet**: The static IP address and subnet mask for the Onyx Edge's SGi interface (eth0), used for management connectivity to the enterprise network and Internet access. This is the IP address from which NATed UE traffic will originate as seen by the enterprise network.
         * **Gateway**: The IP address of the enterprise network's default gateway router for the SGi interface. This gateway enables the Onyx Edge to route traffic to other networks and the Internet. Must be reachable within the IP/Subnet range configured above.
         * **DNS Primary**: Primary DNS server's IP address.
         * **DNS Secondary**: Secondary DNS server's IP address.
       * **DHCP**: Default: On.
3. In the **RAN** tab, configure the following parameters:

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKHBU8JXk3Ap7o6c4q08p%2F4g-oe-add-nat-flat-mode-ran-tab.png?alt=media&amp;token=a0380630-032a-453b-9ac1-a3e9cf3f4f0a" alt=""><figcaption></figcaption></figure></div>

   * **S1 Interface**:
     * **Static**: Off.
     * **DHCP**: Off.
     * **Same as SGi**: On. In NAT Flat mode, both S1 and SGi traffic use the same physical interface (eth0). APs connect through the enterprise network simplifying deployment.
4. To save your edits, in the upper-right corner of the page, click **Save Onyx Edge**.
   {% endstep %}

{% step %}
Create/configure subscriber groups / subscriber accounts.

For detailed information, see the *4G Onyx Portal Operations Guide*.
{% endstep %}
{% endstepper %}

### Configure 4G Onyx Edge for Bridge Classic Mode

**To configure a 4G Onyx Edge for Bridge Classic mode:**

{% stepper %}
{% step %}
Confirm that the 4G network is configured in Bridge mode.

See [*Configure Network for NAT or Bridge Mode Support*](#configure-network-for-nat-or-bridge-mode-support).
{% endstep %}

{% step %}
Add APNs required for Bridge mode support.

See [*Add APNs*](#add-apns).
{% endstep %}

{% step %}
Add or edit the Onyx Edge for Bridge Classic mode.

1. In the **Onyx Edge** tab, add/verify the Onyx Edge configuration.

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FWBbDHTl1LFrIOefSX58X%2F4g-oe-add-nat-bridge-mode-oe-tab.png?alt=media&amp;token=978fe1ff-39af-4a17-8afa-740a49403cd6" alt=""><figcaption></figcaption></figure></div>
2. In the **Core** tab, configure the following parameters:

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FG4q2h2jN1U7U4bYwxoh8%2F4g-oe-add-bridge-classic-mode-core-tab.png?alt=media&amp;token=b8ca0e7b-07aa-405a-bc2b-3b75ff35ab5a" alt=""><figcaption></figcaption></figure></div>

   * **Onyx Edge-as-DNS-Server**: Disabled.
   * **DNS Primary**: The primary DNS server's IP address. Default value: 8.8.8.8.
   * **DNS Secondary**: The secondary DNS server's IP address. Default value: 8.8.4.4.
   * **SGi Interface**:
     * **Static**: On.
       * **IP/Subnet**: The management IP address for Onyx Edge to reach enterprise network/Internet.
       * **Gateway**: The enterprise gateway router's IP address.
       * **DNS Primary**: The primary DNS server's IP address.
       * **DNS Secondary**: The secondary DNS server's IP address.
       * **SGi Management VLAN**: The SGi Management VLAN ID. Default value: 0. (default value of 0 means untagged; management traffic will not carry a VLAN tag. Set to a non-zero VLAN ID if management traffic must be carried on a specific VLAN.)
3. In the **RAN** tab, configure the following parameters:

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FsnxsCsfu0c3sXGpJP0QI%2F4g-oe-add-bridge-classic-ran-tab.png?alt=media&amp;token=3a8d6a6f-7505-40ce-b0a8-b64754fa50e8" alt=""><figcaption></figcaption></figure></div>

   * **S1 Interface**:
     * **Static**: On.
       * **IP/Subnet**: The IP address/subnet for the Onyx Edge's S1 interface. Default value: 10.0.2.1/24.
     * **Access Point DHCP Service**: On.
       * **Start IP**: The Access Point DHCP pool's start IP address. Default value: 10.0.2.240.
       * **No. of IPs**: The number of IP addresses. Default value: 15.
4. In the **Per APN Per Onyx Edge Config** tab, configure the Per-APN-Per-Onyx-Edge configurations:

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fhu6pKYeXY8zIKjVWurtC%2F4g-oe-add-bridge-classic-mode-per-apn-tab.png?alt=media&amp;token=8161d41b-d27a-4016-9ab4-25accbf98c86" alt=""><figcaption></figcaption></figure></div>

   * **APN ID**: Read-only field. Cannot be edited.
   * **Local IP / Subnet**: Enterprise subnet for the APN.
   * **Default GW IP**: Enterprise gateway IP address for the VLAN.
   * **VLAN ID**: VLAN identifier for the APN.
   * **Default GW MAC**: MAC address of the enterprise gateway router on this VLAN.
5. To save your edits, in the upper-right corner of the page, click **Save Onyx Edge**.
   {% endstep %}

{% step %}
Create/configure subscriber groups / subscriber accounts to use APNs configured for Bridge mode support.

For detailed information, see the *4G Onyx Portal Operations Guide*.
{% endstep %}
{% endstepper %}

### Configure 4G Onyx Edge for Bridge Flat Mode

**To configure a 4G Onyx Edge for Bridge Flat mode:**

{% stepper %}
{% step %}
Confirm that the 4G network is configured in Bridge mode.

See [*Configure Network for NAT or Bridge Mode Support*](#configure-network-for-nat-or-bridge-mode-support).
{% endstep %}

{% step %}
Add APNs required for Bridge mode support.

See [*Add APNs*](#add-apns).
{% endstep %}

{% step %}
Add or edit the Onyx Edge for Bridge Flat mode.

1. In the **Onyx Edge** tab, add/verify the Onyx Edge configuration.

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJNZeEYJiugqlsutVccCn%2F4g-oe-add-bridge-flat-mode-oe-tab.png?alt=media&amp;token=5f834d1d-7bf2-4579-ba71-e8cdd5a4b5ed" alt=""><figcaption></figcaption></figure></div>
2. In the **Core** tab, configure the following parameters:

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Ftyc7KqAXb1z6S0wGZe28%2F4g-oe-add-bridge-flat-mode-core-tab.png?alt=media&amp;token=9bb02455-ab2d-4f0d-ba39-1ec95359de19" alt=""><figcaption></figcaption></figure></div>

   * **Onyx Edge-as-DNS-Server**:
     * **DNS Primary**: Primary DNS server's IP address. Default value: 8.8.8.8.
     * **DNS Secondary**: Secondary DNS server's IP address. Default value: 8.8.4.4.
   * **SGi Interface**:
     * **Static**: On.
     * **IP/Subnet**: Management IP address for Onyx Edge to reach enterprise network/Internet.
     * **Gateway**: Enterprise gateway router's IP address.
     * **DNS Primary**: Primary DNS server's IP address.
     * **DNS Secondary**: Secondary DNS server's IP address.
     * **SGi Management VLAN**: SGi Management VLAN ID. Default value: 0. (default value of 0 means untagged management traffic. Set to a non-zero VLAN ID if management traffic must be carried on a specific VLAN.)
3. In the **RAN** tab, configure the following parameters:

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0CdCbIVMuqnpyqGFI0Zl%2F4g-oe-add-bridge-flat-mode-ran-tab.png?alt=media&amp;token=012fa998-dfa0-41bc-83dd-a2655e43220b" alt=""><figcaption></figcaption></figure></div>

   * **S1 Interface**:
     * **Static**: Off.
     * **DHCP**: Off.
     * **Same as SGi**: On. In Bridge Flat mode, both S1 and SGi traffic use the same physical interface (eth0), configured as a VLAN trunk. APs connect through the enterprise network simplifying deployment.&#x20;
4. In the **Per APN Per Onyx Edge Config** tab, configure the Per-APN-Per-Onyx-Edge settings as required for each APN:

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5xxXpV46ZyDOfnhNgNLo%2F4g-oe-add-bridge-flat-mode-per-apn-tab.png?alt=media&amp;token=9ee32f22-0600-4bf5-a616-bcb75fc934c6" alt=""><figcaption></figcaption></figure></div>

   * **Local IP / Subnet**: Enterprise subnet for the APN.
   * **Default GW IP**: Enterprise gateway IP for the VLAN.
   * **VLAN ID**: VLAN identifier for the APN.
   * **Default GW MAC**: MAC address of the enterprise gateway router on this VLAN.

     <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>Each APN must be mapped to a unique VLAN to enable proper traffic segregation and enterprise policy enforcement.</p></div>
5. In the upper-right corner of the page, click **Save Onyx Edge**.
   {% endstep %}

{% step %}
Create/configure subscriber groups / subscriber accounts to use APNs configured for Bridge mode support.

For detailed information, see the *4G Onyx Portal Operations Guide*.
{% endstep %}
{% endstepper %}

## 5G Onyx Edge Configuration

{% hint style="info" %}
This section applies to 5G Onyx Edge (NR + Core) configurations and outlines only the key configurations required to set up Onyx Edge for each 5G networking mode. For detailed configuration instructions, refer to the *5G Onyx Portal Operations Guide*.
{% endhint %}

This section covers the following configurations:

* [*Configure 5G Onyx Edge for NAT Mode*](#configure-5g-onyx-edge-for-nat-mode)
* [*Configure 5G Onyx Edge for Bridge Mode*](#configure-5g-onyx-edge-for-bridge-mode)

### Configure 5G Onyx Edge for NAT Mode

**To configure a 5G Onyx Edge for NAT mode:**

{% stepper %}
{% step %}
Confirm that the 5G network is configured in NAT mode.

*See* [*Configure Network for NAT or Bridge Mode Support*](#configure-network-for-nat-or-bridge-mode-support).
{% endstep %}

{% step %}
Add or edit the Onyx Edge for NAT mode.

1. In the **Onyx Edge** tab, configure the Onyx Edge parameters.

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FtMwSzYCyFyStIEs4ghg0%2F5g-oe-add-nat-mode-onyx-edge-tab.png?alt=media&amp;token=5517ea8c-e34b-4d42-88f7-d0977fa332dd" alt=""><figcaption></figcaption></figure></div>
2. In the **Core** tab, configure the following parameters:

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FcVu2swcw9WpWy3bgMhod%2F5g-oe-add-nat-mode-core-tab.png?alt=media&amp;token=d5a141dd-e91b-4892-88d7-4bdb7c868a5d" alt=""><figcaption></figcaption></figure></div>

   * **UE Configurations**:
     * **IP Range**: The IP address pool from which the Onyx Edge will allocate IP addresses to UE. Example: 192.168.128.0/24.
     * **DNS Server**:
       * **Onyx Edge-as-DNS-Server**: On. The Onyx Edge provides DNS to UE.
       * **Second Server**: Off (enable and configure if a secondary DNS is required).
     * Management Interface: Static/DHCP — select IP assignment for the N6 interface.
       * **Static:** IP/Subnet (enterprise-facing IP), Gateway (enterprise default gateway), DNS Primary, DNS Secondary.
       * **DHCP:** N6 interface obtains IP settings automatically from enterprise DHCP.
3. In the **RAN** tab, configure the RAN parameters.

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F4k0HnR5y5GliMnVw3vqt%2F5g-oe-add-nat-mode-ran-tab.png?alt=media&amp;token=adc0950c-ab84-49bd-9823-29207238b6c7" alt=""><figcaption></figcaption></figure></div>
4. To save your edits, in the upper-right corner of the page, click **Save Onyx Edge**.
   {% endstep %}

{% step %}
Create/configure subscriber groups / subscriber accounts.

For detailed information, see the *5G Onyx Portal Operations Guide*.
{% endstep %}
{% endstepper %}

### Configure 5G Onyx Edge for Bridge Mode

**To configure a 5G Onyx Edge for Bridge mode:**

{% stepper %}
{% step %}
Confirm that the 5G network is configured in Bridge mode.

*See* [*Configure Network for NAT or Bridge Mode Support*](#configure-network-for-nat-or-bridge-mode-support).
{% endstep %}

{% step %}
Add APNs required for Bridge mode support.

See [*Add APNs*](#add-apns).
{% endstep %}

{% step %}
Add or edit the Onyx Edge for Bridge mode.

1. In the **Onyx Edge** tab, add/verify the Onyx Edge configurations.

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FTxt1fGj6lWsMpeMjhFCC%2F5g-oe-add-bridge-mode-onyx-edge-tab.png?alt=media&amp;token=c8ec2bea-4830-4d43-b615-72070bb0f479" alt=""><figcaption></figcaption></figure></div>
2. In the **Core** tab, configure the following parameters:

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F7oZRkAw8fkYQJ2sUKPJO%2F5g-oe-add-bridge-mode-core-tab.png?alt=media&amp;token=2c47a4f7-a54b-470d-9e97-97732fc9d24f" alt=""><figcaption></figcaption></figure></div>

   * **Onyx Edge-as-DNS-Server**: Disabled. In 5G Bridge mode, UE obtain DNS from the enterprise DHCP service on their assigned VLAN, not from the Onyx Edge.
     * **DNS Primary**: The IP address of the primary DNS server that the Onyx Edge itself uses for system operations and management functions.
     * **DNS Secondary**: The IP address of the secondary/backup DNS server that the Onyx Edge itself uses for system functions if the primary DNS server becomes unavailable.
   * **Management Interface**:
     * **Static**: On.
       * **Management IP/Subnet**: Management IP address for Onyx Edge to reach enterprise network/Internet.
       * **N6 IP**: IP address for N6 interface.
       * **Gateway**: Enterprise gateway router IP address.
       * **Management VLAN**: Management VLAN ID.
       * **DNS Primary**: Onyx Edge's primary DNS server's IP address.
       * **DNS Secondary**: Onyx Edge's secondary DNS server's IP address.
3. In the **RAN** tab, configure the required RAN parameters.

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FkZhtha0xTwPh36fyK8Ic%2F5g-oe-add-bridge-mode-ran-tab.png?alt=media&amp;token=6a745125-b599-42e7-82fa-3c7451b62daa" alt=""><figcaption></figcaption></figure></div>
4. In the **Per APN Per Onyx Edge Config** tab, configure the following for each APN:

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fmhzj1pAwkHNJdja0n5US%2F5g-oe-add-bridge-mode-per-apn-tab.png?alt=media&amp;token=712915dd-103d-4885-a197-4beee81fe30f" alt=""><figcaption></figcaption></figure></div>

   * **APN ID**: Read-only field. Cannot be edited.
   * **Local IP / Subnet**: Enterprise subnet for this APN.
   * **Default GW IP**: Enterprise gateway IP address for this VLAN.
   * **VLAN ID**: VLAN identifier for this APN.
   * **Default GW MAC**: MAC address of the enterprise gateway router on this VLAN.

     <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE</strong>: Each APN must be mapped to a unique VLAN to enable proper traffic segregation and enterprise policy enforcement. The N6 interface is configured as a VLAN trunk to carry tagged UE traffic to the enterprise network.</p></div>
5. In the upper-right corner of the page, click **Save Onyx Edge**.
   {% endstep %}

{% step %}
Create/configure subscriber groups / subscriber accounts to use APNs configured for Bridge mode support.

For detailed information, see the *5G Onyx Portal Operations Guide*.
{% endstep %}
{% endstepper %}

## Related Documentation

* *4G Onyx Portal Operations Guide*
* *5G Onyx Portal Operations Guide*
* *GXC Glossary*

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# 4G & 5G Onyx Survey Solution

## Introduction

The Onyx Survey is a comprehensive RF coverage assessment solution that combines the GXC Survey mobile app for field data collection with the Onyx Portal Survey tool for data analysis and visualization.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FtSNoOA0eomNL6gRfh39q%2Fimage%20(9).png?alt=media&amp;token=fa7db4b6-be60-4a0d-b28c-51194475816a" alt=""><figcaption></figcaption></figure></div>

Field engineers use the mobile app to capture real-time RF measurements and GPS coordinates during walk-through or drive-test surveys.

Network engineers use the Onyx Portal to analyze survey data through interactive maps, time-series charts, and signal quality metrics. The tool supports comprehensive network assessment for private 4G and 5G cellular networks, including coverage validation, post-deployment verification, troubleshooting, and optimization.

## GXC Survey Mobile App

The GXC Survey mobile app is a companion tool designed to collect real-time RF measurements in the field as the surveying mobile device moves through the coverage area. Collecting measurement data directly from mobile devices provides several advantages, including:

* Captures live RF measurements as you move through the survey area
* Automatically records location coordinates with each measurement
* Allows for both structured drive tests and ad-hoc walking surveys
* Can upload survey logs to cloud storage for immediate access
* Generates log files compatible with the Onyx Portal Survey tool for immediate visualization and analysis

The survey logs generated by the GXC Survey mobile app can be uploaded to the Onyx Portal for visualization and analysis.

* Cloud-Based Access – If cloud synchronization was active during the survey, logs are automatically available in the Survey tool's cloud file selection.
* Local File Upload – Survey logs locally saved on the mobile device can be transferred to a computer and uploaded to the Onyx Portal.

{% hint style="info" %}
**NOTE:** The GXC Survey mobile app is compatible only with GXC-approved mobile devices that meet specific hardware and software requirements for accurate RF data collection. For more information, contact GXC Technical Support.
{% endhint %}

### Authentication and Venue Association

The Survey app supports streamlined authentication and venue association via automatic network detection or QR code scanning, enabling automatic upload of survey logs to Onyx Portal. The app automatically selects the appropriate connection method based on your network environment:

* Automatic Connection – When connected to a GXC network, the app automatically authenticates and links to your Onyx Portal account.
* QR Code Authentication – When not on a GXC network, scan the QR code generated in the Onyx Portal to:
  * Log in to your Onyx Portal account
  * Associate the app with the venue
  * Enable automatic upload of survey log files to Onyx Portal

Survey logs are generated using the GXC Survey mobile app during field surveys. The following procedure describes how to use the mobile app to collect RF measurement data and create survey logs for analysis.

The GXC Survey mobile app comes pre-installed on GXC mobile devices. For additional information, please contact GXC Technical Support.

## Onyx Portal Survey Tool

The Onyx Portal Survey tool provides visualization and analysis capabilities for RF survey data. After survey logs are generated using the GXC Survey mobile app and uploaded to the system, the Survey tool enables you to view interactive maps, analyze signal metrics, and extract actionable insights for network optimization.

### Survey Log Sources

The Survey tool supports two methods for accessing survey logs—cloud-based storage and local file upload. When generating a survey report, you must select the appropriate log source based on where your survey data is stored.

#### Cloud Survey Logs

Cloud survey logs are stored in centralized, cloud-based storage systems and can be accessed remotely by authorized users. This storage option is well suited for organizations that require centralized data management, collaboration across teams, and the ability to perform survey analysis from remote locations.

Access to cloud survey logs requires a valid access token to ensure secure authentication. Once authenticated, users can view and manage survey data collected across multiple sites, enabling consistent and unified data handling.

Cloud survey logs are automatically synchronized with survey collection devices, ensuring that the latest data is always available without manual file transfers.

Cloud survey log files typically follow this naming pattern:&#x20;

`<SiteID>_<SessionID>_radio_log_<YYYYMMDD>_<HHMMSS>.json`

Where:

* SiteID – Unique identifier for the survey location
* SessionID – Survey session identifier
* YYYYMMDD – Date of survey (Year-Month-Day)
* HHMMSS – Time of survey (Hour-Minute-Second)

#### Local Survey Logs

Survey logs saved on the surveying mobile device can be transferred to a computer and uploaded via Onyx Portal. These local survey logs can be uploaded and analyzed without requiring cloud storage or access tokens, making them suitable for offline environments or isolated deployments.

Local survey log files typically follow this naming pattern, but can be renamed if required:

`radio_log_<YYYYMMDD>_<HHMMSS>.json`

Where:

* YYYYMMDD – Date of survey (Year-Month-Day)
* HHMMSS – Time of survey (Hour-Minute-Second)

The maximum supported file size depends on the system configuration; please consult your system administrator for the existing limits.

### Access Tokens

Access tokens are security credentials required to retrieve survey logs from cloud storage. These tokens provide secure, time-limited access to your survey data, ensuring that only authorized users can access sensitive network performance information.

Access tokens serve the following purposes:

* Authentication – Verify user identity when requesting access to survey data
* Authorization – Grant specific permissions to designated survey resources
* Time-limited access – Tokens expire after a defined validity period, reducing long-term credential risks
* Audit trail – Token usage is tracked for security monitoring and compliance

Best practices for token management:

* Set token validity periods based on actual access needs — avoid unnecessarily long expiry windows
* Store tokens securely and never share them publicly
* Generate new tokens only when existing ones expire
* Revoke any unused or compromised tokens immediately

### Map View

The map view provides an interactive geographic visualization of survey data, allowing you to see exactly where measurements were taken and how signal quality varies across the coverage area. This spatial representation helps identify coverage gaps, interference sources, and optimal base station placement.

The map view displays:

* Survey Drive Route – The path taken during the RF survey, represented by connected data points.
* Color-Coded Markers – Each marker represents a measurement point, color-coded by signal strength.
* Geographic Context – Streets, buildings, and terrain features from Google Maps
* Neighbor Cell Data – Accessible by clicking any measurement point, showing all cells detected at that location
* Access Point Markers – Registered APs are displayed on the map based on GPS coordinates. AP markers help correlate survey signal measurements with the physical locations of deployed or planned APs. AP markers can also be added manually for units not yet provisioned in the network.
* KMZ Coverage Overlay – When a KMZ file has been uploaded, the predicted coverage basemap is displayed on the map alongside the live survey data, enabling direct visual comparison of predicted versus actual coverage.

#### Map Controls

The map interface provides the following controls for navigation, customization, and analysis:

* Map/Satellite Toggle – Switch between map view and satellite imagery
* Zoom Controls – Use + and - buttons or mouse wheel to zoom in/out.
* Pan – Click and drag to move the map.
* Fullscreen Map View – Expand the map to view it full screen.
* Expandable Map View – Toggle to show/hide signal graphs below the map, expanding the map to fill available screen space.
* Signal Metric Selector – Choose between RSRP, SINR, RSRQ, RSSI, or Cell (PCI) to visualize different coverage metrics on the map.
* Signal Quality Legends
* Point Measurement Metrics
* Survey Playback – Trace the surveyor's route from start to end point to identify coverage gaps and temporal aspects of measurements.
* Legends – Click to view comprehensive signal quality information and record type definitions.
* Switch Survey – Load a different survey without returning to the venues list for easy comparison.

#### Signal Metric Selector with Legends

The Survey tool provides a metric selector dropdown and corresponding signal quality legends for flexible coverage analysis.

Available metrics:

* RSRP – Reference Signal Received Power (primary indicator of signal strength and coverage quality)
* SINR – Signal-to-Interference-plus-Noise Ratio (best predictor of data throughput and user experience)
* RSRQ – Reference Signal Received Quality (signal quality relative to adjacent cell interference)
* RSSI – Received Signal Strength Indicator (total received power — signal, interference, and noise combined)
* Cell (PCI) – Physical Cell ID (PCI) visualization with unique color coding per cell (use to verify cell boundaries and handover zones). The same PCI will always appear in the same color across the map.

Legends provide comprehensive reference tables with signal quality thresholds for the selected metric, including color-coded signal quality ranges (Excellent, Good, Fair, Poor, Very Poor), thresholds for each quality level, service quality descriptions, and technology-specific ranges (separate criteria for 4G and 5G, where applicable).

The following screenshot shows the Metric Selector dropdown and the Show Legends button.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FhyWFM8uXeIs48NUekK4z%2Fimage.png?alt=media&amp;token=6bc7b984-4b17-4c86-b31b-30ec20557bf0" alt=""><figcaption></figcaption></figure>

The following screenshot displays the Legends dialog box for RSRP metrics.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FOSPGhr6ODmGF5rRfHsdo%2Fsurvey-legend-rsrp.png?alt=media&amp;token=d2ec1a15-b7c8-420e-9f8f-43fb86f29e44" alt="" width="563"><figcaption></figcaption></figure></div>

For detailed usage instructions and analysis workflows, see [Analyze Survey Reports](#generate-survey-reports).

#### Radio Log Record Types

Survey logs contain three types of records, each serving a specific purpose in capturing and organizing RF measurement data.

* Summary – ● (Disc) A Summary record is generated when the device moves a set distance (every 10 meters). It contains aggregated statistics from the Detail records collected in that area, plus a snapshot of all neighbor cells visible at that moment. Use Summary records to identify broad coverage patterns and trends across geographic areas.
* Detail – ◆ (Diamond) A Detail record captures the primary serving cell's signal metrics at a fixed interval (every 1 second). Provides high-resolution temporal data for precise signal analysis, including handover events and rapid signal changes. Use Detail records when fine-grained analysis of a specific location or time period is required.
* Notes – ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQKbZX9XtYS2gd4sOivEE%2Fimage.png?alt=media\&token=f342c684-7a3c-49d0-a095-5f56a9c60179) (Star) Generated when a user manually saves a note at their current location during the survey. Use notes to flag specific locations of interest — obstacles, interference sources, or anomalies observed in the field.

#### Signal Quality Legends

Signal quality legends provide standardized interpretations of RF measurements for both 4G and 5G networks. These classifications help network engineers quickly assess coverage quality and identify areas requiring optimization.

**4G Signal Quality Legend**

For 4G networks, signal strength is measured using RSRP with the following quality classifications.

<p align="center"><strong>4G RSRP Signal Legend</strong></p>

| Color & Strength                                                                                                                                                                                                                                                           | RSRP Range (dBm) | Quality     | Interpretation            |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | ----------- | ------------------------- |
| <p><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fhwd3SZRDRwLp4rjhQ2zl%2Fimage.png?alt=media&amp;token=6252236e-84a9-4dc1-8e42-6375d62be182" alt="" data-size="line"> Excellent<br></p> | ≥ -80            | Very strong | Ideal for high throughput |
| <p><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fq73WqzJ8V0bxZZfDPfS7%2Fimage.png?alt=media&amp;token=aadc9425-a1db-4946-bd1d-49ef2f1589bf" alt=""> Good<br></p>                       | -81 to -90       | Good        | Stable connection         |
| <p><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FGQXR3siHvGJ3bTXKOFpN%2Fimage.png?alt=media&amp;token=583db84b-3031-4fd5-bca3-0bc26412b646" alt=""> Fair<br></p>                       | -91 to -100      | Moderate    | Some drops, lower speeds  |
| <p><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FLGACxP4Gx9fIMxySoxpZ%2Fimage.png?alt=media&amp;token=caa9cbd0-be3b-4ae4-be03-39aebdaae9d6" alt=""> Poor<br></p>                       | -101 to -110     | Weak        | Marginal service          |
| <p><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FooshvazszKVrmrfGNaii%2Fimage.png?alt=media&amp;token=e29cea96-af0e-4aab-bc5a-84fb6afe1bd1" alt=""> Very Poor<br></p>                  | < -110           | Very weak   | Likely unusable           |

<p align="center"><strong>4G SINR Signal Legend</strong></p>

<table><thead><tr><th>Color &#x26; Strength</th><th>SINR (dB)</th><th width="150">Quality</th><th>Interpretation</th></tr></thead><tbody><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FA6Qpt4LZY9lr16q0jILs%2Fimage.png?alt=media&amp;token=f9be0539-fc76-474a-97cd-7f14ad28adf2" alt=""> Excellent<br></td><td>≥ 20 dB</td><td>Excellent</td><td>Very high throughput</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FSoer4V3wrh185UQvB0nv%2Fimage.png?alt=media&amp;token=59c20329-b275-4b28-9c12-98a27eb69b90" alt=""> Good<br></td><td>13 to 19 dB</td><td>Good</td><td>High data rates</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQobesaFeB8PaSJPDhHzP%2Fimage.png?alt=media&amp;token=a676ab39-2aa7-4c27-9f07-fe22017ef7b2" alt=""> Fair<br></td><td>0 to 12 dB</td><td>Fair</td><td>Usable but limited</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fy03vXLDnbl6RVapDRh8e%2Fimage.png?alt=media&amp;token=9a455c6d-60ec-480c-becd-fa5a3e74353a" alt=""> Poor<br></td><td>-3 to -1 dB</td><td>Poor</td><td>Edge of usability</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FdoDiIG4Gy8dJEyWJT7Gv%2Fimage.png?alt=media&amp;token=45c19c46-f35d-41ae-a619-a036a970b162" alt=""> Very Poor<br></td><td>&#x3C; -3 dB</td><td>Very Poor</td><td>No reliable service</td></tr></tbody></table>

<p align="center"><strong>4G RSRQ Signal Legend</strong></p>

<table><thead><tr><th>Color &#x26; Strength</th><th>RSRQ (dB)</th><th width="150">Quality</th><th>Interpretation</th></tr></thead><tbody><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FP8greBr5ldjUdUuxKp7q%2Fimage.png?alt=media&amp;token=e5b3a1ab-b1e6-4c36-8dde-170693cf2cb0" alt="" data-size="line"> Excellent<br></td><td>≥ -9 dB</td><td>Excellent</td><td>Very clean signal</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F6HYwMS6A72zVlJ0oNQqT%2Fimage.png?alt=media&amp;token=373696e7-cab0-41e6-9e93-6fccf2b4d4b9" alt=""> Good<br></td><td>-9 to -12 dB</td><td>Good</td><td>Stable performance</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FivULS50gAJWkOh1iPxbD%2Fimage.png?alt=media&amp;token=44273175-a765-4a3b-82c7-0c08c0a18ffb" alt=""> Fair<br></td><td>-13 to -15 dB</td><td>Fair</td><td>Moderate interference</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5oKaRbPFVyreht21GDb2%2Fimage.png?alt=media&amp;token=8a15ef76-dc76-4b22-b723-cdffef87396c" alt=""> Poor<br></td><td>-16 to -18 dB</td><td>Poor</td><td>High interference</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8taF3HoqXXLYn5DllnMh%2Fimage.png?alt=media&amp;token=14001873-b71a-4969-9883-6edf73c48646" alt=""> Very Poor<br></td><td>&#x3C; -18 dB</td><td>Very Poor</td><td>Likely unusable</td></tr></tbody></table>

<p align="center"><strong>4G RSSI Signal Legend</strong></p>

<table><thead><tr><th>Color &#x26; Strength</th><th>RSSI (dBm)</th><th width="150">Quality</th><th>Interpretation</th></tr></thead><tbody><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F1ueP5AbV7l6Ocn7e6a6V%2Fimage.png?alt=media&amp;token=889bae82-b0fe-48de-8ac9-35dd62eadd65" alt=""> Excellent<br></td><td>≥ -65 dBm</td><td>Excellent</td><td>Very strong signal</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FFUAufFqLtd9XsU5uwNbY%2Fimage.png?alt=media&amp;token=6f1a7bde-9e2a-49ac-a9a3-e06cc1a8be60" alt=""> Good<br></td><td>-66 to -75 dBm</td><td>Good</td><td>Strong signal</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FNDqlOvZKRZPQbflEJeAF%2Fimage.png?alt=media&amp;token=860377ef-e4ea-4cc9-8c45-4ffe6106eeeb" alt=""> Fair<br></td><td>-76 to -85 dBm</td><td>Fair</td><td>Usable signal</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F3u7L6Xm5MrjTFU0PugcB%2Fimage.png?alt=media&amp;token=1bce5a8a-1d54-459a-9125-ab864a10e0be" alt=""> Poor<br></td><td>-86 to -95 dBm</td><td>Poor</td><td>High noise</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F59ogOl1cP72eipVqB3bk%2Fimage.png?alt=media&amp;token=9b30661c-1e65-4033-9bb3-98b4c47cfa50" alt=""> Very Poor<br></td><td>&#x3C; -95 dBm</td><td>Very Poor</td><td>Likely unusable</td></tr></tbody></table>

**5G Signal Quality Legend**

For 5G New Radio (NR) networks, signal strength is measured using “Synchronization Signal – Reference Signal Received Power” (SS-RSRP) with the following quality classifications.

<p align="center"><strong>5G SS-RSRP Signal Legend</strong></p>

| Color & Strength                                                                                                                                                                                                                                          | SS-RSRP Range (dBm) | Quality     | Interpretation                |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | ----------- | ----------------------------- |
| <p><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FSBPiwxtwEGcnSBDBNMZi%2Fimage.png?alt=media&amp;token=dd23d3e2-eb59-4cc6-a6f5-344653e8016f" alt=""> Excellent<br></p> | ≥ -75               | Very strong | Excellent 5G coverage         |
| <p><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Ft9Ghr2Yb1XfidleCjz14%2Fimage.png?alt=media&amp;token=709a9f97-dc47-4d7e-ae6d-6732298ec035" alt=""> Good<br></p>      | -76 to -90          | Good        | Reliable throughput           |
| <p><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FPAjTb8mt9UKk1NsB95P2%2Fimage.png?alt=media&amp;token=887e1e2f-3773-4ee7-a503-92d0d041d810" alt=""> Fair<br></p>      | -91 to -105         | Moderate    | Usable, but may switch to LTE |
| <p><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5fMTfUQsTm83yGzY41DH%2Fimage.png?alt=media&amp;token=84427577-70d7-4d21-80ef-0b9070b3f43e" alt=""> Poor<br></p>      | -106 to -120        | Weak        | Edge of coverage              |
| <p><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FakWcjiq6S4lGe9BFOJIX%2Fimage.png?alt=media&amp;token=7606f049-c657-432a-90fa-a815f5957e5d" alt=""> Very Poor<br></p> | < -120              | Very weak   | Usually, no service           |

<p align="center"><strong>5G SINR Signal Legend</strong></p>

| Color & Strength                                                                                                                                                                                                                                          | SINR (dB)   | Quality   | Interpretation       |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | --------- | -------------------- |
| <p><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FY2QaIGRJ7zSG43iG1PqN%2Fimage.png?alt=media&amp;token=d701e1d1-bcc2-49e5-83f8-66f3f1dc0b13" alt=""> Excellent<br></p> | ≥ 20 dB     | Excellent | Very high throughput |
| <p><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FVcdACDRqyyt8W6wY72R2%2Fimage.png?alt=media&amp;token=e323eea5-5722-421d-9664-cbbee54a9c82" alt=""> Good<br></p>      | 13 to 19 dB | Good      | High data rates      |
| <p><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FTgseFdYcKTzxhliPTxSm%2Fimage.png?alt=media&amp;token=a6d9d2d2-cd37-423d-ae5d-12f18b9a7480" alt=""> Fair<br></p>      | 0 to 12 dB  | Fair      | Usable but limited   |
| <p><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKrzVkBCmXomg5uq5slMK%2Fimage.png?alt=media&amp;token=a0b9b7e7-bb43-4268-b376-a6f7bcbb4eba" alt=""> Poor<br></p>      | -3 to -1 dB | Poor      | Edge of usability    |
| <p><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FSGi7pDrSuilOB3EwakZM%2Fimage.png?alt=media&amp;token=8ae06964-d68b-4df6-a65e-57c019447a61" alt=""> Very Poor<br></p> | < -3 dB     | Very Poor | No reliable service  |

<p align="center"><strong>5G RSRQ Signal Legend</strong></p>

| Color & Strength                                                                                                                                                                                                                                          | RSRQ (dB)     | Quality   | Interpretation        |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | --------- | --------------------- |
| <p><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8gdUDveYatOsswR1vKuO%2Fimage.png?alt=media&amp;token=0a306128-62c0-4205-bcba-43114ad41dda" alt=""> Excellent<br></p> | ≥ -9 dB       | Excellent | Very clean signal     |
| <p><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FOpIhRcVcgaNeJPuw9Edi%2Fimage.png?alt=media&amp;token=ea9d644c-3ae0-42fc-88ad-bc29512204ea" alt=""> Good<br></p>      | -10 to -12 dB | Good      | Stable performance    |
| <p><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FoQTi2NjTDCKfxjjDdSrR%2Fimage.png?alt=media&amp;token=d9eaee14-5fa8-43a0-9805-93652fb106b6" alt=""> Fair<br></p>      | -13 to -15 dB | Fair      | Moderate interference |
| <p><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FhRKTY3YpZ4RnQ9BXicdw%2Fimage.png?alt=media&amp;token=edbf2ad6-1605-44d1-ae92-76a96f9b2133" alt=""> Poor<br></p>      | -16 to -18 dB | Poor      | High interference     |
| <p> <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FP3F5ITaWoqXg4Yo1suQm%2Fimage.png?alt=media&amp;token=0ae7ed4c-e42d-40aa-8d97-21d112c99046" alt="">Very Poor<br></p> | < -18 dB      | Very Poor | Likely unusable       |

<p align="center"><strong>5G RSSI Signal Legend</strong></p>

<table><thead><tr><th width="187" valign="middle">Color &#x26; Strength</th><th valign="middle">RSSI (dBm)</th><th>Quality</th><th>Interpretation</th></tr></thead><tbody><tr><td valign="middle"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXm78Xpzyz9DIb16WZDPi%2Fimage.png?alt=media&amp;token=3fc270ec-0ee1-4eed-9732-0dbcef2ecbd1" alt=""> Excellent<br></td><td valign="middle">≥ -65 dBm</td><td>Excellent</td><td>Very strong signal</td></tr><tr><td valign="middle"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fa1688PBpl5mIFuZAyA6n%2Fimage.png?alt=media&amp;token=503b6d8f-d78c-43c5-8525-107cbbd21575" alt=""> Good<br></td><td valign="middle">-65 to -75 dBm</td><td>Good</td><td>Strong signal</td></tr><tr><td valign="middle"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FTA8F2qQV0vnUHj5W0cFQ%2Fimage.png?alt=media&amp;token=8712857c-51c9-4913-af14-2ebf6bdbfe45" alt=""> Fair<br></td><td valign="middle">-76 to -85 dBm</td><td>Fair</td><td>Usable signal</td></tr><tr><td valign="middle"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FjUZ7aZMdi4lpBLpZTaP7%2Fimage.png?alt=media&amp;token=f2e96ba3-3690-4589-a26b-433268b2e464" alt="" data-size="line"> Poor<br></td><td valign="middle">-86 to -95 dBm</td><td>Poor</td><td>High noise</td></tr><tr><td valign="middle"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F2EFezeEVlIK2XxcVlphV%2Fimage.png?alt=media&amp;token=fe99a003-097e-4bad-a99f-c2c2faee8834" alt="" data-size="line"> Very Poor<br></td><td valign="middle">&#x3C; -95 dBm</td><td>Very Poor</td><td>Likely unusable</td></tr></tbody></table>

### Charts and Visualizations

The Survey tool generates comprehensive time-series charts that display RF performance metrics throughout the survey duration. These visualizations help identify temporal patterns, signal degradation trends, and correlation between different RF parameters. The charts are displayed below the map visualization and update dynamically based on the loaded survey data.

#### RSRP Signal Strength Chart

Displays RSRP measurements over time, showing the power level of the received signal from the serving cell. RSRP is the primary metric for assessing overall signal strength and coverage quality.

Higher values (closer to 0) indicate stronger signal. Look for consistent levels indicating stable coverage or drops suggesting coverage gaps.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FZvOS6ATVHTLytM4N5j9l%2Fimage.png?alt=media&amp;token=d2b40c05-59d1-4690-b62c-71940ae81fb7" alt=""><figcaption></figcaption></figure>

Y-Axis: Signal strength in dBm (decibels relative to one milliwatt)

X-Axis: Time progression during the survey

#### SINR Chart

Displays SINR measurements over time, indicating signal quality relative to interference and noise. SINR is the best predictor of actual data throughput and user experience.

Higher values indicate better signal quality. Low SINR suggests interference issues that may impact throughput even when signal strength appears adequate.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FvBkCngQY87vnNbo6jotC%2Fimage.png?alt=media&amp;token=e9b7e70f-ac4e-41e8-a751-a46b1e5058a4" alt=""><figcaption></figcaption></figure>

Y-Axis: Ratio in dB (decibels)

X-Axis: Time progression during the survey

#### RSRQ Signal Strength Chart

Displays RSRQ measurements over time, indicating signal quality considering interference from adjacent cells. RSRQ helps identify interference scenarios and cell edge conditions.

Poor RSRQ with good RSRP suggests high interference from neighboring cells. This pattern often indicates need for interference mitigation or frequency refarming.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQicVL3bqC2XSo2u9TWT2%2Fimage.png?alt=media&amp;token=8f3495d7-d122-4ad6-b20a-bbdf5b858c32" alt=""><figcaption></figcaption></figure>

Y-Axis: Quality metric in dB (decibels)

X-Axis: Time progression during the survey

#### RSSI Chart

Displays RSSI measurements over time, representing the combined power of signal, interference, and noise. Useful for assessing overall radio environment conditions. RSSI cannot distinguish between useful signal and interference. Use alongside RSRP and SINR for a complete picture.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0FOYKZDYCBEQDYCjdqzu%2Fimage.png?alt=media&amp;token=72e3b75a-0d63-4163-bd8b-9fc603d11302" alt=""><figcaption></figcaption></figure>

Y-Axis: RSSI in dBm

X-Axis: Time progression during the survey

### Distance-Based Grouping

The “Group by Distance” feature allows you to aggregate measurement data points at specific spatial intervals, simplifying visualization and analysis of large survey datasets. This feature is particularly useful when analyzing extensive drive tests or when you need to reduce visual clutter while maintaining spatial patterns.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F1y8ZvqfR4rRKGjEAMIrt%2Fimage.png?alt=media&amp;token=7b034642-fded-4a6d-a183-6febcf47e09b" alt=""><figcaption></figcaption></figure>

The following grouping intervals are available:

* None – Display all individual measurement points without aggregation. Use this for detailed analysis of specific areas or when survey data is already sparse.
* 1m interval – Group measurements at 1-meter intervals. Useful for pedestrian surveys or detailed indoor coverage analysis.
* 2m interval – Group measurements at 2-meter intervals. Provides good balance between detail and readability for walking surveys.
* 5m interval – Group measurements at 5-meter intervals. Suitable for slow-speed drive tests or comprehensive area surveys.
* 7m interval – Group measurements at 7-meter intervals. Good compromise for moderate-speed drive tests.
* 10m interval – Group measurements at 10-meter intervals. Ideal for high-speed drive tests or when analyzing large coverage areas.

## Generate Survey Logs

Prepare for the survey:

1. Verify that the GXC Survey mobile app is installed on the mobile device.
2. Verify that location services (GPS) are enabled on the device.
3. Verify that the mobile device has sufficient battery life for the planned survey duration.
4. Verify network connectivity if using cloud synchronization.
5. If using local storage, verify sufficient storage space is available.

**To generate a survey log using the GXC Survey mobile app:**

{% stepper %}
{% step %}
Open the Onyx Portal Survey tool interface:

1. Click **Venue**.\
   The **Venues** page is displayed.
2. In the list of venues, click the venue for which you want to generate a survey log.\
   The **\<venue name>** page > **Overview** tab displays the venue's details.
3. Click the **Survey** tab.\
   The Survey tool interface is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FFs54FY3I3UmQwRde0Ok3%2F5g-venue-view-details-survey-app.png?alt=media&amp;token=9f95333c-a440-40db-895e-248e6cf6b826" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Generate an access token:

1. In the **Survey Logs** section, click the **Generate Access Token** button.

   The **Generate Access Token** dialog box is displayed.

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F6woSwRsgbwqjnr4wVcR0%2Fimage.png?alt=media&amp;token=c8a6edf6-f840-4bd9-b60f-663f3527e70e" alt="" width="227"><figcaption></figcaption></figure></div>
2. In the **Token validity (days)** text box, enter the number of days the token should remain valid, then click **Generate**.\
   The system generates an access token QR code.<br>

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FYokZNB3uwUsHNzLdds85%2F5g-venue-view-details-survey-app-generate-access-token-qr-code.png?alt=media&amp;token=e297d72d-ba7a-4943-950a-efcf94105ecb" alt="" width="201"><figcaption></figcaption></figure></div>

{% endstep %}

{% step %}
To start a survey:

1. In the mobile device, open the GXC Survey app and scan the access token QR code generated in the Onyx Portal to authenticate and associate the app with the venue.
2. Close the **Generate Access Token** dialog box.
   {% endstep %}

{% step %}
Configure the survey parameters:

1. Launch the GXC Survey app on your mobile device.
2. To scan the access token QR code generated in the Onyx Portal:

   1. Click the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FgzP1lBop064xWuK38ope%2Fimage.png?alt=media&amp;token=ec3f6b75-043f-4972-91f1-6e4e3a777959" alt="" data-size="line"> (scan) icon.\
      The camera/scanner app opens.
   2. Point to the QR code displayed in the Onyx Portal interface.\
      The **QR Code Data** dialog box displays the QR code’s details.

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FqTd233kfGVHp5ZcPWNr5%2Fimage.png?alt=media&amp;token=3a89faf1-49b9-4021-9ce2-18539a0af572" alt="" width="280"><figcaption></figcaption></figure></div>
3. Click **Close**.
   {% endstep %}

{% step %}
Conduct the survey:

1. To start the survey recording in the mobile app, click the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fdjlj7U5i3gkHfLLav53V%2Fimage.png?alt=media&amp;token=5a3ee152-4ac6-4b84-b4ff-8371206978cc" alt="" data-size="original"> (start) icon.
2. Walk or drive through the planned route.
3. Move at a steady pace to ensure consistent data collection.
4. If required, to pause the survey, click the ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fyj1rDNq4BrlUos1YjQnD%2Fimage.png?alt=media\&token=c9fe533b-8f1e-4791-8d31-5788025fe7d1) (pause) icon.\
   To resume the survey, click the ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FylFlcZDrp2VGwLzt373b%2Fimage.png?alt=media\&token=86d81f71-30aa-48ed-b44e-36942df91d9c) (start) icon.
5. To add notes at specific locations to document observations (obstacles, interference sources, points of interest, etc.), click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQffYrFUcaVAFmg7HNMC4%2Fimage.png?alt=media&amp;token=92f93742-accc-49fc-a5ce-ce2d6bd4b0a6" alt="" data-size="line"> (add notes) icon.

   The **Add Note** dialog box is displayed.

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FlmAeqAiDTwCsdvNiGznQ%2Fimage.png?alt=media&amp;token=a2227e2c-c2d3-4f7f-9bea-36ba5da372cd" alt="" width="259"><figcaption></figcaption></figure></div>
6. Enter the note and click **Save**.
7. Monitor the app to ensure continuous data collection.
   {% endstep %}

{% step %}
Complete and save the survey:

1. To stop the survey recording when the coverage area has been fully surveyed, click the ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmCBS9HoBmWVo0dtojIiP%2Fimage.png?alt=media\&token=a0e08169-f3af-48cd-870b-866178461feb) (stop) icon.
2. The survey log file is automatically saved to cloud storage.
3. To save the survey log file locally on the mobile device, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FeXb6UrkXoScZV5DgbhoZ%2Fimage.png?alt=media&amp;token=2b9bac36-fa42-4114-9b8a-d6d9721bee3a" alt="" data-size="original"> **Save HTML**.
4. To view survey log files saved locally on the mobile device, click ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F3epde2S3dYlbXbkjCUBf%2Fimage.png?alt=media\&token=b7d3b9d6-1d38-41aa-b677-b65e624f18a1) **Files**.
   {% endstep %}
   {% endstepper %}

### Upload Local Survey Logs <a href="#upload-local" id="upload-local"></a>

If your survey logs are stored locally on your mobile device, you can transfer them to your computer and upload them to cloud storage via the Onyx Portal.

**To upload a local survey log file to the cloud storage:**

{% stepper %}
{% step %}
Open the Onyx Portal Survey tool interface:

1. Click **Venue**.\
   The **Venues** page is displayed.
2. In the list of venues, click the name of the venue for which you want to generate a survey report.
3. Click the **Survey** tab.\
   The Survey tool interface is displayed.
   {% endstep %}

{% step %}
Upload the local survey file:

1. Click the **Upload Local File** button.\
   The **Select Survey Files** dialog box is displayed.

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FGI3vLDhj5fnudu2x1bgg%2F5g-venue-view-details-survey-upload-local-survey-files.png?alt=media&amp;token=f8c4ea34-5475-493e-bbe7-90e3215a2d72" alt="" width="362"><figcaption></figcaption></figure></div>
2. Click **Browse File**, then select the survey file on your computer.
3. To only view the survey file, click **View Only**.
4. To upload the survey file to the cloud storage, click **Upload & View**.

{% hint style="info" %}
**NOTE**: The survey location must be within 20 miles of the venue. If file validation fails, an error is displayed.
{% endhint %}
{% endstep %}
{% endstepper %}

### Upload KMZ Coverage Overlays

You can upload a KMZ coverage prediction file (exported from EINO or a compatible planning tool) and overlay it on the survey map to compare predicted RF coverage against actual measured data. Where possible, the overlay uses aligned legends and color coding for consistent interpretation.

**To upload a KMZ coverage overlay:**

{% stepper %}
{% step %}
Open the Onyx Portal Survey tool interface:

1. Click **Venue**.\
   The **Venues** page is displayed.
2. In the list of venues, click the name of the venue for which you want to generate a survey report.
3. Click the **Survey** tab.\
   The Survey tool interface is displayed.
   {% endstep %}

{% step %}
Under **Coverage Overlays (KMZ from EINO)**, click **Upload KMZ**.
{% endstep %}

{% step %}
Select the KMZ file from your computer and click **Open**.

The file is uploaded and appears in the list of Coverage Overlays.
{% endstep %}

{% step %}
Open a survey for the venue.

The KMZ basemap is displayed as an overlay layer on the survey map.
{% endstep %}
{% endstepper %}

### Add or Edit Survey Labels to Log Files

Labels allow you to annotate survey log files and coverage overlay files with descriptive names and notes, making it easier to identify files and understand their context at a glance.

**To add or edit a label:**

{% stepper %}
{% step %}
Open the Onyx Portal Survey tool interface:

1. Click **Venue**.\
   The **Venues** page is displayed.
2. In the list of venues, click the name of the venue for which you want to generate a survey report.
3. Click the **Survey** tab.\
   The Survey tool interface is displayed.
   {% endstep %}

{% step %}
In the list of survey logs / coverage overlays, for the file that you want to add or edit label, in the **Actions** column, click the ⋮ (options) icon, and then click **Edit Label**.

<p align="center"><strong>Survey Log File Actions Menu</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FrxZwWGPlItiZHAZdvh5Y%2Fsurvey-label-add-edit.png?alt=media&amp;token=486388bc-b55c-427e-898f-056b92185a24" alt="" width="128"><figcaption></figcaption></figure></div>

<p align="center"><strong>Coverage Overlay File Actions Menu</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FByzfChKbdGCSVHvzDGpJ%2Fsurvey-coverage-overlay-label-add-edit.png?alt=media&amp;token=4aef6f30-7c42-45ac-8375-f5b030a3c75e" alt="" width="131"><figcaption></figcaption></figure></div>

The **Edit Label** dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fv5RhlfzZlokb7ZDVmYft%2Fsurvey-label-add-edit-db.png?alt=media&amp;token=724a5806-c4b5-42d1-9319-2d48eb08d0b8" alt="" width="251"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the **Label** text box, enter/edit the label text, then click **Save**.

In the list of survey logs / coverage overlays, the **Label** column displays the added/updated label.
{% endstep %}
{% endstepper %}

### Best Practices for Field Surveys

To ensure high-quality survey data collection:

* Plan Survey Routes – Map out the survey path in advance to ensure complete coverage of the area of interest.
* Maintain Consistent Speed – Walk or drive at a steady pace (typically 3-5 mph for walking surveys, 15-25 mph for drive tests).
* Verify GPS Accuracy – Ensure GPS signal is strong before starting the survey, especially in indoor or urban canyon environments.
* Monitor Battery Levels – For extended surveys, bring backup power sources.
* Survey Multiple Times – Conduct surveys at different times of day to capture variations in network performance.
* Compare Multiple Surveys – Conduct multiple surveys over time and compare results to track network performance trends.
* Note environmental conditions – Document physical obstructions, weather, and other factors that may affect signal at the time of the survey.

## Generate Survey Reports

{% hint style="info" %}
**NOTE:** You can generate, analyze, and view survey reports in the Onyx Portal interface only if you are a GXC Administrator or Super Administrator.
{% endhint %}

This section provides instructions for generating survey reports. The process involves accessing the Survey app, configuring data sources, generating access tokens when needed, and loading survey data for visualization and analysis.

Before using the Survey tool, ensure the following requirements are met:

* Valid user account with appropriate permissions to access the Venues section
* Network configuration completed (4G or 5G network deployed)
* Survey logs generated from compatible RF measurement tools
* For cloud-based logs: Active network connectivity and valid access token
* For local logs: Survey log files in JSON format

**To generate a survey report:**

{% stepper %}
{% step %}
Open the Onyx Portal Survey tool interface:

1. Click **Venue**.\
   The **Venues** page is displayed.
2. In the list of venues, click the name of the venue for which you want to generate a survey report.
3. Click the **Survey** tab.\
   The Survey tool interface is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FFs54FY3I3UmQwRde0Ok3%2F5g-venue-view-details-survey-app.png?alt=media&amp;token=9f95333c-a440-40db-895e-248e6cf6b826" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
In the **Survey Logs** section, click the survey log file's name.

After a survey log is successfully loaded, the interface displays an interactive visualization of the survey report, including:

* Map with signal measurements and color-coded markers
* Time-series charts showing RSRP, SINR, RSRQ, RSSI metrics
* Interactive data points with detailed measurement information
* Summary statistics for RF performance metrics

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FzfIuF4AmxELwHGZ1jXYT%2Fimage%20(9).png?alt=media&amp;token=9838d7d0-4d39-4d42-8734-bf88133ce1c1" alt=""><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}

## Analyze Survey Reports

This section explains how to analyze survey reports using visualization tools, interpret RF metrics, and extract actionable insights for network optimization. Effective analysis combines spatial visualization with quantitative metrics to identify coverage issues, interference patterns, and optimization opportunities.

## Interactive Map Features

The Survey tool includes several interactive controls to optimize your analysis workflow. These features help you focus on specific RF metrics, understand temporal coverage patterns, and efficiently compare multiple surveys.

### Signal Metric Selector

The Signal Metric Selector allows you to switch between different RF metrics to diagnose network issues and verify coverage quality.

Understanding metrics:

* RSRP measures the power level of the primary signal from the serving cell. Use RSRP to assess overall signal strength and identify areas with weak coverage. RSRP is the primary indicator for coverage assessment and network planning.
* SINR indicates signal quality relative to interference and noise. Use SINR to diagnose interference issues and assess potential data throughput. SINR is the best predictor of user experience and application performance.
* RSRQ measures signal quality considering interference from adjacent cells. Use RSRQ to identify cell edge conditions and inter-cell interference scenarios. RSRQ helps distinguish between coverage problems and capacity issues.
* RSSI represents total received power including signal, interference, and noise. Use RSSI to assess overall RF energy levels in the environment. Note that RSSI cannot distinguish between useful signal and interference.
* Cell (PCI) visualization displays Physical Cell IDs with unique color coding per cell. Use Cell view to visualize cell boundaries, identify handover zones, and detect coverage overlap areas. This is essential for cell planning and neighbor relation optimization.

**To select a metric:**

{% stepper %}
{% step %}
Above the map area, in the right corner, click the metric selector dropdown and select the desired metric.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FqP0kgY8WhlVyVFewee9N%2Fimage.png?alt=media&amp;token=59895183-8617-4b29-8e59-6aa157f3dcc2" alt="" width="91"><figcaption></figcaption></figure></div>

The map automatically updates to display color-coded measurement points corresponding to the selected metric. The color scheme follows the signal quality thresholds (green = excellent, yellow = good, orange = fair, red = poor, black = very poor).
{% endstep %}

{% step %}
Observe the coverage patterns and identify problem areas based on color coding.
{% endstep %}
{% endstepper %}

**Analysis Workflows:**

* Coverage Assessment – Start with RSRP to get an overall view of signal strength distribution. Green markers indicate strong coverage suitable for high throughput applications. Yellow markers show good coverage with stable connections. Orange markers indicate areas where service quality may degrade. Red and black markers highlight priority areas needing network improvements.
* Interference Diagnosis – If RSRP shows adequate signal strength (green or yellow) but users report poor performance, switch to SINR. Low SINR despite good RSRP indicates interference problems rather than weak signal. This typically requires interference mitigation (antenna optimization, power adjustments, or frequency planning) rather than additional sites.
* Cell Boundary Verification – Use Cell (PCI) visualization to verify that cells are serving their intended coverage areas. Each cell appears in a unique color. Multiple colors in close proximity may indicate coverage overlap requiring handover parameter optimization. Abrupt color changes suggest hard handover boundaries that may cause call drops.
* Quality Troubleshooting – Compare RSRP (signal strength) with RSRQ (signal quality). Good RSRP but poor RSRQ suggests interference from neighboring cells or capacity constraints. Poor RSRP with poor RSRQ indicates fundamental coverage gaps requiring additional infrastructure.
* Post-Deployment Validation – After network changes, systematically review each metric. Verify RSRP meets coverage targets, SINR indicates low interference, RSRQ shows good cell quality, and Cell (PCI) boundaries align with planning expectations.

### Signal Quality Legends

The Signal Quality Legends dialog box provides comprehensive reference information to help you interpret the color-coded measurement points on the map.

To access legends:

{% stepper %}
{% step %}
In the Metric Selector dropdown, select a metric.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FOELMUPWmgbmG1VNBeRYK%2Fimage.png?alt=media&amp;token=f853f325-371d-494a-b292-6d70c139e447" alt="" width="214"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click the **Show Legends** button.

The Legend's dialog box displays record types and signal quality thresholds information.
{% endstep %}

{% step %}
Review the record types and applicable signal quality thresholds.

For information on record types refer to Radio Log Record Types. For detailed interpretation of the signal quality thresholds, refer to *Signal Quality Legends*.
{% endstep %}
{% endstepper %}

### Point Measurement Metrics

Point measurement analysis allows you to inspect detailed RF metrics and neighbor cell information for any measurement point on the map. This feature is essential for troubleshooting specific coverage issues, validating network performance at critical locations, and understanding the RF environment at problem areas.

**To view detailed information about a specific measurement point:**

{% stepper %}
{% step %}
On the map, click a measurement point.

A popup displays the following information.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FkKPnGqOAnZPLdwWGsGCs%2Fimage.png?alt=media&amp;token=ccd13759-1d20-43d8-984f-f0c3f7009ef0" alt="" width="317"><figcaption></figcaption></figure></div>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQUNB8uZU5coMC5DL8WyJ%2Fimage.png?alt=media&amp;token=137a3fa1-1732-4842-8906-30e7629dcf4f" alt="" width="327"><figcaption></figcaption></figure></div>

* **Network** – Network identifier and type (e.g., LTE, 315010 (NR) for 5G New Radio)
* **Timestamp** – Exact date and time of measurement (YYYY-MM-DD HH:MM:SS.mmm)
* **PCI** – Physical Cell Identifier
* **Bandwidth** – Channel bandwidth (MHz)
* **CenterFrequency** – Operating frequency of the channel (MHz)
* When viewing a single measurement point, individual metric values are displayed:
  * **RSRP** – Reference Signal Received Power (dBm)
  * **SINR** – Signal-to-Interference-plus-Noise Ratio (dB)
  * **RSRQ** – Reference Signal Received Quality (dB)
  * **RSSI** – Received Signal Strength Indicator (dBm)
* **Summary** – When multiple measurements exist at a point, a Summary table displays statistical analysis for each RF metric:
  * **Min** – Minimum value recorded
  * **Max** – Maximum value recorded
  * **Mean** – Average value across all measurements
* **Neighbor Cells** – A table displays information about neighboring cells detected during the measurement:
  * **Type** – Network type (e.g., LTE, NR)
  * **MCC** – Mobile Country Code
  * **MNC** – Mobile Network Code
  * **PCI** – Physical Cell Identifier of the neighbor cell
  * **RSRP** – Signal strength from neighbor cell (dBm)
  * **SINR** – Signal quality from neighbor cell (dB)
  * **Freq** – Operating frequency (MHz)
  * **BW** – Bandwidth (MHz)
    {% endstep %}
    {% endstepper %}

### Survey Playback

Survey Playback animates the surveyor's route from start to end at an accelerated speed, revealing how signal quality varied during data collection. Playback is particularly useful for identifying the exact location and time of coverage gaps, handover events, or sudden signal changes along the survey route.

**To initiate a survey playback:**

{% stepper %}
{% step %}
Click the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FbUPt75qHcJxRIfp3d6na%2Fimage.png?alt=media&amp;token=4927bb53-b85f-40c4-a98f-a3ea2447e6a1" alt="" data-size="line"> (Play Survey) control above the map area.

A marker begins moving along the survey route from the starting point.

The animation follows the actual surveyor's path at an accelerated speed.

Watch how the measurement points colors change as the survey progresses. This reveals how signal quality varied during data collection.

The playback automatically stops on reaching the end point.
{% endstep %}

{% step %}
To repeat the animation, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F7vdlaSpUHhxwTU5tIEBB%2Fimage.png?alt=media&amp;token=3e5a732e-b40f-4bb9-ae77-6c74ced0ca9f" alt="" data-size="line"> (Play Survey) control again.
{% endstep %}
{% endstepper %}

### Expandable Map View

Expandable map view allows you to hide the signal graphs displayed below the map area. When graphs are hidden, the map automatically expands to fill the available screen space, providing a larger canvas for analyzing coverage data. It is particularly useful when reviewing long survey routes or analyzing coverage in dense urban environments where detailed map inspection is required.

**To expand the map view:**

{% stepper %}
{% step %}
Below the map area, in the right corner, click the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FX7yvlZNDDeSJqWaC2J3K%2Fimage.png?alt=media&amp;token=b66557df-3180-46a4-a9da-b447bf7c615b" alt="" data-size="line"> (Hide Graphs) control.

The graphs are hidden, and the map automatically expands to fill the available screen space.
{% endstep %}

{% step %}
To display the signal graphs, click the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FHRIIUdm6eedY987iOOug%2Fimage.png?alt=media&amp;token=89fc1621-b6e9-40f1-a049-41a8b3d75d8b" alt="" data-size="line"> (Show Graphs) control.
{% endstep %}
{% endstepper %}

### Fullscreen Map View

Fullscreen map view expands the map to fill your entire browser window, maximizing the viewing area for detailed coverage analysis. It is particularly useful for large venue analysis, detailed inspection of long drive-test routes, multi-metric comparison, and working on smaller displays.

**To view full screen map:**

{% stepper %}
{% step %}
In the map interface, click the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FpMmkJvnfG2q3SfDwx5TP%2Fimage.png?alt=media&amp;token=cdbcc1c0-c4d7-4e38-9a2b-baefa5d56f1a" alt="" data-size="line"> (Fullscreen) control.

The map expands to fill the browser window.
{% endstep %}

{% step %}
To restore normal view, press **ESC**.
{% endstep %}
{% endstepper %}

### Combine Multiple Surveys

The Combine Surveys feature allows you to merge two or more survey logs into a single consolidated view on the map and in the signal charts. This is useful for building a comprehensive picture of coverage across an entire venue from surveys conducted in multiple sessions or by multiple surveyors.

#### Constraints

* Distance constraint – Surveys can only be combined if their geographic extents are within a defined proximity. Surveys from distant or unrelated locations cannot be combined.
* Performance constraint – Combining a large number of surveys or surveys with very high data point counts may affect rendering performance. The system may limit the number of surveys that can be combined simultaneously.

#### Graph Behavior for Combined Surveys

When surveys are combined, the signal charts differentiate data from each individual survey. Non-overlapping survey segments are visually distinguished in the graphs, allowing you to identify which portion of the chart corresponds to each survey session.

#### Combine Surveys Procedure

**To combine surveys:**

{% hint style="info" %}
**NOTE:** Combining surveys does not permanently merge the underlying survey log files. The combined view is only a visualization overlay. Each survey log remains independently accessible in the Survey Logs table.
{% endhint %}

### Switch Survey

The Switch Survey feature allows you to load a different survey without returning to the list of venues. It is particularly useful when analyzing multiple surveys, for before/after optimization comparisons, observing coverage trends over time, and comparing 4G and 5G coverage patterns.

The survey selection dropdown sorts surveys by date, with the most recent survey listed first, making it easier to locate and load the latest data.

**To switch surveys:**

{% stepper %}
{% step %}
Above the map area, in the right corner, click the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fd9AcltSO4MMmcwEBA0Xs%2Fimage.png?alt=media&amp;token=ffeca8f2-873d-4b22-819e-8b94378fd431" alt="" data-size="line"> (switch survey file) control.

The *\<venue name page>* **Survey** tab is displayed.
{% endstep %}

{% step %}
In the **Survey Logs** section, click the survey log file's name.

The survey map is displayed.
{% endstep %}
{% endstepper %}

## Analyze RF Metrics

The Survey tool displays multiple RF metrics that provide different perspectives on network performance. Understanding how to interpret these metrics individually and in combination is essential for effective network analysis. This section provides guidance for interpreting RF metrics displayed in the Survey tool. For detailed signal quality thresholds and color-coded legends, refer to the Signal Quality Legends section.

### Understanding RF Metrics

The Survey tool displays four primary RF performance metrics. Understanding how these metrics interact is essential for accurate network assessment:

* RSRP (4G) / SS-RSRP (5G)
  * Purpose: Primary indicator of signal strength and coverage
  * What it measures: Power level of reference signals from the serving cell
  * Key insight: Indicates how far the signal reaches and overall coverage quality
  * Units: dBm (decibels relative to one milliwatt)
  * Typical range: -80 dBm (excellent) to -120 dBm (very poor)
* RSRQ
  * Purpose: Indicates signal quality considering interference from adjacent cells
  * What it measures: Signal quality relative to interference levels
  * Key insight: Reveals interference issues, especially at cell edges
  * Units: dB (decibels)
  * Typical range: -9 dB (excellent) to -18 dB (very poor) for 4G
* SINR
  * Purpose: Best predictor of actual data throughput and user experience
  * What it measures: Ratio of useful signal power to combined interference and noise
  * Key insight: Directly correlates with achievable data rates
  * Units: dB (decibels)
  * Typical range: +20 dB (excellent) to -3 dB (very poor)
* RSSI
  * Purpose: Measures total wideband received power
  * What it measures: Combined power of signal, interference, and noise
  * Key insight: Total RF energy level; doesn't distinguish between signal and interference
  * Units: dBm
  * Typical range: -65 dBm (excellent) to -95 dBm (very poor) for 4G

### Metric Relationships and Dependencies

Understanding how metrics interact helps identify specific network issues:

* Good coverage, poor performance (Good RSRP, Poor SINR, Poor RSRQ)
  * Likely Cause: High interference from neighboring cells
  * Recommended Action: Check for co-channel interference; adjust antenna tilt or power
* Weak signal everywhere (Poor RSRP, Poor SINR, Fair RSRQ)
  * Likely Cause: Distance from cell or physical obstruction
  * Recommended Action: Add cell site or increase power; check for physical obstructions
* Edge of cell condition (Fair RSRP, Fair SINR, Poor RSRQ)
  * Likely Cause: Cell edge condition with adjacent cell interference
  * Recommended Action: Normal behavior; consider adding sites or adjusting cell boundaries
* Strong signal, good performance (Good RSRP, Good SINR, Good RSRQ)
  * Status: Optimal conditions
  * Action: No action needed
* Inconsistent metrics (Variable across all)
  * Likely Cause: Mobility effects or changing environmental conditions
  * Recommended Action: Review survey path and environmental factors

### Best Practices for Metric Analysis

* Always analyze metrics together – No single metric tells the complete story
* Consider context – Indoor vs outdoor, distance from cell, environmental factors
* Compare with baseline – Track changes over time to identify degradation
* Validate with user experience – Metrics predict performance, but actual user testing confirms
* Document environmental factors – Note physical obstructions, interference sources, weather conditions
* Use the Survey Playback to correlate metric changes with specific locations along the survey route

## Export Survey Log Files

Raw survey log files can be downloaded from the Onyx Portal to your local computer for external analysis, archival, or use with third-party tools.

**To export a survey log file:**

{% stepper %}
{% step %}
Open the Onyx Portal Survey tool interface.
{% endstep %}

{% step %}
In the **Survey Logs** list, for the survey file that you want to export, in the **Actions** column, click the ⋮ (options) icon, and then click **Export**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FrxZwWGPlItiZHAZdvh5Y%2Fsurvey-label-add-edit.png?alt=media&amp;token=486388bc-b55c-427e-898f-056b92185a24" alt="" width="128"><figcaption></figcaption></figure></div>

The raw JSON survey log file is downloaded to your computer's default download location.
{% endstep %}
{% endstepper %}

## Add an AP Marker

AP markers place AP location indicators on survey maps to help correlate RF measurements with the physical positions of deployed or planned APs. Markers can be added for units not yet provisioned in the network.

When you add an AP marker to a venue's survey map, it will appear on all survey maps associated with the venue.

AP markers can be added from the AP Markers tab or by right-clicking directly on the survey map.

**To add an AP marker directly on the survey map:**

{% stepper %}
{% step %}
Open the survey map.
{% endstep %}

{% step %}
On the map, right click the point at which you want to add the AP marker.

The **Add Access Point** dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Ftzi61VYRWqDCWcnDsWlc%2Fsurvey-ap-marker-add-on-map-db.png?alt=media&amp;token=da56ea7a-05c8-45ce-8ae1-e624126cc4a7" alt="" width="283"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

* **Name** — (Required) The AP's name.
* **Serial Number** — (Required) The AP equipment's vendor-assigned serial number.
* **Device Class** — (Optional) The AP equipment's device class.
* Latitude — (View-only) The location's latitude.
* Longitude — (View-only) The location's longitude.
  {% endstep %}

{% step %}
To save the AP marker, click **Add**.

The AP marker is added to the location on the map.

The AP marker is added to the list of AP markers in the venue's **AP Markers** tab.
{% endstep %}
{% endstepper %}

**To add an AP marker from the venue's AP Markers tab:**

{% stepper %}
{% step %}
Click **Venues**.

The **Venues** page displays the list of venues associated with the network.
{% endstep %}

{% step %}
Click the name of the venue to which you want to add AP markers to survey maps.

The ***\<venue name>*** page > **Overview** tab displays the venue's details.
{% endstep %}

{% step %}
Click the **AP Markers** tab.

The **AP Markers** tab displays the list of AP markers added to the venue's survey maps.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FZmHGw87QQMpmH6hA8HPy%2Fsurvey-ap-markers-tab.png?alt=media&amp;token=57ee7a80-1673-4155-98f1-f177f2949da1" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click **Add AP Marker**.

The **Add Access Point** dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Ftzi61VYRWqDCWcnDsWlc%2Fsurvey-ap-marker-add-on-map-db.png?alt=media&amp;token=da56ea7a-05c8-45ce-8ae1-e624126cc4a7" alt="" width="283"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the following details:

* **Name** — (Required) The AP's name.
* **Serial Number** — (Required) The AP equipment's vendor-assigned serial number.
* **Device Class** — (Optional) The AP equipment's device class.
* Latitude — (View-only) The location's latitude.
* Longitude — (View-only) The location's longitude.
  {% endstep %}

{% step %}
To save the AP marker, click **Add**.

The AP marker is added to the list of AP markers.

The AP marker is added to the location on the venue's survey map(s).
{% endstep %}
{% endstepper %}

## Delete Survey and Coverage Overlay Files

Survey log and coverage overlay files that are no longer needed can be deleted from the Onyx Portal to keep the survey list manageable.

{% hint style="info" %}
**NOTE:** Deletion is permanent and cannot be undone. Export or archive any files you may need before deleting. See *Download Survey Data*.
{% endhint %}

**To delete a survey or coverage overlay file:**

{% stepper %}
{% step %}
Open the Onyx Portal Survey tool interface.
{% endstep %}

{% step %}
In the list of survey logs / coverage overlays, for the file that you want to delete, in the **Actions** column, click the ⋮ (options) icon, and then click **Delete**.

<p align="center"><strong>Survey Log File Actions Menu</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FrxZwWGPlItiZHAZdvh5Y%2Fsurvey-label-add-edit.png?alt=media&amp;token=486388bc-b55c-427e-898f-056b92185a24" alt="" width="128"><figcaption></figcaption></figure></div>

<p align="center"><strong>Coverage Overlay File Actions Menu</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FByzfChKbdGCSVHvzDGpJ%2Fsurvey-coverage-overlay-label-add-edit.png?alt=media&amp;token=4aef6f30-7c42-45ac-8375-f5b030a3c75e" alt="" width="131"><figcaption></figcaption></figure></div>

A confirmation dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fz7v0edQuknNP08KtfYjQ%2Fsurvey-delete-cdb.png?alt=media&amp;token=788478f5-f88a-4b88-ace2-9e03e2d70850" alt="" width="265"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To confirm deleting the file, click **Confirm**.

The survey log / coverage overlay file is removed from the list.
{% endstep %}
{% endstepper %}

## Related Documentation

* *GXC Glossary*
* *4G Onyx Portal Operations Guide* / *5G Onyx Portal Operations Guide*
* *5G Spectrum Analyzer Application Note*

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# 4G & 5G Onyx Portal MFA

## Introduction

Multi-factor Authentication (MFA), also known as Two-Factor Authentication (2FA), is a layered approach to securing your Onyx Portal user account. Your Onyx Portal user ID/password is the first factor of authentication. A Time-based One-time Password (TOTP) generated by an authenticator app installed on your mobile phone is the second factor of authentication.

{% hint style="info" %}
NOTE: MFA is enabled system-wide for all Onyx Portal users and cannot be disabled.
{% endhint %}

{% hint style="info" %}
NOTE: If you log on to the Onyx Portal using your customer organization’s SSO credentials, you must follow your organization’s MFA requirements.
{% endhint %}

**MFA workflow:**

1. Install an authenticator app on your mobile phone. See [Install Authenticator App](#install-authenticator-app).
2. Log on to the Onyx Portal and activate your MFA. See [Activate Your MFA](#activate-your-mfa).
3. Whenever you log on to the Onyx Portal, use the current MFA OTP displayed in your authenticator app as your second factor of authentication. See [Log On to the Onyx Portal](#log-on-to-the-onyx-portal).
4. If your mobile phone is compromised or lost, or your MFA backup codes are unavailable or exhausted, reset your MFA secrets. See [Reset Your MFA Secrets](#reset-your-mfa-secrets) or [As Administrator Reset Onyx Portal User’s MFA Secrets](#as-administrator-reset-onyx-portal-users-mfa-secrets).

## Set Up MFA

To set up your MFA, you must have an authenticator app such as Google Authenticator, Microsoft Authenticator, or Duo Mobile installed on your mobile phone. If you don't already have one installed, proceed to the [Install Authenticator App](#install-authenticator-app) section. If you already have one installed, proceed to the [Activate Your MFA](#activate-your-mfa) section.

### Install Authenticator App

To activate and use MFA, you must install an authenticator app on your mobile phone. Any authenticator app that generates TOTPs using the standard “HMAC-based One-time Password” (HOTP) algorithm—such as Google Authenticator, Microsoft Authenticator, or DUO Mobile—can be used. The authenticator app generates the TOTPs used as the second factor of authentication. This document describes how to use the Google Authenticator app, which is available for Android on the Google Play Store and for iPhone on the App Store.

### Activate Your MFA

{% hint style="info" %}
NOTE: Activating your MFA is a one-time procedure.
{% endhint %}

**To activate your MFA:**

{% stepper %}
{% step %}
Using a supported web browser visit [https://portal.gxc.io](https://portal.gxc.io/).

The Onyx Portal Login page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FVfkOdALKb4FWffKosCRM%2Fimage.png?alt=media&amp;token=b25183f2-7427-4fcd-93b0-69603b264395" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details, then click **Login**:

* **Email** – (Required) Your Onyx Portal logon ID (email address).

The GXC IdP Login page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXQQjQGbpA7yNsV7Z5rF6%2Fimage.png?alt=media&amp;token=d242118a-fd0d-4dc5-b704-dfa62cd66663" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details, then click **Login**:

* **Username** – (Required) Your Onyx Portal username (email address).
* **Password** – (Required) Your Onyx Portal password.
* **I’m not a robot** – (Displayed only if you fail a login attempt. Required.) Select to validate reCAPTCHA—a seamless fraud detection service that stops bots and other automated attacks by rate-limiting log on attempts while allowing valid users.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>NOTE: The I’m not a robot checkbox for reCAPTCHA validation is displayed only if you fail an Onyx Portal login attempt. For example, when you enter an incorrect username or password. The Activate Multi-Factor Authentication dialog box is displayed.</p></div>

  The **Activate Multi-Factor Authentication** dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FymKoij4qlj9BpnsIVQpF%2Fimage.png?alt=media&amp;token=1da76cfa-1393-477b-bc54-6d90b86924cb" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
On your mobile phone, open the authenticator app and scan the QR code displayed in the Onyx Portal > **Activate Multi-Factor Authentication** dialog box > **QR Code** section.

For example, if you are using the Google Authenticator app:

* If it is your first time setting up MFA in the app, click **Scan a QR code**.
* If you have previously set up other MFA in the app, click > **Scan a QR code**.
* If you are unable to scan the QR code, click **Enter a setup key**, then manually enter the alphanumeric key displayed in the Onyx Portal > **Activate Multi-Factor Authentication** dialog box > **Setup Key** section.

  To copy the setup key to your clipboard, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FYGqzYy6dwJW5j3cCSDDG%2Fimage.png?alt=media&amp;token=039db3fa-db5e-4cd5-bddd-c081e0d72f78" alt="" data-size="line"> (copy).

  <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmmZAt3N592JtRgBavgbE%2Fimage.png?alt=media&amp;token=35802d3e-0b5a-449c-9fbb-f54134ff73e6" alt=""><figcaption></figcaption></figure>

  <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FwOGiCSdl9HhUvW3ERrTZ%2Fimage.png?alt=media&amp;token=c26db727-b347-4685-823f-46e11790afe1" alt=""><figcaption></figcaption></figure>

  The authenticator app displays a six-digit OTP.

  This indicates you have successfully activated your MFA.

  Hereon, every time you log in to the Onyx Portal, you must use the current OTP displayed in your authenticator app as your second factor of authentication.
  {% endstep %}

{% step %}
Save your MFA backup codes to a safe location.

After activating your MFA, whenever you log on to the Onyx Portal, if you are unable to obtain an OTP from the authenticator app, instead of an OTP, you can use one of the backup codes as your second factor of authentication. For more information, see [MFA Backup Codes](#mfa-backup-codes).

To save your MFA backup codes as a text file, in the Onyx Portal > **Activate Multi-Factor Authentication** dialog box > **Backup Codes** section > click ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FuDpsbOr8D8Ghw1onEFKf%2Fimage.png?alt=media\&token=62d2e6f8-175e-4310-9142-4a04d01d111d) (download).

{% hint style="info" %}
NOTE: If you do not download your backup codes before you confirm your MFA activation (Step 6), a text file containing your MFA backup code is automatically downloaded to your computer. In your Downloads folder look for the most recent text file with the name format “OnyxPortal\_BackupCodes\_\_\<date\_timestamp>.txt”.
{% endhint %}
{% endstep %}

{% step %}
Confirm your MFA is activated (Step 4).

You can log on to the Onyx Portal up to five times without activating your MFA (Step 4). To skip activating your MFA (Step 4), click **Skip**. After you exhaust your five grace logins, to access the Onyx Portal you must activate your MFA.

To confirm your MFA is activated (Step 4), click **Confirm MFA OTP**. The **Confirm MFA OTP** dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXpqkleFx3SRTDqNISIDK%2Fimage.png?alt=media&amp;token=ada7169d-bce5-4909-88bc-98148477bfb8" alt="" width="269"><figcaption></figcaption></figure>

Enter the MFA OTP displayed in the authenticator app on your mobile phone and click **Submit**.

The Onyx Portal Dashboard page is displayed.
{% endstep %}
{% endstepper %}

## Log On to the Onyx Portal

You can log on to Onyx Portal only if you have an Onyx Portal user account, or if SSO authentication is supported for your customer organization (i.e., your organization’s IdP is integrated with the Onyx Portal/Onyx IdP).

For information on how to log on with your Onyx Portal credentials, see [Log On Using Your Onyx Portal Credentials](#log-on-using-your-onyx-portal-credentials).

For information to log on with your customer organization’s SSO credentials, see [Log On Using Your Organization’s SSO Credentials](#log-on-using-your-organizations-sso-credentials).

### Log On Using Your Onyx Portal Credentials

{% hint style="info" %}
NOTE: Before you can log on to the Onyx Portal for the first time, you must activate your Onyx Portal user account. For more information, refer to Onyx Portal Operations Guide > Getting Started > Activate Your Onyx Portal User Account.
{% endhint %}

**To log on to the Onyx Portal using your Onyx Portal credentials:**

{% stepper %}
{% step %}
Using a supported web browser visit [https://portal.gxc.io](https://portal.gxc.io/).

The Onyx Portal Login page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FB54lBx3tlcpbfKKPY1aP%2Fimage.png?alt=media&amp;token=85f48aea-2d50-4897-b140-381e6f628ac2" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details, then click **Login**:

* **Email** – (Required) Your Onyx Portal logon ID (email address).

The IdP Login page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FDNn19K1mypn4xskcZ2et%2Fimage.png?alt=media&amp;token=ea728da9-0c38-49a0-bbe9-0ddaa4bcdb2f" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details, then click **Login**:

* **Email** – (Required) Your Onyx Portal username (email address).
* **Password** – (Required) Your Onyx Portal password.
* **I’m not a robot** – (Displayed only if you fail a login attempt. Required.) Select to validate reCAPTCHA—a seamless fraud detection service that stops bots and other automated attacks by rate-limiting log on attempts while allowing valid users.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>NOTE: The <strong>I’m not a robot</strong> checkbox for reCAPTCHA validation is displayed only if you fail an Onyx Portal login attempt. For example, when you enter an incorrect username or password. </p></div>

  The 2FA page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FWJuHpk7xsNxQGzqMqIGy%2Fimage.png?alt=media&amp;token=1625aca5-c782-4b53-8410-26a2f0c9ee16" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the six-digit MFA OTP displayed in the authenticator app on your mobile phone, then click **Login**.

You are logged on to the Onyx Portal, and the Dashboard page is displayed.

{% hint style="info" %}
NOTE: The six-digit OTP refreshes every 30 seconds and is valid only for one minute.
{% endhint %}

{% hint style="info" %}
NOTE: If your mobile phone is not accessible or you are unable to obtain an MFA OTP, instead of an MFA OTP you can pro tem use an MFA backup code to authenticate your Onyx Portal logon. For more information, see [MFA Backup Codes](#mfa-backup-codes).
{% endhint %}

{% hint style="info" %}
NOTE: If you are unable to obtain MFA OTPs to log in to the Onyx Portal and you have exhausted your MFA backup codes, you will have to create a support ticket to contact GXC Technical Support for assistance. When the message “You have exhausted your MFA backup codes. Please contact GXC Technical Support for assistance.” is displayed, click the “Technical Support” link to enter the “Onyx Support Portal” and create the support ticket. You are logged on to the Onyx Portal, and the Dashboard page is displayed.
{% endhint %}
{% endstep %}
{% endstepper %}

### Log On Using Your Organization’s SSO Credentials

{% hint style="info" %}
NOTE: If you log on to the Onyx Portal using your customer organization’s SSO credentials, you must follow your organization’s MFA requirements.
{% endhint %}

{% hint style="info" %}
NOTE: To use SSO authentication, your organization’s IdP must be integrated with the Onyx IdP. In this case, the user accounts exist in the customer IdP and are authenticated by the customer IdP.
{% endhint %}

**To log on to Onyx Portal using your organizational SSO credentials:**

{% stepper %}
{% step %}
Using a supported web browser visit [https://portal.gxc.io](https://portal.gxc.io/).

The Onyx Portal Login page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FWx7v3AcmFpdRwewOgOT3%2Fimage.png?alt=media&amp;token=9ad38881-d319-46b7-bfd6-731c3ccd13a6" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Click the **Sign in to an Organization** link.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FbUWi9yxqy4bHEJ6FZWbB%2Fimage.png?alt=media&amp;token=e1411405-e4cb-46d5-a58e-082f8880f7b1" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details, then click **Login**:

* **Organization Name** – (Required) Your organization’s name.

Contact your Onyx Portal administrator for the organization name to use.

{% hint style="info" %}
NOTE: The Organization Name field is case-sensitive. Your organization’s IdP login page is displayed.
{% endhint %}

Your organization’s IdP login page is displayed.
{% endstep %}

{% step %}
Enter the authentication information required by your organization’s IdP and continue as instructed.

You are logged on to the Onyx Portal, and the Dashboard page is displayed.
{% endstep %}
{% endstepper %}

## MFA Backup Codes

After activating your MFA, if your mobile phone is unavailable or you are unable to obtain an OTP from the authenticator app, instead of an OTP, you can pro tem use a backup code as your second factor of authentication.

{% hint style="info" %}
NOTE: You must make sure to save your backup codes that are displayed when you activate your MFA or whenever you reset your MFA secrets. For more information, see [Activate Your MFA ](#activate-your-mfa)and [Reset Your MFA Secrets ](#reset-your-mfa-secrets)respectively.
{% endhint %}

{% hint style="info" %}
NOTE: Only if you have saved the backup codes that were generated when you activated your MFA or last reset your MFA secrets, whichever is recent, can you use the backup codes.
{% endhint %}

{% hint style="info" %}
NOTE: The MFA backup codes are single use only and cannot be reused.
{% endhint %}

{% hint style="info" %}
NOTE: If you have not saved your backup codes, or if you have exhausted all your backup codes, you can reset your MFA secrets to generate a new set of backup codes. For more information, see [Reset Your MFA Secrets](#reset-your-mfa-secrets).
{% endhint %}

{% hint style="info" %}
NOTE: When you reset your MFA secrets, any previous backup codes will become invalid.
{% endhint %}

{% hint style="info" %}
NOTE: If you are unable to obtain MFA OTPs to log in to the Onyx Portal and have exhausted your MFA backup codes, you will have to create a support ticket to contact GXC Technical Support for assistance. When the message “You have exhausted your MFA backup codes. Please contact GXC Technical Support for assistance.” is displayed, click the “Technical Support” link to enter the “Onyx Support Portal” and create the support ticket.
{% endhint %}

## Reset Your MFA Secrets

If your mobile phone is compromised or lost, or your MFA backup codes are unavailable or exhausted, you must reset your MFA secrets. Resetting your MFA secrets is equivalent to deleting your MFA registration, allowing you to set up your MFA again as if you are a new user.

**To reset your MFA secrets:**

{% stepper %}
{% step %}
In the upper-right corner of the Onyx Portal GUI, click the current Onyx Portal account’s name, then click **Reset MFA Secrets**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FsXSth0fgDaExjIKKGyfh%2Fimage.png?alt=media&amp;token=ef9d83c2-7e19-409b-b07a-dfccc7b26a45" alt="" width="231"><figcaption></figcaption></figure>

{% hint style="info" %}
NOTE: The **Reset MFA Secrets** option is enabled only if you have already activated your MFA. For more information, see [Activate Your MFA](#activate-your-mfa).
{% endhint %}

The **Reset MFA Secrets** confirmation box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0OFNWvS1ybACu5CikpHv%2Fimage.png?alt=media&amp;token=426d13db-c669-4857-b1b5-552636ff847e" alt="" width="299"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To confirm you want to reset your MFA secrets, click **Yes**.

The **Reset MFA Secrets** dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FLerMe2vuvgqb5IQHG0bX%2Fimage.png?alt=media&amp;token=705d2314-901b-41e8-abd2-cd245c1d9ae1" alt="" width="563"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
On your mobile phone, open the authenticator app and scan the QR code displayed in the Onyx Portal > **Reset MFA Secrets** dialog box > **QR Code** section.

For example, if you are using the Google Authenticator app:

* If it is your first time setting up MFA in the app, click **Scan a QR code**.
* If you have previously set up other MFA in the app, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FVSxlIH9m3l0BSFmRT5xX%2Fimage.png?alt=media&amp;token=ba0d9675-1dca-457e-9d69-a64ec894aeb8" alt="" data-size="line"> > **Scan a QR code**.
* If you are unable to scan the QR code, click **Enter a setup key**, then enter the alphanumeric key displayed in the Onyx Portal > **Reset MFA Secrets** dialog box > **Setup Key** section.

  To copy the setup key to your clipboard, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FTQdK6Ren95yxuthviZDr%2Fimage.png?alt=media&amp;token=3743805b-3809-4f1b-b1cc-5a0d34ef165a" alt="" data-size="line"> (copy).

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0n5cP1CxS4qgqQpZrb17%2Fimage.png?alt=media&amp;token=1268efb1-9723-4058-8c5a-d8231440869f" alt=""><figcaption></figcaption></figure>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FzQattwkuzuxW7EGhnQY9%2Fimage.png?alt=media&amp;token=30f0ea4d-7312-4eb8-8cf2-0b21578e9d39" alt=""><figcaption></figcaption></figure>

The authenticator app displays a six-digit OTP.

This indicates you have successfully reset your MFA secrets.

Hereon, every time you log in to the Onyx Portal, you must use the current OTP displayed in your authenticator app as your second factor of authentication.
{% endstep %}

{% step %}
Save your MFA backup codes to a safe location.

Whenever you log on to the Onyx Portal, if you are unable to obtain an OTP from the authenticator app, instead of an OTP, you can use one of these backup codes as your second factor of authentication. For more information, see [MFA Backup Codes](#mfa-backup-codes).

To save your MFA backup codes as a text file, in the Onyx Portal > **Reset MFA Secrets** dialog box > **Backup Codes** section > click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FRuvqsRia6kuyJRpvptNN%2Fimage.png?alt=media&amp;token=88c3f878-5275-44d1-8622-e6b5aa9f3e7b" alt="" data-size="line"> (download).

{% hint style="info" %}
NOTE: When you reset your MFA secrets, any previous backup codes will become invalid.
{% endhint %}

{% hint style="info" %}
NOTE: If you do not download your backup codes before you close the Reset MFA Secrets dialog box, a text file containing your MFA backup codes is automatically downloaded to your computer. In your Downloads folder, look for the most recent text file with the name format “OnyxPortal\_BackupCodes\_\_*\<date\_timestamp>*.txt”.
{% endhint %}
{% endstep %}

{% step %}
To confirm your MFA secrets are reset (Step 3), click **Confirm MFA OTP**.

The **Confirm MFA OTP** dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F7p92EV2CsFbljAajal6i%2Fimage.png?alt=media&amp;token=3b838704-2dee-40f1-a5dd-4ae60fa93fd4" alt="" width="308"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the MFA OTP displayed in the authenticator app on your mobile phone and click **Submit**.
{% endstep %}

{% step %}
The next time you log on to the Onyx Portal, after your user ID/password is authenticated, the **2-Factor Authentication OTP** dialog box is displayed. Enter the current OTP displayed in your authenticator app, then click **Login**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fy8KjGFQqCJ4HJLv3KR6L%2Fimage.png?alt=media&amp;token=bc1b0e60-df84-411c-b707-bf1e953ce0d5" alt=""><figcaption></figcaption></figure>

After the OTP is authenticated, you are logged in to the Onyx Portal, and the Dashboard page is displayed.
{% endstep %}
{% endstepper %}

## As Administrator Reset Onyx Portal User’s MFA Secrets

If a user’s mobile phone is compromised or lost, and the user’s MFA backup codes are unavailable or exhausted, you can reset the user’s MFA secrets. Resetting a user’s MFA secrets is equivalent to deleting the user’s MFA registration, allowing the user to set up MFA again as if for a new user.

{% hint style="info" %}
NOTE: You can reset another Onyx Portal user’s MFA secrets only if you are a GXC Administrator, GXC Partner Administrator, or a Super Administrator.
{% endhint %}

{% hint style="info" %}
NOTE: If a user does not have access to his/her phone temporarily, the user can use their backup codes to log in. For more information, see Reset Your MFA Secrets.
{% endhint %}

**To reset a user’s MFA secrets:**

{% stepper %}
{% step %}
Switch to the required customer account.

To switch between Onyx Portal accounts, in the upper-right corner of the page, click the current Onyx Portal account’s name, then select the required account.
{% endstep %}

{% step %}
In the navigation pane, click **Administration** > **Users** tab.

The **Administration** page > **Users** tab displays the list of active user accounts.
{% endstep %}

{% step %}
For the user account that you want to reset MFA secrets, in the **Actions** column, click the corresponding ⋮ (options) icon, then click **Reset MFA Secrets**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FAGek6XMqBx3zjwm1KFoi%2Fimage.png?alt=media&amp;token=06ee8672-bccc-4223-85f2-c00762139624" alt="" width="127"><figcaption></figcaption></figure>

The **Reset MFA Secrets** confirmation dialog box is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FcSyyNG3mULkgZTzOlPxI%2Fimage.png?alt=media&amp;token=986b0c6c-4e7d-42bf-b73a-ab51d34643bd" alt="" width="333"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To confirm resetting the user’s MFA secrets, click **Yes**.
{% endstep %}
{% endstepper %}

## Related Documentation

* *4G & 5G Onyx Portal Integration with Customer IdP Application Note*
* *GXC Glossary*

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# 4G & 5G Onyx Portal Integration with Customer IdP

## Introduction

There are two approaches to integrating a Customer IdP with the Onyx Portal:

1. Direct Integration — In this approach, the customer IdP is configured and integrated directly with Onyx Portal. All IdP-related configuration like entity ID, IdP metadata, Single Sign-On/Single Logout URLs, and certificates are configured directly in the Onyx Portal.
   1. Login
      1. Single Sign-On and Single Logout requests are directly redirected from Onyx Portal to the customer IdP.
      2. User is authenticated by customer IdP and SAML response is sent from the customer IdP to Onyx Portal.
   2. Logout
      1. Single Logout requests are directly redirected from Onyx Portal to the customer IdP.
      2. The logout request is validated by the customer IdP and the SAML response (if any) is sent from the customer IdP to Onyx Portal.
2. IdP-to-IdP SAML Proxying Integration — In this approach, the customer IdP is configured and integrated with the Onyx IdP. All IdP-related configurations such as entity ID, IdP metadata, Single Sign-On/Single Logout URLs, and certificates are configured in the Onyx IdP. The Single Sign-On and Single Logout requests are redirected from Onyx Portal to the Onyx IdP. Onyx IdP does target IdP discovery based on the RequestedAuthnContext in the SAML authentication request and redirects the Single Sign-On/Logout request to the target IdP.

{% hint style="info" %}
**NOTE:** We have chosen to integrate with customer IdPs in IdP Proxy configuration.
{% endhint %}

## IdP-to-IdP Integration Using SAML Proxying

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FzXklkEL4BFNtXHEwtHpZ%2Fimage.png?alt=media&amp;token=2032227c-4bc5-40ee-8e60-c67f6159fee1" alt=""><figcaption></figcaption></figure>

We can use SAML Proxying mechanism to integrate the authentication flows with other SAML2-compliant identity providers.

If a customer has a SAML2-compliant Identity Provider, the process of authenticating users will be delegated to the customer's IdP, instead of relying on Onyx IdP. The resulting assertion is used to generate the user's local username, which is then used in the standard Attribute Resolution process.

The Onyx IdP will become a Service Provider (SP) to the customer's IdP.

### Login Flow

#### Login via Customer IdP (Using SAML Proxying)

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FAj8Xj6nMWyivCB5cUIsl%2Fimage.png?alt=media&amp;token=aa828462-44b7-498c-9a95-1d3bd9b11735" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}
If the user is from a partner organization having its own IdP integrated with the Onyx Solution, the user should click the **Sign In to an Organization** link.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F6lXcax3vVHNYAYsIk6Bc%2Fimage.png?alt=media&amp;token=04104d85-628e-4804-b46d-a3272ff415a2" alt="" width="426"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
The user enters his/her organization's name and clicks **Login**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FGJCflZjaR7grEdJYMCao%2Fimage.png?alt=media&amp;token=39cacb9c-a2f5-4b09-a1d6-b6109da61d68" alt="" width="426"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
The Onyx Portal backend generates an authentication request and sends it to the Onyx IdP's SSO URL. The authentication request passes the customer IdP's entityID in RequestedAuthnContext. This helps the Onyx IdP in doing an IdP discovery and proxy the request to the customer's IdP.

```
<samlp:RequestedAuthnContext Comparison="exact">
<saml:AuthnContextClassRef>[entityID of customer IdP]</saml:AuthnContextClassRef>
</samlp:RequestedAuthnContext>
```

{% endstep %}

{% step %}
The Onyx IdP receives the SAML authentication request. Based on the attributes (Tenant ID), it does IdP discovery. Onyx IdP maintains the tenant and target IdP mapping. Based on this mapping, the IdP discovery process identifies the entityID of the target IdP. The authentication request is proxied to the target IdP's SSO URL for SSO authentication.
{% endstep %}

{% step %}
The Customer IdP's login page is displayed, where the user enters his/her user ID/password and proceeds to login.
{% endstep %}

{% step %}
The Customer IdP authenticates the user.
{% endstep %}

{% step %}
On successful authentication, the Customer IdP does attribute resolution to generate the SAML authentication response. Onyx Portal expects the following attributes to be present in the SAML assertion to allow the user access to Onyx Portal.

{% code overflow="wrap" %}

```
email – User Email
onyxPortalRole – User Role
onyxPortalTenantId – User Organization
```

{% endcode %}
{% endstep %}

{% step %}
SAML response is generated and sent back to the Onyx IdP.
{% endstep %}

{% step %}
The Onyx IdP receives the SAML response. After attribute resolution and based on the attribute release policy it passes the required attributes in the SAML assertion to the Onyx Portal.
{% endstep %}

{% step %}
The Onyx Portal receives the SAML response from the Onyx IdP. It validates the SAML response and extracts the SAML attributes. The SAML attributes are validated and after all the validations have passed, it allows the user to access the Onyx Portal. The user is redirected to the Onyx Portal's Dashboard page.
{% endstep %}
{% endstepper %}

### User Profile

The Identity Provider shall configure the following user attributes in their user information directory/repository and release the same attributes in SAML assertion.

<table><thead><tr><th width="303">Attribute Name</th><th width="290">Description</th><th width="173">Example</th><th width="125">Mandatory</th></tr></thead><tbody><tr><td><code>mail</code> / <code>urn:oid:0.9.2342.19200300.100.1.3</code></td><td>Email ID of the subject. Not used as primary identifier; honored as long as Subject ID or IDM ID is present in the SAML assertion.</td><td>abc@example.com</td><td>Y</td></tr><tr><td><code>firstName</code> / <code>givenName</code></td><td>The user's first name.</td><td>Roger</td><td>N</td></tr><tr><td><code>lastName</code> / <code>sn</code></td><td>The user's last name.</td><td>Smith</td><td>N</td></tr><tr><td><code>onyxPortalTenantId</code></td><td>Tenant ID of the customer account in Onyx Portal. Communicated to the customer by GXC when the account is created.</td><td>CNH</td><td>C</td></tr><tr><td><code>onyxPortalRole</code></td><td>Role assigned to the user in Onyx Portal. One of: SUPER ADMIN, ADMIN, VIEWER.</td><td>ADMIN</td><td>C</td></tr></tbody></table>

C - Conditional. These attributes are required for us to support dynamic User Profile creation in the portal. If they cannot be supplied for some reason, then we have to create an upstream IdP user profile in the Onyx Portal and map it with the customer's tenant and a role (SUPER ADMIN, ADMIN or VIEWER). For information on adding an upstream IdP user, refer to *Add Upstream IDP User*.

## Integration Procedure

### Configure Onyx Portal as Service Provider

#### Get Onyx IdP Metadata to Configure Onyx Portal as a Service Provider in the Customer IdP

The latest Onyx IdP metadata is available at <https://idp.gxc.io/idp/shibboleth>. This metadata or the URL will be shared with the customer to integrate Onyx Portal as a service provider in their IdP. The necessary service provider specific details are available in the "SPSSODescriptor" block in the Onyx IdP metadata. The configuration procedure is specific to the IdP solution used by the customer and outside the scope of this document. A sample metadata is provided below for reference.

{% code overflow="wrap" %}

```
<?xml version="1.0" encoding="UTF-8"?>
<EntityDescriptor  xmlns="urn:oasis:names:tc:SAML:2.0:metadata" xmlns:ds="http://www.w3.org/2000/09/xmldsig#" xmlns:shibmd="urn:mace:shibboleth:metadata:1.0" xmlns:xml="http://www.w3.org/XML/1998/namespace" xmlns:mdui="urn:oasis:names:tc:SAML:metadata:ui" xmlns:req-attr="urn:oasis:names:tc:SAML:protocol:ext:req-attr"  entityID="https://idp.gxc.io/idp/shibboleth">

    <IDPSSODescriptor WantAuthnRequestsSigned="true" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol">

        <Extensions>
            <shibmd:Scope regexp="false">gxc.io</shibmd:Scope>
            <mdui:UIInfo>
                <mdui:DisplayName xml:lang="en">Onyx IdP</mdui:DisplayName>
                <mdui:Description xml:lang="en">Onyx IdP - GXC</mdui:Description>
                <mdui:Logo height="80" width="80">https://nms-images-1.s3.us-west-2.amazonaws.com/placeholder-gxc-logo.png</mdui:Logo>
            </mdui:UIInfo>
        </Extensions>

        <!-- First signing certificate is BackChannel, the Second is FrontChannel--> 
        <KeyDescriptor use="signing">
            <ds:KeyInfo>
                    <ds:X509Data>
                        <ds:X509Certificate>
MIIEEzCCAnugAwIBAgIUOsjLRS1A/Nd6p5OeC2n8NL2Bgu4wDQYJKoZIhvcNAQEL
BQAwFTETMBEGA1UEAwwKaWRwLmd4Yy5pbzAeFw0yMzA4MjQwODA1MjBaFw00MzA4
MjQwODA1MjBaMBUxEzARBgNVBAMMCmlkcC5neGMuaW8wggGiMA0GCSqGSIb3DQEB
AQUAA4IBjwAwggGKAoIBgQCNBsrfk3iRdVZc6fuSekvXuZdAN1RJFfeXpP0/tneb
kmdMrDURL0ZcHtQnyCgdgnypYmbZKrwBT4PAMW8b6Qex32M5ctAHoqwWshIg15As
iSou8+gxOVZbdRAfigmCH7aDuJ0mJhpAhOE4rMGCo+Hkpb/S03jcD/iJLSb6sgIR
mCnF6CYtaGFHYkko02YerDF7ZYoGLLg2CGijnhHugpMSCFqG/vqvC63EQ+xtpz5i
4ZYGRpykBaEdeiZIxYsJZqJtAQUlNgbcyi+hBEe56QgUwOQxr1kpcHxk27RJhJqD
/AfSc/NG88KoSxFWHPOLakkyq+dEkwxiEBd+SArXW8YjhDH+zM3Jsc2BDU18XEBz
R85VUwjOaCUhhXox3NFHlYipcz4yTHf/mfpNziXeDvjXv5/0PcTa6KCjb9W3cMK/
FluT8F5GvytL0JuWBJq6I+zC+cvs7rwrndkHMAZKZfI3pu7teBjNC+1beqve4Aa4
94mBbvo5uvlNdVdeWXO1YoECAwEAAaNbMFkwHQYDVR0OBBYEFHDnMPoNAC3Q7gEa
zRVNrCEkNwVQMDgGA1UdEQQxMC+CCmlkcC5neGMuaW+GIWh0dHBzOi8vaWRwLmd4
Yy5pby9pZHAvc2hpYmJvbGV0aDANBgkqhkiG9w0BAQsFAAOCAYEAcUCDuZsXQqTA
9ZkA45KvQzk1/7spCIqDMeIHDneYV5QxjE4DwKmDmUUXBqrFEuZUE4cGOxkyCEca
mPH8/TmRxFPImlS2yh45yn/uVsL7DRMjsJUiOTHiN2HaEitOhNkuxJCJ1WdZW/y9
6/ojallbnVxXOndB8+hKuKATsCmL0HD1w9RQy+kwgEFJ7rwS6fNLoESHFQkk9Yrt
xZtF8rxNgnhEmMKIbo9pUU5Z7nQI3YLAWDOmucsqHg6hEkyIgu8RzzuLeKu2udot
d258+Jt3BAvWO0qDPMYt/iAPqRfPCGtvDd0xb8dmL3Pt28picMWOkmir8LUw/62j
tDOTKhiKLe6dpBSrAPfsb56W5OkcN7OzaEPQ+cwUnnNTvIIQMS57N1YIf3/IQbxW
TdoiOJ9MhAzbDCkD8cnK7pLq1lO4zxRI580RLpnZ4tYA0xAl+75jnGJr0m4ecyBJ
BlpI2HUx48iXjdcR79RyH7W0ume6LBRwqsd6Go/UjXM53S8EwtYk
                        </ds:X509Certificate>
                    </ds:X509Data>
            </ds:KeyInfo>

        </KeyDescriptor>
        <KeyDescriptor use="signing">
            <ds:KeyInfo>
                    <ds:X509Data>
                        <ds:X509Certificate>
MIIEFDCCAnygAwIBAgIVAJNFLERWE0TU3pSnjJNDu7SRXiIoMA0GCSqGSIb3DQEB
CwUAMBUxEzARBgNVBAMMCmlkcC5neGMuaW8wHhcNMjMwODI0MDgwNDQzWhcNNDMw
ODI0MDgwNDQzWjAVMRMwEQYDVQQDDAppZHAuZ3hjLmlvMIIBojANBgkqhkiG9w0B
AQEFAAOCAY8AMIIBigKCAYEAnqSsNnebqwG5YYlbCulWZILf0RactSxywT1SEKiB
kUkfF1Y8uGljYPZ2hvBgoaWEnCx13HOJ7nDJ/9tXbTgL+EB6WhOIaB7NUpZqsDf2
02hKrlgVNC00Hwphn10SLXQsIi28aiYeM51OOQjIButlkxXtAlLPYk1R1lRBfihf
XlA5docC65WRW4g5JEztR27YPU3eqbowvhnyYLnj9tpQ5Wp3HjavP+u5ubUUp47+
ukLGlIDv6V1OgAvWrHSc9KYQ0Pb6pAAZwJxESkZveH+7HZJJjr4Qvd3daqSQA3Mi
Da2qV9iXV2+CDdroKHG/WCyZHvXkCyrfYzCE9JiksT2g9Z4sk3jyAwV/8F19Ku0z
uY3xxo9hlp+uIRBAyf1Emh/+H1/C6B5BV4w47WUsa5xdDo1Uya1+mpgBQxi6JnJU
rw03i8fwgMrBsndXdxEZf02yzwjSd8n/2f2eu1zh1TQwHe9/lUTZuBOXFZlEZiPK
X1OXR8R0mVXwfMMSDOuCMzXzAgMBAAGjWzBZMB0GA1UdDgQWBBTl0ifX7BNL5vmO
A6tlP9BmKHphezA4BgNVHREEMTAvggppZHAuZ3hjLmlvhiFodHRwczovL2lkcC5n
eGMuaW8vaWRwL3NoaWJib2xldGgwDQYJKoZIhvcNAQELBQADggGBACUp0UHthDLt
Ry3VbxG5uvGxw+fR3X6FimhtyfaATdjwBXtZKoHHvOc3qawZKGoj4bgACua7IAb7
hM+G/x+y+PIqYON22Pge7K9U85OcI5sJ1MBsW+CEiT7deVDLdIr8y9Ohxi+KH8QE
3737jX9rrW6YFTQUawzkfwJ7d4gNVk0J9YP1Y1NUsKE+5RRwJl8wearxnXQ4CG3I
CCg16OU7tAXn5wNDKm1AjOru417Q2UBRAXW/ttE1DY8na6tJOjsKpnji4xDfMlQV
Ul9BV3CSSokO1jbaXDenyb9z7aOiSE6UKgKcWsjt+ZcwPpY5TI41LHwLmW24vQTX
qYRf2JxUxuksYm2cxTdBZrzJNrimuHE3i2BOHIs8C5ZuFF9LmOrwqaDUVbBbxQcA
1qHmGn1wXz4tqRbRB6rLJx86c8rg8u83fIN9SNlg9Pi/+l5iYEeCBebwuuiy2hw2
yH+Tsk8vobnOKrj1qUvOmTQ/N2GqNs/INKv6kIyifn0p0s0KlBm3hw==
                        </ds:X509Certificate>
                    </ds:X509Data>
            </ds:KeyInfo>

        </KeyDescriptor>
        <KeyDescriptor use="encryption">
            <ds:KeyInfo>
                    <ds:X509Data>
                        <ds:X509Certificate>
MIIEEzCCAnugAwIBAgIUWI5+HkN1ouywsuKbY+HCnIfU7ZMwDQYJKoZIhvcNAQEL
BQAwFTETMBEGA1UEAwwKaWRwLmd4Yy5pbzAeFw0yMzA4MjQwODA0NDRaFw00MzA4
MjQwODA0NDRaMBUxEzARBgNVBAMMCmlkcC5neGMuaW8wggGiMA0GCSqGSIb3DQEB
AQUAA4IBjwAwggGKAoIBgQCyf92pAKarIdeeJt9XkiwPyzIfR7CkZNWKndXw4Zg6
vp2zefk7zfxgbfbfw4hi/fhfaefTOPOPvTy2QksbNor+XVOdBKgoW2mhb1BVz0CC
gOKgTECYLBnRgUQgBSv/UVr6vni4DgsuKk89I5h08HrRAkTUDI0cfrVOTyPZoE35
jz/JNII05MIkh+KPPPbIHXUkpZyR6kF5eCOuToa94UoQLL7nng6JhgvcjuNrMMHG
wXaB8Mcmwn/0QbCemM49IXZNA4FLuCg+qVvJmc3GTaLad+7FE76YHmrieyrIERqH
eiLSkMm4FkztxUFHmkCTpcZCM4BJr3LyKXEysjobvQ0IhRvoUh96JLBJfAg2BgQy
/vofCp6TQt+GyL8lryKiKuv/5WMwsSUxCKAfVWDfsAW0PtyeD4W8fbYC9BofvFcO
cFKCakeKFlwxJGcPxrh2HU3epiSe7A/5gbW2vDiVtJwJxe8fwFJ1Vkh6abGkWudn
BjxPdTWeSisEhGrM3rHgWBUCAwEAAaNbMFkwHQYDVR0OBBYEFL6vZHH4bZ8/4Z5t
CNAizAF3wUTcMDgGA1UdEQQxMC+CCmlkcC5neGMuaW+GIWh0dHBzOi8vaWRwLmd4
Yy5pby9pZHAvc2hpYmJvbGV0aDANBgkqhkiG9w0BAQsFAAOCAYEAUk8d8/zXuMPH
W7HUBvdvThxGIYBrcywJ4/EAAn9vZnaGn6RE5GnMRpn8KBQlq9vMp4HDd2o+112l
IHzEBmJSDcZO0/NgeYalVEfMocaZvHwvhm2oaWp9B8BTp/7sNNBDOJsxtaMCnG/x
Pw10zieRs1CLDyEPAbaejVFP5Px1FB2n+fhwejIScxmrxVvkHhEd1WHSA/tOBn7r
5C9UwFoUcvpwjfikuIj0y2BGOZGs7xcxLRz92k2KXCzlK/bP3Z/ISemDzo9ZCJiq
WWxOQG6GRJxZxScB6sLURgEuh/ShHwqR8HlhbQNqRWaulmatnX07pKYm3R8PsJ4G
1O8U62YFwlmZjuN4MhADe/162ujxSO4Lak7XV70JpjckwVO10+3SQfg6fBlDeoB3
vdIKKy4QkbWqj9SXnWPMef7MwIbfisZStmpGYIGrjSo6wBKiJWjSfW/DFaPosstZ
+sqkD6W4Fi6HTZGS0ZWFu32n7w25DMSpn1PMNM07RVqtyhvWq48L
                        </ds:X509Certificate>
                    </ds:X509Data>
            </ds:KeyInfo>

        </KeyDescriptor>

        <ArtifactResolutionService Binding="urn:oasis:names:tc:SAML:2.0:bindings:SOAP" Location="https://idp.gxc.io:8443/idp/profile/SAML2/SOAP/ArtifactResolution" index="1"/>

        <SingleLogoutService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" Location="https://idp.gxc.io/idp/profile/SAML2/Redirect/SLO"/>
        <SingleLogoutService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST-SimpleSign" Location="https://idp.gxc.io/idp/profile/SAML2/POST-SimpleSign/SLO"/>
        <SingleLogoutService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://idp.gxc.io/idp/profile/SAML2/POST/SLO"/>
        <SingleLogoutService Binding="urn:oasis:names:tc:SAML:2.0:bindings:SOAP" Location="https://idp.gxc.io:8443/idp/profile/SAML2/SOAP/SLO"/>

        <SingleSignOnService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST-SimpleSign" req-attr:supportsRequestedAttributes="true" Location="https://idp.gxc.io/idp/profile/SAML2/POST-SimpleSign/SSO"/>
        <SingleSignOnService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" req-attr:supportsRequestedAttributes="true" Location="https://idp.gxc.io/idp/profile/SAML2/Redirect/SSO"/>
        <SingleSignOnService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" req-attr:supportsRequestedAttributes="true" Location="https://idp.gxc.io/idp/profile/SAML2/POST/SSO"/>
    </IDPSSODescriptor>

    <AttributeAuthorityDescriptor protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol">

        <Extensions>
            <shibmd:Scope regexp="false">gxc.io</shibmd:Scope>
        </Extensions>

	<AttributeService Binding="urn:oasis:names:tc:SAML:2.0:bindings:SOAP" Location="https://idp.gxc.io:8443/idp/profile/SAML2/SOAP/AttributeQuery"/>
    </AttributeAuthorityDescriptor> 
    <SPSSODescriptor protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol">

        <KeyDescriptor use="signing">
            <ds:KeyInfo>
                <ds:X509Data>
                    <ds:X509Certificate>
MIIEIzCCAougAwIBAgIUZSxb98yWCiOFzEJGlOF2XmlUZTwwDQYJKoZIhvcNAQEL BQAwGTEXMBUGA1UEAwwOaWRwLXN2dC5neGMuaW8wHhcNMjMwNzAyMDk1ODA3WhcN NDMwNzAyMDk1ODA3WjAZMRcwFQYDVQQDDA5pZHAtc3Z0Lmd4Yy5pbzCCAaIwDQYJ KoZIhvcNAQEBBQADggGPADCCAYoCggGBAI/ZKhNKsEvGDh2nzrCXtWg3BbHrAnpw VJtVfcouVDoehKyiN6nu/47QO3VKsuZZfting/W+HIoigiR3A2FvOeDsaS4NKJMy EHhz+z0uPhYiJ1rjs0vdD0+BtXOP5IZKGBBSwTrHTJCvdI3oQXP3aB4jPgBL84ND OGZlQUXkRmaxQ0cAMzPY/6RRalA3CPT2tfuvf27LppedO1MWvej0CGSpdmz+4SHI Pd7n7T0323QOFjsShNCGS/YxTBxNSzTll5BHz0UnDtzKFyq54iQzHHAhMXnUB/WB awax1IQrjDslQZtlZ+7+05CzHCThFQkSpmWwUu83Ccc+vUZdCE2q9uCTo04Yxdra 5B3eVnWd2BSLEDFntGL6glxzgtKpC9vykMvl4Th1/pc2THz+XTsnb5I2XSfIOz/c iu00TXWfkL3OIHxDIhXMmcyB32s9EWbZH9UR2rgHNZRxPOYbC7VAFXEmcn+BKjQ2 iZRipaLlE0NyxmLj7kLR6u84dY/l3v1bKQIDAQABo2MwYTAdBgNVHQ4EFgQU9zlv E9P51S+5rJSZOpVWQz8+xtIwQAYDVR0RBDkwN4IOaWRwLXN2dC5neGMuaW+GJWh0 dHBzOi8vaWRwLXN2dC5neGMuaW8vaWRwL3NoaWJib2xldGgwDQYJKoZIhvcNAQEL BQADggGBAIJUqMZEA6AxPcOe8uaP3pfhOlZnYsLpcAjfUm9dtXf63Z9hMa/Tung9 6wSs5ugKieIPKxibCqz806t/WrLcGRsGj6nfKC5vAsG5q8irwUQsHz7/Ckh8BRox 8Q1QN7tC5efqBaLVFOOE8y1N+j+8/1MVbZOHl8SPChx/hiI7TBU5i382rJ2z5Hfm wy9Dc7ZBFIHUnwjhCFoRqyGhHnDO7AbsA8lL7SwuMIDahIZh6DfaNA3yZkJGlA7X 6K3jIOsTWqru7OyjbsIxWkifb++W3mOTcYp5FhC9LgTtFRUgr3bCNQcF3Wxylbgy e7RoKwRV9RdGYhTb+gOEZWsTV5yWFQmAlKxJWNahjV6TGvUUxDgICFaupeCYLjQx 1GAdULHbgxCuraPE2bS//eK4bMf+GJsQZ7lJt47tp/09WCC8TBqndZ/BqYfRldxV XnhUlxSVOvgcnasGai4Ho2wn8O1TyJsXk6f2PHWJwhlg9H2isblxHkfdQA+zA3Uo
thWc6nOyoA==
                    </ds:X509Certificate>
                </ds:X509Data>
            </ds:KeyInfo>
        </KeyDescriptor>
        <KeyDescriptor use="encryption">
            <ds:KeyInfo>
                <ds:X509Data>
                    <ds:X509Certificate>
MIIEJDCCAoygAwIBAgIVAPtcYiUFZQH7C7bvM1CxPDnoithcMA0GCSqGSIb3DQEB CwUAMBkxFzAVBgNVBAMMDmlkcC1zdnQuZ3hjLmlvMB4XDTIzMDcwMjA5NTgwOFoX DTQzMDcwMjA5NTgwOFowGTEXMBUGA1UEAwwOaWRwLXN2dC5neGMuaW8wggGiMA0G CSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQDLXHVjsUkGB0ZzXeIo5+0+JptkZu3R zl8gJBpp/XdxPNaX8nP5ocYHNzYjLzUT7uRvE+YIOME8rZ8CVM6qI9A58VJfr7s/ lnfKHSQd5Sf4CIrG6cwYQTAKh9Pb4swWSIV8RK3YB6h5yPF7WueZ45O4dVggBqKu LQReVfyS2Ujw4ytb+oeFbWM/huuwLoUv7FeK3OaBriu5uUbYuKV2dNpH6tdl/rWZ JFlgW6H/XjpSWTOz/W+/tN9c3Y4LzA243q3WTD/DShlb/OS7axc6nwyPXEgI5Wug QYbKclFrdTs3Kxx3IJfoTqwsgLh0sd2TsMp67ni9ORhkk2sqO1VSlMPZZv0fgqis ba7L2laKO5nB9lxEGfxUwqWa/kTDJ60Hq+C2vRYSsx6Y247dOfsAbJYYzdIguqt+ bKic+rHXHZZGXQqvnOZlD7m+NLF4FYQn5ii5p/WaN+7kEaJxFj+CBFTjF76Fjj1t oKzu0OIzLaFMg+yuR1tsOHuDsX/IiP7xJnECAwEAAaNjMGEwHQYDVR0OBBYEFPoC MiLymf7M7jgGbJt/Nt6Jbp/yMEAGA1UdEQQ5MDeCDmlkcC1zdnQuZ3hjLmlvhiVo dHRwczovL2lkcC1zdnQuZ3hjLmlvL2lkcC9zaGliYm9sZXRoMA0GCSqGSIb3DQEB CwUAA4IBgQAdB8bgnLm8PR2q8nF43TYr27ySq2G7e9rjbaeE7xiYu2PTt/0fBCn6 UhWCNSJcRk3wKLEk9RSrlPN5VNh77YCjqSiLJscsOY0N9t2+LzMXeHDrvKs58ujp A73AiNsFV4RXwAB+a8F/pu6ybgvtthBu013MiU+1y7evfjGrN8R6mKsAKYLfipFN jcHvSwiAIh/+tiwIbCBQWYpJXH/Q2gC5hMnsM3jj0pfSrA8QYCs5JKx6ekLColaw x+7ujjgmDvnKrOOD+Cd/n/dkgkqi1ned0y8TbTg1wH92P2HGr8fJ07PK3Hfgdbr2 o/55NxgFnpqrNn2+PPnIKXPSodQNVNtPpYydeqifeblLWS7K0W/Fhag9ejCcEVnz c1Tl7RGzVtqxDuB7WxSN2GYGNIGE9ZS5yvK258zHTk7dyRAZdQJiERoW4W78CInf xG+xTMUBM1LRq0vklQxxXTx+BrahbuDnkcuaBrS/+4SSpn0QW1CJFqH9584N6wBJ
ZQA4nHeApog=
                    </ds:X509Certificate>
                </ds:X509Data>
            </ds:KeyInfo>
        </KeyDescriptor>

        <AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://idp.gxc.io/idp/profile/Authn/SAML2/POST/SSO" index="0"/>
    </SPSSODescriptor>
</EntityDescriptor>

```

{% endcode %}

Key information in this IdP metadata:

* **entity ID:** `https://idp.gxc.io/idp/shibboleth`
* **ACS URL:** `https://idp-svt.gxc.io/idp/profile/Authn/SAML2/POST/SSO`
* Signing Key in SPSSODescriptor block
* Encryption Key in SPSSODescriptor block

### Configure Customer IdP as Upstream IdP in Onyx IdP

#### Accessing Onyx Portal Before the Customer IdP is Integrated

The first Super Admin user of a customer account (created when the customer account was created) will have an Onyx Portal localized account. This user can log in to the Onyx Portal to configure the customer's own IdP's details.

#### User Interface to Register Customer IdP Details in Onyx Portal

The Onyx Portal provides a UI screen to register IdP metadata and endpoint details. The customer account's Super Admin user can configure their IdP's metadata (or metadata URL), SSO URL, SLO URL, and entity ID in this screen.

To register the customer IdP's details, click **Administration** > **Add/Edit SSO Config**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQUZP8QJkiJW0rY7w85Mj%2Fimage.png?alt=media&amp;token=395783ea-114e-4a72-8337-60e86d287b19" alt=""><figcaption></figcaption></figure>

#### Add Upstream IDP User

In case the IdP is not releasing the onyxPortalTenantId and onyxPortalRole attributes, the upstream IdP SSO users can be created in the Onyx Portal.

To create upstream IdP user accounts, click **Administration** > **Add User**. The **Upstream IdP User** option must be enabled for the Onyx Portal to treat the user as an upstream IdP user. The details are used only for mapping the tenant ID and user's role.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FNrsFZnQvZHjkX3VSFP9Y%2Fimage.png?alt=media&amp;token=eb7a09b4-83d0-4f02-af0e-44280f51dd3e" alt=""><figcaption></figcaption></figure>

#### Register Customer IdP Metadata in Onyx IdP

After the customer IdP's details are registered, the details are configured in the Onyx IdP (currently, this is a manual procedure as documented below; however, it is planned to be automated in an upcoming release).

1. Copy the customer IdP's metadata at /opt/shibboleth-idp/metadata/upstream--idp.xml and do the following configuration in metadata-providers.xml.

{% code overflow="wrap" %}

```
<MetadataProvider id="upstream-<customername>-idp-metadata"
        xsi:type="FilesystemMetadataProvider"
        metadataFile="/opt/idp/metadata/upstream-<customername>-idp.xml"
/>

```

{% endcode %}

{% hint style="info" %}
**NOTE:** For information on OSU-specific steps to configure OSU IdP, see [OSU IdP Integration](#osu-idp-integration).
{% endhint %}

2. Configure attribute-resolver, attribute-filter, or attribute proxy-pass-through to proxy pass the assertion attributes received from the customer IdP to the Onyx Portal.
3. Restart the Jetty service.

{% code overflow="wrap" %}

```
systemctl restart jetty.service
```

{% endcode %}

{% hint style="info" %}
**NOTE:** Service restart is required when we configure and integrate a customer IdP with the Onyx IdP. The downtime is less than a minute. Any new login attempts during this downtime will fail. Existing user sessions will not be impacted during this downtime, and the user will continue to use the Onyx Portal without any service interruption.
{% endhint %}

### OSU IdP Integration

#### How to Get OSU IdP Metadata

OSU's suggestion for federating with them is to define an InCommon metadata source to the Onyx IdP. It is the most secure way to do it, and will automate getting updated information if it changes. It is "set and forget".

1. Configure a DynamicHTTPMetataProvider to consume per-entity metadata with a minimum cache duration of 10 minutes, and a maximum cache duration of one day.

{% code overflow="wrap" %}

```
<!-- InCommon Per-Entity Metadata Distribution Service -->
<MetadataProvider id="incommon" xsi:type="DynamicHTTPMetadataProvider"
                  maxCacheDuration="PT24H" minCacheDuration="PT10M">
  <!-- Verify the signature on the root element (i.e., the EntityDescriptor element) -->
  <MetadataFilter xsi:type="SignatureValidation" requireSignedRoot="true"
                  certificateFile="%{idp.home}/credentials/inc-md-cert-mdq.pem" />
 
  <!-- Require a validUntil XML attribute no more than 14 days into the future -->
  <MetadataFilter xsi:type="RequiredValidUntil" maxValidityInterval="P14D" />
 
  <!-- The MetadataQueryProtocol element specifies the base URL for the query protocol -->
  <MetadataQueryProtocol>https://mdq.incommon.org/</MetadataQueryProtocol>
</MetadataProvider>

```

{% endcode %}

2. Create a file %{idp.home}/credentials/inc-md-cert-mdq.pem with the following content.

{% code overflow="wrap" %}

```
-----BEGIN CERTIFICATE-----
MIIEvjCCAyagAwIBAgIJANpi9/mkU/zoMA0GCSqGSIb3DQEBCwUAMHQxCzAJBgNV
BAYTAlVTMQswCQYDVQQIDAJNSTESMBAGA1UEBwwJQW5uIEFyYm9yMRYwFAYDVQQK
DA1JbnRlcm5ldDIuZWR1MREwDwYDVQQLDAhJbkNvbW1vbjEZMBcGA1UEAwwQbWRx
LmluY29tbW9uLm9yZzAeFw0xODExMTMxNDI5NDNaFw0zODExMTAxNDI5NDNaMHQx
CzAJBgNVBAYTAlVTMQswCQYDVQQIDAJNSTESMBAGA1UEBwwJQW5uIEFyYm9yMRYw
FAYDVQQKDA1JbnRlcm5ldDIuZWR1MREwDwYDVQQLDAhJbkNvbW1vbjEZMBcGA1UE
AwwQbWRxLmluY29tbW9uLm9yZzCCAaIwDQYJKoZIhvcNAQEBBQADggGPADCCAYoC
ggGBAJ0+fUTzYVSP6ZOutOEhNdp3WPCPOYqnB4sQFz7IeGbFL1o0lZjx5Izm4Yho
4wNDd0h486iSkHxNf5dDhCqgz7ZRSmbusOl98SYn70PrUQj/Nzs3w47dPg9Tpb/x
y44PvNLS/rE56hPgCz/fbHoTTiJt5eosysa1ZebQ3LEyW3jGm+LGtLbdIfkynKVQ
vpp1FVeCamzdeB3ZRICAvqTYQKE1JQDGlWrEsSW0VVEGNjfbzMzr/g4l8JRdMabQ
Jig8tj3UIXnu7A2CKSMJSy3WZ3HX+85oHEbL+EV4PtpQz765c69tUIdNTJax9jQ2
1c3wL0K27HE8jSRlrXImD50R3dXQBKH+iiynBWxRPdyMBa1YfK+zZEWPbLHshSTc
9hkylQv3awmPR/+Plz5AtTpe5yss/Ifyp01wz1jt42R+6jDE+WbUjp5XDBCAjGEE
0FPaYtxjZLkmNl367bdTN12OIn/ixPNH+Z/S/4skdBB9Gc4lb2fEBywJQY0OYNOd
WOxmPwIDAQABo1MwUTAdBgNVHQ4EFgQUMHZuwMaYSJM5mlu3Wc4Ts5xq4/swHwYD
VR0jBBgwFoAUMHZuwMaYSJM5mlu3Wc4Ts5xq4/swDwYDVR0TAQH/BAUwAwEB/zAN
BgkqhkiG9w0BAQsFAAOCAYEAMr4wfLrSoPTzfpXtvL+2vrKBJNnRfuJpOYTbPKUc
DOP2QfzRlczi7suYJvd5rLiRonq8rjyPUyM8gvTfbTps+JhJ6S9mS6dTBxOV1qPZ
3Ab+XKmq8LUtguGRabKgJgmJH0+inR/wVoal7EVHcWXfij9AT8DZOXW88shc6grh
jUaFZBu/2+q8c8ee0e4ip8B+CVEnCwDKI0d+nTcSmPvAE34CNa33F+QGpXawv5yv
VvIpSaLAeFQhc/jKcnNHfy+Zi7JmSnKZiMvQCbWANQmDjHg7pGmBW9nyQcm6P2/B
0AVcEj1YTpAR8Mbh1pUdIhoB+chaNnFEIZsXeRsdbbAFpxodInlJ7WekfuvSQ6sU
EXpoyBGOeuuTmR1va8k3QeL8Wc4yNu/g5LwjmtvPrh2jBF8xujc4J6VzP8K2BjA4
xk4LnXgjHOT93dBAJhVYJkykDHwyvHUvsBHoP6lfjrt5P8zunK2mdP/AZKik+Rdt
1GGlErV2AyWShTOaDLW6NxdP
-----END CERTIFICATE-----

```

{% endcode %}

3. To "harden" it to *only* allow OSU's metadata to be loaded, the following metadata filter can be added.

{% code overflow="wrap" %}

```
<MetadataFilter xsi:type="Predicate" direction="include">
        <Entity>urn:mace:incommon:osu.edu</Entity>
</MetadataFilter>
```

{% endcode %}

4. Configure proxy-pass-through to proxy pass the attributes released by the OSU IdP.

#### Sharing Onyx IdP's Metadata with OSU

To integrate with the Onyx Portal, OSU must register the Onyx IdP as a service provider. Onyx IdP's metadata is available at <https://idp.gxc.io/idp/shibboleth>. The metadata also contains signing and encryption certificates.

#### Finalize the Foreign IdP Integration with Onyx IdP

Shibboleth IdP requires a service restart to apply the configuration changes.

To restart Shibboleth IdP, run the following command.

```
systemctl restart jetty.service
```

{% hint style="info" %}
**NOTE:** Service restart is required when configuring and integrating a customer IdP with the Onyx IdP. The downtime is less than a minute. Any new login attempt during this downtime will fail. Existing user sessions will not be impacted during this downtime, and the user will continue to use the Onyx Portal without any service interruption.
{% endhint %}

## Appendix

### Sample SAML Request

{% code overflow="wrap" %}

```
<?xml version="1.0" encoding="UTF-8"?>
<saml2p:AuthnRequest
	xmlns:saml2p="urn:oasis:names:tc:SAML:2.0:protocol" AssertionConsumerServiceURL="https://api-dev.gxc.io/tms/authenticate/login/sso/handler" Destination="https://accounts.google.com/o/saml2/idp?idpid=C040ly2b0" ID="_f27484aaa0fed12bd830d49290fb656e" IssueInstant="2023-06-26T07:18:21.353Z" ProtocolBinding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Version="2.0">
	<saml2:Issuer
		xmlns:saml2="urn:oasis:names:tc:SAML:2.0:assertion">https://accounts.google.com/o/saml2?idpid=C040ly2b0
	</saml2:Issuer>
	<saml2p:NameIDPolicy AllowCreate="true" Format="urn:oasis:names:tc:SAML:2.0:nameid-format:transient"/>
</saml2p:AuthnRequest>
```

{% endcode %}

### Sample SAML Response

{% code overflow="wrap" %}

```
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<saml2p:Response
	xmlns:saml2p="urn:oasis:names:tc:SAML:2.0:protocol" Destination="https://api-dev.gxc.io/tms/authenticate/login/sso/handler" ID="_49d176eab8f70c4ca15fa20722f69a67" InResponseTo="_f27484aaa0fed12bd830d49290fb656e" IssueInstant="2023-06-26T07:19:29.733Z" Version="2.0">
	<saml2:Issuer
		xmlns:saml2="urn:oasis:names:tc:SAML:2.0:assertion">https://accounts.google.com/o/saml2?idpid=C040ly2b0
	</saml2:Issuer>
	<saml2p:Status>
		<saml2p:StatusCode Value="urn:oasis:names:tc:SAML:2.0:status:Success"/>
	</saml2p:Status>
	<saml2:Assertion
		xmlns:saml2="urn:oasis:names:tc:SAML:2.0:assertion" ID="_92cd96df2ff07fb4d54fa5437ce898c1" IssueInstant="2023-06-26T07:19:29.733Z" Version="2.0">
		<saml2:Issuer>https://accounts.google.com/o/saml2?idpid=C040ly2b0</saml2:Issuer>
		<ds:Signature
			xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
			<ds:SignedInfo>
				<ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
				<ds:SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"/>
				<ds:Reference URI="#_92cd96df2ff07fb4d54fa5437ce898c1">
					<ds:Transforms>
						<ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/>
						<ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
					</ds:Transforms>
					<ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/>
					<ds:DigestValue>qBEualSgvfYQnz8KMoe60paMefGmd5rcxYHh2rkJH5s=</ds:DigestValue>
				</ds:Reference>
			</ds:SignedInfo>
			<ds:SignatureValue>hF6VIfUOhQgcldp05a2qElpSHN4SMuM7jNPXwZFnYjY3w0fwc56VktOcJeTsyOtFgOe2PUz0SIUK
BKTbPxi/FhxUU9ZyAtY0U37DOj/6lwbABVVgI6PweW1S3lP/dMtewfGiJHxvSS7RU1pHU9qaCyaF
Pf0LE5QIOZT2fvz7VZnJsMgnRDIHh9LfEsDov+VV/nMtmopy+zMd7MUKEpjd/oCoA+nNnBFGOhDd
k+Hu7ErKpimMIQoK4LZ+0h/BE7JTXA4cQkgQkELvNE69VJ6vIQB37LdkzxpIoYWMhK50s3SauBH1
fi1Y/lN6BTiucVzpf2kC9BYYA6LdmFVpaOXYZA==</ds:SignatureValue>
			<ds:KeyInfo>
				<ds:X509Data>
					<ds:X509SubjectName>ST=California,C=US,OU=Google For Work,CN=Google,L=Mountain View,O=Google Inc.</ds:X509SubjectName>
					<ds:X509Certificate>MIIDdDCCAlygAwIBAgIGAXW4V2GMMA0GCSqGSIb3DQEBCwUAMHsxFDASBgNVBAoTC0dvb2dsZSBJ
bmMuMRYwFAYDVQQHEw1Nb3VudGFpbiBWaWV3MQ8wDQYDVQQDEwZHb29nbGUxGDAWBgNVBAsTD0dv
b2dsZSBGb3IgV29yazELMAkGA1UEBhMCVVMxEzARBgNVBAgTCkNhbGlmb3JuaWEwHhcNMjAxMTEx
MTcyNTM0WhcNMjUxMTEwMTcyNTM0WjB7MRQwEgYDVQQKEwtHb29nbGUgSW5jLjEWMBQGA1UEBxMN
TW91bnRhaW4gVmlldzEPMA0GA1UEAxMGR29vZ2xlMRgwFgYDVQQLEw9Hb29nbGUgRm9yIFdvcmsx
CzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlhMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A
MIIBCgKCAQEA0yVSlpMvhLYART4e+Fg7DlPFBx1ST2oyyaTi+x59EQfsWh+OUXlFlevnpswSyF51
bof+02pB5X8SGOZ6PhWRhCdqmTgl/m+NNP0E/nYcjI4bjHXo7cQg+ThKujsndg9JyiEBVJLxqWi8
pP5whq6b6HKQOw3OctrJqGDR5SrFgvmVjm3q67eEMUfawk11cZYcO0/GRpww6OPMpQ5Mff4FdXw0
KR8kTkzEMeppp1NR85+PiGADTIKq5HBRJ3/J/uE61hkCtyICh76tykmRPLQHVCraZZhKUEvpv1rU
8veX6zBOZEPJvOnq9y73wgTpUUvt0Ec/tpzwJDqU0KPfrbOzbQIDAQABMA0GCSqGSIb3DQEBCwUA
A4IBAQBdhkt+m1FifgTO3dMYdlSkxm2NIzbOSxQ99ewghc5vUTTnVwcS92Vpe913JHFkx8Yfgtu/
MCj16dk5Xr6g+RRZEoIkzs8JAmUMZP7d7hufBPcIz6XCM3XjkT5ro1twHbME1vR45ioOKni8pDoL
/QVV0/lT2cYmOG1qrjVrI52kqOjgen4FMGbPXDO+h0FZzmbTa2cHf0kiVLAf2OfipwfS6QUo8qYJ
MvoWQxihu+EksZrQR3aHzPHRbv9DKgKwhcRFu3kADTb7HEJF6fi1y+1XsbT5UBgKnNTtwg2P7foa
xqCocpQ9+iVaJHS85x2bmI6jlG5vKRZjAaNVVzzLfif+</ds:X509Certificate>
				</ds:X509Data>
			</ds:KeyInfo>
		</ds:Signature>
		<saml2:Subject>
			<saml2:NameID Format="urn:oasis:names:tc:SAML:2.0:nameid-format:transient">guptesh.sahu@gxc.io</saml2:NameID>
			<saml2:SubjectConfirmation Method="urn:oasis:names:tc:SAML:2.0:cm:bearer">
				<saml2:SubjectConfirmationData InResponseTo="_f27484aaa0fed12bd830d49290fb656e" NotOnOrAfter="2023-06-26T07:24:29.733Z" Recipient="https://api-dev.gxc.io/tms/authenticate/login/sso/handler"/>
			</saml2:SubjectConfirmation>
		</saml2:Subject>
		<saml2:Conditions NotBefore="2023-06-26T07:14:29.733Z" NotOnOrAfter="2023-06-26T07:24:29.733Z">
			<saml2:AudienceRestriction>
				<saml2:Audience>https://accounts.google.com/o/saml2?idpid=C040ly2b0</saml2:Audience>
			</saml2:AudienceRestriction>
		</saml2:Conditions>
		<saml2:AttributeStatement>
			<saml2:Attribute Name="firstName">
				<saml2:AttributeValue
					xmlns:xs="http://www.w3.org/2001/XMLSchema"
					xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:anyType">Guptesh
				</saml2:AttributeValue>
			</saml2:Attribute>
			<saml2:Attribute Name="lastName">
				<saml2:AttributeValue
					xmlns:xs="http://www.w3.org/2001/XMLSchema"
					xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:anyType">Sahu
				</saml2:AttributeValue>
			</saml2:Attribute>
			<saml2:Attribute Name="userId">
				<saml2:AttributeValue
					xmlns:xs="http://www.w3.org/2001/XMLSchema"
					xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:anyType">GXC0002011
				</saml2:AttributeValue>
			</saml2:Attribute>
			<saml2:Attribute Name="onyxPortalTenantId">
				<saml2:AttributeValue
					xmlns:xs="http://www.w3.org/2001/XMLSchema"
					xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:anyType">gxcdirect
				</saml2:AttributeValue>
			</saml2:Attribute>
			<saml2:Attribute Name="userEmail">
				<saml2:AttributeValue
					xmlns:xs="http://www.w3.org/2001/XMLSchema"
					xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:anyType">guptesh.sahu@gxc.io
				</saml2:AttributeValue>
			</saml2:Attribute>
			<saml2:Attribute Name="onyxPortalRole">
				<saml2:AttributeValue
					xmlns:xs="http://www.w3.org/2001/XMLSchema"
					xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:anyType">SUPER_ADMIN
				</saml2:AttributeValue>
			</saml2:Attribute>
		</saml2:AttributeStatement>
		<saml2:AuthnStatement AuthnInstant="2023-06-26T07:19:27.000Z" SessionIndex="_92cd96df2ff07fb4d54fa5437ce898c1">
			<saml2:AuthnContext>
				<saml2:AuthnContextClassRef>urn:oasis:names:tc:SAML:2.0:ac:classes:unspecified</saml2:AuthnContextClassRef>
			</saml2:AuthnContext>
		</saml2:AuthnStatement>
	</saml2:Assertion>
</saml2p:Response>

```

{% endcode %}

## Related Documentation

* *4G & 5G Onyx Portal Multi-Factor Authentication Application Note*
* *GXC Glossary*

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# 4G AP Deployment Modes

## Introduction

The GXC Access Points (APs) — G100, G101, and G501 — support Single Carrier (SC), Dual Carrier (DC), and Carrier Aggregation (CA) deployment modes, providing the flexibility to optimize networks for diverse requirements. These deployment modes empower network operators to provide reliable mobile services, adapt to evolving user demands, and effectively support advanced applications.

In this document, the terms "carrier" or "one frequency" refer to a 10 MHz or 20 MHz frequency channel, which represents the bandwidth available for network transmission in each deployment mode. This distinction is important for understanding the throughput comparison tables later in this document, which highlight the differing performance of 10 MHz and 20 MHz frequency channels across deployment modes.

### 4G AP Deployment Mode Comparison Summary

This table summarizes the key differences between deployment modes to help you select the most appropriate option for your use case.

<p align="center"><strong>Deployment Mode Comparison Summary</strong></p>

<table><thead><tr><th width="170.54754638671875"></th><th>SC Mode</th><th>DC Mode</th><th>CA Mode</th></tr></thead><tbody><tr><td>Antennas per 
AP</td><td>1</td><td>2</td><td>1</td></tr><tr><td>UE Capacity</td><td>96</td><td>192 (96 per sector)</td><td>96</td></tr><tr><td>Best For</td><td>Lower traffic, basic
<br>services</td><td>High device density, two
 coverage areas</td><td>High throughput, lower
 device density</td></tr><tr><td>License
 Required</td><td>None</td><td>FAP010</td><td>FAP009</td></tr></tbody></table>

### Single Carrier Mode

In SC mode, APs use a single carrier frequency, making it suitable for smaller networks or areas with lower traffic where bandwidth needs can be met with one frequency. SC mode is often used for basic services with lower data rates. While it performs well in environments with limited spectrum, it may become less effective as data demands grow. APs in SC mode use a single antenna and support up to 96 active UE per AP.

<p align="center"><strong>Single Carrier Mode</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FZMX6sfDBENwLiHDn8ULq%2Fap-sc-mode.png?alt=media&amp;token=cb1d47c3-8639-4b79-a748-fc979070a7af" alt="" width="563"><figcaption></figcaption></figure></div>

### Dual Carrier Mode

In DC mode, APs use two carrier frequencies simultaneously, effectively doubling the available bandwidth. Compared to the SC mode, DC mode provides the same data rates but allows for increased network capacity by effectively doubling the number of connected UE. DC mode is particularly advantageous for covering two distinct areas from a single AP, especially when the required throughput is less than that of a single channel. APs in DC mode use two antennas and support up to 96 + 96 active UE per carrier sector, with a total aggregate UE capacity of 192 UE per AP.

<p align="center"><strong>Dual Carrier Mode</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F6vfLMgGt1ngxPScKoe0W%2Fap-dc-mode.png?alt=media&amp;token=e3751b15-2d69-4088-a879-c6532c22eafe" alt="" width="563"><figcaption></figcaption></figure></div>

{% hint style="info" %}
**NOTE:** DC mode doubles network capacity (connected UE), not
&#x20;peak per-device throughput. Each carrier sector delivers the same throughput as SC mode independently. See [*Throughput Comparisons*](#throughput-comparisons) for details.
{% endhint %}

### Carrier Aggregation Mode

In CA mode, APs can combine up to two component carriers (frequencies from the same or different bands) to increase throughput capacity and peak data rates. This mode enhances spectrum efficiency and significantly improves network performance, supporting high-speed data for bandwidth-intensive applications. CA mode is ideal for scenarios requiring peak data rates that exceed the capacity of a single carrier. It is better suited for use cases with lower device density but higher data throughput requirements, effectively doubling the data capacity. APs in CA mode use a single antenna and can support up to 96 active UE per AP.

<p align="center"><strong>Carrier Aggregation Mode</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FSXKN6vrA8Wta6WN4mnaP%2Fap-ca-mode.png?alt=media&amp;token=76386d07-4f4e-44f5-96ad-01f1d5fa9169" alt="" width="563"><figcaption></figcaption></figure></div>

{% hint style="info" %}
**NOTE**: CA mode requires UE devices that support Carrier Aggregation.
&#x20;Verify UE capability before deploying CA mode.
{% endhint %}

{% hint style="info" %}
**NOTE**: For detailed information on the cabling and antenna requirements for the GXC APs, refer to the AP documentation listed in the *Reference Documentation* section.
{% endhint %}

### Throughput Comparisons

The following tables list the throughput differences across SC, DC, and CA modes for the GXC G100, G101, and G501 APs, considering different bandwidth configurations.

In the following tables, the columns DL/UL Config 1, 2, and 6 refer to
&#x20;LTE Time Division Duplex (TDD) frame configurations that define the ratio of downlink to
&#x20;uplink subframes. Config 1 is balanced (3DL:2UL), Config 2 is downlink-heavy (4DL:1UL),
&#x20;and Config 6 is uplink-heavy (3DL:5UL subframe ratio).

#### **SC Mode**

<p align="center"><strong>SC Mode Throughput</strong></p>

<table><thead><tr><th>Bandwidth</th><th width="114.66668701171875">DL Config 1 (Mbps)</th><th width="114.6666259765625">DL Config 2 (Mbps)</th><th width="114.66668701171875">DL Config 6 (Mbps)</th><th width="114.66668701171875">UL Config 1 (Mbps)</th><th width="114.66668701171875">UL Config 2 (Mbps)</th><th width="114.666748046875">UL Config 6 (Mbps)</th></tr></thead><tbody><tr><td>20 MHz</td><td>105</td><td>145</td><td>85</td><td>28</td><td>14</td><td>35</td></tr><tr><td>10 MHz</td><td>51</td><td>70</td><td>42</td><td>14</td><td>7</td><td>17</td></tr></tbody></table>

#### **DC Mode**

DC mode values represent per-carrier throughput. Each carrier sector delivers the
&#x20;figures shown independently.

<p align="center"><strong>DC Mode Throughput</strong></p>

<table><thead><tr><th>Bandwidth</th><th width="114.66668701171875">DL Config 1 (Mbps)</th><th width="114.6666259765625">DL Config 2 (Mbps)</th><th width="114.66668701171875">DL Config 6 (Mbps)</th><th width="114.6666259765625">UL Config 1 (Mbps)</th><th width="114.66668701171875">UL Config 2 (Mbps)</th><th width="114.6666259765625">UL Config 6 (Mbps)</th></tr></thead><tbody><tr><td>2x20 MHz</td><td>2x105</td><td>2x145</td><td>2x85</td><td>2x28</td><td>2x14</td><td>2x35</td></tr><tr><td>2x10 MHz</td><td>2x51</td><td>2x70</td><td>2x42</td><td>2x14</td><td>2x7</td><td>2x17</td></tr></tbody></table>

#### **CA Mode**

<p align="center"><strong>CA Mode Throughput</strong></p>

<table><thead><tr><th>Bandwidth</th><th width="114.66668701171875">DL Config 1 (Mbps)</th><th width="114.66668701171875">DL Config 2 (Mbps)</th><th width="114.66668701171875">DL Config 6 (Mbps)</th><th width="114.66668701171875">UL Config 1 (Mbps)</th><th width="114.66668701171875">UL Config 2 (Mbps)</th><th width="114.6666259765625">UL Config 6 (Mbps)</th></tr></thead><tbody><tr><td>2x20 MHz</td><td>210</td><td>290</td><td>170</td><td>56</td><td>28</td><td>70</td></tr><tr><td>2x10 MHz</td><td>102</td><td>140</td><td>84</td><td>28</td><td>14</td><td>34</td></tr><tr><td>20 MHz + 10 MHz</td><td>156</td><td>215</td><td>127</td><td>42</td><td>21</td><td>52</td></tr><tr><td>20 MHz + 15 MHz</td><td>182</td><td>250</td><td>148</td><td>49</td><td>24</td><td>61</td></tr></tbody></table>

## Carrier Mode Configuration

### Onyx Portal Configuration

This section describes how to configure an AP's carrier mode in the Onyx Portal.

{% hint style="info" %}
For detailed information on the AP configuration parameters, refer to *4G Onyx Portal Operations Guide > Add Access Points*.
{% endhint %}

**To configure AP Carrier Mode:**

{% stepper %}
{% step %}
In the Onyx Portal, click **Equipment** > **Access Point** tab.

The **Equipment** page > **Access Point** tab displays the summary details of APs configured in the network.
{% endstep %}

{% step %}
Add an AP or edit an existing AP.

* To add an AP, in the upper-right corner of the page, click **Add Node** > **Add Access Point**.

  <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FWv6iP15I23bA9ac3Bcq6%2Fimage.png?alt=media&amp;token=a6af3afd-8f45-4d0b-af8c-2f2c011b394c" alt="" width="563"><figcaption></figcaption></figure>

  The **Create Access Point** page is displayed.
* To edit an existing AP, in the **Action** column, click the corresponding ⋮ (options) icon, then click **Edit**.

  <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FD2qCOnOiOfD8TEDbXcgf%2Fimage.png?alt=media&amp;token=f3db33c7-e117-499e-8ba5-98b9d25a47d3" alt="" width="563"><figcaption></figcaption></figure>

  The **Edit Access Point&#x20;*****\<AP name>*** page is displayed.
  {% endstep %}

{% step %}
In the **Access Point** tab, configure the AP details, then click **Configure RAN**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FGmvt1fCqXnMqwaaR79D5%2Fimage.png?alt=media&amp;token=a2092ec5-6e32-4e5f-8d49-898fa799978f" alt="" width="563"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
In the **RAN** tab, configure the RAN details, then click **CSG Configuration**.

In the **Carrier Mode** field, select the carrier mode and configure the corresponding parameters. Note that the RAN parameters differ for each carrier mode:

* Single Carrier Mode

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0QUVI1GvVvBOPtT6XD2o%2Fimage.png?alt=media&amp;token=088ea4ed-cb66-4328-9d66-5e8b4293f4f4" alt="" width="563"><figcaption></figcaption></figure>

* Dual Carrier Mode

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fi1ze207mgwIv3cxSlI1u%2Fimage.png?alt=media&amp;token=4d58d329-098b-4f9a-baff-d55e39e71bf7" alt="" width="563"><figcaption></figcaption></figure>

* Carrier Aggregation Mode

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FED4OpsntXZjn4nh77ZgO%2Fimage.png?alt=media&amp;token=46335328-1f7c-4c4d-89f6-3bd047658314" alt="" width="563"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
In the **CSG Configuration** tab, configure the CSG parameters.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FSo40MhJgZbUeO8CWSTjR%2Fimage.png?alt=media&amp;token=ce1a42c6-7668-4bba-9193-fdfc27387b95" alt="" width="563"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To save the AP, in the upper-right corner of the page, click **Save Access Point**.
{% endstep %}
{% endstepper %}

### AP LCI Configuration

The carrier mode configurations required in the AP equipment are managed by GXC. For queries, please contact GXC Technical Support.

{% hint style="info" %}
**NOTE**: For DC mode, the APs must be updated with the "FAP010 Dual Carrier Function" license.
{% endhint %}

{% hint style="info" %}
**NOTE**: For CA mode, the APs must be updated with the "FAP009 Carrier Aggregation Function" license.
{% endhint %}

{% hint style="info" %}
**NOTE**: If APs running software version BaiBLQ\_3.1.14 are configured for DC mode, to ensure seamless handovers between an AP's cells, GXC Technical Support must remotely log on to DC APs and run an internal command. Please contact GXC Technical Support to fulfill this requirement.
{% endhint %}

## Reference Documentation

For detailed information on onboarding the GXC APs and detailed hardware information including cabling and antenna requirements, refer to the following documentation:

* *4G Onyx Portal Operations Guide*
* *G100 Access Point Datasheet*
* *G100 Access Point Hardware Installation and Configuration Guide*
* *G101 Access Point Datasheet*
* *G101 Access Point Hardware Installation and Configuration Guide*
* *G501 Access Point Datasheet*
* *G501 Access Point Hardware Installation and Configuration Guide*

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# 4G Handovers

## Introduction

Handovers are a core capability in mobile networks, enabling uninterrupted service continuity as active User Equipment (UE) move between cells. For mission-critical applications, such as autonomous systems, industrial automation, and enterprise communications, seamless handovers are essential to prevent service disruptions and maintain safety and operational standards.

GXC's Onyx solution delivers high-reliability, ultra-low latency handovers with seamless mobility management, ensuring optimal Quality of Experience (QoE) across enterprise, private, and mission-critical networks where connection loss can impact operations or safety. GXC's 4G architecture supports both intra-Access Point (AP) and inter-AP handovers using an optimized “make-before-break” approach. This design reduces interference between cells, improves spectral efficiency, minimizes signaling overhead, and enables precise mobility control. As a result, critical applications can operate without interruption, even in complex RF environments with overlapping coverage areas.

Neighbor cell relationships are configured in the Onyx Portal, providing operators with complete control over handover topology. The system automatically generates an initial all-to-all neighbor configuration that can be customized with prioritized neighbor lists for each cell. This approach ensures predictable, reliable handover behavior tailored to your specific network topology and operational requirements.

### Supported Handover Types

The 4G Onyx solution supports multiple handover mechanisms designed to ensure seamless mobility and service continuity as UE move across cells.

{% columns %}
{% column valign="middle" %}

#### Intra-AP Handovers

An intra-AP handover occurs when a UE moves between cells managed by the same AP. These handovers are internal to the AP, allowing for faster execution, reduced signaling delays, and minimal service impact. Intra-AP handovers are optimized for high-density environments where multiple cells per AP provide overlapping coverage.
{% endcolumn %}

{% column valign="middle" %}

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fxgc38RykJX60E89CYFNd%2Fimage.png?alt=media&amp;token=afa5a630-1f9a-426a-bd4c-d9221cc566d7" alt="" width="281"><figcaption></figcaption></figure>
{% endcolumn %}
{% endcolumns %}

{% columns %}
{% column valign="middle" %}

#### Inter-AP Handovers

An inter-AP handover occurs when a UE moves between cells managed by different APs. This process, requiring precise neighbor cell configuration and robust measurement reporting, involves coordination between APs via the Onyx Edge over the S1 interface. Inter-AP handovers ensure service continuity across wider coverage areas, supporting uninterrupted mobility as UE move between different coverage zones.
{% endcolumn %}

{% column valign="middle" %}

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXZ9zxPWxSem9UcbbOOjM%2Fimage.png?alt=media&amp;token=f68c1d29-fca4-4490-9068-2cebbd54cec8" alt="" width="281"><figcaption></figcaption></figure>
{% endcolumn %}
{% endcolumns %}

GXC employs a "make-before-break" handover strategy that enhances spectral efficiency by establishing the new connection before terminating the existing one. This approach reduces interference and signaling overhead while providing more predictable network behavior. The method is particularly valuable in private and industrial networks, where efficient radio resource management and consistent performance are essential for service continuity.

### Neighbor Relation Tables

GXC APs maintain two types of neighbor relation tables:

* **Neighbor Frequency Table** – Contains the list of frequencies that UE should measure to detect neighboring cells. This table is automatically populated by the Onyx Edge based on Spectrum Access System (SAS) grants received by associated APs and cannot be edited manually.
* **Neighbor Cell Table** – Contains detailed information about neighboring APs and cells, including cell IDs, PCI, signal strengths, signal quality metrics, and other parameters necessary for handover decisions. This table is populated based on the neighbor relationships manually configured in the Onyx Portal.

### Special Configuration Cases

Dual-Carrier and Carrier Aggregation APs require specific neighbor table considerations when configuring handovers.

* **Dual-Carrier (DC) APs** – In DC APs, each cell maintains its own "Neighbor Frequency Table" and "Neighbor Cell Table". One cell's frequency is listed as a neighbor for the other cell within the same AP, enabling seamless intra-AP handovers. Neighbor relationships and advanced handover parameters must be configured for each cell independently.
* **Carrier Aggregation (CA) APs** – In CA APs, only the primary frequency is advertised to other APs. For example, if AP 1 uses frequency A as primary and B as secondary, and AP 2 uses X and Y respectively, then frequency X is included as a neighbor for AP 1, and frequency A as a neighbor for AP 2.

### Neighbor Relationship Configuration Modes

The Onyx Portal offers two modes for configuring neighbor relationships. Choose the mode that best fits your network topology and operational requirements.

* **Automatic Neighbor Configuration (Default)** – In this mode, the system automatically manages neighbor relationships.
  * All cells associated with the same Onyx Edge are configured as neighbors to each other
  * The system automatically assigns priority order
  * No manual neighbor selection required
  * Ideal for networks where all cells need connectivity to all other cells
  * Simplifies deployment and reduces configuration overhead
  * Use this mode when:
    * Your network has 16 or fewer cells per Onyx Edge. The AP “Neighbor Frequency Table” has a limit of eight unique frequencies. If the AP has more than eight neighbors with different frequencies, priority determines which frequencies are included.
    * You want to minimize manual configuration
* **Manual Neighbor Configuration (Explicit Neighbors)** – In this mode, you have full control over neighbor relationships.
  * Manually select which specific cells should be neighbors for each cell
  * Define priority order by arranging neighbors in your preferred sequence (Priority 1 = highest)
  * Add or remove neighbor relationships as needed
  * Control handover topology precisely
  * Use this mode when:
    * Your network has more than 16 cells (only 16 neighbors can be configured per cell). The AP “Neighbor Frequency Table” has a limit of eight unique frequencies. If the AP has more than eight neighbors with different frequencies, priority determines which frequencies are included.
    * You need to optimize handover paths based on physical layout or UE movement patterns
    * You want to prevent handovers to certain cells
    * You need asymmetric neighbor configurations (different neighbors for different cells)

{% hint style="info" %}
**NOTE:** Neighbor configuration is directional. Adding Cell-2 as a neighbor of Cell-1 does not automatically make Cell-1 a neighbor of Cell-2. Each directional relationship must be configured separately. For example, configuring Cell-A as a neighbor of Cell-B does not automatically make Cell-B a neighbor of Cell-A. If bidirectional handovers are needed, you must configure both relationships: Add Cell-B to Cell-A's neighbor list and Add Cell-A to Cell-B's neighbor list.
{% endhint %}

### Notes and Limitations

* Handovers are supported only between APs associated with the same Onyx Edge or the same Onyx Edge Pool.
* Manual neighbor configuration requires GXC APs running software version 3.1.14 or later.
* Onyx Edge running pre-3.1.3 release version will have ANR enabled. To manage neighbor relations, upgrade to Onyx Edge release 3.1.3 or later.
* The AP “Neighbor Frequency Table” is automatically populated by the Onyx Edge based on SAS grants and cannot be edited manually.
* The AP “Neighbor Frequency Table” has a limit of eight unique frequencies. If the AP has more than eight neighbors with different frequencies, priority determines which frequencies are included. Contact GXC Technical Support for assistance with multi-frequency deployments.
* The AP “Neighbor Cell Table” has a limit of 16 cell entries, with a constraint that the corresponding frequencies do not exceed eight. Priority order determines which neighbors are added when the limit is reached.
* If the full list of configured neighbors cannot be applied due to table limits, an alert is generated for the affected cell.
* UE must support the necessary hardware and software capabilities for handover functionality. Older or lower-end UE may lack adequate support.
* Changes to neighbor frequency or cell tables reboots the APs, resulting in service disruption during configuration updates. Plan all neighbor table changes during scheduled maintenance windows.

### How it Works

This section describes how inter-AP handovers work in conjunction with Onyx Portal-configured neighbor relationships for successful UE handovers.

Inter-AP handovers follow a two-phase process:

* [*Neighbor Relationship Configuration*](#neighbor-relationship-configuration)
* [*UE Handover Execution*](#ue-handover-execution)

#### Neighbor Relationship Configuration

Before handovers can occur, the Onyx Portal and Onyx Edge must establish which cells are neighbors and what frequencies they use, for each AP.

<p align="center"><strong>Neighbor Relationship Configuration Call Flow</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FEfMPE2naRkjwpsRODSsK%2Fimage.png?alt=media&amp;token=14695c03-4f12-4860-94a4-5724746be9ad" alt=""><figcaption></figcaption></figure></div>

1. **Configure Neighbor Cell Relationships** — An Onyx Portal Administrator configures AP neighbor cell relationships using automatic or manual configuration modes. For more information, see [*Configuration Workflow*](#configuration-workflow).
2. **Populate Neighbor Tables** — When a TR-069 session is established with an AP, the Onyx Edge applies the neighbor cell and frequency table configurations:
   * The Onyx Edge populates each AP’s “Neighbor Cell Table” based on the neighbor relationships and priorities configured in the Onyx Portal. Priority order determines which neighbors are included when the 16-cell table limit is reached (with the constraint that corresponding frequencies do not exceed eight).
   * The Onyx Edge automatically populates each AP’s “Neighbor Frequency Table” based on SAS grants assigned to the neighbor cells.
   * Changes to the neighbor tables result in AP reboot.

#### UE Handover Execution

With neighbor tables in place, the network continuously monitors UE signal quality and executes handovers based on LTE measurement events: A1, A2, and A5.

For a description of each measurement event, the signal-level timeline, and a worked example, see [*Sample Handover Walkthrough*](#sample-handover-walkthrough). For detailed parameter definitions, default values, and tuning guidance, see [*Handover Parameters Reference*](#handover-parameters-reference).

The following call flow diagram summarizes the end-to-end UE handover execution sequence.

<p align="center"><strong>UE Handover Call Flow</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FLxq66So1ki9ALwAVg7oR%2Fimage.png?alt=media&amp;token=0dc191f5-ca81-4ebd-9efb-762b3345987c" alt=""><figcaption></figcaption></figure></div>

1. **Send A1 Measurement Configuration** — The serving AP delivers a measurement configuration message to the UE containing the A1 RSRP threshold parameters. When the serving cell’s RSRP exceeds this threshold (Event A1), the UE stops measuring neighbor cells, reducing power consumption and measurement overhead.
2. **Send A2 Measurement Configuration** — The serving AP delivers a measurement configuration message to the UE containing the A2 RSRP threshold parameters. When the serving cell’s RSRP falls below this threshold (Event A2), the UE begins measuring neighbor cells to identify candidate target cells for handover.
3. **Trigger Neighbor Measurements (A2 Event Report)** — When the serving cell’s signal quality falls below the configured A2 threshold, the UE reports the condition to the serving AP.
4. **Configure Neighbor Cell Measurements (A5 Measurement Configuration)** — Upon receiving the A2 report, the serving AP configures the UE to perform neighbor cell measurements on frequencies listed in the AP’s “Neighbor Frequency Table”. The AP uses A5 event triggers to control when measurements are reported.
5. **Evaluate Handover Conditions (A5 Event Report)** — As the UE moves and signal strength changes, the UE continuously monitors both serving and neighbor cell signal levels. Event A5 is triggered when both A5 conditions are met simultaneously:

   * The serving cell’s RSRP drops below the A5 threshold, and
   * A configured neighbor cell’s RSRP exceeds the A5 threshold.

   This dual-condition approach ensures handovers occur only when the current cell is genuinely degrading and a stronger alternative is available. For a detailed example of how A5 conditions play out in practice, see [*Sample Handover Walkthrough*](#sample-handover-walkthrough).
6. **Execute Handover** — The serving AP initiates the handover procedure over the S1 interface. The Onyx Edge coordinates the handover between the serving and target APs using a make-before-break approach. The UE disconnects from the serving cell and connects to the target cell, maintaining service continuity.

For detailed parameter definitions, default values, and tuning guidance for each event's thresholds, see [*Handover Parameters Reference*](#handover-parameters-reference).

#### Sample Handover Walkthrough

This section walks through an example of a UE moving from AP-1 (serving cell) toward AP-2 (neighbor cell) in a typical deployment scenario, illustrating how each measurement event is triggered as signal conditions change."

{% hint style="info" %}
**NOTE:** Threshold values used in this section are illustrative and may differ from the defaults listed in [*Sample Configurations*](#sample-configurations). Actual trigger timing depends on the thresholds, hysteresis, and time-to-trigger configured for your deployment.
{% endhint %}

<p align="center"><strong>Example Threshold Values</strong></p>

| Threshold                      | Example Value |
| ------------------------------ | ------------- |
| A1 Threshold                   | −82 dBm       |
| A2 Threshold                   | −92 dBm       |
| A5 Threshold 1 (serving cell)  | −100 dBm      |
| A5 Threshold 2 (neighbor cell) | −96 dBm       |

The following diagram illustrates how RSRP levels drive each measurement event as the UE moves away from the serving AP and toward a neighbor AP.

<p align="center"><strong>LTE Handover Measurement Events — Signal Level Timeline</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FsLC9S0FttGXVK9iaKKs5%2Fhandover-measurement-events-signal-level-timeline.png?alt=media&amp;token=4ebc1434-de52-48f7-9cb6-f640241718a9" alt=""><figcaption></figcaption></figure></div>

1. Initially, while the serving cell’s RSRP remains above the A1 threshold (−82 dBm), Event A1 is triggered, and the UE suspends neighbor cell measurements.
2. As the UE moves farther away from the serving cell, the serving cell signal level gradually decreases.
3. When the serving cell RSRP falls below the A2 threshold (−92 dBm), Event A2 is triggered, and the UE begins actively measuring neighbor cells. This measurement phase is represented by the shaded region.
4. Measurements continue until both A5 conditions are satisfied simultaneously:

   * The serving cell RSRP drops below A5 Threshold1 (−100 dBm), and&#x20;
   * The neighbor cell RSRP exceeds A5 Threshold2 (−96 dBm).

   At this point, Event A5 is triggered, and the serving AP initiates the handover procedure.

**Event A1: UE Close To Serving AP**

<p align="center"><strong>Event A1 - Serving Cell Becomes Better Than Threshold</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FYY4g4zlcHQQQL4JZM6XK%2Fevent-a1.png?alt=media&amp;token=32fa7c1f-bfc8-42fc-b267-04698346467a" alt="" width="563"><figcaption></figcaption></figure></div>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FcrPgFNLEEWpWXJCtXQj1%2Fevent-a1-1.png?alt=media&amp;token=c57cdff9-4c96-4c27-bf4e-f5c8d9aceb1f" alt="" width="563"><figcaption></figcaption></figure></div>

The UE is in close proximity to AP-1, and the serving cell RSRP is above A1 threshold (−82 dBm), which satisfies the A1 threshold condition. Event A1 is triggered, and the UE stops neighbor cell measurements. Signal conditions are strong; no handover is needed.

**Event A2: UE Moves Away, Signal Degrades**

<p align="center"><strong>Event A2 — Serving Cell Becomes Worse Than Threshold</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F59AVAiI1Q5P4iJhVuJgH%2Fevent-a2.png?alt=media&amp;token=97cbb3c1-872e-43b6-a828-e80f6f6a687a" alt="" width="563"><figcaption></figcaption></figure></div>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5zjBMHcouYTaSo31XFTk%2Fevent-a2-1.png?alt=media&amp;token=cb12ce1e-0c0d-46e7-b3a3-8273c313b57e" alt="" width="563"><figcaption></figcaption></figure></div>

As the UE moves away from AP-1, serving cell RSRP gradually decreases. When it drops below the A2 threshold (−92 dBm), Event A2 is triggered. The UE reports this condition to AP-1, which instructs the UE to begin measuring neighbor cells on the frequencies listed in its “Neighbor Frequency Table”. During this phase, the UE actively evaluates AP-2 and other configured neighbors. This measurement process continues until either the serving signal exceeds the A1 threshold (thereby triggering Event A1) or a suitable handover candidate is identified, thereby triggering Event A5.

**Event A5: Both A5 Conditions Are Met, Handover Triggered**

<p align="center"><strong>Event A5 — Handover Triggered (Dual Threshold Condition Met)</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F2tVFDPaVBzjnanpS5qds%2Fevent-a5.png?alt=media&amp;token=556c741d-f4e1-47c7-83d5-8d4450297601" alt="" width="563"><figcaption></figcaption></figure></div>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FDwCuhrtyoBpUmsIsQ9sD%2Fevent-a5-1.png?alt=media&amp;token=f1180291-2dc9-4b3d-9244-772c67fe155e" alt="" width="563"><figcaption></figcaption></figure></div>

As the UE continues moving towards AP-2, Event A5 is triggered when both of the following conditions are met simultaneously:

* The serving cell (AP-1) RSRP drops below A5 Threshold1 (−100 dBm)
* The neighbor cell (AP-2) RSRP rises above A5 Threshold2 (−96 dBm)

This dual-condition mechanism ensures that handover occurs only when the current connection is clearly degrading and a better target cell is available.

Once both conditions are satisfied:

* The UE reports the measurement to AP-1
* AP-1 forwards the request to the Onyx Edge
* The Onyx Edge coordinates a make-before-break handover
* The UE transitions to AP-2 without service interruption

## Configuring Handovers

In the 4G Onyx architecture, handover configuration requires careful planning of neighbor relations, precise adjustment of mobility parameters, and thorough testing to ensure seamless transitions. While actual parameter ranges and GUI steps may vary based on the specific GXC equipment and network environment, this section outlines the foundational steps for configuring reliable handovers.

### Configuration Workflow

1. Add the APs.\
   See [*Add APs*](#add-aps).
2. Associate the APs with an Onyx Edge or an Onyx Edge Pool.\
   See [*Associate APs with Onyx Edge or Pool*](#associate-aps-with-onyx-edge-or-pool).
3. Configure neighbor relationships and handover parameters for each AP. Choose the configuration approach that best suits your network topology and mobility requirements:
   * Configure all cells associated with the Onyx Edge as the AP’s prospective neighbors and allow the Onyx Edge to decide on the neighbors.\
     See [*Edit APs to Use Automatic Neighbor Configuration*](#edit-aps-to-use-automatic-neighbor-configuration).
     * Keep the default advanced handover parameter configurations.
     * Edit the default advanced handover parameter configurations to configure optimal threshold values for the given radio environment.\
       See [*Configure Advanced Handover Parameters*](#configure-advanced-handover-parameters).
   * Configure specific cells as the AP’s neighbors.\
     See [*Edit APs to Use Manual Neighbor Configuration*](#edit-aps-to-use-manual-neighbor-configuration).
     * Keep the default handover advanced parameter configurations.
     * Edit the default advanced handover parameter configurations to configure optimal threshold values for the given radio environment.\
       See [*Configure Advanced Handover Parameters*](#configure-advanced-handover-parameters).

#### Add APs

This section describes the high-level steps to add an AP.

For detailed instructions, see *4G Onyx Portal Operations Guide > Add APs*.

**To add an AP:**

{% stepper %}
{% step %}
In the Onyx Portal’s navigation pane, click **Equipment** > **Access Points** tab.

The **Equipment** page > **Access Points** tab displays the summary details of all APs configured in the network.
{% endstep %}

{% step %}
In the upper-right corner of the page, click **Add Node** > **Add Access Point**.

The **Create Access Point** page > **Access Point** tab is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FgmGnOM0PcJpbiR0XZK7P%2F4g-ap-add-access-point-tab.png?alt=media&amp;token=e2a6fd59-e4c4-4ef9-a696-b081aed9366a" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the AP's details.

For detailed instructions, see *4G Onyx Portal Operations Guide > Add APs*.
{% endstep %}

{% step %}
In the lower-right corner of the page, click **Configure RAN**.

The **RAN** tab is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8OKcy2TiOECXmJ7NQx8G%2F4g-ap-add-ran-tab.png?alt=media&amp;token=d0ac1ff4-9907-4ed2-9b31-5284e0b47b90" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the RAN details.

For detailed instructions, see *4G Onyx Portal Operations Guide > Add APs*.

{% hint style="info" %}
**NOTE:** Do not configure the handover parameters at this time. You must first save the AP and associate it with an Onyx Edge or an Onyx Edge pool.
{% endhint %}
{% endstep %}

{% step %}
To save the AP, in the upper-right corner of the page, click **Save Access Point**.
{% endstep %}
{% endstepper %}

#### Associate APs with an Onyx Edge or Onyx Edge Pool

After you add the APs, you must associate them with an Onyx Edge or an Onyx Edge Pool.

**Associate APs with an Onyx Edge**

**To associate APs with an Onyx Edge:**&#x20;

{% 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 (*****\<Onyx Edge name>*****)** page displays the Onyx Edge’s details.
{% endstep %}

{% step %}
Click the **RAN** tab.
{% endstep %}

{% step %}
Click the **Associated Access Point** dropdown and select the APs to associate with the Onyx Edge.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FfduEopE2U8Q1mJu3Jxol%2Foe-edit-associate-ap.png?alt=media&amp;token=88541920-e738-45f3-aee6-0adea9b26694" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To save your edits, in the upper-right corner of the page, click **Save Onyx Edge**.
{% endstep %}
{% endstepper %}

**Associate APs with an Onyx Edge Pool**

**To associate APs with an Onyx Edge pool:**

{% 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. At the bottom of the page, the **Onyx Edge Pool** panel lists the available pools.
{% endstep %}

{% step %}
For the pool that you want to edit, in the **Onyx Edge Pool (n)** panel > **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

The **Edit Onyx Edge Pool** page is displayed.
{% endstep %}

{% step %}
Click the **Associated Access Points** dropdown and select the APs to associate with the Onyx Edge pool.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmU97MY36kJgHjjTT5ZgO%2Foe-pool-edit-associate-ap.png?alt=media&amp;token=1cedddf9-88b8-4192-871b-361fade6f62d" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To save your edits, click **Save Onyx Edge Pool**.
{% endstep %}
{% endstepper %}

#### Edit APs to Use Automatic Neighbor Configuration

This section describes how to edit an AP to configure every cell as a neighbor and allow the Onyx Edge to decide on a cell’s neighbors. Note that this is the default behavior.

{% hint style="info" %}
**NOTE:** A cell can be configured with up to 16 neighbor cells. By default, Onyx Edge configures all associated cells as neighbors to each cell. If more than 17 cells are associated with an Onyx Edge, it automatically selects any 16 cells as neighbors for each cell. To specify which specific cells should be neighbors, you must configure the neighbor cells explicitly. For more information, see [*Edit APs to Use Manual Neighbor Configuration*](#edit-aps-to-use-manual-neighbor-configuration).
{% endhint %}

**To edit an AP to configure every cell as a neighbor to the AP:**

{% stepper %}
{% step %}
In the Onyx Portal’s navigation pane, click **Equipment** > **Access Points** tab.

The **Equipment** page > **Access Points** tab displays the summary details of all APs configured in the network.
{% endstep %}

{% step %}
In the **Actions** column, for the AP that you want to edit, click the corresponding ⋮ (options) icon, then click **Edit**.

The **Edit Access Point** page displays the AP’s details.
{% endstep %}

{% step %}
Navigate to the **Handover** tab and configure the following details:

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FsPsGDW3UrrqFqLDCr7iS%2Fimage.png?alt=media&amp;token=2a8f3ba1-726c-4193-a4c9-aa94a53afb01" alt=""><figcaption></figcaption></figure></div>

* **Explicit Neighbors** – When disabled, all cells associated with the Onyx Edge are automatically configured as the AP’s neighbors.
  {% endstep %}

{% step %}
To edit advanced handover parameters, see [*Configure Advanced Handover Parameters*](#configure-advanced-handover-parameters).
{% endstep %}

{% step %}
To save your edits, in the upper-right corner of the page, click **Save Access Point**.
{% endstep %}
{% endstepper %}

#### Edit APs to Use Manual Neighbor Configuration

This section describes how to edit APs to configure specific cells as neighbors.

{% hint style="warning" %}
**CAUTION:** Adding or editing APs restarts all APs, since tables are modified and updated across all units. This is a service-disrupting operation and must be planned accordingly.
{% endhint %}

**To edit an AP to configure specific cells as its neighbors:**

{% stepper %}
{% step %}
In the Onyx Portal’s navigation pane, click **Equipment** > **Access Points** tab.

The **Equipment** page > **Access Points** tab displays the summary details of all APs configured in the network.
{% endstep %}

{% step %}
In the **Actions** column, for the AP that you want to edit, click the corresponding ⋮ (options) icon, then click **Edit**.

The **Edit Access Point (*****\<AP name>*****)** page displays the AP’s details.
{% endstep %}

{% step %}
Navigate to the **Handover** tab and configure the following details:

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FdrxJRwogEnk1fR4b8zAF%2Fimage.png?alt=media&amp;token=d49cfd24-2d86-40d9-953f-a516e956f3f9" alt=""><figcaption></figcaption></figure></div>

* **Explicit Neighbors** – Enable to manually configure specific neighbor cells for this AP. When enabled, you can explicitly select which cells should be neighbors and specify their priority order.
  * **Select Neighbor Cell (Priority Order)** – Click to select the AP’s neighbor cells from the list of cells associated with the Onyx Edge.

    The list order determines priority, with the first cell in the list assigned priority 1 (highest), the second cell priority 2, and so on.

    To reorder priorities, drag and drop cells up or down in the list as required.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F1FVCCPxxOv6BBP9g7sGp%2Fimage.png?alt=media&amp;token=d9017f1e-e4c3-47e6-8e40-1b5b0ae48f51" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To edit advanced handover parameters, see [*Configure Advanced Handover Parameters*](#configure-advanced-handover-parameters).
{% endstep %}

{% step %}
To save your edits, in the upper-right corner of the page, click **Save Access Point**.
{% endstep %}
{% endstepper %}

#### Configure Advanced Handover Parameters

Advanced handover parameters control the RSRP threshold values that govern when measurements are triggered and when handovers execute. This section describes how to edit APs to configure advanced handover parameters.

{% hint style="info" %}
**NOTE:** The default threshold values are optimized for typical deployment scenarios. Only adjust these values if you fully understand their impact on your specific radio environment. For optimization guidance or troubleshooting support, contact GXC Technical Support.
{% endhint %}

{% hint style="info" %}
**NOTE:** Each AP in your network may require different handover settings based on their role, coverage characteristics, and traffic patterns. This asymmetric approach enables fine-tuned optimization for specific network topology requirements.
{% endhint %}

#### **Portal Power Measurement Value Conversion**

In practice, power measurements are referred to in the dBm scale, typically ranging from -80 dBm (very good power) to -120 dBm (very poor power). To simplify GUI configuration in the Onyx Portal, these negative dBm values (which are hard to compare intuitively) are converted into positive values by adding an offset of 140. For example, -80 dBm becomes 60 in the Onyx Portal. The following table lists the default values.

Unlike absolute power thresholds (A1, A2, A5), the A3 Offset RSRP and Hysteresis parameters represent relative values measured in decibels (dB), not absolute power levels (dBm). The Onyx Portal values for these parameters are entered directly as dB offsets without the conversion used for absolute power measurements.

<p align="center"><strong>Portal Power Measurement Value Conversion</strong></p>

<table><thead><tr><th valign="top">Threshold</th><th valign="top">Power Level</th><th valign="top">Onyx Portal Value (power in dBm + 140)</th></tr></thead><tbody><tr><td valign="top">A1 RSRP</td><td valign="top">-85 dBm</td><td valign="top">55</td></tr><tr><td valign="top">A2 RSRP</td><td valign="top">-90 dBm</td><td valign="top">50</td></tr><tr><td valign="top">A5 RSRP Neighbor Cell</td><td valign="top">-97 dBm</td><td valign="top">43</td></tr><tr><td valign="top">A5 RSRP Serving Cell</td><td valign="top">-100 dBm</td><td valign="top">40</td></tr><tr><td valign="top">A3 Offset RSRP</td><td valign="top">N/A (relative value)</td><td valign="top">10 dB</td></tr><tr><td valign="top">Hysteresis</td><td valign="top">N/A (relative value)</td><td valign="top">1 dB</td></tr></tbody></table>

#### **Handover Parameters Reference**

The following table describes all advanced handover parameters — definitions, defaults, and tuning guidance. The [*Sample Configurations*](#sample-configurations) section provides ready-made profiles for common deployment scenarios.

<p align="center"><strong>Handover Parameters Reference</strong></p>

<table><thead><tr><th width="150.42852783203125" valign="top">Parameter</th><th width="150.238037109375" valign="top">Default (Onyx Portal value / dBm)</th><th valign="top">Purpose</th><th valign="top">Tuning Guidance (When to Increase or Decrease)</th></tr></thead><tbody><tr><td valign="top"><strong>A1 RSRP</strong></td><td valign="top">55 / −85 dBm</td><td valign="top"><p>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.</p><p>In DC mode, configure this parameter for Cell 1 and Cell 2.</p></td><td valign="top"><p><strong>Increase</strong> </p><p>In strong coverage environments, to reduce unnecessary neighbor measurements and improve UE battery life.
</p><p>When you want to prioritize stability over frequent measurements (e.g., stationary or slow-moving UE).</p><p><strong>Decrease</strong> </p><p>In challenging RF environments with frequent micro-mobility, to keep neighbor measurements active longer.
</p><p>When UE are moving fast or have high reliability demands (e.g., AGVs or autonomous machines), so they stay ready to handover earlier.</p></td></tr><tr><td valign="top"><strong>A2 RSRP</strong></td><td valign="top">50 / −90 dBm</td><td valign="top"><p>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.</p><p>In DC mode, configure this parameter for Cell 1 and Cell 2.</p></td><td valign="top"><p><strong>Increase</strong> </p><p>In stable environments with good coverage, to avoid triggering neighbor measurements too early.
</p><p>When reducing measurement overhead is more important than early preparation.</p><p><strong>Decrease</strong></p><p>In high-mobility or interference-prone areas, to start neighbor cell monitoring earlier, ensuring smoother handovers.
</p><p>To improve handover responsiveness for mission-critical applications.</p></td></tr><tr><td valign="top"><strong>A5 RSRP — Serving Cell</strong></td><td valign="top">40 / −100 dBm</td><td valign="top"><p>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.</p><p>In DC mode, configure this parameter separately for Cell 1 and Cell 2.</p><p></p><p></p></td><td valign="top"><p><strong>Increase</strong> </p><p>If UE stay too long on poor signals (delayed handovers), increasing this value will cause them to handover sooner.</p><p><strong>Decrease</strong> </p><p>To avoid unnecessary or premature handovers (ping-pong effect), especially if UE are stationary or moving slowly.</p></td></tr><tr><td valign="top"><strong>A5 RSRP — Neighbor Cell</strong></td><td valign="top">43 / −97 dBm</td><td valign="top"><p>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.</p><p>In DC mode, configure this parameter separately for Cell 1 and Cell 2.</p></td><td valign="top"><p><strong>Increase</strong> </p><p>To ensure UE only move to strong and stable cells, improving post-handover performance.
</p><p>In environments where overlapping cells have varying quality, to avoid weak target cells.</p><p><strong>Decrease</strong> </p><p>To allow handovers to weaker cells if no stronger options are available, preventing drops or service interruption.</p></td></tr><tr><td valign="top"><strong>A3 Offset RSRP</strong></td><td valign="top">10 dB</td><td valign="top"><p>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.</p><p>In DC mode, configure this parameter for Cell 1 and Cell 2.</p></td><td valign="top"><p><strong>Increase</strong></p><p>In stable RF environments to reduce ping-pong handovers caused by small signal variations.
</p><p>When prioritizing connection stability over signal optimization, particularly for stationary or slow-moving UE.
</p><p>In high-density deployments with significant cell overlap where frequent handovers would create excessive signaling overhead.</p><p><strong>Decrease</strong> </p><p>In environments where signal quality changes rapidly and UE need to switch to better cells quickly.
</p><p>For high-mobility scenarios where faster handover decisions improve service continuity.
</p><p>When optimizing for maximum signal quality is critical for application performance (e.g., high-throughput data applications).</p></td></tr><tr><td valign="top"><strong>Hysteresis</strong></td><td valign="top">1 dB</td><td valign="top">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.</td><td valign="top"><p><strong>Increase</strong> </p><p>In highly variable RF conditions to reduce oscillating handovers.
</p><p>When UE experience frequent rapid changes in signal quality.</p><p><strong>Decrease</strong> </p><p>If handovers are delayed too long despite a neighbor being better, or if service continuity requires faster switching.</p></td></tr><tr><td valign="top"><strong>Time to Trigger</strong></td><td valign="top">480 ms</td><td valign="top">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.</td><td valign="top"><p><strong>Increase</strong> </p><p>To avoid unnecessary handovers caused by short-term fading or momentary interference.</p><p><strong>Decrease</strong> </p><p>To make handover reactions faster, especially for high-speed mobility scenarios.</p></td></tr></tbody></table>

**To configure advanced handover parameters:**

{% stepper %}
{% step %}
In the Onyx Portal’s navigation pane, click **Equipment** > **Access Points** tab.

The **Equipment** page > **Access Points** tab displays the summary details of all APs configured in the network.
{% endstep %}

{% step %}
In the **Actions** column, for the AP that you want to edit, click the corresponding ⋮ (options) icon, then click **Edit**.

The **Edit Access Point** page displays the AP’s details.
{% endstep %}

{% step %}
Click the **Handover** tab.
{% endstep %}

{% step %}
Click **Show Advanced Configuration** and configure the following details.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FRYoNBIMq2y9njyf5h9AW%2Fimage.png?alt=media&amp;token=19267e0f-5555-4a3f-a01c-01d88e622c75" alt=""><figcaption></figcaption></figure></div>

* **Neighbor Management** – Enable to allow Onyx Edge to manage neighbor relationships for this AP. When enabled, the Onyx Edge automatically populates and maintains this AP’s “Neighbor Frequency Table” and “Neighbor Cell Table” based on the other cells associated with it.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> If you need to disable neighbor management for a particular AP, you must disable this <strong>Neighbor Management</strong> toggle switch.</p></div>
* **Handover Thresholds** – Parameters that control the handover process, ensuring smooth transitions between cells when a UE moves out of the serving cell's coverage area.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> For detailed parameter descriptions, see <a href="#handover-parameters-reference"><em>Handover Parameters Reference</em></a> table.</p></div>

  * **A5 RSRP** – A handover is initiated when both of the following conditions are met simultaneously:
    * **Serving Cell** – (Required) When the serving cell RSRP falls below this threshold handover is evaluated. Ensures handovers only occur when the serving cell is genuinely weak. In DC mode, configure this parameter for Cell 1 and Cell 2. Default value: 40 (equivalent to –100 dBm).
    * **Neighbor Cell** – (Required) When the neighbor cell RSRP rises above this threshold it is considered a valid handover target. Prevents handovers to cells with insufficient signal. In DC mode, configure this parameter for Cell 1 and Cell 2. Default value: 43 (equivalent to -97 dBm).
  * **A1 RSRP** – (Required) When the serving cell RSRP rises above this threshold, the signal is considered acceptable. The UE stops measuring neighbors, conserving battery. Default value: 55 (equivalent to -85 dBm). In DC mode, configure this parameter for Cell 1 and Cell 2.
  * **A2 RSRP** – (Required) When the serving cell RSRP falls below this threshold, the signal is considered poor. The UE begins measuring neighbors in preparation for handover. Default value: 50 (equivalent to -90 dBm). In DC mode, configure this parameter for Cell 1 and Cell 2.
  * **A3 Offset RSRP** – (Required) The margin, in dB, by which the neighbor cell RSRP must exceed the serving cell RSRP to trigger a handover. Prevents unnecessary handovers from minor signal fluctuations. Default value: 10 dB. In DC mode, configure this parameter for Cell 1 and Cell 2.
  * **Hysteresis (dB)** – (Required) A buffer value, in dB, that prevents handover flapping from small signal fluctuations. The neighbor cell signal must exceed the serving cell signal by this margin before a handover is triggered. Default value: 1 dB.
  * **Time to trigger (ms)** – The duration, in milliseconds, that a qualifying condition must persist before a handover is initiated. Prevents handovers triggered by temporary fading or momentary interference. Default value: 480 ms.
    {% endstep %}

{% step %}
To save your edits, in the upper-right corner of the page, click **Save Access Point**.
{% endstep %}
{% endstepper %}

#### Sample Configurations

The following table provides recommended starting configurations for typical deployment environments. Use these as baselines and adjust based on field testing results and your specific network requirements.

* **Conservative (Stable Connection)** – Designed for stationary or slow-moving devices and mission-critical applications requiring maximum stability. Minimizes handover frequency and reduces ping-pong effects, though devices may stay on weaker signals longer.
* **Baseline (GXC Default)** – GXC-recommended starting point for general enterprise environments with mixed mobility patterns. Provides balanced performance across most scenarios with optimal trade-offs between stability and optimization.
* **Aggressive (Opportunistic)** – Optimized for high-density environments with excellent coverage overlap and performance-critical applications. Maximizes signal quality through quick handovers to better cells but increases handover frequency and signaling overhead.
* **High-Mobility** – Tailored for vehicular applications and fast-moving devices with faster reaction times. Optimized for movement patterns while maintaining reasonable stability but may not suit stationary devices.

<p align="center"><strong>Sample Configurations</strong></p>

| Parameter             | Conservative (Stable) | Baseline (GXC Default) | Aggressive (Opportunistic) | High-Mobility |
| --------------------- | --------------------- | ---------------------- | -------------------------- | ------------- |
| A1 RSRP               | 60 (-80 dBm)          | 55 (-85 dBm)           | 55 (-85 dBm)               | 53 (-87 dBm)  |
| A2 RSRP               | 45 (-95 dBm)          | 50 (-90 dBm)           | 50 (-90 dBm)               | 52 (-88 dBm)  |
| A5 RSRP Neighbor Cell | 48 (-92 dBm)          | 43 (-97 dBm)           | 45 (-95 dBm)               | 42 (-98 dBm)  |
| A5 RSRP Serving Cell  | 35 (-105 dBm)         | 40 (-100 dBm)          | 38 (-102 dBm)              | 40 (-100 dBm) |
| A3 Offset RSRP (dB)   | 12                    | 10                     | 6                          | 8             |
| Hysteresis (dB)       | 3                     | 1                      | 0.5                        | 2             |
| Time to Trigger (ms)  | 640                   | 480                    | 320                        | 240           |

## Testing and Validation

Proper testing is essential to confirm that handover performance meets requirements before full deployment. The recommended process combines theoretical modeling, field measurement, and portal-based monitoring.

**Recommended testing process:**

1. **Model parameters using the GXC Handover Visualization Tool**. Model parameters using the GXC Handover Visualization Tool to understand how threshold values affect the handover region before deploying to the field. See [*GXC Handover Visualization Tool*](#gxc-handover-visualization-tool).
2. **Plan and configure neighbor relationships**. Plan and configure neighbor relationships in the Onyx Portal based on your network topology and expected UE movement patterns.
3. **Apply initial handover parameter configuration**. Configure handover parameters in Onyx Portal for initial field testing. Start with model or default threshold values. See [*Configuring Handovers*](#configuring-handovers).
4. **Perform field testing.** Use the GXC Onyx Survey Tool across all coverage areas and mobility scenarios. The Onyx Survey Tool is purpose-built for GXC private cellular deployments and provides integrated handover measurement and reporting. For details on using the tool, see the *4G & 5G Onyx Survey Solution Application Note*.

   Alternatively, professional drive test tools such as TEMS Investigation or Nemo Outdoor may be used. Monitor the performance metrics – track handover success rates, timing, and signal levels to validate real-world performance against expectations. See [*Field Testing*](#field-testing).
5. **Monitor performance in the Onyx Portal.** Use Onyx Portal to analyze handover statistics, review neighbor table status, and track overall mobility performance. See [*Onyx Portal-Based Monitoring*](#onyx-portal-based-monitoring).
6. **Adjust and re-test.** Based on field test results, refine threshold values and neighbor priorities. Re-test until target performance levels are achieved. See [*Configure Advanced Handover Parameters*](#configure-advanced-handover-parameters).
7. **Validate mission-critical applications.** Confirm that applications requiring uninterrupted connectivity maintain acceptable connectivity and performance during handover transitions.

### GXC Handover Visualization Tool

GXC provides an interactive web-based tool to help visualize and understand LTE handover behavior before field deployment. Use this tool to understand the relationship between threshold parameters and handover regions before making any configuration changes.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F2JXcUq6MF06xXXkstjzT%2Fimage.png?alt=media&amp;token=4d976286-baa6-4542-bebc-c598231813ce" alt=""><figcaption></figcaption></figure></div>

**Using GXC’s LTE Handover Region Visualization Tool:**

{% hint style="info" %}
**NOTE:** Each AP in your network may require different handover settings based on their role, coverage characteristics, and traffic patterns. This asymmetric approach enables fine-tuned optimization for specific network topology requirements.
{% endhint %}

{% stepper %}
{% step %}
Access the tool at: [*https://lte-handoff-vfa3mkxapbectiedyiptvj.streamlit.app/*](https://lte-handoff-vfa3mkxapbectiedyiptvj.streamlit.app/)
{% endstep %}

{% step %}
Under **Threshold Parameters**, use the sliders to adjust the threshold and hysteresis values to observe how changes affect the handover region.

For detailed information on these parameters, see [*Configuring Handovers*](#configuring-handovers).
{% endstep %}

{% step %}
The green region in the visualization shows where handovers will occur based on the relationship between Serving Cell Power (X-axis) and Neighbor Cell Power (Y-axis).
{% endstep %}

{% step %}
Experiment with different parameter combinations to understand:

* How hysteresis affects handover stability
* The relationship between serving and neighbor cell thresholds
* Optimal parameter ranges for different deployment scenarios
  {% endstep %}

{% step %}
Use the tool to identify starting parameters and understand parameter interactions before moving to field testing.
{% endstep %}
{% endstepper %}

### Field Testing

After initial parameters are configured, deploy and validate handover performance in the live network environment.

1. Deploy theoretical parameters in the actual network environment.
2. Perform field tests using the GXC Onyx Survey Tool to confirm real-world handover performance across your coverage area. The Onyx Survey Tool is purpose-built for GXC private cellular deployments and provides integrated measurement collection, handover event logging, and reporting. For full details on using the tool, see the *4G & 5G Onyx Survey Solution Application Note*. Alternatively, use third-party drive test tools such as TEMS Investigation or Nemo Outdoor.
3. During testing, monitor key performance indicators:
   * Handover success rate
   * Handover failure rate
   * Call drop rate during mobility
   * Time to complete handover
   * Signal strength at handover trigger points
   * Application continuity during handover
4. Test different mobility scenarios as per deployment requirements:
   * Pedestrian speed (3 km/h)
   * Vehicular speed (30-60 km/h)
   * Stationary to mobile transitions
   * High-density areas with multiple overlapping cells

### Onyx Portal-Based Monitoring

**To review and adjust the AP Handover settings in the Onyx Portal:**

{% stepper %}
{% step %}
In the Onyx Portal’s navigation pane, click **Equipment** > **Access Point** tab.

The **Equipment** page > **Access Points** tab displays the summary details of all APs configured in the network.
{% endstep %}

{% step %}
To view the details of a particular AP, click its name.

The ***\<AP name>*** page displays the AP’s details.
{% endstep %}

{% step %}
Click the **Handover** tab.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fu8P4qQm9WI49uEhAdFtw%2Fap-view-handover-tab.png?alt=media&amp;token=63ce2c24-431d-4478-9377-5cc240617978" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Analyze handover measurements and adjust parameters based on observed performance.&#x20;

For details, see [*Configuring Handovers*](#configuring-handovers).
{% endstep %}
{% endstepper %}

## Best Practices and Optimization

The following recommendations help ensure reliable handover performance and simplify ongoing network optimization.

1. **Plan before you configure**. Plan neighbor relationships based on physical cell locations and expected UE mobility patterns before deployment.
2. **Start all-to-all, then refine**. Start with the default all-to-all neighbor configuration and refine based on traffic patterns and field testing.
3. **Use priority ordering to manage table limits**. Ensure the most likely handover targets appear within the 16-cell table limit.
4. **Configure bidirectional relationships**. Configure bidirectional neighbor relationships for cells where UE movement is expected in both directions.
5. **Start with GXC default thresholds**. Use GXC-provided default values as your baseline before adjusting them based on field test results. See [*Sample Configurations*](#sample-configurations).
6. **Use the Visualization Tool before field testing**. Leverage GXC's LTE Handover Region Visualization Tool to understand parameter relationships before field deployment. See [*GXC Handover Visualization Tool*](#gxc-handover-visualization-tool).
7. **Monitor continuously**. Track handover success rates, failure patterns, and mobility performance metrics to identify optimization opportunities.
8. **Test iteratively**. Combine theoretical modeling, field testing, and Onyx Portal analytics in an iterative cycle to achieve optimal performance.
9. **Validate application performance, not just connectivity**. Ensure mission-critical applications maintain service quality during handover transitions.
10. **Schedule table changes during maintenance windows.** All neighbor table changes cause AP reboots and service disruption.
11. **Document all changes**. Record all configuration changes, performance results, and rationale for future troubleshooting.
12. **Contact GXC Technical Support** for advanced tuning and optimization guidance.

## Related Documentation

* *4G Onyx Portal Operations Guide*
* *4G & 5G Onyx Survey Solution Application Note*
* *5G Spectrum Analyzer Application Note*
* *GXC Glossary*

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# 4G Onyx Edge HA

## Introduction

The MME, a crucial component of the Onyx Core Network, plays a key role in the handling of control plane traffic, including signaling messages related to call setup, handovers, and session management. Enabling High Availability (HA) of the MME/Onyx Edge in a network ensures uninterrupted and reliable MME services in the face of failures or disruptions.

MME/Onyx Edge Pooling is the technique used to achieve HA of the MME/Onyx Edge in a network. It involves grouping the Onyx Edge in a network into a pool and associating APs with the pool. All the Onyx Edge in a pool have equal capacity and function in Active-Active mode. If an Onyx Edge in a pool experiences failures, the UE registered on that Onyx Edge are moved to the other Onyx Edge in that pool. If the Onyx Edge designated as the Primary "Automatic Configuration Server" (ACS) fails, a Standby ACS Onyx Edge takes over the Primary ACS responsibility. This helps minimize service disruptions due to failures, making the network more reliable.

{% hint style="info" %}
**NOTE:** Onyx Edge HA is supported only for Onyx Edge On-Premises.
{% endhint %}

{% hint style="info" %}
**NOTE:** Each pool can have a maximum of three Onyx Edge associated with it.
{% endhint %}

{% hint style="info" %}
**NOTE:** Each Onyx Edge can be associated only with one pool at any time.
{% endhint %}

{% hint style="info" %}
**NOTE:** Each AP can be associated only with one pool at any time.
{% endhint %}

{% hint style="info" %}
**NOTE:** IPSec is not supported in conjunction with HA/Onyx Edge pools. IPSec-enabled Onyx Edge and APs must not be associated with an Onyx Edge pool. IPSec must not be enabled on Onyx Edge and APs already associated with a pool.
{% endhint %}

## Onyx Edge Pool Architecture

The following diagram illustrates the Onyx Edge pool architecture.

<p align="center"><strong>Onyx Edge Pool Architecture</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FtPMVgIINeFyP3CQq8A1S%2Fimage.png?alt=media&amp;token=f708e463-3655-4dff-aeea-d00e091dba33" alt="" width="560"><figcaption></figcaption></figure>

* The MME/Onyx Edge pool is the overarching entity that groups together the MME/Onyx Edge.
* MME/Onyx Edge 1, MME/Onyx Edge 2, and MME/Onyx Edge 3 represent the individual MME/Onyx Edge within the pool. The Onyx Edge share the same pool identity and configuration. MME/Onyx Edge 1 is configured as the Primary ACS and manages AP management traffic (AP configuration and AP status).

  Automatic Configuration Server (ACS) Redundancy: The Onyx Edge with the highest ACS priority in a pool acts as the Primary ACS Onyx Edge within the pool. The Primary ACS Onyx Edge anchors the ACS endpoint address configured in the pool, and manages AP management traffic to pass on configuration to and read status from the APs. If the Primary ACS Onyx Edge fails, a Standby ACS Onyx Edge takes over the Primary ACS responsibility ensuring continuity of service and thereby further improving the network's reliability.
* AP1, AP2, through AP*n* represent the APs associated with the pool. An AP associated with a pool can talk to any operational MME/Onyx Edge within the pool. The APs associated with a pool direct UE traffic to the Onyx Edge in the pool based on the current load on each Onyx Edge. This balancing helps ensure no single Onyx Edge becomes overloaded while others are underutilized.

In the Onyx Edge pool architecture:

1. An MME/Onyx Edge pool groups the Onyx Edge and has APs associated with it.

2. The APs associated with a pool direct UE traffic to the Onyx Edge in the pool based on the current load on each Onyx Edge.

   **Onyx Edge Pool Load Balancing**

   <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fxv1I9dErSxOXza5gfas8%2Fimage.png?alt=media&amp;token=a8433c3c-d8e2-4a08-92ab-b8a02881010b" alt="" width="560"><figcaption></figcaption></figure>

3. If an MME/Onyx Edge in a pool experiences failures, the UE registered on that MME/Onyx Edge are moved to the other MME/Onyx Edge within the pool.

   **Onyx Edge Pool High Availability**

   <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FtqyoExz7XnJpnOuYehQs%2Fimage.png?alt=media&amp;token=32905184-2590-462c-8e91-4b6450778169" alt="" width="560"><figcaption></figcaption></figure>

4. The Onyx Edge with the highest ACS priority acts as the Primary ACS within the pool. The Primary ACS Onyx Edge manages the AP management traffic.

   **Onyx Edge Pool ACS Redundancy**

   <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FKKmCfj3pDKndjeA1PCHQ%2Fimage.png?alt=media&amp;token=f7f2bc6a-63d0-4134-97bf-34812b250309" alt="" width="560"><figcaption></figcaption></figure>

   If the Primary ACS Onyx Edge fails, an operational Standby ACS Onyx Edge with the highest priority takes over the Primary ACS responsibility.

   **Onyx Edge Pool ACS Redundancy — Primary ACS Switch**

   <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FB7ps1e7ZuPtDlYSg8gws%2Fimage.png?alt=media&amp;token=ee665dda-506d-4c4a-a38c-4c004db25148" alt="" width="560"><figcaption></figcaption></figure>

This basic architecture forms the foundation for MME/Onyx Edge Pooling, providing redundancy and reliability in core network functions.

## Networking Requirements

This section describes the networking configurations recommended for the Onyx Edge associated with an Onyx Edge pool.

* When deploying multiple Onyx Edge for HA, you must allocate an additional IP address within the same S1 subnet as those assigned to each individual Onyx Edge. This extra IP address serves as the "Virtual IP" and is used to centrally manage APs in the MME/Onyx Edge pool as a unified entity from the Onyx Orchestrator.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FNWiylWmYlzgI7GezSrLC%2Fimage.png?alt=media&amp;token=412fde45-eae0-4f96-aac3-54efcffead31" alt="" width="560"><figcaption></figcaption></figure>

* It is also required to avoid deploying the Onyx Edge in "S1 same as SGi" mode. If the network layout follows the "flat networking model", a separate RAN network will be required to run the eth1/S1 network separate from eth0/SGi interfaces. This can be accomplished by segregating the S1/RAN network traffic on its own unique VLAN to maintain traffic separation.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fz1JyixLQjWXwld1WvcYJ%2Fimage.png?alt=media&amp;token=a223cb3c-cdce-4bbc-95ba-1a1e0bc5c884" alt="" width="359"><figcaption></figcaption></figure>

* **S1 Interface IP** — The subnet must be the same across all the Onyx Edge in a pool. The S1 interface should be static and different, and should be in the same subnet as the TR069 HA IP. Recommended configuration: 10.0.2.1, 10.0.2.2, 10.0.2.3.

  It is not possible to change the S1 subnet of the Onyx Edge in a pool or the VIP in the pool configuration — you can only edit them to a different IP address within the same subnet. If the subnet must be changed, the required procedure is:

  1. Disassociating all ONYX Edge from the pool.
  2. Editing the VIP in the pool configuration.
  3. Editing the S1 subnet (use the same subnet for all Onyx Edge).
  4. Associating the Onyx Edge back with the pool.
* **Access Point DHCP Service** — The Start IP address must be a host inside the S1 IP/Subnet and must be the same across all the Onyx Edge in a pool. Recommended configuration: **Start IP**: 10.0.2.240, **No. of IP**: 15.
* **Onyx Edge Tunnel Anchoring Subnet** — The Onyx Edge Tunnel Anchoring subnet must be different across all the Onyx Edge in a pool. Recommended configuration: 192.168.133.0/28, 192.168.151.0/28, 192.168.152.0/28.
* **Mesh Node Assignment Subnet** — The Mesh Node Assignment subnet must be the same across all the Onyx Edge in a pool.
* **Mesh UE IP Subnet** — Applicable for VLAN mode. The Mesh UE IP subnet must be different across all the Onyx Edge in a pool. Recommended configuration: 192.168.129.0/24, 192.168.160.0/24, 192.168.161.0/24.
* **Per APN Per Onyx Edge Config** — Applicable for VLAN mode. Except for the **Local IP** (which must be different across all Onyx Edge and from the same subnet), all the other parameters (**Default GW IP**, **VLAN ID**, and **Default GW MAC**) must be the same across all the Onyx Edge in a pool.

## Manage Onyx Edge Pools

This section describes how to create and manage Onyx Edge pools.

{% hint style="info" %}
**NOTE:** You can create and manage Onyx Edge pools only if you are a GXC Administrator, Customer Administrator, or an Administrator.
{% endhint %}

<p align="center"><strong>Onyx Edge Pool Configuration Workflow</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F1En2Og2NyjEgyntA2WMm%2Fimage.png?alt=media&amp;token=08831502-a1b9-40de-8697-497114d5e74e" alt="" width="334"><figcaption></figcaption></figure>

The workflow to create and configure an Onyx Edge pool:

{% stepper %}
{% step %}
Create the Onyx Edge pool.

See [Create Onyx Edge Pools](#create-onyx-edge-pools).
{% endstep %}

{% step %}
If the Onyx Edge that you want to associate with the pool already exist.

1. Remove any direct Onyx Edge – AP associations.

   See [Remove Direct Onyx Edge – AP Associations](#remove-direct-onyx-edge--ap-associations).
2. Update Onyx Edge configurations for pool requirements.

   See [Networking Requirements](#networking-requirements).
   {% endstep %}

{% step %}
Add any new Onyx Edge to associate with the pool.

See *4G Onyx Portal Operations Guide > Add Onyx Edge*.
{% endstep %}

{% step %}
Associate the Onyx Edge with the pool.

See [Associate or Disassociate Onyx Edge with Pools](#associate-or-disassociate-onyx-edge-with-pools).
{% endstep %}

{% step %}
Set the ACS priorities for the Onyx Edge in the pool.

See [Edit Onyx Edge Pools](#edit-onyx-edge-pools).
{% endstep %}

{% step %}
Add any new APs to associate with the pool.

See *4G Onyx Portal Operations Guide > Add APs*.
{% endstep %}

{% step %}
Associate the APs with the pool.

See [Edit Onyx Edge Pools](#edit-onyx-edge-pools).
{% endstep %}
{% endstepper %}

### View Onyx Edge Pool Details

This section describes how to view Onyx Edge pool details using the following views:

* [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 Details of an Onyx Edge Pool](#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.
{% endstep %}

{% step %}
The **Onyx Edge Pool** panel displays the number of Onyx Edge pools in the network, the pool names, and their HA connectivity status.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F2STgN5w4yKsGq05eM4BU%2Fimage.png?alt=media&amp;token=cf502736-9ce5-4235-9d41-db1b42bf14b2" alt=""><figcaption></figcaption></figure>

Onyx Edge pool HA connectivity status:

* <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FOBevMZmxd9jybly3DYTR%2Fimage.png?alt=media&amp;token=07325dac-adc2-494f-a51d-fd0d2a11cce1" alt="" data-size="line"> Green — One Onyx Edge is functioning as the Primary ACS, and the others as Standby ACS.
* <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FyBrIggvYU9WoVkEDLAs4%2Fimage.png?alt=media&amp;token=fb231de6-353f-4f21-9e0a-0cc5cfd35b44" alt="" data-size="line"> Amber — One Onyx Edge is functioning as the Primary ACS, but one or more of the other Onyx Edge are non-functional.
* <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0yjWZz9FrSNhqPu3i9eV%2Fimage.png?alt=media&amp;token=bc1f720c-02c7-4e95-8ca8-1b5593dbfa30" alt="" data-size="line"> Red — All Onyx Edge are non-functional, or their status is not available.
* <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FGmZQpbjNur6Z4R4x8YrY%2Fimage.png?alt=media&amp;token=15e8500c-f5c6-4e9c-93ef-3bac2d2fe7bb" alt="" data-size="line"> 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.
{% endstep %}

{% step %}
To view a pool's details, click its name.

The ***\<pool name>*** page displays the Onyx Edge pool's details.

For more information, see [View Details of an Onyx Edge Pool](#view-details-of-an-onyx-edge-pool).
{% endstep %}
{% endstepper %}

#### View Summary Details of all Onyx Edge Pools in the Network

**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.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FgHFXhSEAe1iA6viy7Mqs%2Fimage.png?alt=media&amp;token=3d999d79-0708-4148-96f5-5982b5244f3c" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
The **Onyx Edge Pool** section displays the following columns:

* **Status** — The Onyx Edge pool's HA connectivity status:

  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FsoX3u4REt0p3EilHXZX4%2Fimage.png?alt=media&amp;token=82f8ddea-39fa-4b6d-9380-14b5fd71ce7d" alt="" data-size="line"> Green — One Onyx Edge is functioning as the Primary ACS, and the others as Standby ACS.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FNwxAHYZFcjcTClQIEpds%2Fimage.png?alt=media&amp;token=1d583b00-71c1-4fdf-b49f-268dfd6c2e18" alt="" data-size="line"> Amber — One Onyx Edge is functioning as the Primary ACS, but one or more of the other Onyx Edge are non-functional.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FhvQu45pCFzy5Aci7gIYQ%2Fimage.png?alt=media&amp;token=a6839233-57e1-48d9-85e9-1eb60fd8dde2" alt="" data-size="line"> Red — All Onyx Edge are non-functional, or their status is not available.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8oMffolNPOeYcxNtJr64%2Fimage.png?alt=media&amp;token=615942ea-ec8c-4667-b758-47a67073031c" alt="" data-size="line"> 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.
* **Name** — The pool's name.
* **HA IP Address** — The virtual management IP address used to anchor the TR069 endpoint in the Primary ACS Onyx Edge.
* **Associated Onyx Edges** — The number of Onyx Edge associated with the pool.
* **Associated Access Points** — The number of APs associated with the pool.
* **Actions** — Options to view details, edit, and delete the Onyx Edge pool.
  {% endstep %}
  {% endstepper %}

#### View Details of an Onyx Edge Pool

**To view the details of a particular 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.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FxWIApBtPM9GMiub8hbEW%2Fimage.png?alt=media&amp;token=f93697fc-fa27-4fb0-a965-8fb6bc2513d3" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To view the details of a particular pool, click its name.

The ***\<pool name>*** page displays the pool's details, including the following sections:

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FW9eHEhkprlPahioIvEuk%2Fimage.png?alt=media&amp;token=f2149c24-4bfe-420a-bb74-f7c653dc181b" alt=""><figcaption></figcaption></figure>

**Pool Details**

* **Name** — The pool's name.
* **ID** — The pool's ID. This ID is system-generated.
* **MME Group ID** — Uniquely identifies the pool that the MME/Onyx Edge is associated with.
* **HA IP Address** — The virtual management IP address.
* **HA Connectivity Status** — The Onyx Edge pool's HA connectivity status:

  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F7NY3jRWeFKif3WlPlJsZ%2Fimage.png?alt=media&amp;token=76dfd24f-fc01-472d-b6a6-0e1085dec8fc" alt="" data-size="line"> Green — One Onyx Edge is functioning as the Primary ACS, and the others as Standby ACS.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FEcuSLTPGlYE2wHRm7cSn%2Fimage.png?alt=media&amp;token=64c7332e-7558-4c51-a592-0ada987c2d23" alt="" data-size="line"> Amber — One Onyx Edge is functioning as the Primary ACS, but one or more of the other Onyx Edge are non-functional.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FScIl0EcvV4pp9BDPtfcv%2Fimage.png?alt=media&amp;token=03b1d041-c3a4-420f-ac64-e5fca85ec174" alt="" data-size="line"> Red — All Onyx Edge are non-functional, or their status is not available.
  * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FNSyXb9mfoKTNi1PQ3BAV%2Fimage.png?alt=media&amp;token=91fdcfc8-682c-41a9-b1de-124ee7161e6e" alt="" data-size="line"> 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** — The Onyx Edge's ACS priority within the pool. The ACS priority indicates the probability of an Onyx Edge functioning as the Primary ACS relative to the other Onyx Edge in the pool. Priority 1 is the highest priority and 3 the lowest. If the Primary ACS Onyx Edge fails, an operational Standby ACS Onyx Edge with the highest priority will take over as the Primary.
  * **Name** — The Onyx Edge's name.
  * **Access Point** — The APs associated with the Onyx Edge.
  * **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:
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FQlfmL8VicYKxEFDln0jW%2Fimage.png?alt=media&amp;token=b210cc85-911c-4354-b795-b375f11002ff" alt="" data-size="line"> Green — The Onyx Edge has checked in with the Onyx Portal in the last five minutes.
    * &#x20;<img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fz0hvHpYBVrWgUXZDOicy%2Fimage.png?alt=media&amp;token=04218a45-1437-4c63-abcd-d27b0995bb73" alt="" data-size="line"> Red — The Onyx Edge has not checked in with the Onyx Portal in the last five minutes.
  * **ACS** — Indicates the Onyx Edge's current ACS status:
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FBxlSTJ5Tt6Ae92bf0aEr%2Fimage.png?alt=media&amp;token=0bc89471-4def-4b2e-b3cb-89c082fe7d14" alt="" data-size="line"> Green — The Onyx Edge holds the Virtual IP, and it manages and provides AP configuration to the APs.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F2vyKJcc4VO3LWQcRIL6n%2Fimage.png?alt=media&amp;token=88094789-dd21-4eab-9c4e-10309f63ef8f" alt="" data-size="line"> Amber — The Onyx Edge's ACS status is not available.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FnWjT3MYfwIKpRL4UzOae%2Fimage.png?alt=media&amp;token=1ba7e2ae-2f04-42d6-8e48-4f94422d9570" alt="" data-size="line"> Red — The Onyx Edge is configured with the highest ACS priority (priority 1) but is not the Primary ACS.
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FkO4ZQEucfgz5WfPbiN5k%2Fimage.png?alt=media&amp;token=9e80550e-9cf6-45d6-9fd2-4a535e903b0a" alt="" data-size="line"> Grey — The Onyx Edge is configured with a lower ACS priority and is not the Primary ACS as expected.
  * **Interface Status** — Indicates the SGi and RAN (S1) interface connection status:
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F4OJkhVbMlgP2Un5kOy3m%2Fimage.png?alt=media&amp;token=05a8dc01-f090-4eba-924a-ed89884527d7" alt="" data-size="line"> Green — All APs are MME-connected to the Onyx Edge, the SGi interface is up and has IP, and the SGi link is active (periodic ICMP checks every five minutes).
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fop4rdI2mvtHc974U0voW%2Fimage.png?alt=media&amp;token=4737ee5f-8f39-41c0-8868-3a08e9876575" alt="" data-size="line"> Amber — At least one AP is MME-connected, but some are not; the SGi interface is up and has IP (SGi link is active).
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FMKUe0ZIN6T92CrBINOBC%2Fimage.png?alt=media&amp;token=71b03007-2aaf-47f7-8fd2-cec0113f9fb2" alt="" data-size="line"> Red — None of the APs are MME-connected (all APs are MME-disconnected or management-disconnected), or the SGi interface is not up or is not active (SGi link activity check through ICMP).
    * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FMvHoA6Ra6Y6J8d1CTWko%2Fimage.png?alt=media&amp;token=0428e963-4e1c-4de7-905b-a196780ff4b3" alt="" data-size="line"> Grey — The Onyx Edge is offline, or data is not available.
  * **Associated Access Points —** The APs associated with the pool.
    * **Name** — The AP's name.
    * **B/W 1 (MHz)** — Cell 1's bandwidth in MHz.
    * **Freq 1 (MHz)** — Cell 1's frequency in MHz.
    * **Cell ID 1** — Cell 1's cell ID.
    * **PCI 1** — Cell 1's Physical Cell ID (PCI). The PCI is used for cell identity during the cell selection procedure and is used by UE to decode physical layer data being transmitted by the AP.
    * **Power 1 (dBm)** — Cell 1's power in dBm.
    * **Online** — Indicates the AP's online status, which is determined by its reachability from the Onyx Portal:

      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FZ2GPxe2BYcxnJhyexC4c%2Fimage.png?alt=media&amp;token=4d095600-2f4f-4196-bcc3-ec8c0f3ffd61" alt="" data-size="line"> Green — The AP has checked in with the Onyx Portal in the last five minutes.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FPi5G4NgscXHmFopqWOuC%2Fimage.png?alt=media&amp;token=5a795b89-0eb8-40b4-bce4-97b4bea55880" alt="" data-size="line"> Red — The AP has not checked in with the Onyx Portal in the last five minutes, or the time reported is older than five minutes.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F2Rnd6nrT0AQj0hkNk8wC%2Fimage.png?alt=media&amp;token=229c8aec-2fc6-4a25-8b40-da9394a24c90" alt="" data-size="line"> Grey — The associated Onyx Edge is offline.

      To view the last check-in timestamp, hover your cursor over the Online icon.
    * **Interface Status** — Indicates the AP's interface status:

      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0YsdBB2wuTcxHs26Q5M7%2Fimage.png?alt=media&amp;token=47754a86-f533-401b-8542-385386d8419d" alt="" data-size="line"> Green — The AP is MME-connected.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F3Gm1LCmPvUnmVwMupI4E%2Fimage.png?alt=media&amp;token=0a0cc422-6a46-44e6-bc3e-be262152cfcf" alt="" data-size="line"> Red — The AP is MME-disconnected.
      * <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F5ZbeJp1hifUYbPQRayPA%2Fimage.png?alt=media&amp;token=df05e493-d406-4994-88b8-8c9bfee9924a" alt="" data-size="line"> Grey — The AP is offline.

      To view the MME status and the Onyx Edge that the AP is connected to, hover your cursor over the Interface Status icon.
  * To include or exclude additional columns from the list, click the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FvPjAMcC9BqHTF5OvEpjO%2Fimage.png?alt=media&amp;token=4f2032cd-2ee0-4e38-8d57-45800b0c9d2e" alt="" data-size="line"> column selector icon and select or clear from the following additional parameters:
    * **IP Address** — The AP's IP address.
    * **Model** — The AP equipment's model.
    * **Software Version** — The AP's software version.
    * **Up Time** — The duration for which the AP equipment has been up.
    * **FSM State** — The Finite State Machine (FSM) state.
    * **GPS Latitude** — The AP equipment's GPS latitude coordinate.
    * **GPS Longitude** — The AP equipment's GPS longitude coordinate.
    * **Access Mode** — The access mode: Open Access, Closed Access, or Hybrid Access.
      {% 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 %}

**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. At the bottom of the page, the **Onyx Edge Pool** section lists the existing pools.
{% endstep %}

{% step %}
Click **Add Pool**.

The **Create Onyx Edge Pool** page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FhFklX9IQFg6tWXrf8J4o%2Fimage.png?alt=media&amp;token=b26344e8-aa18-4b4a-9128-d4169d66cae5" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Enter the following details:

* **Name** — (Required) The pool's name. The Onyx Portal will automatically populate the pool name, which you can edit if required. The pool name must be unique within the network and must be an alphanumeric string of 1–64 characters.
* **HA IP Address** — (Required) The TR069 anchoring endpoint address.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The HA IP address must be in the same subnet as the S1 interface of the Onyx Edge to be associated with this pool.</p></div>
* **Associated Access Points** — To associate an AP with this pool, select the corresponding checkbox. To simultaneously associate all available APs with this pool, select the **Select All** checkbox.

  <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FbYa7j1aDOAbCyc1qmDco%2Fimage.png?alt=media&amp;token=8417b5da-5b70-48ae-9c2e-93b5a2836ce2" alt="" width="463"><figcaption></figcaption></figure>

  \
  To disassociate an AP currently associated with the pool, clear the corresponding checkbox. To simultaneously disassociate all APs currently associated with the pool, click the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FpEAG4QDZDEnLqOL2Wc9W%2Fimage.png?alt=media&amp;token=02048fd9-a95a-407e-9e66-e624848c7892" alt="" data-size="line"> icon. A confirmation dialog box is displayed. To confirm, click **Yes**.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> IPSec is not supported in conjunction with HA/Onyx Edge pools. IPSec-enabled APs must not be associated with an Onyx Edge pool.</p></div>

{% 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](#associate-or-disassociate-onyx-edge-with-pools).
{% endstep %}

{% step %}
Set the ACS priority order of the Onyx Edge within the pool, for which you must edit the pool's details.

For more information, see [Edit Onyx Edge Pools](#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 %}

**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**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FylhIrel13Qhsq1PwjqSd%2Fimage.png?alt=media&amp;token=c75893e4-930c-4c39-b21a-ce80d9f140ea" alt=""><figcaption></figcaption></figure>

The **Edit Onyx Edge Pool** page is displayed.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fye64DnCBTZOh38200aA5%2Fimage.png?alt=media&amp;token=0b12dc68-7243-4e09-a9e3-2bbc06b91d8f" alt=""><figcaption></figcaption></figure>
{% 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) The TR069 anchoring endpoint address.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The HA IP address must be in the same subnet as the S1 interface of the Onyx Edge associated with this pool.</p></div>
* **Associated Access Points** — To associate an AP with this pool, select the corresponding checkbox. To simultaneously associate all available APs with this pool, select the **Select All** checkbox.

  <figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FICqG07BHFHAfqYccRRFN%2Fimage.png?alt=media&amp;token=739016d7-1925-456a-98ee-85ac5daa8415" alt="" width="462"><figcaption></figcaption></figure>

  \
  To disassociate an AP currently associated with this pool, clear the corresponding checkbox. To simultaneously disassociate all APs currently associated with the pool, click the <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FmblswXKSNzvjl6HCxmDG%2Fimage.png?alt=media&amp;token=437ba550-a11b-47de-96bd-b4a82fb74b9c" alt="" data-size="line"> icon. A confirmation dialog box is displayed. To confirm, click **Yes**.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> IPSec is not supported in conjunction with HA/Onyx Edge pools. IPSec-enabled APs must not be associated with an Onyx Edge pool.</p></div>

{% endstep %}

{% step %}
To save your edits, click **Save MME Pool**.
{% endstep %}

{% step %}
Associate or disassociate Onyx Edge with the pool. For more information, see [Associate or Disassociate Onyx Edge with Pools](#associate-or-disassociate-onyx-edge-with-pools).
{% endstep %}

{% step %}
Set the ACS priority order of the Onyx Edge within the pool.

**Onyx Edge Priority** — The Onyx Edge's ACS priority within the pool. The ACS priority indicates the probability of an Onyx Edge functioning as the Primary ACS relative to the other Onyx Edge in the pool. Priority 1 is the highest priority and 3 the lowest. If the Primary ACS Onyx Edge fails, an operational Standby ACS Onyx Edge with the current highest priority will take over as the Primary ACS.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F2dSx6hYCu9Jg3tUQJ7da%2Fimage.png?alt=media&amp;token=b65a7049-7741-47e0-9ef2-5a401a46e5b6" alt=""><figcaption></figcaption></figure>

* To change the ACS priority of an Onyx Edge in the pool, drag and drop the corresponding row up or down as required.
* To save your changes, click **Save Priority**.
  {% 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](#associate-or-disassociate-onyx-edge-with-pools). For information on disassociating APs from a pool, see [Edit Onyx Edge Pools](#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. At the bottom of the page, 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**.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F1Nr8UI5LcxSr2gJKyqdi%2Fimage.png?alt=media&amp;token=2f9cb2f7-cc0a-44e8-9500-6a8dcc0e2fc8" alt=""><figcaption></figcaption></figure>

A confirmation dialog box is displayed.
{% endstep %}

{% step %}
To confirm, click **Delete**.
{% endstep %}
{% endstepper %}

### Remove Direct Onyx Edge – AP Associations

Before you associate an existing Onyx Edge with a pool, you must disassociate any APs that are directly associated with the Onyx Edge.

{% hint style="info" %}
**NOTE:** You can disassociate APs associated with Onyx Edge only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

{% hint style="info" %}
**NOTE:** ONYX Edge HA is supported only for Onyx Edge On-Premises.
{% endhint %}

**To disassociate any APs directly associated with an Onyx Edge:**

{% 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 (*****\<onyx edge name>*****)**" page displays the Onyx Edge's details.
{% endstep %}

{% step %}
In the **RAN** tab > **Associated Access Point** section, click the **Associated Access Point** dropdown and clear any selected APs.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F7kKt1I9XlUJyV5gyaLw8%2Fimage.png?alt=media&amp;token=a624724b-a444-4a23-b91c-2ffbe71fa96b" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
To save your edits, in the upper-right corner of the page, click **Save Onyx Edge**.
{% 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:** Onyx Edge HA is supported only for Onyx Edge On-Premises.
{% endhint %}

{% 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 %}

{% hint style="info" %}
**NOTE:** Before associating an Onyx Edge with a pool, ensure that there are no APs directly associated with it. Remove any existing AP associations before associating the Onyx Edge with a pool. The Orchestrator manages the AP associations with the Onyx Edge.
{% endhint %}

{% hint style="info" %}
**NOTE:** After associating an Onyx Edge with a pool, you cannot directly associate APs with it.
{% endhint %}

{% hint style="info" %}
**NOTE:** When you disassociate an Onyx Edge from a pool, the Onyx Edge is also disassociated from the APs associated with the pool.
{% endhint %}

{% hint style="info" %}
**NOTE:** IPSec is not supported in conjunction with HA/Onyx Edge pools. IPSec-enabled Onyx Edge and APs must not be associated with an Onyx Edge pool. IPSec must not be enabled on Onyx Edge and APs already associated with a pool.
{% 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 (*****\<onyx edge name>*****)**" page displays the Onyx Edge's details.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F9WIrHDmwXFLyTewRGvxr%2Fimage.png?alt=media&amp;token=53713f69-212a-4d95-8940-41e9f3d87b6a" alt=""><figcaption></figcaption></figure>
{% 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 %}

## Related Documentation

* *4G Onyx Portal Operations Guide*
* *GXC Glossary*

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# 4G Onyx Platform - Mesh Node

## Introduction

This document introduces the concepts and criteria for designing a Private Cellular Network using the GXC Mesh Node in both outdoor and indoor scenarios. *Figure Sample GXC Private Cellular Network* serves as a reference throughout the document, providing a high-level understanding of the hardware and operational characteristics of the GXC Onyx Platform.

<p align="center"><strong>Sample GXC Private Cellular Network</strong> </p>

<figure><img src="https://content.gitbook.com/content/Zc9hpHmiTCrh1sn4mWXn/blobs/C65O6EhD2KDcMzOGy7IX/media/image6.png" alt=""><figcaption></figcaption></figure>

ONYX Edge ① is a hardware appliance that houses an on-premises 4G/5G mobile core network solution. Its function is to manage:

* radio registrations
* user network entry authorizations
* enforcement of network services and policies
* configurations through the Onyx Portal
* backhauling of user traffic to the Internet&#x20;

Two Indoor APs ③ are directly cabled via Ethernet to the Onyx Edge and provide indoor coverage to UE operating on CBRS bands.&#x20;

The Outdoor Onyx Gateway Node ② is a High Power AP Radio (transmitting at F<sub>gw</sub>) that not only provides access to UE within range of its RF footprint but also allows the wireless extension of the Onyx Private Wireless Network using the Mesh Node ④.&#x20;

To provide subscriber access, the
&#x20;Mesh Node is directly cabled to an Outdoor High Powered Access Point (HP AP) ⑤ (also
&#x20;referred to as the Mesh AP). This access point is configured for a different frequency
&#x20;(F<sub>map</sub>) from the gateway, creating a new cell for subscriber devices.

## Mesh Node Implementation and Applications

### Purpose and Requirements

Mesh Nodes can be placed anywhere within range of the Gateway AP, performing best with a line-of-sight backhaul connection. The following general design rules apply to network design using a Mesh node:

* The Mesh Node AP must achieve timing synchronization through one of the following options:
  * GPS (GNSS)
  * Network Synchronization (Network Listening)
    * This method requires a second backhaul antenna attached to the Mesh AP receiving an RSRP of ≥ -70 dBm. Contact GXC for design/configuration details.
* Antenna Isolation between backhaul and access antennas must be ≥ 50 dB. This is generally achieved through the selection of directional access and backhaul antennas, with narrow vertical beamwidth.
  * As a general rule, avoid positioning Mesh Node antennas within 20m of large reflective obstacles, such as a building wall, etc.
* The Mesh AP should expand coverage radially away from the Gateway AP.
  * Optimally, access and backhaul antennas should be oriented 180 degrees opposite from one another at the Mesh Node location, such that the new Mesh AP cell extends outward from the Gateway cell.
* Target backhaul signal strength range, as determined from propagation simulations, or read directly from the Mesh Node Local Control Interface (LCI).
  * For Mesh Node Peak Performance: DL RSRP > -85 dBm
  * For Mesh Node Stable cell-edge performance: DL RSRP > -100dBm

### Installation of the Mesh Node

For those familiar with the Onyx platform, refer to the *Mesh Node Quick Start Guide*. If you would like more detailed information, refer to the *Onyx GM01 Mesh Node Installation Guide* or *Onyx GM02 Mesh Node Installation Guide*.

### Standard Application

The primary use case for a Mesh Node is in an outdoor environment, where the availability of wired data backhaul is otherwise prohibitive. In this application, the only external cabling requirement is a source of power. *Figure Outdoor Implementation of a Mesh Node* is a graphical representation and requirements for an outdoor Mesh Node deployment.

<p align="center"><strong>Outdoor Implementation of a Mesh Node</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FsAUcLo59kRK84ihMpdDx%2Fimage.png?alt=media&amp;token=20c830fd-ab2d-4d51-bd15-5e51a3dded9b" alt=""><figcaption></figcaption></figure>

### Use of Multiple Mesh Nodes

Mesh Nodes are primarily used for coverage extension and with UE share the available bandwidth of the Gateway AP. It is important to note that a Mesh Node does not increase the capacity of the Gateway AP.&#x20;

*Figure Sample GXC Private Cellular Network* is an example of the Mesh Nodes used in a currently supported star configuration. Mesh Nodes in a cascaded configuration (a Mesh Node connected to another Mesh Node) is a planned feature, contact GXC for release timing and details.

### Dual Carrier/Carrier Aggregation

#### GM01 Mesh Node

* The Mesh Node supports 2CA in the downlink only.
* If the GW AP is configured for Dual Carrier, the Mesh Node will connect to one of the two carriers.

#### Mesh AP

The Mesh AP currently does not support Dual Carrier or Carrier Aggregation.

## Mesh Filter and Channel Frequency Assignments

<p align="center"> <strong>Mesh Node to Gateway Frequency Planning</strong> </p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXG3eobWUzugIT9OQpA90%2Fimage.png?alt=media&amp;token=4864772d-6936-4de8-a228-8745b1364a1c" alt=""><figcaption></figcaption></figure>

A Mesh Node uses a filter network to isolate the Mesh AP’s TX/RX frequency from the Mesh Node backhaul TX/RX frequency.&#x20;

During the configuration of the SAS parameters in the Onyx Portal, the operator will configure the Gateway AP and Mesh AP for a series of Preferred Frequencies (from most to least). The operator should take into consideration the desired bandwidth of 10 or 20 MHz to avoid selecting a frequency that will fall out of the “low or high” pass band ranges shown in *Table Backhaul to Mesh Node-AP Frequency Assignments*. This process allows for SAS grant flexibility, as channel assignments can change.

{% hint style="info" %}
**NOTE:** *Table Backhaul to Mesh Node-AP Frequency Assignments* specifies the Backhaul (Blue) and Mesh AP (Yellow) 10 and 20 MHz channels that should be used when configuring the Gateway and Mesh AP frequencies. When the Backhaul falls into the “Low Band” the Mesh AP should be configured to transmit in the “High Band” and vice versa.
{% endhint %}

<p align="center"><strong>Backhaul to Mesh Node-AP Frequency Assignments</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FX0yeTrCMlqf5BWhKzdo3%2Fimage.png?alt=media&amp;token=9151cbea-fa28-496a-9f3e-159ccfb84f31" alt=""><figcaption></figcaption></figure>

### Frequency Planning Example

Consider the following example.&#x20;

<p align="center"><strong>Mesh Node Example</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FMleHZV6XFZwlJ1Ogs4FN%2Fimage.png?alt=media&amp;token=e0a79e64-a251-4e8f-b686-25e75f798102" alt=""><figcaption></figcaption></figure>

Refer to *Figure Mesh Node Example*, for the following example and questions.&#x20;

**Gateway Node Information:**

* Operating BW = 20 MHz
* F<sub>gw</sub> = 3575 MHz&#x20;

**Questions:**

1. Determine the frequency passband for the Mesh Node and list the center channel
   \
   frequencies that could be used for the Mesh AP.
2. If bandwidth was changed to BW = 10 MHz, list all the center channel frequencies
   \
   that could be used for the Mesh AP.

**Solution:**

We have explained that F<sub>mn</sub> = F<sub>gw</sub>, in this case = 3575 MHz.&#x20;

Since we are operating with a
&#x20;BW=20 MHz, we refer to *Table Example Solution Summary* and see that Mesh Node backhaul is operating in the
&#x20;filter “low pass band” range of 3570-3590 MHz. This configures the “high pass band” of
&#x20;3640 to 3700 MHz for use by the Mesh AP.&#x20;

The operator should then select “Preferred
&#x20;Frequencies” for the Mesh AP in the “high pass band”. Examples of frequencies that could
&#x20;be selected in the Onyx Portal for the Mesh AP are summarized below:

<p align="center"><strong>Example Solution Summary</strong></p>

<table data-full-width="false"><thead><tr><th valign="top">Fgw = Fmn (MHz) (Backhaul Frequency, Low Band)</th><th valign="top">Fmap (MHz) 20 MHz (Mesh AP Center Channels, High Band)</th><th valign="top">Fmap (MHz) 10 MHz (Mesh AP Center Channels, High Band)</th></tr></thead><tbody><tr><td valign="top">3575</td><td valign="top">3650</td><td valign="top">3645, 3675</td></tr><tr><td valign="top">3575</td><td valign="top">3670</td><td valign="top">3655, 3685</td></tr><tr><td valign="top">3575</td><td valign="top">3690</td><td valign="top">3665, 3695</td></tr></tbody></table>

Remember that this example looks at the single Mesh Node example. When more Mesh Nodes and APs are added, RF planning to avoid overlapping channels and SAS considerations will play a big role in frequency planning.

## Related Documentation

* *4G Onyx Portal Operations Guide*
* *GM01 Mesh Node Installation Guide*
* *GM02 Mesh Node Installation Guide*
* *GXC Glossary*

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# 4G Onyx QoS Management

## Introduction

This application note describes the Quality of Service (QoS) management functionality in GXC's Onyx solution. For detailed information on the 3GPP QoS architecture offered in 3GPP LTE Networks, refer to *3GPP TS 23.107 — "QoS Concept and Architecture".*

In 3GPP, QoS refers to the network's ability to differentiate and prioritize between different types of traffic, applications, services, and subscribers based on their specific QoS requirements. For example, during periods of congestion, real-time services can be prioritized over non-real-time services, and premium subscribers prioritized over basic subscribers to provide a differentiated quality experience.

## Onyx QoS Management

*Figure: Onyx QoS Architecture* illustrates the Onyx QoS management functionality in a mobile network, highlighting how bearers are utilized to handle different types of traffic between a User Equipment (UE) and the Public Data Network (PDN).

<p align="center"><strong>Onyx QoS Architecture</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FS41F7M9Y42ZCcchmLHr2%2Fimage.png?alt=media&amp;token=4f7fcc8c-8b2a-4beb-8479-67aab30639b4" alt=""><figcaption></figcaption></figure>

* **User Equipment (UE)** — Client devices that generate different types of traffic, such as email, video streaming, IoT monitoring, and IoT management.

* **Packet Data Network (PDN)** — External networks or services, such as the internet or private corporate networks, that the UE access to utilize services such as email, video streaming, IoT monitoring, and IoT management.

* **Bearer** — A logical connection between the UE and the PDN to facilitate data transmission. Each bearer corresponds to a specific data flow, enabling differentiated traffic treatment. QoS management occurs at the bearer level, where QoS characteristics associated with the bearer determine how traffic flowing through that bearer is treated within the network. Bearers are of two types — Default and Dedicated.
  * **Default Bearer** — The first bearer established when a UE connects to the network. It provides basic connectivity between the UE and PDN, enabling basic services and internet access, and carries both user data and signaling traffic. The QoS of the default bearer is always Non-Guaranteed Bandwidth (Non-GBR), suitable for low-priority data traffic. It remains established until the UE detaches from the network or the user session is terminated.
  * **Dedicated Bearer** — Additional bearers established between the UE and the PDN for specialized services/traffic such as video streaming, IoT data transmission, etc. QoS of dedicated bearers can be either Guaranteed Bandwidth (GBR) or Non-Guaranteed Bandwidth (Non-GBR). Dedicated bearers are released when the UE detaches from the network or the user session is terminated.

* **APNs** — An Access Point Name (APN) specifies the PDN (public internet or private corporate networks) that the subscribers/UE should connect to. One default bearer is established per APN. The QoS category associated with the APN specifies the QoS policy for the default bearer.

  For information on creating and managing APNs, see *4G Onyx Portal Operations Guide > Manage APNs*.

* **Applications** — Application definitions specify the traffic classification rules that distinguish between different types of data flows based on their flow characteristics (direction, protocol, peer IP address, and source and destination ports). Multiple flow classification rules can be used to define what constitutes an application.

  For information on creating and managing applications, see *4G Onyx Portal Operations Guide > Manage Applications*.

* **Application Groups** — Application groups categorize similar applications based on factors such as data rate, latency sensitivity, and reliability requirements. For example, all real-time streaming applications can be grouped into one application group, while all monitoring applications can form another group. One dedicated bearer is established per application group. The QoS category associated with an application group specifies the QoS policy for the data flows associated with all applications in that group.

  For information on creating and managing application groups, see *4G Onyx Portal Operations Guide > Manage Application Groups*.

* **QoS Categories** — QoS categories are predefined QoS policies that can be associated with APNs and application groups, simplifying the QoS configuration process. If required, operators can create their own custom QoS categories.

  For APNs, the system supports the following QoS categories:

  <table><thead><tr><th>QoS Category</th><th width="79.66668701171875">QCI</th><th width="99.66668701171875">Priority</th><th width="100">PDB</th><th width="80.166748046875">PER</th><th>Use Cases</th></tr></thead><tbody><tr><td>NA</td><td>5</td><td>1</td><td>100ms</td><td>10^-6</td><td>IMS signaling</td></tr><tr><td>High Priority Data</td><td>6</td><td>6</td><td>300ms</td><td>10^-6</td><td>Buffered video/TCP based</td></tr><tr><td>NA</td><td>7</td><td>7</td><td>100ms</td><td>10^-3</td><td>Live streaming</td></tr><tr><td>Medium Priority Data</td><td>8</td><td>8</td><td>300ms</td><td>10^-6</td><td>Buffered video/TCP based</td></tr><tr><td>Low Priority Data</td><td>9</td><td>9</td><td>300ms</td><td>10^-6</td><td>Buffered video/TCP based</td></tr></tbody></table>

  For application groups, the system supports the following QoS categories.

  **Guaranteed Bandwidth Type (GBR):**

  <table><thead><tr><th>QoS Category</th><th width="79.6666259765625">QCI</th><th width="99.6666259765625">Priority</th><th width="100">PDB</th><th width="100.1666259765625">PER</th><th>Use Cases</th></tr></thead><tbody><tr><td>Live Audio</td><td>1</td><td>2</td><td>100ms</td><td>10^-2</td><td>Conversational voice</td></tr><tr><td>Live Video</td><td>2</td><td>4</td><td>150ms</td><td>10^-3</td><td>Video/live streaming</td></tr><tr><td>Real-time Applications</td><td>3</td><td>3</td><td>50ms</td><td>10^-3</td><td>Real-time gaming</td></tr><tr><td>High Priority Data</td><td>4</td><td>5</td><td>300ms</td><td>10^-6</td><td>Non-conversation video/buffered streaming</td></tr></tbody></table>

  **Non-Guaranteed Bandwidth Type (Non-GBR):**

  <table><thead><tr><th>QoS Category</th><th width="79.66668701171875">QCI</th><th width="99.6666259765625">Priority</th><th width="100">PDB</th><th width="100.1666259765625">PER</th><th>Use Cases</th></tr></thead><tbody><tr><td>NA</td><td>5</td><td>1</td><td>100ms</td><td>10^-6</td><td>IMS signaling</td></tr><tr><td>High Priority Data</td><td>6</td><td>6</td><td>300ms</td><td>10^-6</td><td>Buffered video/TCP based</td></tr><tr><td>NA</td><td>7</td><td>7</td><td>100ms</td><td>10^-3</td><td>Live streaming</td></tr><tr><td>Medium Priority Data</td><td>8</td><td>8</td><td>300ms</td><td>10^-6</td><td>Buffered video/TCP based</td></tr><tr><td>Low Priority Data</td><td>9</td><td>9</td><td>300ms</td><td>10^-6</td><td>Buffered video/TCP based</td></tr></tbody></table>

* **Subscriber Groups** — Subscriber groups categorize UE/subscribers into different groups based on their usage patterns and other criteria. Members of the same group share a common APN and set of application groups, allowing a uniform QoS policy to be applied across all members. For example, all camera devices can be grouped into a "Cameras" group, and all IoT scanners into an "IoT Scanners" group. By default, the system creates the "Default" and "Mesh Nodes" subscriber groups in the network.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>Each subscriber group is associated with a single APN. All the subscribers/UE associated with a subscriber group connect to the same APN.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>Each subscriber/UE can be associated only with a single subscriber group.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>All the subscribers/UE associated with a subscriber group use the same set of application groups.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>Each subscriber group can contain multiple application groups. Within a subscriber group, the order in which application groups are prioritized determines which application group (QoS policy) is applied when there are overlapping traffic selection rules.</p></div>

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>The "Mesh Nodes" subscriber group is visible only to GXC Administrators.</p></div>

  For information on creating and managing subscriber groups, see *4G Onyx Portal Operations Guide > Manage Subscriber Groups*.

* **Subscriber Accounts** — For information on creating and managing subscriber accounts, see *4G Onyx Portal Operations Guide > Manage Subscriber Accounts*.

* **Guaranteed Bandwidth / Guaranteed Bit Rate (GBR)** — (Applicable only to GBR bearers.) The minimum GBR per EPS bearer guaranteed by the network. It is specified separately for uplink and downlink traffic.

* **Maximum Bandwidth / Maximum Bit Rate (MBR)** — Specifies the maximum data rate allowed per EPS bearer in the network. It is specified separately for uplink and downlink traffic. Any packets arriving at the bearer after the configured MBR is exceeded will be discarded. The MBR can be higher than the GBR.

* **QoS Parameters** — The QoS parameters specified in the QoS categories determine how the traffic flowing through the bearers is treated in the network.
  * **QoS Class Identifier (QCI)** — Specifies the QoS level or class for data traffic. Each QCI value represents the following set of QoS characteristics: QCI=*\<QCI class Id>* (PDB=*\<packet delay budget>*, PER=*\<packet error rate>*).
    * **Packet Delay Budget (PDB)** (50 ms–300 ms) — Specifies the maximum allowable end-to-end delay for a packet while traversing the network from source to destination. PDB is crucial for applications and services with real-time requirements, such as video streaming. It ensures that packets are delivered within a specified time frame, maintaining responsiveness and communication quality.
    * **Packet Error Rate (PER)** — Specified as "10^-2", "10^-3", or "10^-6", where 10^-6 means for every 1,000,000 (10^6) transmitted packets, up to one packet is allowed to contain errors or be lost during transmission. PER is a key metric for assessing the reliability of communication links. It is critical for applications where data integrity is essential, such as file transfers or mission-critical applications. A lower PER indicates better performance and fewer errors with packet delivery.\
      For more information, see *3GPP TS 23.203 > Table 6.1.7*.
    * **Pre-emption Priority / Allocation and Retention Priority (ARP)** — Indicates the priority level of a bearer for resource allocation during network congestion.
    * **Pre-emption Capability** — Indicates whether, during periods of network congestion, establishment of the corresponding bearer could lead to the release of an established lower-priority bearer.
    * **Pre-emption Vulnerability** — Indicates whether, during periods of network congestion, the corresponding bearer can be released to make way for a new bearer with a higher priority.

## How it Works

The following illustration depicts the QoS configuration associations, including relationships between subscribers/UE, subscriber groups, APNs, application groups, applications, and QoS categories.

<p align="center"><strong>Onyx QoS Configuration Associations</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FrWzc1hecRQcCryIKJ8QO%2Fimage.png?alt=media&amp;token=b4c95965-31f2-444e-b4eb-ec0902112841" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}
Each subscriber/UE is associated with a specific subscriber group.
{% endstep %}

{% step %}
Each subscriber group is associated with an APN and a set of application groups.
{% endstep %}

{% step %}
Each APN is associated with a PDN, which specifies the network that subscribers/UE in the subscriber group can access, and a QoS category, which specifies the QoS policy for traffic flows associated with the APN.
{% endstep %}

{% step %}
Each application group is associated with specific applications, which classify different types of traffic based on their flow characteristics.
{% endstep %}

{% step %}
Each application group is associated with a specific QoS category, which specifies the QoS policy for the traffic flows associated with its applications.
{% endstep %}

{% step %}
When a subscriber/UE registers with the network, it sends an Attach Request to the AP, which includes the APN identifying the PDN to connect to. The network verifies the UE's identity and checks if the UE is authorized to access the requested APN. The network then establishes the default bearer and applies the QoS policy specified in the APN to the default bearer.
{% endstep %}

{% step %}
After the default bearer is established, the network sets up a dedicated bearer for each application group associated with the subscriber group and applies the QoS policy specified in the application group to it.
{% endstep %}

{% step %}
After the bearers are established, data packets are transmitted over the bearers — the default bearer handles general data traffic and the dedicated bearers handle traffic for their respective application groups.
{% endstep %}

{% step %}
At the UE and the Onyx Edge, downlink and uplink packets are routed to their respective bearers according to the application definitions associated with the corresponding application group.

* Uplink data packets (originating from the UE) are routed to the appropriate bearer based on the application definitions associated with the applications running on the UE.
* At the Onyx Edge, downlink data packets are inspected and routed to the appropriate bearers based on the application definitions in the corresponding application group.
  {% endstep %}

{% step %}
The default and dedicated bearers are released when:

* The UE detaches from the network.
* The user session is terminated.
* Network/operator policies trigger bearer release under specific conditions.
  {% endstep %}
  {% endstepper %}

## Limitations

This section outlines the limitations of the QoS Management feature in this release.

1. The QoS functionality works end-to-end only with UE connected to APs that are directly connected with an Onyx Edge.
2. When application definitions are modified, changes will not affect current sessions. The modifications will only come into effect when the UE establishes a new session.
3. Downlink-only application groups are not supported. To ensure the creation of a dedicated bearer, at least one uplink rule (even if it is a dummy rule) must be included in any of its member applications.
4. A maximum of four simultaneous dedicated bearers are supported per UE.
5. It is possible that not all dedicated bearers (one per application group) will always be established — for example, due to radio resource constraints.
6. The Onyx Edge can only create up to 15 TFTs in a bearer. This is further restricted by how many TFTs can be encoded within 255 octets in the "Create Bearer Request" message. Consequently, this restricts the number of flows across all applications within an application group.
7. Preemption Vulnerability and Preemption Capability functionality are not qualified in this release.

## Manage QoS Configuration

This section describes the QoS configuration workflow for:

* A new network
* A new UE/subscriber type in an existing network

### QoS Configuration Workflow — New Network

This section describes the QoS configuration workflow for a new network.

<p align="center"><strong>QoS Configuration Workflow — New Network</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FzdT2976rAiaoO9uJtk8L%2Fimage.png?alt=media&amp;token=4e9ddc70-3acf-48f0-a442-198202f4ac2f" alt="" width="276"><figcaption></figcaption></figure>

{% stepper %}
{% step %}
Create APNs.

Specify the default bearer characteristics (associate with a predefined QoS category or define a custom QoS category).

See *4G Onyx Portal Operations Guide > Create APNs*.
{% endstep %}

{% step %}
Create application definitions.

Specify the flow classification rules.

See *4G Onyx Portal Operations Guide > Create Applications*.

{% hint style="info" %}
Avoid creating new application definitions unless there is a specific requirement to prioritize certain types of traffic over others.
{% endhint %}
{% endstep %}

{% step %}
Create application groups.

* Specify the application group's QoS characteristics (associate with a predefined QoS category or define a custom QoS category).
* Associate the application group with application definitions.

See *4G Onyx Portal Operations Guide > Create Application Groups*.
{% endstep %}

{% step %}
Create subscriber groups.

* Associate the subscriber group with an APN.
* Associate the subscriber group with application groups.

See *4G Onyx Portal Operations Guide > Create Subscriber Groups*.

{% hint style="info" %}
By default, the system creates the "Default" and "Mesh Nodes" subscriber groups in the network. The "Mesh Nodes" subscriber group is visible only to GXC Administrators. Avoid creating subscriber groups unless there is a specific requirement.
{% endhint %}
{% endstep %}

{% step %}
Create subscriber accounts.

Associate each subscriber account with a specific subscriber group.

See *4G Onyx Portal Operations Guide > Create Subscriber Accounts*.
{% endstep %}
{% endstepper %}

### QoS Configuration Workflow — New UE Type

This section describes the QoS configuration workflow for adding a new UE/subscriber type — such as a camera or a POS scanner — to an existing network.

For QoS configuration recommendations for basic internet, IoT telemetry, and video streaming traffic types, refer to [QoS Sample Configurations for Recommended Common Data Services](#qos-sample-configurations-for-recommended-common-data-services).

<p align="center"><strong>QoS Configuration Workflow — New UE/Subscriber Type</strong></p>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FHGzRbJp1h3XnBw4OvQc6%2Fimage.png?alt=media&amp;token=d9a29135-ea74-4e3e-9a76-75920de39709" alt="" width="563"><figcaption></figcaption></figure>

{% stepper %}
{% step %}
Review client application(s) running on the new UE/subscriber type.
{% endstep %}

{% step %}
Review existing subscriber groups, APNs, application groups, and applications.

{% hint style="info" %}
If you associate a subscriber group with an application group that is not applicable to all UE in that subscriber group, resources may be unnecessarily allocated to that application group for those UE. In such cases, it is recommended to create a new subscriber group.
{% endhint %}

1. If an existing subscriber group (along with its associated application groups and applications) meets the UE's requirements, simply add the UE to that subscriber group.
2. If a new subscriber group is required:
   1. (If required) Create a new APN.
      * Specify the default bearer characteristics (associate with a predefined QoS category or define a custom QoS category).

        See *4G Onyx Portal Operations Guide > Create APNs*.
   2. (If required) Create the application definition.
      * Specify the flow classification rules.\
        See *4G Onyx Portal Operations Guide > Create Applications*.
   3. (If required) Create the application group.

      * Specify the application group's QoS characteristics (associate with a predefined QoS category or define a custom QoS category).
      * Associate the application group with application definitions.

      See *4G Onyx Portal Operations Guide > Create Application Groups*.
3. Create the subscriber group.

   <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>When adding a new application group that is not applicable to all devices in the subscriber group, extra unnecessary resources may be allocated to that application group for those devices.</p></div>

   * Associate the subscriber group with an APN.
   * Associate the subscriber group with application groups.

   See *4G Onyx Portal Operations Guide > Create Subscriber Groups*.

{% hint style="info" %}
By default, the system creates the "Default" and "Mesh Nodes" subscriber groups in the network. The "Mesh Nodes" subscriber group is visible only to GXC Administrators. Avoid creating subscriber groups unless there is a specific requirement.
{% endhint %}
{% endstep %}
{% endstepper %}

## QoS Sample Configurations for Recommended Common Data Services

This section presents QoS sample configurations recommended for basic internet, IoT telemetry, and video streaming traffic types, which represent different types of traffic with distinct characteristics.

{% hint style="info" %}
QoS requirements vary based on factors such as operator policies, subscription plans, service types, device capabilities, specific use cases, etc. When defining QoS requirements, analyze all probable use cases, and clearly define the service profile, identifying characteristics, requirements, and priorities to fine-tune QoS configurations. Subsequently, regularly monitor network performance and optimize the QoS configurations based on observed traffic patterns, device behavior, and changing network conditions.
{% endhint %}

### Basic Internet Traffic

Basic internet traffic encompasses a variety of data types such as web browsing, email, and other general internet activities. In general, the characteristics of basic internet traffic are best effort with moderate latency and throughput requirements.

The following sample configuration should provide adequate QoS for basic internet browsing activities, ensuring that users can access web content efficiently without significantly impacting higher priority network traffic.

{% stepper %}
{% step %}
APN Configuration: The APN configuration must account for all required use cases.
{% endstep %}

{% step %}
Sample Application configuration:

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8fck5m5xnbNWE6k6SrOO%2Fimage.png?alt=media&amp;token=58b1fe67-2514-47f9-9d3a-f2a4fc9fac13" alt=""><figcaption></figcaption></figure>

* **Name**: *Internet Browsing*
* **Description**: *Internet Browsing Application*
* **Direction**: *Bidirectional* (traffic flows in upstream and downstream directions)
* **Protocol**: *TCP* (commonly used for web browsing and other internet activities)
* **Peer IP/Subnet**: *1.1.0.0/16* (the peer's IP subnet range allowed for communication)
* **Peer Port**: *443* (the peer's port number, typically associated with HTTPS traffic, commonly used for secure web browsing)
  {% endstep %}

{% step %}
Sample Application Group configuration:

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F3e3SUj1xkdyAQTUyaDw6%2Fimage.png?alt=media&amp;token=6328772a-587c-4dc7-ba9b-7987c6c47752" alt=""><figcaption></figcaption></figure>

* **Name**: *Basic Internet App Group*
* **Applications**: *Internet Browsing*
* **Downlink Max Bandwidth (Mbps)**: *30 Mbps* (maximum allowed bandwidth for downstream traffic received by the subscriber/UE)
* **Uplink Max Bandwidth (Mbps)**: *5 Mbps* (maximum allowed bandwidth for upstream traffic sent by the subscriber/UE)
* **Guaranteed Bandwidth**: No (clear the checkbox)
* **QoS Category**: *Low Priority Data*

  The Non-Guaranteed Bandwidth "Low Priority Data" QoS category settings:

  * QCI: 9
  * PDB: 300ms
  * PER: 10^-6
  * Pre-emption Priority (ARP): 9
    {% endstep %}

{% step %}
Sample Subscriber Group configuration:

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Ft1vYqg8WMTsuueStBb5T%2Fimage.png?alt=media&amp;token=b9db1d0c-4a58-4fa9-8ca1-028f09a34189" alt=""><figcaption></figcaption></figure>

* **Name**: *Basic Internet Subscriber Group*
* **APN**: *internet*
* **Select Application Groups**: *Basic Internet App Group*

{% hint style="info" %}
The QCI configured for the Application Group and the APN must be different. The "Low Priority Data" QoS category uses QCI 9.
{% endhint %}
{% endstep %}
{% endstepper %}

### IoT Telemetry Traffic

Internet of Things (IoT) telemetry involves the collection and transmission of data from sensors and devices in an IoT ecosystem. It can include data such as temperature, humidity, motion, etc. IoT telemetry data typically involves many small packets generated by IoT devices.

Latency requirements for IoT telemetry data can vary. Some applications, like environmental monitoring, may have more relaxed latency constraints, while industrial control systems may require low latency for real-time decision-making. Throughput requirements for IoT telemetry data tend to be relatively low, as individual data packets are often small. However, the volume of data from numerous devices can accumulate, requiring efficient handling and processing. In general, the characteristics of IoT telemetry data are reliable delivery, moderate latency, and throughput.

#### IoT Alert Notification Traffic

**Recommended configuration for IoT Alert Notifications with Guaranteed Bandwidth:**

The following sample configuration should provide adequate QoS for IoT GBR traffic within the network, ensuring a guaranteed minimum bandwidth of 0.5 Mbps in both directions while allowing a maximum bandwidth of 1 Mbps, ensuring timely delivery of critical IoT telemetry data.

{% stepper %}
{% step %}
APN Configuration: The APN configuration must account for all required use cases.
{% endstep %}

{% step %}
Sample Application configuration:

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FIjtGgtrioRBazcr5VcoL%2Fimage.png?alt=media&amp;token=92f4d727-5b70-422c-ba94-ff0ae3e5c5ee" alt=""><figcaption></figcaption></figure>

* **Name**: *IoT Alert Notification*
* **Description**: *IoT Alert Notification Application*
* **Direction**: *Bidirectional* (traffic flows in upstream and downstream directions)
* **Protocol**: *TCP* (suitable for reliable and ordered data delivery)
* **Peer IP/Subnet**: *1.1.0.0/16* (the peer's IP subnet range allowed for communication)
* **Peer Port**: *443* (commonly used for secure HTTPS communication, with encrypted data transmission for enhanced security)
  {% endstep %}

{% step %}
Sample Application Group configuration:

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FIRAhwwnUhdSCm6OhjMUf%2Fimage.png?alt=media&amp;token=2ee35d5d-1c9d-4e9e-842d-d0dd0fb8414d" alt=""><figcaption></figcaption></figure>

* **Name**: *IoT Telemetry GBR App Group*
* **Applications**: *IoT Alert Notification*
* **Downlink Max Bandwidth (Mbps)**: *1 Mbps* (maximum allowed bandwidth for downstream traffic received by the subscriber/UE)
* **Uplink Max Bandwidth (Mbps)**: *1 Mbps* (maximum allowed bandwidth for upstream traffic sent by the subscriber/UE)
* **Guaranteed Bandwidth**: Yes
* **Downlink Guaranteed Bandwidth (Mbps)**: *0.5 Mbps* (minimum guaranteed bandwidth for downstream traffic received by the subscriber/UE)
* **Uplink Guaranteed Bandwidth (Mbps)**: *0.5 Mbps* (minimum guaranteed bandwidth for upstream traffic sent by the subscriber/UE)
* **QoS Category**: *High Priority Data*

  The Guaranteed Bandwidth "High Priority Data" QoS category settings:

  * &#x20;QCI: 4
  * PDB: 300ms
  * PER: 10^-6
  * Pre-emption Priority (ARP): 5

{% hint style="info" %}
Traffic categorized under the QoS category "High Priority Data" with GBR takes precedence over traffic categorized as "High Priority Data" without GBR.
{% endhint %}
{% endstep %}

{% step %}
Sample Subscriber Group configuration:

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FhH5adDkjCuJr3UOz5nKH%2Fimage.png?alt=media&amp;token=70be16e5-764d-4fc0-946b-d166fa604941" alt=""><figcaption></figcaption></figure>

* **Name**: *IoT Devices Subscriber Group*
* **APN**: *internet*
* **Select Application Groups**: *IoT Telemetry GBR App Group*

{% hint style="info" %}
The QCI configured for the Application Group and the APN must be different. The "Low Priority Data" QoS category uses QCI 9.
{% endhint %}
{% endstep %}
{% endstepper %}

#### IoT Metrics Collection Traffic

**Recommended configuration for IoT Metrics Collection with Non-Guaranteed Bandwidth:**

{% stepper %}
{% step %}
APN configuration: APN configuration must account for all required use cases.
{% endstep %}

{% step %}
Sample Application configuration:

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FtjKdzwYPfdQCXNcHS5L5%2Fimage.png?alt=media&amp;token=1928e18f-5309-4b41-925e-b926907f0cc5" alt=""><figcaption></figcaption></figure>

* **Name**: *IoT Metrics Collection*
* **Description**: *IoT Metrics Collection Application*
* **Direction**: *Bidirectional* (traffic flows in upstream and downstream directions)
* **Protocol**: *TCP* (suitable for reliable and ordered data delivery)
* **Peer IP/Subnet**: *1.1.0.0/16* (the peer's IP subnet range allowed for communication)
* **Peer Port**: *443* (commonly used for secure HTTPS communication, with encrypted data transmission for enhanced security)
  {% endstep %}

{% step %}
Sample Application Group configuration:

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FRKqCxwcxFD4IzfBg8krb%2Fimage.png?alt=media&amp;token=138f389d-759c-4a09-84aa-b4a49bc1774c" alt=""><figcaption></figcaption></figure>

* **Name**: *IoT Telemetry Non-GBR App Group*
* **Applications**: *IoT Metrics Collection*
* **Downlink Max Bandwidth (Mbps)**: *1 Mbps* (maximum allowed bandwidth for downstream traffic received by the subscriber/UE)
* **Uplink Max Bandwidth (Mbps)**: *1 Mbps* (maximum allowed bandwidth for upstream traffic sent by the subscriber/UE)
* **Guaranteed Bandwidth**: No (clear the checkbox)
* **QoS Category**: *High Priority Data*

  The Non-Guaranteed Bandwidth "High Priority Data" QoS category settings:

  * QCI: 6
  * PDB: 300ms
  * PER: 10^-6
  * Pre-emption Priority (ARP): 6

{% hint style="info" %}
Traffic categorized under the QoS category "High Priority Data" with GBR takes precedence over traffic categorized as "High Priority Data" without GBR.
{% endhint %}
{% endstep %}

{% step %}
Sample Subscriber Group configuration:

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FaHoymk74NfdLdSc3DUnK%2Fimage.png?alt=media&amp;token=567ff40e-4a02-4f7d-bac9-8a32dcd61617" alt=""><figcaption></figcaption></figure>

* **Name**: *IoT Devices Subscriber Group*
* **APN**: *internet*
* **Select Application Groups**: *IoT Telemetry Non-GBR App Group*

{% hint style="info" %}
The QCI configured for the Application Group and the APN must be different. The "Low Priority Data" QoS category uses QCI 9.
{% endhint %}
{% endstep %}
{% endstepper %}

### Video Streaming Traffic

Video streaming is a real-time, bandwidth-intensive application that involves the continuous transmission of video data. Video streaming, particularly HD and 4K streaming, requires higher bandwidth compared to basic internet traffic. Low latency is crucial for live streaming applications, such as live sports or news broadcasts, whereas on-demand video streaming services may tolerate slightly higher latency. In general, the traffic characteristics are continuous streaming, low latency, and high and consistent throughput.

**Recommended configuration for Video Streaming data:**

{% stepper %}
{% step %}
APN Configuration: The APN configuration must account for all relevant network use cases.
{% endstep %}

{% step %}
Sample Application configuration:

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FRXCazIct1EjRX5kl3qSL%2Fimage.png?alt=media&amp;token=f145fa54-04bd-4f78-a77b-94246c68afb3" alt=""><figcaption></figcaption></figure>

* **Name**: *Video Streaming*
* **Description**: *Video Streaming Application*
* **Direction**: *Bidirectional* (traffic flows in upstream and downstream directions)
* **Protocol**: *TCP* (suitable for reliable and ordered data delivery)
* **Peer IP/Subnet**: *1.1.0.0/16* (the peer's IP subnet range allowed for communication)
* **Peer Port**: *443* (commonly used for secure HTTPS communication, with encrypted data transmission for enhanced security)
  {% endstep %}

{% step %}
Sample Application Group configuration:

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8MP2s8M717xct9HFROAB%2Fimage.png?alt=media&amp;token=bd6f694f-2125-4a16-b3fd-6728d3e73c1b" alt=""><figcaption></figcaption></figure>

* **Name**: *Video Streaming App Group*
* **Applications**: *Video Streaming*
* **Downlink Max Bandwidth (Mbps)**: *1 Mbps* (maximum allowed bandwidth for downstream traffic received by the subscriber/UE)
* **Uplink Max Bandwidth (Mbps)**: *15 Mbps* (maximum allowed bandwidth for upstream traffic sent by the subscriber/UE)
* **Guaranteed Bandwidth**: Yes
* **Downlink Guaranteed Bandwidth (Mbps)**: *1 Mbps* (minimum guaranteed bandwidth for downstream traffic received by the subscriber/UE)
* **Uplink Guaranteed Bandwidth (Mbps)**: *3 Mbps* (minimum guaranteed bandwidth for upstream traffic sent by the subscriber/UE)
* **QoS Category**: *Live Video*

  The Guaranteed Bandwidth "Live Video" QoS category settings:

  * QCI: 2
  * PDB: 150ms
  * PER: 10^-3
  * Pre-emption Priority (ARP): 4
    {% endstep %}

{% step %}
Sample Subscriber Group configuration:

* **Name**: *Camera Devices Subscriber Group*
* **APN**: *internet*
* **Select Application Groups**: *Video Streaming App Group*

{% hint style="info" %}
The QCI configured for the Application Group and the APN must be different. The "Low Priority Data" QoS category uses QCI 9.
{% endhint %}
{% endstep %}
{% endstepper %}

## Related Documentation

* *4G Onyx Portal Operations Guide*
* *GXC Glossary*

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# 5G AP Deployment Modes

## Introduction

Private cellular networks often require coverage expansion as facilities grow, production areas are reconfigured, or new operational areas are added. Traditionally, extending coverage requires deploying additional Access Points (APs), increasing infrastructure costs, cabling requirements, configuration complexity, and ongoing operational management.

Multi-Port Attach is a dual-sector coverage feature that enables a single AP to serve two distinct or geographically separated operational areas. By partitioning a supported 4×4 AP into two independent 2×2 MIMO sectors, operators can independently direct high-gain, narrow-beam antennas toward different coverage areas while continuing to use a single AP. Each sector operates independently with its own 2×2 MIMO configuration, preserving the spatial diversity and antenna gain required to deliver optimal RF performance within its intended coverage area. This approach is especially valuable in uplink-heavy use cases, where a strong link budget from each sector is critical to reliable performance, without compromising uplink strength to gain coverage.

Although the physical RF implementation changes, the deployment continues to operate as a single AP and a single NR Cell, preserving the existing logical network architecture.

{% hint style="info" %}
**NOTE:** Enabling Multi-Port Attach partitions the AP's 4×4 array into two independent 2×2 sectors, so each sector no longer has 4×4 MIMO in the downlink. This reduces the maximum downlink throughput available per sector compared to a single full-array (4×4) deployment. This is a deliberate design trade-off made in favor of extended coverage reach rather than capacity.
{% endhint %}

### Key Benefits

Multi-Port Attach provides the following operational and deployment benefits:

* Operational Benefits:
  * Reduces the number of APs required to cover a facility.
  * Reduces infrastructure, installation, and maintenance costs.
  * Simplifies network management by preserving existing operational workflows.
* RF Coverage Benefits:
  * Improves directional RF coverage for geographically separated operational areas.
  * Maximizes spectrum efficiency by allowing both sectors to share the same operating channel, eliminating the need to allocate separate channels for each coverage area.
  * Simplifies frequency/channel planning, since both sectors run on the same channel, only a single channel needs to be planned for the entire deployment instead of one per coverage area.
  * Preserves antenna gain and 2×2 MIMO operation for each sector.
  * Supports heavy-uplink use cases by maintaining a strong per-sector link budget instead of trading gain for broader coverage.
* Mobility Benefits:
  * Keeps UE attached to the same logical NR Cell while moving between coverage areas, eliminating inter-sector handover signaling and associated control-plane overhead.
  * Maintains consistent service continuity across both coverage areas.

### Standard 4×4 versus Multi-Port Attach

The following figure compares a standard 4×4 AP deployment with a Multi-Port Attach deployment, illustrating how a supported 4×4 AP can be partitioned into two independent 2×2 sectors while continuing to operate as a single AP and a single NR Cell.

<p align="center"><strong>Figure: Standard 4×4 Configuration versus Multi-Port Attach</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FlH0DRm0a0YFG0YMuDftt%2F4x4-to-2x2%20-%20Copy.png?alt=media&amp;token=9713bec0-3444-4d7d-8e9e-030e16ba04bb" alt=""><figcaption></figcaption></figure></div>

### Deployment Scenarios

Multi-Port Attach is intended for deployments where two physically separated operational areas can be served by a single AP while maintaining a single logical network. Typical deployment environments include:

* Warehouses
* Manufacturing facilities
* Distribution centers
* Long corridors
* Transportation platforms
* Outdoor yards
* Mixed indoor/outdoor environments

### RF Coverage Comparison

The following figures compare a standard 4×4 deployment with a Multi-Port Attach deployment and illustrate how partitioning a supported 4×4 AP into two independent 2×2 sectors improves RF coverage for two distinct or geographically separated operational areas.

<p align="center"><strong>Figure: Standard 4×4 Mode</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FtrvYnY7VmuubzYUamWTc%2F4x4.png?alt=media&amp;token=b1bb6dc8-f301-4e3a-8d12-0d6874dbd059" alt=""><figcaption></figcaption></figure></div>

In a standard deployment, all four antenna ports operate together as a single 4×4 MIMO sector, providing RF coverage through a single antenna pattern. This approach may result in reduced signal quality at the edges of geographically separated operational areas.

<p align="center"><strong>Figure: Multi-Port Attach Mode</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F9YrKph5VYHwBGW1gogJx%2F2x2.png?alt=media&amp;token=e80dda24-a691-4711-b9cb-f295d0057b7f" alt=""><figcaption></figcaption></figure></div>

In a Multi-Port Attach deployment, the AP antenna ports split into two independent 2×2 sectors. Each sector can be connected to a dedicated directional antenna to provide optimized RF coverage for its intended operational area while both sectors continue operating as part of the same NR Cell. This is the core benefit of the feature — going from one antenna to two lets you direct each sector into a different area while each sector keeps its own strong uplink budget, neither sector “splits” its uplink gain with the other.

### When to Use Multi-Port Attach

Use Multi-Port Attach when:

* Improving RF coverage is the primary deployment objective.
* Two geographically separated operational areas can be effectively served by one supported AP.
* Maintaining a single logical network architecture is preferred.
* Reducing additional infrastructure without compromising RF design is desirable.

### When Multi-Port Attach Is Not Appropriate

Do not use Multi-Port Attach when:

* Additional network capacity is required.
* Independent NR Cells are required.
* RF planning indicates that additional APs are required.
* The intended coverage areas cannot be effectively served by a single AP.
* Unsupported hardware is deployed.

## Architecture

Multi-Port Attach partitions the AP's four antenna ports into two independent 2×2 MIMO sectors, each connected to its own directional antenna system. Although the physical RF implementation changes, the deployment continues to behave as a standard single-cell network.

### Direct AP Deployment

In a direct deployment, the Onyx Edge hosts a single NR Cell that is connected directly to one supported AP. When Multi-Port Attach is enabled, the AP provides two independent 2×2 MIMO sectors while the Distributed Unit (DU) continues to manage the deployment as a single NR Cell. This deployment model is well suited for environments where a single supported AP can provide RF coverage for two geographically separated operational areas while maintaining a single logical network.

<p align="center"><strong>Figure: Direct AP Deployment</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FhLjsFrdapIu1aIsK0svd%2F5g-multi-port-attach-arch-direct-ap.png?alt=media&amp;token=64dbf427-8b0c-4dab-b9e7-b1c2abbca61f" alt="" width="563"><figcaption></figcaption></figure></div>

### FHM-Managed Multi-AP Deployment

In an FHM-managed deployment, the Onyx Edge hosts a single NR Cell that connects to one or more supported APs through a Fronthaul Multiplexer (FHM). When Multi-Port Attach is enabled on a supported AP, the AP partitions its antenna ports into two independent 2×2 MIMO sectors while the DU continues to manage the deployment as a single NR Cell.

The FHM provides fronthaul connectivity between the Onyx Edge and the APs but does not change the logical operation of Multi-Port Attach.

<p align="center"><strong>Figure: FHM-Managed Deployment</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FFfpiijbnacGRpR4i83Xu%2F5g-multi-port-attach-arch-direct-ap%20-%20Copy.png?alt=media&amp;token=0db19fbd-3be3-4c2d-8c6e-978a8566d80b" alt="" width="563"><figcaption></figcaption></figure></div>

### Logical Network and Physical RF Architecture

Multi-Port Attach preserves the logical network architecture while modifying only the physical RF implementation. This separation enables the deployment to continue operating as a single AP and a single NR Cell.

### Antenna Resource Partitioning

Multi-Port Attach partitions the four antenna ports of a supported 4×4 AP into two independent 2×2 MIMO sectors. The validated antenna port assignments are Sector A: Ports 1 and 2, and Sector B: Ports 3 and 4. Each sector maintains an independent 2×2 MIMO configuration while operating on the same carrier and within the same NR Cell.

### Single NR Cell Operation

Although RF coverage is provided through two independently directed antenna sectors, Multi-Port Attach continues to operate as a single NR Cell.

Both sectors:

* Broadcast the same NR Cell.
* Operate on the same carrier.
* Share the same cell configuration.
* Are managed by the same DU.
* Operate through the same AP.

From the UE perspective, the deployment appears as a single NR Cell throughout the coverage area.

### SAS / CBRS Support

Multi-Port Attach supports both SAS-enabled and non-SAS deployments.

In SAS-enabled deployments, the AP functions as the CBSD, while the SAS authorizes spectrum operation. Multi-Port Attach changes only the physical RF implementation and does not alter the relationship between the AP and the SAS.

When Multi-Port Attach is enabled, each configured antenna gain generates a corresponding CBSD record. These CBSD records are registered independently with the SAS, enabling independent spectrum authorization for each antenna configuration while the deployment continues to operate as a single AP and a single NR Cell.

In direct AP deployments, each configured antenna gain generates a corresponding CBSD record, which is registered with the SAS — allowing independent antenna and power management for each sector. In FHM-managed deployments, each AP generates its own CBSD records based on its configured antenna gain values, enabling independent spectrum authorization per AP and sector while maintaining a common operating channel across the deployment.

For complete information about SAS deployment prerequisites, CBSD configuration, registration, spectrum grants, and operational procedures, refer to the *Onyx CBRS SAS Registration Application Note*.

## Deployment Prerequisites & Planning

{% hint style="info" %}
**NOTE:** This document assumes that the AP is already installed, mounted, and operating normally. For hardware installation, cabling, grounding, and antenna installation, and site preparation procedures, see [*GXC 5G Access Points*](https://docs.gxc.io/hw/5g/5g-access-points) for AP specifications sheets and hardware installation guides.
{% endhint %}

Successful Multi-Port Attach deployments begin with proper planning. Before enabling the feature, verify that the deployment environment, hardware, software, and RF design meet the deployment requirements. Completing these activities before making configuration changes helps reduce deployment risk and simplifies post-deployment validation.

Before deploying Multi-Port Attach, complete the following planning activities.Verify Existing Deployment — Before enabling Multi-Port Attach, verify that the existing deployment is operating normally. Resolving existing issues before deployment significantly reduces implementation risk.

* Verify that the Onyx Edge is operational.
* Verify that the AP is online and operational.
* Verify that the existing NR Cell is operational.
* Resolve any existing alerts or configuration issues before proceeding.
* Verify Hardware and Software Compatibility — Verify that all platform components support Multi-Port Attach before beginning deployment.
* Plan RF Coverage — Multi-Port Attach is designed to improve RF coverage rather than increase network capacity. Proper RF planning is essential for achieving the intended coverage objectives.
  * Identify the operational areas that require RF coverage.
  * Verify that both areas can be effectively served by a single supported AP.
  * Determine antenna placement and orientation for each sector.
  * Ensure sufficient RF overlap where seamless UE mobility is required.
  * Frequency/channel planning is simplified. Both sectors operate on the same channel, so only one channel needs to be planned for the entire deployment.
* Define Deployment Objectives — Clearly define the objectives before enabling Multi-Port Attach. Typical deployment objectives include:
  * Extending RF coverage to two geographically separated operational areas.
  * Improving RF coverage without deploying an additional AP.
  * Maintaining a single logical network architecture.
  * Optimizing infrastructure utilization while preserving RF performance.
* CBRS Deployment Considerations — For deployments operating in CBRS spectrum:
  * Verify that the SAS environment has been prepared.
  * Complete all required SAS configuration before enabling Multi-Port Attach.
  * Verify that CPI requirements have been completed, if applicable.

For detailed SAS prerequisites, CBSD configuration, and deployment procedures, refer to the *Onyx CBRS SAS Registration Application Note*.

### Deployment Design Considerations

When designing a Multi-Port Attach deployment, consider the following recommendations.

* RF Design
  * Perform an RF site survey before deployment.
  * Identify the operational areas to be served.
  * Select antennas appropriate for the deployment environment.
  * Validate antenna orientation and placement.
  * Ensure sufficient RF overlap where seamless UE mobility is expected.
  * Minimize physical obstructions that may affect signal propagation.
* Platform Design
  * Verify that the AP supports Multi-Port Attach.
  * Verify compatible GXC Onyx software versions.
  * Confirm that the required feature licenses are installed.
  * Review the applicable release notes before deployment.
* Coverage Planning
  * Align each RF sector with its intended operational area.
  * Validate the expected RF coverage before deployment.
  * Identify RF measurement locations for post-deployment verification.
  * Define acceptance criteria for coverage validation.

Design RF coverage to meet operational requirements rather than simply extending coverage distance. Proper antenna selection, orientation, and placement are the primary factors that determine a successful Multi-Port Attach deployment.

## Feature Limitations & Considerations

Review the following limitations and considerations before deploying Multi-Port Attach. Understanding these constraints helps ensure that the feature is deployed in supported environments and according to validated design practices.

* Multi-Port Attach is supported only on 5G Onyx Edge (NR+Core) deployments.
* Multi-Port Attach transition constraints apply to SAS-enabled deployments. Before changing the Multi-Port Attach state, remove all SAS-enabled cells from the deployment. Refer to [*Deploy Multi-Port Attach*](#deploy-multi-port-attach).
* Enabling Multi-Port Attach reduces the maximum theoretical downlink throughput available to each sector. Partitioning a 4×4 RU into two independent 2×2 sectors reduces the number of available downlink spatial layers from four to two per sector. This is an intentional design trade-off that improves RF coverage flexibility rather than increasing capacity or user density. Consider this reduction during network planning.
* Multi-Port Attach improves RF coverage but does not increase network capacity or support higher user density within a single coverage area. Deployments requiring additional capacity should use additional APs rather than Multi-Port Attach.

{% hint style="warning" %}
**CAUTION:** Sustained Maximum-Throughput Traffic **—** When Multi-Port Attach is enabled, sustained simultaneous maximum-rate UDP or TCP traffic across all active antenna ports may cause the Onyx Edge to reboot unexpectedly. This behavior occurs only when all active antenna ports are driven at maximum throughput simultaneously. Lower-bandwidth traffic, such as ICMP ping, is not affected.
{% endhint %}

{% hint style="info" %}
**NOTE**: Physical Antenna Installation Requirements — Multi-Port Attach requires two independently oriented antenna systems, with one antenna system serving each operational area. For supported four-port APs, the validated antenna port pairing is Ports 1+2 and Ports 3+4. Port pairing Ports 1+3 and Ports 2+4 is not supported and must not be used.
{% endhint %}

{% hint style="info" %}
**NOTE**: SAS-Enabled Deployments — Complete all SAS configuration and authorization procedures before enabling Multi-Port Attach. For SAS prerequisites, CBSD registration, spectrum grants, operational requirements, and troubleshooting, refer to the *Onyx CBRS SAS Registration Application Note*.
{% endhint %}

{% hint style="info" %}
**NOTE:** Partial SAS Grant Behavior — When Multi-Port Attach is enabled, each antenna port registers as a separate CBSD with the SAS. If one CBSD receives a spectrum grant but the other does not, the expected behavior is that the AP does not radiate unless all associated CBSDs receive valid spectrum grants.
{% endhint %}

## Configure Multi-Port Attach

This section describes how to configure Multi-Port Attach. Before beginning deployment, complete the planning activities described in *Deployment Prerequisites and Planning.*

The following diagram summarizes the end-to-end workflow for enabling Multi-Port Attach on an Onyx Edge, from verifying its current status through the point where the configuration diverges into a non-SAS path and a SAS-enabled path.

<p align="center"><strong>Figure: Multi-Port Attach Configuration Workflow</strong></p>

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FhNJJ1vqPdnczhbpufqZi%2F5g-multi-port-attach-config-workflow.png?alt=media&amp;token=c3d11801-3c58-4cb5-b4c3-1ca76f496e69" alt="" width="563"><figcaption></figcaption></figure></div>

{% hint style="info" %}
**NOTE**: If the deployment operates in CBRS spectrum, complete the required SAS configuration before enabling Multi-Port Attach. For SAS-specific procedures, refer to the *Onyx CBRS SAS Registration Application Note*.
{% endhint %}

### View Multi-Port Attach Status

Before configuring Multi-Port Attach, verify the current Multi-Port Attach status for the target Onyx Edge.

**To view the Multi-Port Attach status of the target Onyx Edge (NR+Core)**:

{% stepper %}
{% step %}
Navigate to **Equipment** > **Onyx Edge (NR+Core)** tab or **Onyx Edge** tab.

{% hint style="info" %}
**NOTE:** If a 5G network includes both Onyx Edge (NR+Core) and Onyx Edge (Core), the summary details for all Onyx Edge (NR+Core) configured in the network are displayed in the **Equipment** page > **Onyx Edge (NR+Core)** tab. If the network includes only Onyx Edge (NR+Core), the summary details are displayed in the **Equipment** page > **Onyx Edge** tab.
{% endhint %}
{% endstep %}

{% step %}
In the **Onyx Edge (n)** panel, click the Onyx Edge's name.

The ***\<onyx-edge-name>*** page > **RAN** section > **Multi-Port Attach** parameter indicates the Multi-Port Attach feature's status — **True** (enabled) or **False** (disabled).

* Onyx Edge with Multi-Port Attach disabled (**False**).<br>

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FeQGtUgYkOvdwLKztOSca%2Fimage.png?alt=media&amp;token=e913d608-88a8-4cf8-a239-d63d743fc72c" alt=""><figcaption></figcaption></figure></div>

* In CBRS deployment, with Multi-Port Attach disabled (**False**) and SAS status **Authorized**:<br>

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FaOeN83cnjPVfg0w2VOqM%2Fimage.png?alt=media&amp;token=8f395b1e-8464-41f8-9c76-3c222253987e" alt=""><figcaption></figcaption></figure></div>

* In CBRS deployment, to view the cell's CBSD details, click the **Show More** link.\
  Cell details showing CBSD information for the single-antenna configuration:<br>

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FsJvyiohX1maMDCLA86fI%2F2-mpa-false-sas-enabled-ap-more-details.png?alt=media&amp;token=d28405c6-0c1e-4d39-9857-1fb441daff3b" alt=""><figcaption></figcaption></figure></div>

{% endstep %}
{% endstepper %}

### Add Cell Parameter Reference

The following tables define the cell configuration parameters required when adding a new NR cell with Multi-Port Attach enabled, referenced in *Enable and Configure Multi-Port Attach*. Parameters vary by band and whether SAS is enabled for the cell.

<p align="center"><strong>Table: Parameters Applicable to N48 with SAS Disabled, N77, and N78 Bands</strong></p>

<table><thead><tr><th width="249.5555419921875">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>SAS Enabled</strong></td><td>Click the toggle switch to disable SAS. Default: disabled.</td></tr><tr><td><strong>Name</strong></td><td>(Required) The cell's name.</td></tr><tr><td><strong>BW (MHz)</strong></td><td>(Required) Click to select the cell's channel bandwidth from <strong>10</strong>, <strong>20</strong>, <strong>40</strong>. Select the bandwidth appropriate for the deployment and RF design.</td></tr><tr><td><strong>Freq (MHz)</strong></td><td>(Required) Click to select the cell's operating center frequency. Available frequencies depend on the selected band and system configuration.</td></tr><tr><td><strong>Associated AP/FHM [Band N**]</strong></td><td>Click to select the associated AP/FHM.</td></tr><tr><td><strong>PSS (for PCI)</strong></td><td>(Required) Click to select the Primary Synchronization Signal (PSS) from <strong>0</strong>, <strong>1</strong>, <strong>2</strong>. The PSS contributes to the Physical Cell Identity (PCI). Configure a value that results in a unique PCI within the RF environment to minimize interference with neighboring cells.</td></tr></tbody></table>

<p align="center"><strong>Table: Parameters Applicable to N48 Band with SAS Enabled</strong></p>

<table><thead><tr><th width="249.5555419921875">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>SAS Enabled</strong></td><td>Click the toggle switch to enable SAS. Default: disabled.</td></tr><tr><td><strong>Name</strong></td><td>(Required) The cell's name.</td></tr><tr><td><strong>User ID</strong></td><td>(Required) The SAS account's user ID. This identifier is included during CBSD registration to authenticate ownership of the CBSD.</td></tr><tr><td><strong>Preferred BW (MHz)</strong></td><td>(Required) Click to select the preferred channel bandwidth requested during SAS grant acquisition from <strong>10</strong>, <strong>20</strong>, <strong>40</strong>. The SAS attempts to allocate spectrum matching this bandwidth, subject to spectrum availability and regulatory constraints. Default: 40 MHz.</td></tr><tr><td><strong>Preferred Freq (MHz) in Priority Order</strong></td><td>(Required) Click to select one or more preferred center frequencies, listed in order of preference — highest priority first. During grant acquisition, the SAS attempts to assign the highest-priority available frequency.</td></tr><tr><td><strong>Strict Freq Preference</strong></td><td>(Required) Click to specify whether the selected preferred frequencies must be strictly adhered to. Default: <strong>True</strong>. When <strong>True</strong>, grant requests are limited to the preferred frequency range (the system may fall back to a lower bandwidth at the same frequency if needed). When <strong>False</strong>, the next best frequency will be requested for the grant.</td></tr><tr><td><strong>PSS (for PCI)</strong></td><td>(Required) Click to select the Primary Synchronization Signal (PSS) from <strong>0</strong>, <strong>1</strong>, <strong>2</strong>. The PSS contributes to the Physical Cell Identity (PCI). Configure a value that results in a unique PCI within the RF environment to minimize interference with neighboring cells.</td></tr><tr><td><strong>Access Point Association</strong></td><td></td></tr><tr><td>   <strong>Associated AP/FHM</strong></td><td>(Required) Click to select the AP or FHM to associate with this cell. Selecting an FHM enables unified control of SAS settings for all APs associated with that FHM.</td></tr><tr><td>   <strong>CBSD Category</strong></td><td>(Required) Click to select the CBSD category — Category A for devices operating at a maximum of 30 dBm EIRP, Category B for devices operating at a maximum of 47 dBm EIRP. Default: A.</td></tr><tr><td>   <strong>Antenna Gain &#x3C;n> (dBi)</strong></td><td>(Required) The antenna gain in decibels relative to an isotropic radiator (dBi). Enter an integer value in the range of 0–35. Default: 0. For Multi-Port Attach deployments, configure two values — Antenna Gain 1 and Antenna Gain 2 — one per sector.<br>To add Antenna Gain 2, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FrJVvDPNiBWtDZ3Ux9b6j%2Ficon-add-antenna-gain.png?alt=media&amp;token=ee7aaf4b-3c64-4d99-9b1c-155c6a318dee" alt="">.</td></tr></tbody></table>

{% hint style="info" %}
**NOTE**: SAS-Enabled FHM Cell Behavior — When SAS is enabled for a cell associated with an FHM, only one center frequency can be selected under Preferred Freq (MHz) in Priority Order, and Strict Preference is automatically set to True and cannot be modified. If multiple frequencies were selected before associating the cell with an FHM, the first frequency in the original selection is retained as the active choice.
{% endhint %}

### Enable and Configure Multi-Port Attach

Multi-Port Attach is configured at the Onyx Edge level, is disabled by default, and can be enabled or disabled independently for each Onyx Edge.

{% hint style="info" %}
**NOTE:** You can enable or 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 %}

{% hint style="info" %}
**NOTE:** If the Onyx Edge contains SAS-enabled cells, you must delete those cells and save the configuration before you can enable Multi-Port Attach. See [*Update Workflow and Multi-Port Transition Constraints*](#update-workflow-and-multi-port-transition-constraints) for details.
{% endhint %}

**To enable and configure Multi-Port Attach for an Onyx Edge:**

{% stepper %}
{% step %}
Navigate to **Equipment** > **Onyx Edge (NR+Core)** tab or the **Onyx Edge** tab.
{% endstep %}

{% step %}
For the Onyx Edge that you want to configure, in the **Onyx Edge (n)** panel > **Actions** column, click the corresponding **⋮** (options) icon, then click **Edit**.

The **Edit Onyx Edge (*****\<onyx edge name>*****)** page is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FUn0v3Dxh9rfa4h7BGhp8%2Fimage.png?alt=media&amp;token=ed8d9807-6adb-47b0-bf8f-a16b00bce2b0" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click the **RAN** tab.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F17oaQ75p9p7dpf9wcYZV%2Fimage.png?alt=media&amp;token=2932cbe4-6ab5-4b95-aa16-7f2fdfe6a2e0" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
If the Onyx Edge contains any SAS-enabled cells, delete them before continuing:

1. For each SAS-enabled cell, click the corresponding ⋮ (options) icon, then click **Delete**.<br>

   <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FACwYjC0RmmMF6GNYkR3S%2Fimage.png?alt=media&amp;token=db1b1eee-23f7-494d-9553-a15ef562bdba" alt=""><figcaption></figcaption></figure></div>
2. Confirm the deletion when prompted.
3. Click **Save Onyx Edge** to save the configuration with the cell(s) removed.

{% hint style="info" %}
**NOTE:** You cannot enable Multi-Port Attach while previously configured SAS-enabled cells exist on the Onyx Edge. This save step must complete before proceeding to Step 5.
{% endhint %}
{% endstep %}

{% step %}
To enable the Multi-Port Attach feature, toggle the **Multi-Port Attach** switch on.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FfwLudSFUGcvOmEWj7uao%2Fimage.png?alt=media&amp;token=43a68e29-0112-49ba-99c6-b83984d3cdc1" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
To add a cell, click **Add Cell**.

The **Add Cell** dialog box is displayed.

{% hint style="info" %}
**NOTE**: The parameters displayed in the **Add Cell** dialog box depend on whether SAS is enabled or disabled.
{% endhint %}

**N48 band with SAS disabled, N77, and N78 bands:**

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FNEg9LojALfJCHCCQmc3J%2Fimage.png?alt=media&amp;token=97f03af6-4a30-4400-8869-bb8945f43676" alt=""><figcaption></figcaption></figure></div>

**N48 band with SAS enabled:**

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FCHuD1cTXZfILG2IjmG36%2Fimage.png?alt=media&amp;token=2721da4b-b503-4790-b4f3-754a8f67a989" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Enter the required details and click **Submit**.

For parameter descriptions, see [*Add Cell Parameters Reference*](#add-cell-parameters).

Sample configuration screens:

* SAS disabled:<br>

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FSHb178E8F598ZaArMtTh%2Fadd-cell-sas-disabled.png?alt=media&amp;token=c02c3962-0aff-4f5b-9e3b-769cb3c151f8" alt=""><figcaption></figcaption></figure></div>

* SAS enabled with two Antenna Gain configured:<br>

  <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FZE2ahWbBYAwIH58V9hhw%2Fadd-cell-sas-enabled.png?alt=media&amp;token=6858d696-fca9-4aa5-bdf4-5ac3e16ba96e" alt=""><figcaption></figcaption></figure></div>

{% endstep %}

{% step %}
To save your edits, in the top right corner of the page, click **Save Onyx Edge**.
{% endstep %}
{% endstepper %}

#### SAS-Enabled Deployments

The deployment workflow for SAS-enabled networks is the same as for non-SAS deployments, with the additional SAS configuration required before RF transmission can begin. For how CBSD records are generated and registered per sector, see [*SAS / CBRS Support*](#sas-cbrs-support).

When Multi-Port Attach is enabled:

* Each configured antenna gain generates a corresponding CBSD record.
* Each generated CBSD is registered independently with the SAS.
* Spectrum grants are managed independently for each CBSD.

**Transition Constraints**

When changing the Multi-Port Attach state in a SAS-enabled deployment:

* Remove all SAS-enabled cells before enabling or disabling Multi-Port Attach.
* Save the configuration before adding the required cells.

For SAS account setup, CPI requirements, CBSD registration, spectrum grants, heartbeat procedures, and troubleshooting, refer to the *Onyx CBRS SAS Registration Application Note*.

## Verify the Deployment

After deploying Multi-Port Attach, verify that the configuration has been successfully applied and that the deployment is operating as expected. Validation should begin by confirming that the configuration has been applied correctly in the Onyx Portal, followed by verification of platform health, RF coverage, UE connectivity, and, where applicable, SAS authorization.

### Verify the Configuration

Immediately after saving the configuration, verify that Multi-Port Attach has been successfully applied.

**To verify the Multi-Port Attach configuration:**

1. Navigate to **Equipment** > **Onyx Edge (NR+Core)** tab or the **Onyx Edge** tab.
2. In the **Onyx Edge (n)** panel, click the Onyx Edge's name.
3. In the **RAN** section, verify Multi-Port Attach status:
   * Multi-Port Attach enabled (**True**) with the new cell's details.<br>

     <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FM6gwZstp4L2YBt11zLV4%2Fimage.png?alt=media&amp;token=77a2c7d8-c592-479f-bd5d-e615d30a631f" alt=""><figcaption></figcaption></figure></div>

   * In CBRS deployment, Multi-Port Attach enabled (**True**) with cell's SAS status **Authorized**.<br>

     <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FNZ9DxxfHMAn5Zd57iFUW%2Fimage.png?alt=media&amp;token=7323c627-5ab6-4d4d-9b76-850151e6867c" alt=""><figcaption></figcaption></figure></div>

   * In CBRS deployment, to view the cell's CBSD details, click the **Show More** link.<br>

     <div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FxIUmE6ds05KkPdpMsrd8%2Ffhm-sas-enabled-2.png?alt=media&amp;token=05c5b5db-564a-4327-b733-5a211956eb59" alt=""><figcaption></figcaption></figure></div>

     Verify that:

     * Two CBSD records are displayed for the NR Cell (one for each 2×2 sector).
     * Both CBSD records show an **Authorized** SAS status.

### Verify Platform Status

Confirm that:

* The Onyx Edge is online.
* The AP is online.
* The NR Cell is operational.
* No critical alerts are active or configuration errors are reported.

### Verify RF Coverage

Perform RF validation within each intended coverage area.

Verify that:

* Sector A provides the expected RF coverage.
* Sector B provides the expected RF coverage.
* Signal strength meets the planned design objectives.
* Sufficient RF overlap exists where seamless UE mobility is expected.

Compare the measured RF coverage against the deployment objectives established during planning.

### Verify UE Connectivity

Using one or more test UE, verify that devices can successfully access the network.

Confirm that the UE:

* Detects the NR Cell.
* Successfully attaches to the network.
* Receives an IP address.
* Successfully exchanges user traffic.

### Verify UE Mobility

Verify that UE can move between the two operational areas while remaining connected to the same NR Cell.

Confirm that:

* Connectivity is maintained while moving between sectors.
* No service interruption occurs.
* No unexpected RRC re-establishment occurs.
* No UE reattachment occurs during normal mobility.

## Related Documentation

* *GXC 5G AP Hardware Installation Guides*
* *Onyx CBRS SAS Registration Application Note*
* *5G Onyx Portal Operations Guide*

## Contact GXC <a href="#contact-gxc" id="contact-gxc"></a>

To get in touch with GXC, please visit [*https://gxc.io/contact-us/*](https://gxc.io/contact-us/).


# 5G Onyx Spectrum Analyzer

## Introduction

In modern 5G networks, RF performance issues such as interference, improper power control, and spectrum anomalies can significantly impact user experience and overall network efficiency. Traditional troubleshooting methods often require expensive external spectrum analyzers, specialized expertise, and time-consuming site visits.

The Spectrum Analyzer feature in the Onyx 5G platform provides real-time, per-RU analysis and visualization of uplink and downlink power characteristics across the RF spectrum. Integrated directly into the Onyx Portal, this tool enables network operators to monitor signal quality, detect interference, and optimize network performance without requiring external test equipment.

The Spectrum Analyzer offers the following analysis plots:

* Average Power – Displays average power distribution across the frequency spectrum to identify interference sources and power anomalies.
* Maximum Power – Displays peak power levels across frequencies to detect transmission spikes and interference patterns.

This application note describes how to configure and use the Spectrum Analyzer, interpret its visualizations, and apply analysis results to real-world RF troubleshooting and network optimization workflows.

### Use Cases

The Spectrum Analyzer supports multiple deployment and operational needs. Understanding when to use it helps optimize network performance and troubleshooting efficiency.

* **Pre-Deployment Site Survey** – Before activating a site, use the Spectrum Analyzer to assess the RF environment and verify spectrum cleanliness. Enable Listen-Only Mode to perform a passive scan without any gNB transmission.
  * Identify existing interference sources in the target frequency band
  * Validate frequency selection and channel planning decisions
  * Document baseline ambient spectrum conditions before the site goes live
* **Interference Detection and Analysis** – When experiencing unexplained performance degradation, use the Spectrum Analyzer to identify and characterize interference patterns.
  * Detect narrowband interference from adjacent services
  * Identify wideband interference from faulty equipment
  * Correlate interference patterns with time-of-day or specific events
  * Use the Maximum Power plot to distinguish between sustained interference and transient spikes
* **Performance Optimization** – Monitor signal quality during network optimization activities to validate configuration changes and parameter adjustments.
  * Verify power control algorithms are functioning correctly
  * Assess impact of TDD configuration changes
  * Evaluate spectrum efficiency
* **Troubleshooting and Root Cause Analysis** – When KPIs indicate degraded performance, use the Spectrum Analyzer to pinpoint the root cause at the physical layer.
  * Diagnose sudden drops in throughput or connection quality
  * Investigate increased retransmission rates
  * Validate antenna system integrity and RF path quality
  * Compare Average Power and Maximum Power plots to distinguish between sustained and intermittent issues
* **Compliance and Validation Testing** – Support regulatory compliance verification and acceptance testing procedures.
  * Document baseline RF characteristics for compliance records
  * Verify transmit power levels meet specifications
  * Validate frequency mask compliance and adjacent channel leakage

### Listen-Only Mode

The Listen-Only Mode configuration determines whether the gNB transmits during signal analysis. Choosing the correct mode before starting analysis is critical — it determines both what the Spectrum Analyzer can measure and whether the network experiences a service interruption.

{% 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 to minimize impact.
{% endhint %}

#### Listen-Only Mode Enabled

When the Listen-Only Mode is enabled, the Spectrum Analyzer disables all gNB transmissions and passively listens to the RF spectrum without transmitting.

Listen-Only Mode causes complete service interruption across the entire cell. The gNB stops transmitting entirely, all connected devices are immediately disconnected, and the network becomes completely unavailable for the duration of the analysis interval. This mode is suitable only for pre-deployment site surveys, scheduled maintenance windows, or inactive test sites where service disruption is acceptable.

Listen-Only Mode is specifically designed for pre-deployment site surveys where you need to assess the RF environment before activating the site. This mode is ideal for:

* Verifying spectrum cleanliness and identifying existing interference sources without your own transmissions masking external signals
* Validating frequency selection decisions
* Hunting for intermittent interference sources
* Performing regulatory compliance testing where documenting ambient spectrum conditions without active transmission is required

In Listen-Only mode, downlink traces are not displayed in the analysis plots as the gNB is not transmitting, downlink measurements would only reflect environmental noise and are suppressed.

Uplink traces may show minimal activity from UE devices attempting random-access connections. As devices gradually lose synchronization with the disabled gNB, this activity decreases over time.

#### Listen-Only Mode Disabled

When Listen-Only Mode is disabled, the Spectrum Analyzer captures RF data while the gNB continues normal transmission and serves active users. This is the default setting and the recommended mode for all production network analysis.

The network continues serving users normally with no service interruption, and real-world operating conditions are maintained throughout the analysis. This mode is ideal for:

* Observing real traffic patterns and resource utilization with active users
* Verifying power control algorithms with connected devices
* Analyzing performance under actual load conditions
* Troubleshooting issues affecting user experience
* Validating configuration changes in production environments where service continuity is essential

Downlink traces show actual gNB transmission power across the channel, including active resource block allocation patterns and real traffic power distribution.

Uplink traces show power from connected UE under active power control, along with real-time user traffic patterns.

## Getting Started

This section describes how to enable and launch the Spectrum Analyzer.

### Enable/Disable Spectrum Analyzer

The Spectrum Analyzer must be enabled for the Onyx Edge before it can be launched.

{% hint style="info" %}
**NOTE:** You can enable/disable the Spectrum Analyzer feature only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

**To enable/disable the Spectrum Analyzer 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 Spectrum Analyzer feature, in the **Onyx Edge (n)** panel > **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.

The **Edit Onyx Edge (\<onyx edge name>)** page is displayed.
{% endstep %}

{% step %}
Click the **Others** tab.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FTJXtC7AdoJDAmsGTG4Ed%2Fimage.png?alt=media&amp;token=ca51a31b-cb3e-433b-9a2d-88f1cedbf330" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Click the **Spectrum Analyzer** toggle switch to enable/disable Spectrum Analyzer for the Onyx Edge. Default: disabled.
{% endstep %}

{% step %}
To save your edits, in the upper-right corner of the page, click **Save Onyx Edge**.
{% endstep %}
{% endstepper %}

### Launch Spectrum Analyzer

After enabling the Spectrum Analyzer, you can launch it from the Onyx Edge's details page.

{% hint style="info" %}
**NOTE:** You can launch the Spectrum Analyzer only if you are a GXC Administrator, GXC Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}

**To launch the Spectrum Analyzer:**

{% 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 launch Spectrum Analyzer, in the **RAN** section > **Actions** column, click the corresponding ⋮ (options) icon, then click **Start Spectrum Analyzer**.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FnZ8dw4mp7Q9xbqWAyGzU%2Fimage.png?alt=media&amp;token=a249f16f-af8e-44aa-a07b-b46b66ec5cd2" alt=""><figcaption></figcaption></figure></div>

The **Spectrum Analyzer** dialog box is displayed.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F2IeqEphu4WgtZ6xxGkSm%2Fimage.png?alt=media&amp;token=93b97af6-3fb4-44b3-842c-ef9e69c829ee" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Configure the following details, then click **Start**.

* **Listen-Only Mode** – Specify whether the gNB transmits during signal analysis. Default: Disabled.

  When disabled (default), the analyzer captures RF data while the gNB continues serving active users — no service interruption occurs. When enabled, the gNB stops transmitting entirely and the analyzer passively listens to the spectrum. See [Listen-Only Mode](#listen-only-mode) for full details before making this selection.
* **Analysis Interval** – Select the duration for which the analyzer should capture and report data. Default: 5 minutes.

{% hint style="info" %}
**NOTE:** Longer analysis intervals consume more system resources and storage. Select the minimum interval needed for your analysis objectives.
{% endhint %}

* **Select RU** – Select all available RUs or a specific RU to analyze.

{% hint style="info" %}
**NOTE:** In multi-RU deployments with FHM, selecting a specific RU will cause service disruption to other RUs, as their transmission gets disabled during analysis.
{% endhint %}

{% hint style="info" %}
**NOTE:** When using Listen-Only mode or in FHM deployments when selecting a specific RU, allow at least 3 minutes between successive Spectrum Analyzer runs. Starting a new analysis within 3 minutes of the previous run will result in an error.
{% endhint %}

After you start the analysis, the Spectrum Analyzer requires an initial setup period of up to two minutes to gather and process the data and then display the plots.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fs0X70G766s3Ct7wjV6DH%2Fimage.png?alt=media&amp;token=5ef183e4-858f-4a29-9e11-a8f71df1a5a7" alt=""><figcaption></figcaption></figure></div>

The **Spectrum Analyzer** dialog box opens displaying real-time analysis plots.
{% endstep %}
{% endstepper %}

## Analysis Plots

The Spectrum Analyzer provides two complementary plot types, each offering unique insights into RF performance. Understanding how to interpret these plots is essential for effective network analysis and troubleshooting.

* Average Power – Displays average power distribution across the frequency spectrum to identify interference sources and power anomalies.
* Maximum Power – Displays peak power levels across frequencies to detect transmission spikes and interference patterns.

{% hint style="info" %}
**NOTE:** All plots refresh automatically every 10 seconds during active analysis.
{% endhint %}

{% hint style="info" %}
**NOTE:** For deployments with FHM and multiple antennas, the Spectrum Analyzer displays data from all configured antennas simultaneously. The interface presents four antenna plots (Antenna 0, Antenna 1, Antenna 2, and Antenna 3) in a 2×2 grid layout, providing comprehensive visibility across the entire antenna array.
{% endhint %}

{% hint style="info" %}
**NOTE:** In Listen-Only mode, downlink traces are not displayed in the analysis plots as the gNB does not transmit, so downlink measurements would only show environmental noise.
{% endhint %}

### Average Power Plot

Displays the average power distribution across the frequency spectrum to highlight interference sources and power anomalies.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fv6CsHlsgw3mWkCxRgGLf%2Fimage.png?alt=media&amp;token=e52f085e-7068-4b48-90fb-e697fc82a90f" alt=""><figcaption></figcaption></figure></div>

**Plot Details**

* X-Axis: Subcarrier Frequencies (MHz)
* Y-Axis: Average Power (dBm)
* Orange line: Uplink Average Power
* Teal line: Downlink Average Power

**What to Look For:**

* Flat, consistent levels across subcarriers indicate healthy signal distribution.
* Sharp spikes at specific frequencies suggest interference from external sources or co-channel interference.
* Significant uplink/downlink imbalance may indicate coverage issues or device power control problems.
* Gradual slopes across the band may indicate filter roll-off or edge-of-band effects.
* Elevated noise floor across the entire band may indicate a broadband interference source nearby.

**Interpretation Examples:**

* Interference – Periodic spikes every X MHz likely indicate adjacent channel interference.
* Investigate – Average power varies significantly over time—check for intermittent interference sources.
* Normal – Symmetrical uplink and downlink traces with a flat noise floor indicate a clean, well-configured channel.

### Maximum Power Plot

Displays peak power levels across frequencies to highlight transmission spikes, interference sources, or power anomalies.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FCjXD3HpnXfbB8rrlxtib%2Fimage.png?alt=media&amp;token=c070753b-8761-4f27-86f3-badaf1df83d5" alt=""><figcaption></figcaption></figure></div>

**Plot Details**

* X-Axis: Subcarrier Frequencies (MHz)
* Y-Axis: Maximum Power (dBm)
* Orange line: Uplink Maximum Power
* Teal line: Downlink Maximum Power

**What to Look For:**

* Peak-to-average ratio – Difference between maximum and average power indicates signal dynamics
* Narrow spikes suggest narrowband interference (e.g., LTE guard bands, other services)
* Broad elevated regions indicate wideband interference or multipath effects
* Symmetry between UL/DL – Asymmetric peaks may indicate one-way interference
* Use the Maximum Power plot alongside the Average Power plot — an anomaly visible in Maximum Power but not Average Power is likely a transient or intermittent event.

**Interpretation Examples:**

* Investigate – Max power >30 dB above average may indicate interference or device malfunction
* Interference – Single subcarrier with consistently high max power suggests CW (continuous wave) interference
* Normal – Max power only slightly above average power across all subcarriers indicates a stable channel with no significant interference.

## Plot Interactions and Control

The Spectrum Analyzer provides the following interactive controls for detailed examination of plot data.

### Interactive Tooltips

The Spectrum Analyzer provides real-time data tooltips that display exact measurements when you hover over the plots.

**To view precise frequency and power measurements for any point:**

{% stepper %}
{% step %}
Move your cursor over any location on the plot.

A tooltip automatically appears showing:

* Frequency value (in MHz, to two decimal places)
* Signal type (Uplink/Downlink, Avg/Max Power)
* Power measurement (in dBm, to three decimal places)

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXKgCOXKI2zBEQQx3yUTy%2Fimage.png?alt=media&amp;token=1e544c4c-015f-4b11-8f43-1988e9797d88" alt=""><figcaption></figcaption></figure>

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJjNK7z0jp4fCkHzUGqOW%2Fimage.png?alt=media&amp;token=32327c4e-040a-4f02-848d-30823d054529" alt=""><figcaption></figcaption></figure>

As you move your cursor across a plot, the tooltip follows your cursor, updating continuously to show values at different frequencies. This feature works on all four antenna plots in both Average Power and Maximum Power views.
{% endstep %}
{% endstepper %}

#### Using Tooltips for Analysis

Tooltips are particularly useful for:

* Identifying exact power levels at specific frequencies
* Locating interference sources by frequency
* Comparing power levels between uplink and downlink
* Measuring power differences between antennas at the same frequency
* Pinpointing the exact frequency of a narrowband interference source for use in frequency planning or regulatory reporting
* Documenting specific measurements for reports or troubleshooting

### Zoom Into Plots

Zoom functionality is available for all plots. Each antenna plot can be zoomed independently, allowing detailed examination of specific frequency regions across different antennas simultaneously.

<figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FE8IsFkgpv553LYc6G6tm%2Fimage.png?alt=media&amp;token=29746c3f-6e02-4ef4-8091-2e10cef44aaf" alt=""><figcaption></figcaption></figure>

**To zoom in on a specific region of a plot:**

{% stepper %}
{% step %}
On the plot, position your cursor at the desired starting frequency.
{% endstep %}

{% step %}
Click and drag horizontally to the left or right to select the frequency range of interest.
{% endstep %}

{% step %}
Release the mouse button to apply the zoom.

The plot zooms into the selected frequency range, adjusting both the X-axis (frequency) and Y-axis (power) scales to show details in that region.
{% endstep %}
{% endstepper %}

**To reset a plot after zooming in:**

In the top-right corner of the plot, click <img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FiucuAXyDdKUNokWfoVAl%2Fimage.png?alt=media&amp;token=d3bf9bf2-db82-436a-908b-83a4c9a6506f" alt="" data-size="line"> (Reset Zoom). The plot immediately returns to the full frequency range view.

{% hint style="info" %}
**NOTE**: In multi-antenna deployments, zoom each antenna plot to the same frequency range to compare power levels across antennas at a specific band. This helps identify antenna imbalances or isolated per-antenna interference.
{% endhint %}

### Analysis Completion

Review the plots before closing — once the dialog is closed, the current analysis data is no longer accessible in the portal.

The Spectrum Analyzer stops automatically when the analysis interval specified at launch expires and displays a completion message.

<div data-with-frame="true"><figure><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FLkZyGMQl1WeHLQxf3gE3%2Fimage.png?alt=media&amp;token=0d7ce4df-6e21-4b7a-b375-80d819aedecd" alt=""><figcaption></figcaption></figure></div>

To close the Spectrum Analyzer, click **Stop**.

### Stop Analysis

**To stop an analysis session and close the Spectrum Analyzer:**

To stop an analysis session and close the Spectrum Analyzer dialog box, click **Stop**.

The analysis terminates immediately and data collection stops.

{% hint style="info" %}
NOTE: After stopping an analysis — whether manually or at interval expiry — allow at least 3 minutes before starting a new session when using Listen-Only mode or when a specific RU was selected in an FHM deployment. Starting a new run within 3 minutes will result in an error.
{% endhint %}

## Related Documentation

* *5G Onyx Portal Operations Guide*
* *4G & 5G Survey Solution Application Note*
* *GXC Glossary*

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# 4G & 5G Timing and Synchronization

Which box holds the clock depends on where the RAN stack runs. That one rule decides whether you need GPS antennas at every radio, a PTP grandmaster, or neither.

## Introduction

TDD networks carry downlink and uplink on the same frequency and separate them in time. Every radio sharing a band has to agree on when each slot begins. Radios that disagree will transmit while a neighbor is listening, and the result is interference that presents as poor coverage, low throughput and dropped sessions. Adding radios or power makes it worse.

Synchronization is what holds that agreement. For any deployment there are two questions, and the first one is already answered by the architecture.

## Synchronization follows the RAN stack

The box running the RAN stack is the box that needs a time reference. Where that box sits is the architecture decision, so the timing design falls out of it.

|                 | RAN stack runs | What you synchronize | Radio has its own GPS        |
| --------------- | -------------- | -------------------- | ---------------------------- |
| **Integrated**  | in the AP      | every AP             | yes, a GPS port on each unit |
| **Distributed** | on Onyx Edge   | the Onyx Edge        | no                           |
| **Super Cell**  | on Onyx Edge   | the Onyx Edge        | no                           |

### Integrated: each radio holds its own reference

Every 4G AP and every 5G gNB carries a GPS port and supports IEEE 1588v2 PTP. Because the AP contains the full stack, it needs the reference locally, and it can take it either way.

The choice is usually decided by the sky, not by accuracy. An outdoor AP on a mast or a rooftop can mount a GPS antenna and use it. An AP in a warehouse ceiling or a basement cannot see satellites at all, so PTP from a grandmaster on the local network is the better option indoors, and often the only one.

### Distributed and Super Cell: the server holds the reference

An O-RAN Radio Unit has no GPS receiver, indoor or outdoor. It takes PTP and SyncE from Onyx Edge across the fronthaul, and it holds no independent reference of its own.

Onyx Edge takes its own reference from a GPS receiver, then acts as the PTP clock source for every RU attached to it. Where a site already runs a timing distribution network, the Edge can take its reference from an upstream grandmaster instead. Contact GXC to confirm the profile before designing around it.

Where an FHM is present, it relays the same timing rather than terminating it. The FHM is a 1588v2 transparent clock, so it forwards PTP and corrects for the delay it adds in passing. A Super Cell timing chain therefore runs Onyx Edge, then FHM, then RU, with one reference at the head of it.

This is a further reason fronthaul is fiber in practice: it carries timing as well as traffic. See [Architecture](https://docs.gxc.io/plan-your-network/architecture).

## When synchronization is required

A single radio with nothing nearby to interfere with has nothing to agree with, and can run on its internal oscillator.

The moment a second radio can reach the first, they need a common reference. Treat radios as co-located if they share a site and a band, or if their coverage overlaps at all. A Super Cell is the clearest case: every RU in it transmits the same cell, so they are a single radio as far as a device is concerned and must be aligned to the sample.

{% hint style="warning" %}
**Free Running is the default on 4G APs.** It is correct for one isolated radio and wrong for every site with a second one. On a multi-radio site it has to be changed deliberately, and a site that works during a single-AP pilot can degrade when the second AP is added.
{% endhint %}

## The three sources

| Source           | Where the time comes from                       | Use it when                                               |
| ---------------- | ----------------------------------------------- | --------------------------------------------------------- |
| **GPS**          | satellites, UTC-traceable                       | the box holding the stack can see the sky                 |
| **PTP**          | a grandmaster on the local network, IEEE 1588v2 | it cannot see the sky, or a timing network already exists |
| **Free Running** | the box's internal oscillator                   | a single isolated radio, with nothing on the band nearby  |

Free Running means slightly different things on each platform. A 4G AP disciplines its internal clock from an NTP server. Onyx Edge runs its oscillator with no external reference at all. NTP corrects long-term drift but delivers accuracy in milliseconds, while TDD slot alignment needs it in microseconds, so neither arrangement substitutes for GPS or PTP where radios share a band.

### Holdover

If GPS is lost, the oscillator keeps running at its last known rate and drifts away from its neighbors. Alignment degrades gradually rather than failing at once, so the symptom is interference that worsens over time rather than an outage.

For planning, treat roughly ten minutes as the window in which alignment stays usable, and design the GPS feed so that outages are shorter than that. A radio that rides out a brief antenna fault is normal; one that spends hours in holdover will interfere with its neighbors.

## Configuring it

### 4G, per access point

Set **Sync Mode** on each AP. See [Manage Access Points](https://docs.gxc.io/docs/network-configuration-and-operations-guides/4g-onyx-portal-4.x-operations/manage-equipment/manage-access-points).

* **Free Running**, **GPS** or **PTP**. The default is Free Running.
* Selecting PTP adds **PTP Transport**, either Ethernet or UDP. The default is Ethernet.

{% hint style="info" %}
**PTP on 4G is qualified for Ethernet transport in Single Carrier mode only.** It is not qualified with PTP over UDP, nor with Dual Carrier or Carrier Aggregation. A dual-carrier site that needs synchronization should plan on GPS.
{% endhint %}

### 5G, at the Onyx Edge

Set **Timing Source** on the Onyx Edge. See [Manage Onyx Edge](https://docs.gxc.io/docs/network-configuration-and-operations-guides/5g-onyx-portal-4.x-operations/manage-equipment/manage-onyx-edge).

* **GPS** for any site with more than one cell. A GPS antenna with clear sky visibility is required at the Edge.
* **Free Running** only for an isolated single-cell deployment.

Attached RUs take their timing from the Edge and need no setting of their own.

## Testing and Validation

* [ ] **Sync Status** reads green in Onyx Portal for every Onyx Edge, AP and FHM
* [ ] On 5G, confirm **SyncE State** and **GPS State** on the Onyx Edge status panel
* [ ] Every AP on a multi-radio site reads a source other than Free Running
* [ ] GPS antennas have clear sky visibility from their final mounted position, not from where they were tested
* [ ] On a PTP design, the grandmaster is reachable from every AP that depends on it, and its own reference is confirmed
* [ ] Throughput measured at a cell edge between two co-located radios, which is where a timing fault shows up first
* [ ] Alarm routing confirmed for loss of synchronization, so holdover is noticed while it is still holding

## Best Practices

**Decide timing with the architecture, not after it.** The RAN stack location determines what needs a reference, so the choice is made once the architecture is set. Treating it as a commissioning detail is what produces late GPS antenna orders and roof access requests.

**Survey sky visibility during the RF survey.** A GPS antenna needs a clear view from its mounted position. Establishing that at the same time as the RF measurements costs nothing; establishing it afterward can mean a second visit.

**Indoors, plan for PTP.** Ceiling and basement positions rarely support GPS. A grandmaster on the local network serves every indoor AP, and one grandmaster covers many of them.

**Check synchronization when adding the second radio.** A single-AP pilot runs correctly on Free Running. The fault appears when the site grows, and it looks like an RF problem rather than a timing one.

## Related Documentation

* [Architecture](https://docs.gxc.io/plan-your-network/architecture) : where the RAN stack runs for each of the three modes
* [5G Handovers](https://docs.gxc.io/docs/application-notes/5g-handovers) : mobility between cells, which assumes aligned neighbors
* [5G AP Deployment Modes](https://docs.gxc.io/docs/application-notes/5g-ap-deployment-modes) : carrier and port configurations referenced above
* [Glossary](https://docs.gxc.io/glossary) : PTP, SyncE, GNSS and S-plane definitions

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# Onyx Troubleshooting Guide

This guide provides structured, step-by-step procedures for diagnosing and resolving the most commonly reported issues encountered on the GXC Onyx private cellular platform.

## What's Covered in This Guide

This guide includes the following chapters:

* [*Onyx Portal Operations and Administration Issues*](/docs/troubleshooting/onyx-troubleshooting-guide/operations-and-administration-issues)
* [*Service Issues*](/docs/troubleshooting/onyx-troubleshooting-guide/service-issues)
* [*Onyx Portal Navigation and Indicators Reference*](/docs/troubleshooting/onyx-troubleshooting-guide/onyx-portal-navigation-and-indicators-reference)
* [*agw\_user CLI Command Reference*](/docs/troubleshooting/onyx-troubleshooting-guide/agw_user-cli-command-reference)

## How to Use This Guide

Each troubleshooting topic in this guide follows a consistent format to help you quickly identify and resolve issues.

* Symptoms — What the user or operator observes (for example, a UE displaying "No Service").
* Indicators — Where to verify the issue in the Onyx Portal (dashboards, status indicators, alerts, and logs).
* Possible Causes — The most likely underlying reasons for the symptom.
* Actions — Recommended diagnostic and corrective steps to take, in recommended order.
* Resolution — How to confirm the issue is fully resolved, where applicable.
* Escalation — When and how to engage GXC Technical Support, and what information to gather before creating a support case.

## Contact GXC

For technical issues or additional support, visit <https://gxc.io/contact-us/>.


# Operations & Administration Issues

This chapter covers Onyx Portal administration, configuration, subscriber and SIM/eSIM management, and monitoring issues that are typically observed by users.

For Onyx Portal navigation and status indicator definitions, see [*Onyx Portal Navigation & Indicators Reference*](/docs/troubleshooting/onyx-troubleshooting-guide/onyx-portal-navigation-and-indicators-reference).

## Access & Account Management

This section covers issues with Onyx Portal login, authentication, and account activation.

<details>

<summary><strong>Unable to Log in to Onyx Portal</strong></summary>

**Symptoms**

A user is unable to log in to the Onyx Portal.

**Indicators**

* The Onyx Portal login page displays the message "*User login was not successful or could not meet the requirements of the requesting application.*"
* A redirect loop occurs between the Onyx Portal login page and the Customer IdP login page after completing SSO authentication.
* A blank screen appears after entering login credentials.
* The MFA OTP is rejected as invalid.

**Possible Causes**

* User account status is Suspended, Verification Pending, or Password Expired — preventing login until the status is resolved.
* The authenticator device is out of synchronization, resulting in invalid OTPs.
* An SSO/IdP integration issue prevents SAML-based authentication.
* SAML certificate between Onyx Portal and the Customer IdP has expired.
* JWT token has expired (API access users).
* The browser is blocking third-party cookies required for the SAML SSO authentication flow.
* Onyx Portal service is unavailable.

**Actions**

1. Determine scope of the issue:
   * If all users are affected, focus on Onyx Portal service health or IdP connectivity.
   * If only one user is affected, focus on the user's account status and MFA configuration.
2. Verify user account status — In the **Administration** > **Users** tab, verify the account status is one of the following:
   * **Verified** — The account is active.
   * **Verification Pending** — An administrator can resend the activation link.
   * **Password Expired** — The user can reset their own password using the **Reset/Forgot Password** option on the login screen.
   * **Suspended** — An administrator can reactivate the account.
3. Verify MFA token synchronization:
   * Verify that the authenticator device is configured to synchronize its date, time, and time zone automatically. The OTP refreshes every 30 seconds and remains valid for one minute. If login fails due to an invalid OTP, enable automatic date, time, and time zone synchronization on the authenticator device.
   * If OTP validation continues to fail:
     * If the user has MFA backup codes (provided when MFA was first enabled), instruct the user to sign in using a backup code instead of the OTP.
     * If backup codes are unavailable, an administrator can reset the user's MFA secret via the **Administration** > **Users** tab.
4. Verify Customer IdP integration (SSO deployments) — Verify that:

   * The external IdP is accessible.
   * The SAML federation metadata is current.

   Refer to the *4G & 5G Onyx Portal Integration with Customer IdP Application Note*.
5. Verify SAML certificate expiry — In **Administration**, click **Edit SSO Config**. In the **Edit SSO Config** dialog box, verify the **Additional Config** > **IdP Certificate** has not expired. An expired certificate prevents all SSO users from logging in.
6. Verify JWT token validity (API access users) — If the JWT token has expired, regenerate the JWT API keys. Refer to the *4G & 5G Onyx API Security with JWT Application Note*.
7. Test in incognito mode — Onyx Portal SSO requires third-party cookie support. If login succeeds in incognito mode, the issue is browser-specific: Clear the cookies and cache for *portal.gxc.io* in the user's regular browser.\
   If login still fails in incognito mode, test from a different device or network — This isolates whether the issue is specific to the user's browser/device/network (for example, a captive portal, DNS issue, or corporate proxy blocking portal.gxc.io) versus a problem with the Onyx Portal service itself or the SSO/IdP integration. If login also fails from a different device and network, the cause is more likely server-side (Onyx Portal availability or IdP connectivity) rather than client-side.

**Resolution**

The issue is resolved when the user successfully logs in and reaches the Onyx Portal Dashboard.

**Escalation**

Escalate to GXC Technical Support if renewing the SAML certificate or reconfiguring the IdP does not restore user access.

If the message "*You have exhausted your MFA backup codes. Please contact GXC Technical Support for assistance.*" is displayed, instruct the user to click the **Technical Support** link in the message to open the Onyx Support Portal and create a support ticket.

Provide the following information:

* SAML error message (if SSO-related)
* IdP type and version
* Onyx Portal version
* Whether the issue affects a single user or all users

**Reference**

* *4G & 5G Multi-Factor Authentication Application Note*
* *4G & 5G Onyx Portal Integration with Customer IdP Application Note*
* *4G & 5G Onyx API Security with JWT Application Note*

</details>

<details>

<summary><strong>Not Receiving User Account Activation Emails</strong></summary>

**Symptoms**

A newly added Onyx Portal user does not receive the account activation email and cannot complete account setup.

**Indicators**

* The user reports that the activation email was not received.
* The user account status is **Verification Pending**.
* The user cannot complete account activation or sign in to the Onyx Portal.

**Possible Causes**

* The account activation email was delivered to the user's Spam or Junk folder.
* An incorrect email address was entered when the user account was created.
* The Onyx Portal email notification service is experiencing a delivery issue.
* The recipient's email system is blocking or filtering account activation emails.

**Actions**

1. Verify the user's email address — In **Administration** > **Users** tab, verify that the user's email address is correct. A typographical error entered during account creation is the most common cause of this issue.
2. Check the Spam and Junk folders — Verify if the account activation email, sent from *<onyx.accounts@gxc.io>* with the subject *"Email Verification and Password Creation Link,"* was not delivered to the **Spam** or **Junk** folders. If necessary, add *<onyx.accounts@gxc.io>* to the organization's allow list.
3. Resend account activation email — In **Administration** > **Users** tab, locate the user account and use the **Resend Activation Email** option, if available. If the option is unavailable, contact GXC Technical Support to request that the activation email be resent.

**Resolution**

The issue is resolved when the user receives the account activation email, activates the account, creates a password, and successfully signs in to the Onyx Portal.

**Escalation**

Escalate to GXC Technical Support if the activation email is not received after verifying the email address, checking the Spam or Junk folders, and resending the activation email. Provide the following information:

* User's email address
* Onyx Portal account name
* Date and time the user account was created

</details>

## Onyx Portal Operations & Permissions

This section covers issues with administrative operations caused by user permissions, backend service errors, or Onyx Edge connectivity.

<details>

<summary><strong>Unable to Perform Operations in Onyx Portal</strong></summary>

**Symptoms**

A user is logged in to the Onyx Portal, but one or more operations fail (for example, adding or modifying an AP configuration, generating an Analytics report, or pushing configuration changes to an Onyx Edge).

**Indicators**

* An operation fails silently or returns an error message in the Onyx Portal UI.
* Browser Developer Tools (**Console** or **Network** tab) display **4xx** or **5xx** API errors when the operation is repeated.
* Onyx Edge Online Status is red, indicating that the Onyx Portal cannot communicate with the Onyx Edge.

**Possible Causes**

* The user's RBAC role does not permit the requested operation, and the user receives a Forbidden error.
* The Onyx Portal backend API returns **4xx** or **5xx** errors while processing the request.
* The Onyx Portal cannot communicate with the Onyx Edge because management-plane connectivity is unavailable.
* The user's Onyx Portal session has expired. For UI sessions, the user is automatically logged out. For API access, the client must use the refresh token to obtain a new access and refresh token pair.
* Browser cache, extensions, or compatibility issues prevent the Onyx Portal UI from updating correctly.
* The Onyx Edge software version is incompatible with the Onyx Portal after a partial upgrade.

**Actions**

1. Verify user role and permissions — In **Administration** > **Users** tab, verify the user's assigned role and confirm that it includes permission to perform the requested operation. Supported user roles are: SUPER\_ADMIN, ADMIN, and VIEWER.
2. Verify user account status — In **Administration** > **Users** tab, verify that the user's account status is Verified. If the account is Suspended, Password Expired, or otherwise not Verified, resolve the account status first — see [*Unable to Log in to Onyx Portal* ](#unable-to-log-in-to-onyx-portal)for the full account-status checklist and recovery steps. A user with an invalid account status may still hold a valid session token temporarily, which can cause operations to fail intermittently rather than block login outright.
3. Check Onyx Edge management connectivity — In the **Onyx Edge** summary page, verify that the affected Onyx Edge's Online Status is green. If the Online Status is red, restore management-plane connectivity before attempting further Onyx Portal operations.
4. Capture browser console and network errors:
   1. Open the browser **Developer Tools** (**F12**).
   2. Select the **Console** and **Network** tabs.
   3. Repeat the failed operation.
   4. Review the results for any **4xx** or **5xx** API responses.
5. Refresh the user session:

   1. Sign out of the Onyx Portal.
   2. Clear the browser cache.
   3. Sign in again.

   If the operation succeeds after signing in again, the issue was caused by an expired session token.
6. Test in incognito mode or a different browser:
   * Repeat the failed operation in an incognito/private browsing session or in a different supported browser.
   * If the issue does not occur, clear the cache and cookies in the original browser, then retry the operation.
7. Verify software version compatibility — Review the applicable *Onyx Release Notes* to verify that the Onyx Portal and Onyx Edge software versions are compatible.

**Resolution**

The issue is resolved when the requested operation completes successfully, and the expected configuration or administrative change is reflected in the Onyx Portal.

**Escalation**

Escalate to GXC Technical Support if API errors continue after verifying user permissions, refreshing the session, and confirming Onyx Edge connectivity. Provide the following information:

* Browser HAR file captured during the failed operation
* Onyx Portal version
* Onyx Edge version
* The failed operation
* Complete error message displayed

</details>

## Alerts & Notifications

This section covers issues with receiving Onyx Portal alert notifications.

<details>

<summary><strong>Not Receiving Alert Notifications</strong></summary>

**Symptoms**

Alert notification emails are not received, or email notifications stop for an alert that remains active.

**Indicators**

* An alert is visible in **Alerts** > **Active Alerts**, but no corresponding email notification is received.
* Email notifications that were previously received stop for a specific alert or for all alerts.
* The alert remains active in the Onyx Portal without any corresponding email notification.

**Possible Causes**

* No receiver is configured for the affected alert severity level. Alert notification emails are sent only to receivers configured for the corresponding alert severity level.
* Email notifications are disabled for the applicable alert rule.
* The alert instance is muted. Muting suppresses hourly repeat emails and the cleared notification for that specific alert instance.
* The recipient's email system is blocking or filtering notification emails.

**Actions**

1. Verify the alert receiver configuration — In **Alerts** > **Receivers** tab, verify that a receiver is configured for the affected alert severity (Critical, Major, Minor, Info, Notice, or Warning). If no receiver is configured for the affected severity, email notifications are not sent.
2. Verify the alert rule notification settings — In **Alerts** > **Alert Rules** tab, verify that the notification option is enabled for the applicable predefined alert.
3. Verify whether the alert instance is muted — In **Alerts > Active Alerts**, check whether the **Mute Alert** toggle is on for the affected alert instance. If it's on, hourly repeat emails and the cleared notification for that alert instance are suppressed. To resume notifications, set the toggle to off.
4. Check Spam and Junk folders — Verify that the notification email was not delivered to the receiver's Spam or Junk folder. If necessary, add the sender domain to the organization's allow list.

**Resolution**

The issue is resolved when alert notification emails are received within the expected timeframe whenever a qualifying alert is generated.

**Escalation**

Escalate to GXC Technical Support if receivers and alert rules are configured correctly, the alert is not muted, and email notifications are still not received. Provide the following information:

* Screenshot of the **Alerts** > **Receivers** tab showing the configured recipients and alert severity levels.
* Screenshot of the **Alerts** > **Alert Rules** tab showing the notification settings.
* Name and severity of the affected alert.

</details>

## Monitoring & Reporting

This section covers issues with viewing logs, analytics, and operational data.

<details>

<summary><strong>Logs Not Available in Onyx Portal</strong></summary>

**Symptoms**

Log entries are unavailable for an Onyx Edge or AP, or log queries fail to return results.

**Indicators**

* The **Logs** tab displays "**No data**" for the selected time range.
* Log queries fail, return an error, or time out.
* Expected log entries are not displayed for the selected equipment.

**Possible Causes**

* The selected log query time range exceeds the supported seven-day query window.
* The Onyx Edge is offline and cannot provide log data.

**Actions**

* Verify the Onyx Edge is online — In the Onyx Edge summary page, verify that the affected Onyx Edge's Online Status is green. If the Onyx Edge is offline, restore connectivity before attempting to retrieve logs.
* Verify the selected time range — In the Onyx Edge details page > **Logs** tab, or in the AP details page > **Logs** tab, select the **NR** or **Core** radio button. Verify that the selected time range is within the last seven days and does not exceed the seven-day query window.

**Resolution**

The issue is resolved when the requested log entries are successfully displayed for the selected equipment and time range.

**Escalation**

Escalate to GXC Technical Support if the Onyx Edge is online, the selected time range is valid, and log entries are still unavailable. Provide the following information:

* Onyx Edge name
* Onyx Edge version
* Screenshot of the Logs tab showing the selected equipment, time range, and any error message or empty results

</details>

<details>

<summary><strong>Analytics Graphs Showing No Data</strong></summary>

**Symptoms**

One or more Onyx Portal analytics dashboards do not display the expected metrics.

**Indicators**

* The **Analytics** page displays "**No data**" for the selected equipment or time range.
* Graphs are displayed but remain flat at zero.
* Expected analytics metrics are not displayed for the selected equipment or subscriber.

**Possible Causes**

* The Onyx Edge is not connected to the Onyx Portal, preventing analytics data from being collected.
* The selected time range does not contain analytics data or exceeds the supported 90-day retention period.
* Dashboard filters are configured for equipment or subscribers that have no associated analytics data.
* No UE were active during the selected time period. Some analytics metrics are generated only while subscriber sessions are active.
* The Onyx Edge software version does not support the selected analytics metric.
* The selected KPI is supported only on specific AP models or network types. For example:
  * 5G-only KPIs are available only for 5G deployments.
  * 4G-only KPIs are available only for 4G deployments.
* Per-subscriber radio metrics are available in the Subscriber details page > **Analytics** tab rather than the main Analytics dashboard.

**Actions**

1. Verify Onyx Edge connectivity — In the Onyx Edge summary page, verify that the affected Onyx Edge's Online Status is green. If the Onyx Edge is offline, restore connectivity and allow approximately 2–5 minutes for analytics data collection to resume.
2. Verify the selected time range:
   * Select a broader time range (for example, **Last 24 Hours** or **Last 7 Days**) and refresh the dashboard.
   * Analytics data is retained for up to 90 days. Custom queries cannot exceed the 90-day retention period.
   * If the most recent data point is zero, wait a few minutes and refresh the dashboard.
3. Clear the dashboard filters — Reset the AP, Subscriber, and Site filters to **All**. A filter set to a decommissioned AP or inactive subscriber returns no analytics data.
4. Verify subscriber activity — In the Subscriber summary page, verify whether any UE were active during the selected time period. Throughput and radio analytics are generated only while subscriber sessions are active.
5. Verify the selected analytics metric — Confirm that the selected AP model and network type support the requested KPI.
   * 5G-only KPIs (Cell SRS SNR, DL/UL BLER, RRC Success %, RACH Attempts, NGAP Dropped Connections) return no data when a 4G network is selected.
   * 4G-only KPIs (GPS Signal Availability, Dropped Call Rate) return no data when a 5G network is selected.
   * Per-subscriber radio metrics (DL RSRP, DL/UL MCS, DL/UL BLER, DL/UL Rank) are available in the Subscriber details page > **Analytics** tab > **Plots** tab > **5G Only KPIs**, rather than in the main Analytics dashboard.
6. Verify the Onyx Edge software version — Some analytics KPIs are available only in specific software releases. Compare the installed software versions with the applicable *Onyx Release Notes*.
   * (4G) In the Onyx Edge details page > **Overview** tab > **Onyx Edge Details** section, verify the **Version** parameter.
   * (5G) In the Onyx Edge details page > **Overview** tab > **Onyx Edge Details** section, verify the **NR Version** and **Core Version** parameters.

**Resolution**

The issue is resolved when the selected analytics dashboard displays the expected metrics for the selected equipment, subscriber, and time range.

**Escalation**

Escalate to GXC Technical Support if analytics data remains unavailable after verifying Onyx Edge connectivity, dashboard filters, supported KPIs, software versions, and the selected time range. Provide the following information:

* Onyx Portal version
* Onyx Edge version
* Screenshot of the affected Analytics dashboard showing the selected equipment, time range, applied filters, and missing metrics

</details>

### Subscriber Management

This section covers issues with subscriber administration and network assignment.

<details>

<summary><strong>Unable to Add a New Subscriber</strong></summary>

**Symptoms**

A new subscriber cannot be added to the selected network.

**Indicators**

* The **Add Subscriber** option is unavailable.
* The required SIM or eSIM is not available for selection.
* The subscriber cannot be created.

**Possible Causes**

* The required SIM or eSIM has not been provisioned.
* No unassigned SIMs or eSIMs are available for the selected network.
* The user does not have sufficient permissions to manage subscribers.

**Actions**

1. Verify user permissions — Confirm that the user account has permission to manage subscribers.
2. Verify SIM availability — Confirm an unassigned SIM or eSIM is available for the selected network.
3. Contact GXC Technical Support — If no unassigned SIMs or eSIMs are available, contact GXC Technical Support to provision additional subscriber credentials.

**Resolution**

The issue is resolved when the subscriber is successfully created and assigned to the selected network.

**Escalation**

Escalate to GXC Technical Support if subscriber provisioning cannot be completed or additional SIMs or eSIMs are required. Provide the following information:

* Network name
* Subscriber details
* Required SIM type (Physical SIM or eSIM)

</details>

<details>

<summary><strong>Subscriber Cannot Be Assigned to the Correct Network</strong></summary>

**Symptoms**

The subscriber appears in the Onyx Portal but cannot access the intended network.

**Indicators**

* The subscriber is assigned to an incorrect network.
* The intended network is unavailable during subscriber assignment.

**Possible Causes**

* The SIM or eSIM is assigned to a different network.
* The subscriber requires reassignment to the intended network.
* The selected APN is not available in the network.

**Actions**

1. Verify the subscriber's current network — In the Subscriber details page, verify that the subscriber is assigned to the intended network.
2. Verify the target network availability — Confirm that the intended network is available for subscriber assignment.
3. Verify APN availability — Confirm that the required APN is available and correctly configured in the selected network.

**Resolution**

The issue is resolved when the subscriber is assigned to the intended network.

**Escalation**

Escalate to GXC Technical Support if the subscriber cannot be assigned to the intended network. Provide the following information:

* Subscriber IMSI
* Current network
* Target network

</details>

<details>

<summary><strong>Subscriber Cannot Be Deleted</strong></summary>

**Symptoms**

A subscriber cannot be deleted from the Onyx Portal.

**Indicators**

* The delete subscriber option is unavailable.
* The subscriber remains assigned to a network.

**Possible Causes**

* The subscriber is currently assigned to an active network.
* The user account does not have sufficient permissions to delete subscribers.

**Actions**

1. Verify the subscriber assignment — Verify that the subscriber is no longer required.
2. Verify user permissions — Confirm that the user account has permission to delete subscribers.

**Resolution**

The issue is resolved when the subscriber is successfully deleted.

**Escalation**

Escalate to GXC Technical Support if the subscriber cannot be deleted after verifying the subscriber assignment and user permissions. Provide the following information:

* Subscriber IMSI
* Subscriber name
* Network name

</details>

### SIM/eSIM Activation & Connectivity

This section covers issues with SIM/eSIM activation and subscriber connectivity.

<details>

<summary><strong>Subscriber Cannot Attach After SIM/eSIM Activation</strong></summary>

**Symptoms**

The subscriber has been provisioned, but the UE cannot attach to the network.

**Indicators**

* The subscriber status remains disconnected.
* The UE displays "No Service" or "Searching."

**Possible Causes**

* The subscriber is inactive.
* The UE is configured with an incorrect PLMN or APN.
* IMEI verification prevents the UE from attaching.

**Actions**

1. Verify the subscriber status — In the Subscriber details page, verify that the subscriber status is active.
2. Verify the UE configuration — Confirm that the UE is configured with the correct PLMN and APN.
3. Verify IMEI verification — If IMEI verification is enabled, verify that the UE IMEI matches the IMEI configured for the subscriber.

**Resolution**

The issue is resolved when the UE successfully attaches to the network and the subscriber status is updated accordingly in the Onyx Portal.

**Escalation**

Escalate to GXC Technical Support if the subscriber cannot attach after verifying the subscriber status. Provide the following information:

* Subscriber IMSI
* UE IMEI
* Subscriber details
* APN configuration

</details>

<details>

<summary><strong>eSIM Activation Issues</strong></summary>

**Symptoms**

An eSIM cannot be installed or activated on the UE.

**Indicators**

* The QR code cannot be scanned.
* The eSIM installation fails.
* The eSIM is installed successfully, but the UE cannot attach to the network.

**Possible Causes**

* The eSIM profile was not installed successfully.
* The UE does not support the required eSIM functionality.
* The eSIM profile has not synchronized correctly.
* The eSIM is already enabled/activated on another UE and has not been deleted from that UE. An eSIM cannot be used on more than one UE at the same time.

**Actions**

1. Verify the QR code — Confirm that the correct QR code is being used for the intended subscriber.
2. Verify device compatibility — Confirm that the UE supports eSIM and meets the deployment requirements.
3. Retry the eSIM installation — Remove any incomplete eSIM profile from the UE, then repeat the eSIM installation using the same QR code.
4. Verify the eSIM is not active on another UE — If the eSIM was previously used on a different UE, it must first be deleted from that UE. A GXC Administrator must then reset the eSIM before it can be activated on the new UE.

**Resolution**

The issue is resolved when the eSIM is successfully installed and the UE successfully attaches to the network.

**Escalation**

Escalate to GXC Technical Support if the eSIM installation or activation continues to fail after verifying the QR code, device compatibility, and installation procedure. Provide the following information:

* Device make and model
* Subscriber IMSI
* ICCID (if available)

</details>


# Service Issues

This chapter provides troubleshooting information for service-affecting issues in GXC Onyx networks.

For Onyx Portal navigation paths and status indicator definitions, see [*Onyx Portal Navigation & Indicators Reference*](/docs/troubleshooting/onyx-troubleshooting-guide/onyx-portal-navigation-and-indicators-reference).

## UE Connectivity & Data Plane Issues

This section covers issues affecting UE connectivity, network registration, and data plane operations. These issues typically represent the highest-priority service-impacting conditions.

### UE Not Seeing Signal / UE Not Latching to Network

<details>

<summary><strong>Onyx AP Offline or Unable to Communicate with Onyx Edge</strong></summary>

**Symptoms**

UE displays "*No Service*" or "*Searching*" within a known coverage area.

**Indicators**

* Alerts: "AP Offline" alert (Major) is active.
* **Dashboard** > **Access Point** summary card: AP's Online Status is red.
* AP summary page and AP details page: AP's Online Status and Interface Status are red.
* Onyx Edge details page: The associated Onyx Edge Interface Status is red.

**Possible Causes**

* The AP has lost network connectivity to the Onyx Edge (cabling, switch port, or PoE issue).
* The AP has lost power or was unexpectedly power cycled.
* The AP has crashed or is otherwise unresponsive.

**Actions**

1. Verify AP Online Status — In the AP summary page or AP details page, confirm the AP's Online Status is green.
2. Ping the AP from the Onyx Edge — In the Onyx Edge details page, click **Actions** > **Ping**, select the **NR** filter, enter the AP's management IP address, then click **Ping**. The test verifies connectivity between the Onyx Edge and the AP and helps distinguish a network-layer issue from an AP-side fault before assuming a cabling or power issue. The result includes Average Response (ms), Error, Host or IP, and packet sent/received/transmitted counts.
3. Restart the AP — If the AP is offline, restart the AP and verify that it reconnects to the Onyx Portal.
4. Check the physical connection to the AP — Verify the following:
   * Cabling
   * Switch port
   * PoE/PoE++ delivery to the AP
5. Verify the interface status — Verify that both Onyx Edge Interface Status and AP Interface Status are green.

**Resolution**

The issue is resolved when all of the following conditions are met:

* AP Online Status returns to green.
* The AP reconnects to the Onyx Portal.
* The UE is able to detect the network.

**Escalation**

Escalate to GXC Technical Support if AP Online Status remains red after restart. Provide the following information:

* AP's serial number
* Active Onyx Portal alerts
* Onyx Edge diagnostic bundle
* AP Online Status

</details>

<details>

<summary><strong>AP Online but Not Broadcasting / RF Transmission Issue</strong></summary>

**Symptoms**

A UE displays "*No Service*" even though the AP appears to be online.

**Indicators**

* Alerts: One or more of the following alerts may be active:
  * "Cell Service Down"
  * "Timing Out of Sync"
  * "CBSD Registration Failure"
  * "SAS Connection Failure"
* AP summary page and AP details page: AP's Online Status is green, but Service Status is red or amber; Sync Status is red.
* (CBRS deployments) AP details page > **Overview** tab > **RAN** section > **SAS Status**: The **Registered**, **Granted**, and/or **Authorized** indicators are not green.
* (CBRS deployments) AP details page > **Logs** tab: **DP Logs** shows the actual CBSD-to-SAS message exchange, filterable by CBSD ID. On 4G APs, a separate generic **Logs** table (Timestamp/Severity/Message) is also available.

**Possible Causes**

* RF transmission is disabled, or the cell is not broadcasting
* The AP has lost PTP or GPS synchronization
* (CBRS deployments) The AP failed to obtain or maintain a SAS grant

**Actions**

1. Verify AP Service Status — In the AP summary page, verify that the AP's Service Status is green.
2. Verify Cell Transmit configuration — In the AP details page > **Overview** tab > **RAN** section, verify the following:

   * The **Transmit** parameter is set to **Enabled**.
   * The configured operating frequency is correct.
   * The configured transmit power matches the deployment requirements.

   If RF transmission is disabled, the UE will not detect the network.
3. Verify the AP's Sync Status — In the AP summary page or AP details page, verify the Sync Status. Also check **Alerts** > **Active Alerts** for the "Timing Out of Sync" alert.
4. (CBRS deployments only) Verify the SAS status:
   * In the AP details page > **Overview** tab > **RAN** section > SAS Status, verify that the **Registered**, **Granted**, and **Authorized** indicators are green.
   * Check **Alerts** > **Active Alerts** for the "CBSD Registration Failure" and "SAS Connection Failure" alerts.
   * Review the DP logs for the SAS grant request and response exchange.

**Resolution**

The issue is resolved when all of the following conditions are met:

* AP Online Status, Service Status, and Sync Status return to green.
* RF transmission is enabled with the correct frequency and power configuration.
* For CBRS deployments, SAS Status shows Authorized in green.
* The UE is able to detect the network.

**Escalation**

Escalate to GXC Technical Support if the AP's Service Status remains red with no configuration issue identified, or if the AP's Sync Status remains red after verifying the synchronization source. Provide the following information:

* AP vendor-assigned serial number
* Active Onyx Portal alerts details
* Onyx Edge diagnostic bundle
* AP Service Status
* AP Sync Status

(CBRS deployments only) Escalate to SAS vendor support if SAS grant failures persist after applying the workaround. Provide the following information:

* CBSD ID
* SAS Status screenshot
* Grant request and response logs
* SAS event logs (if available)

</details>

<details>

<summary><strong>UE Registration/Attach Rejected by Onyx Edge</strong></summary>

**Symptoms**

The UE detects the network but fails to attach or register, remaining in "*No Service*" or "*Searching*" despite adequate signal strength.

**Indicators**

* **Dashboard** > **Subscribers**: The subscriber count does not increment, and no active subscriber session is displayed.
* Subscriber summary page: The **Status** column does not show an active or connected state for the UE's IMSI.
* (4G) AP details page > **Overview** tab: The **Subscribers** panel does not list the UE.
* (5G) Onyx Edge details page > **Overview** tab: The **Subscribers** panel does not list the UE.
* Onyx Edge details page > **Events & Alerts** tab > **Events**: `attach_reject`, `attach_reject_imei_check` (4G), `registration_reject`, `session_rejected` (5G), or `ip_allocation_failure` events are recorded for the UE's IMSI.
* Onyx Edge details page > **Logs** tab (Core): 4G EMM Reject Cause Codes or 5G AMF Reject Cause Codes recorded for the attach or registration attempt.

**Possible Causes**

* The UE SIM is not provisioned in the Onyx Edge subscriber database.
* The subscriber is inactive or is not assigned a valid APN profile.
* The UE PLMN or APN configuration does not match the Onyx Edge network configuration.
* The Onyx Edge is rejecting the UE attach or registration request.

**Actions**

1. Verify subscriber provisioning — In the Subscriber details page, verify:
   * The IMSI is provisioned
   * The subscriber is active
   * A valid APN profile is assigned
2. Verify UE PLMN and APN configuration — Cross-check the following:
   * **PLMN**: In the Network details page > **Core** section, note the configured PLMN ID (e.g., "315 010"). Compare this against the first five to six digits of the subscriber's IMSI, displayed in the Subscriber details page. These digits represent the UE's provisioned PLMN (MCC+MNC) and should match the network's PLMN ID.
   * **APN**: In the Subscriber details page, confirm the APN matches the provisioned subscriber profile. An incorrect PLMN or APN configuration can prevent UE registration.
3. Check UE registration logs — In the Onyx Edge details page > **Logs** tab, select the **Core** radio button and review the 4G EMM Reject Cause Codes or 5G AMF Reject Cause Codes. Use the reject cause to determine whether the failure is related to subscriber provisioning, authentication, or network configuration.
4. Check attach or registration reject events — In the Onyx Edge details page > **Events & Alerts** tab > **Events** section, select the **Core** filter and look for `registration_reject`, `session_rejected`, or `ip_allocation_failure` events associated with the UE's IMSI.
5. Confirm manual network selection — If the UE is configured for automatic network selection, it may attempt to attach to a neighboring or incompatible network instead of the intended one. Disable automatic network selection on the UE and manually select the correct PLMN before continuing to troubleshoot.
6. Check for RAN connection-setup failure events — In the Onyx Edge details page > **Events & Alerts** tab > **Events** section, select the **NR** filter and look for `f1_ue_context_setup_failure` or `ng_initial_context_setup_failure` events.\
   A high volume of these events, rather than an isolated rejection, typically indicates connection-attempt resource exhaustion or a fronthaul or connection setup issue on the cell rather than a subscriber provisioning issue, and should be investigated separately from individual attach-reject cases.
7. Test with a known-good SIM — Replace the UE SIM with a known-good, provisioned GXC test SIM.
   * If the test SIM successfully attaches, the issue is likely related to the original SIM provisioning or UE configuration.
   * If the test SIM also fails, continue troubleshooting the network infrastructure.

**Resolution**

The issue is resolved when all of the following conditions are met:

* The UE detects the network
* The UE successfully attaches or registers
* An active subscriber session is visible in the Subscriber details page

**Escalation**

Escalate to GXC Technical Support if the known-good test SIM also fails to attach, indicating a network infrastructure issue. Provide the following information:

* Onyx Edge diagnostic bundle
* UE IMSI (if available)
* UE registration logs
* Active Onyx Portal alerts

</details>

<details>

<summary><strong>Insufficient RF Coverage or UE/Band Incompatibility</strong></summary>

**Symptoms**

The UE displays a weak signal, no signal, or is unable to detect the network on the configured operating band.

**Indicators**

* AP summary page and AP details page: AP's Online Status and Service Status are both green, ruling out AP-side faults.

**Possible Causes**

* Interference
* Insufficient RF coverage at the UE location because of distance, obstructions, or antenna placement.
* Incorrect antenna placement or antenna connections.
* The UE does not support the configured operating band.
* Incorrect cell frequency or transmit power configuration for the deployment.

**Actions**

1. Use Signal Analyzer to rule out interferencing frequencies, and change the frequencies accordingly.
2. For SAS deployments, use SAS portal or other available (third-party cellular network scanners, etc) means to verify neighboring frequencies and interferences.
3. If no interference is detected, measure the received signal strength (RSRP) at the UE location using the GXC Survey App or any UE diagnostic application tool.
4. If the measured signal level is below the recommended range, verify the following:
   * Antenna placement (is as per RF design recommendations, LOS obstructions, etc.)
   * Antenna connections (check the *AP Installation Guide* for cabling and cable connections)
   * Reposition the AP or UE if necessary
5. Verify UE band support — Confirm that the UE supports the operating frequency band configured on the AP.

{% hint style="info" %}
**NOTE**: 5G APs operate only in Single Carrier mode. Carrier Aggregation (CA) and Dual Connectivity (DC) modes are not supported.
{% endhint %}

**Resolution**

The issue is resolved when all of the following conditions are met:

* RSRP is within the acceptable range for the UE location.
* The UE successfully attaches on a supported band.

**Escalation**

Escalate to GXC Technical Support if RF coverage and operating band compatibility have been verified, but the UE still cannot attach, or if a coverage gap is identified that requires additional AP placement or RF design review. Provide the following information:

* AP vendor-assigned serial number
* Measured RSRP values and measurement location
* Antenna configuration details
* Active Onyx Portal alerts details

</details>

### Data Not Working

<details>

<summary><strong>PDN/PDU Session Not Established (No IP Address Assigned)</strong></summary>

**Symptoms**

The UE is attached to the network and displays signal strength, but no IP address is assigned, and the PDN/PDU session is either not established or is immediately terminated.

**Indicators**

* Subscriber details page > **Overview** tab:
  * **IP Address** — No IP address assigned.
  * PDN/PDU session is not established or is immediately terminated.
* On a commercial UE, the device typically shows signal bars but no data-connection icon (for example, no "4G"/"5G" indicator) when no IP address has been assigned.

**Possible Causes**

* Onyx Edge packet core misconfiguration preventing PDN/PDU session establishment.
* APN profile mismatch between the UE and the subscriber group's APN assignment.
* IP address pool exhausted in Onyx Edge DHCP/IP allocation.

**Actions**

1. Check PDN/PDU session — In the Subscriber details page > **Overview** tab, verify that a data session is active and an IP address has been assigned.
2. Verify APN profile — In the Subscriber Group details page > **APN**, verify the configured APN. Compare it with the APN configured on the UE. Even a single-character mismatch can prevent the PDN/PDU session from being established.
3. In VLAN deployments, verify the enterprise DHCP sever is configured correctly to assign IP addresses to the UE that are mapped to the corresponding APN.

**Resolution**

The issue is resolved when all of the following conditions are met:

* The UE has an active data session.
* An IP address is assigned.

**Escalation**

Escalate to GXC Technical Support if the PDN/PDU session is not established and no configuration issue has been identified. Provide the following information:

* Onyx Portal diagnostic bundle
* APN configuration export
* Subscriber details page screenshot showing session state and IP assignment

</details>

<details>

<summary><strong>Session Established but Data Traffic Fails</strong></summary>

**Symptoms**

The UE has an active data session and an assigned IP address, but application traffic fails, or a Subscriber Speed Test fails or returns 0 Mbps.

**Indicators**

* The UE must be in Connected mode (not Idle) with an assigned IP address; a UE in Idle mode will not produce a meaningful data-traffic test result.
* The UE displays signal strength and has an assigned IP address, but all application traffic fails.
* Subscriber Speed Test at `http://uespeedtest.gxc.io` fails or returns 0 Mbps.

**Possible Causes**

* Networking mode misconfiguration (NAT/Bridge mode mismatch) causes data traffic to fail even though the session is established.
* (VLAN deployments) Incorrect VLAN-to-DHCP mapping or VLAN-to-gateway routing prevents traffic from reaching the correct gateway.
* Firewall rules on the Onyx Edge or upstream enterprise firewall block traffic from the UE subnet.
* DNS is unreachable from the UE's assigned IP address.
* The Onyx Edge uplink interface (connection to enterprise LAN/WAN) is down.

**Actions**

Base checks (all deployments):

1. Run a Subscriber Speed Test — On the UE, open a web browser and navigate to `http://uespeedtest.gxc.io`. This test verifies the UE-to-Onyx Edge data path independently of Internet access. Test results, including uplink, downlink, jitter, RTT, are recorded in the Subscriber details page > **Overview** tab > **Speed Test Details** section.
2. Ping the UE from the Onyx Portal — Confirms the UE is reachable from the Onyx Edge, independently of internet access. If steps "Run a Subscriber Speed Test" and "Ping the UE from the Onyx Portal" both succeed, the UE-to-radio path is confirmed healthy; any remaining data-traffic failure is on the network/internet side, and the deployment-specific checks below apply.

For NAT deployments:

1. Verify the Networking Mode is set to NAT and matches the deployment design. In NAT mode, the UE cannot be pinged directly from an external enterprise server; rely on steps "Run a Subscriber Speed Test" and "Ping the UE from the Onyx Portal" above to confirm the UE-to-radio path.

For VLAN deployments:

1. Verify the enterprise DHCP server is mapped to the correct VLAN and is assigning IP addresses correctly (see [*PDN/PDU Session Not Established*](#pdn-pdu-session-not-established-no-ip-address-assigned)).
2. Ping the UE from the enterprise VLAN network — This confirms the enterprise-side path and is only applicable to VLAN deployments; NAT deployments cannot ping the UE directly from an external server.
3. Verify that VLAN-to-gateway routing is configured correctly so that traffic from the UE's VLAN reaches the correct gateway.

If steps "Run a Subscriber Speed Test" and "Ping the UE from the Onyx Portal" succeed but Internet access still fails:

1. Run an Internet speed test using a third party tool (for example, Ookla) to confirm whether the failure is Internet-specific rather than a base connectivity issue.
2. Check firewall rules for the UE subnet — Verify firewall rules on the Onyx Edge and upstream enterprise firewall permit traffic from the UE subnet. Refer to the *Firewall Configuration Application Note*.
3. Test DNS resolution from the UE — On the UE, run `nslookup` or `dig`. Verify that the DNS server configured in the APN profile is reachable and resolves DNS queries correctly from the UE's allocated IP address.
4. Capture traffic at the Onyx Edge data plane — Use the Onyx Edge CLI packet capture tools to verify that GTP-U/N3 user-plane traffic is flowing. Compare uplink and downlink traffic to determine which direction is affected.

**Resolution**

The issue is resolved when all of the following conditions are met:

* Data traffic flows successfully.
* A Subscriber Speed Test completes successfully.

**Escalation**

Escalate to GXC Technical Support if the Onyx Edge uplink has been verified and data traffic continues to fail with no firewall, DNS, or networking mode issue identified. Provide the following information:

* Onyx Portal diagnostic bundle
* Onyx Edge uplink interface status
* Subscriber details page screenshot showing the session state and IP address assignment

**Reference**

* *Firewall Configuration Application Note*
* *Networking Modes Application Note*

</details>

### Intermittent Connection Drops

<details>

<summary><strong>Poor Radio Conditions (No Handover Involved)</strong></summary>

**Symptoms**

The UE repeatedly loses connectivity even when it is not moving between coverage areas and no handover is involved.

**Indicators**

* Subscriber details page > **Events** tab: Detach or drop events are not correlated with handover events.
* (5G) Subscriber details page > **Analytics** tab > **Plots** tab: CQI and RSRP are degraded leading up to the drop.
* (4G) A UE diagnostic application reports degraded RSRP or CQI at the UE location leading up to the drop.

**Possible Causes**

* Poor radio conditions alone (weak signal, interference, or marginal RSRP/CQI) can cause a UE to intermittently drop even with no mobility or handover involved.

**Actions**

1. Check the Events log for handover correlation — In the Subscriber details page > **Events** tab, confirm whether the drop coincides with a handover attempt. If it does not, treat the drop as a radio-quality issue rather than a handover issue.
2. Check radio quality graphs —&#x20;
   * (5G) In the Subscriber details page > **Analytics** tab > **Plots** tab, review CQI and RSRP.
   * (4G) Use a UE diagnostic application to check RSRP and CQI at the UE location. Degraded CQI or RSRP leading up to a drop indicates a radio-quality issue rather than an equipment fault.

**Resolution**

The issue is resolved when the UE maintains a stable session with no unexpected drops, and CQI/RSRP remain within the expected range in the Subscriber details page > **Analytics** tab > **Plots** tab.

**Escalation**

Escalate to GXC Technical Support if connection drops continue after confirming poor radio conditions with no handover correlation and no equipment or configuration issue identified. Provide the following information:

* Subscriber details page > **Analytics** tab > **Plots** tab screenshot showing the CQI/RSRP trend
* Subscriber details page > **Events** tab screenshot showing drop timestamps
* Active Onyx Portal alerts details

</details>

<details>

<summary><strong>Handover Failure Between APs</strong></summary>

**Symptoms**

The UE repeatedly loses connectivity while moving between coverage areas served by neighboring APs.

**Indicators**

* Subscriber details page > **Events** tab: UE detach and reattach events coincide with AP handover attempts.
* **Alerts** > **Active Alerts**: Handover-related alerts correlate with connection drop timestamps.

**Possible Causes**

* Coverage gaps or poor RF conditions prevent successful handovers between neighboring APs.

**Actions**

1. Check UE session history — In the Subscriber details page > **Events** tab, verify whether the connection drops coincide with AP handover attempts.
2. Check for AP-level alerts during connection drops — In **Alerts** > **Active Alerts**, filter the alerts by the connection drop timestamps and look for handover-related alerts.

**Resolution**

The issue is resolved when the UE maintains a stable session during handovers, with no unexpected detach events in the Subscriber details page > **Events** tab.

**Escalation**

Escalate to GXC Technical Support if connection drops continue with no AP alerts or configuration issues identified. Provide the following information:

* Active Onyx Portal alert details
* Subscriber details page > **Events** tab screenshot showing the connection drop timestamps

</details>

<details>

<summary><strong>(5G) RF Interference / Radio Link Failure (5G TDD Band)</strong></summary>

**Symptoms**

A UE connected to a 5G network experiences intermittent connection drops with no correlation to handovers or equipment status.

**Indicators**

* Subscriber details page > **Events** tab: Connection drops occur with no correlation to handover or detach events.
* No corresponding AP, Mesh Node, or FHM status indicator is red/amber.

**Possible Causes**

* (5G) High interference in the TDD band causes intermittent Radio Link Failures (RLFs).

**Actions**

1. Run Spectrum Analyzer — External interference in the TDD band can increase the noise floor, resulting in intermittent Radio Link Failures (RLFs) and session drops. Refer to the *5G Spectrum Analyzer Application Note* to perform a spectrum scan.

**Resolution**

The issue is resolved when all of the following conditions are met:

* The spectrum scan shows no significant interference.
* Connection drops no longer occur.

**Escalation**

Escalate to GXC Technical Support if connection drops continue with no AP alerts or configuration issue identified. Provide the following information:

* Active Onyx Portal alerts details
* Spectrum scan results

**Reference**

* *5G Spectrum Analyzer Application Note*

</details>

<details>

<summary><strong>Mesh Node / FHM Backhaul Link Degradation</strong></summary>

**Symptoms**

All UE served through a specific Mesh Node or FHM lose connectivity simultaneously or experience intermittent connectivity, rather than a single UE being affected.

**Indicators**

* Status Indicators: The Mesh Node or FHM status indicators are red or amber during the connection drops.

**Possible Causes**

* (4G) Onyx Mesh backhaul link instability interrupts connectivity for all UE served through the affected Mesh Node.
* (5G) FHM fiber or synchronization loss causes connected RUs to go offline.

**Actions**

1. (4G Mesh deployments) Check Mesh Node link health — In the Mesh Node details page, review the Interface Status indicator.

   * A red Interface Status indicates the GRE tunnel is unavailable.
   * An amber Interface Status indicates the Mesh Node is online, but the Mesh AP is offline.

   A degraded mesh backhaul link can cause all downstream UE to disconnect. Reposition the Mesh Node if the signal quality is low.
2. (5G FHM deployments) Verify FHM status — In the FHM summary page or FHM details page, verify that the FHM's Online Status, Interface Status, and Sync Status indicators are green.\
   A red Sync Status indicates that the FHM is out of synchronization, affecting all connected RUs.
3. (5G) Inspect the fiber connections and SFP modules — Dirty or damaged fiber connector ends are a common cause of intermittent fronthaul packet loss and brief (roughly 1–30 second) service glitches. Inspect the fiber connector ends for contamination or damage, and clean or replace them as necessary.\
   Verify that the installed SFP modules are compatible with the FHM and AP hardware. Where possible, use vendor-approved single-mode SFP+ modules.\
   In previous deployments, replacing a copper SFP with a fiber SFP+ module has resolved recurring intermittent connectivity issues.
4. (5G) Verify PTP transport compatibility — Verify that the AP firmware version supports the configured PTP transport mode. \
   PTP-over-Ethernet in Single Carrier mode is the recommended and supported configuration. Some PTP transport modes are not supported on older AP firmware versions and require a firmware upgrade rather than a configuration change.
5. (5G) Correlate packet loss with logs — In the Onyx Edge details page > **Logs** tab, filter by the logs for the fronthaul management service and review packet loss events. Correlate the event timestamps with the reported service interruptions to confirm that the fronthaul link is the source of the issue before escalating.

**Resolution**

The issue is resolved when all of the following conditions are met:

* Mesh Node or FHM status indicators are green.
* All previously affected UE maintain stable sessions.

**Escalation**

Escalate to GXC Technical Support if Mesh Node link degradation is confirmed and repositioning does not resolve the issue, or if an FHM synchronization failure persists after rebooting the FHM. Provide the following information:

* FHM and AP serial numbers (FHM-related issues)
* Mesh Node topology screenshot (Mesh-related issues)

**Reference**

* *4G Mesh Node Application Note*

</details>

<details>

<summary><strong>Onyx Edge Process Restart or Watchdog Recovery</strong></summary>

**Symptoms**

All UE at the site briefly lose connectivity simultaneously and then recover without any AP, Mesh Node, or FHM reporting a persistent fault.

**Indicators**

* **Alerts** > **Active Alerts**: No AP/Mesh/FHM-specific alerts correspond to the connection drop. The outage is brief and affects the entire site.

**Possible Causes**

* An Onyx Edge process restart or Watchdog recovery causes a temporary core network outage.

**Actions**

1. Check the Onyx Edge process health — In the Onyx Edge summary page or Onyx Edge details page, verify the Service Status indicator. A red Service Status indicates that a critical service has gone down or restarted more than three times in the last five minutes, which can result in a brief service interruption for all attached UE.

**Resolution**

The issue is resolved when all of the following conditions are met:

* The Onyx Edge Service Status is green.
* No further site-wide brief service interruptions occur.

**Escalation**

Escalate to GXC Technical Support if the Onyx Edge's Service Status remains red or if repeated service restarts recur. Provide the following information:

* Active Onyx Portal alerts details
* Onyx Edge diagnostic bundle

</details>

<details>

<summary><strong>UE Idle Timer Mismatch</strong></summary>

**Symptoms**

A single UE repeatedly detaches and reattaches, while no other UE connected to the same AP are affected, and no AP, Mesh Node, FHM, or Onyx Edge status indicator is red.

**Indicators**

* Subscriber details page > **Events** tab: Repeated attach and detach events are recorded for a single UE, with no corresponding alerts or equipment status changes.

**Possible Causes**

* A mismatch between the UE idle timer (T3412/T3412-ext) and the Onyx Edge configuration causes unexpected UE detach events.

**Actions**

1. Check UE session history — In the Subscriber details page > **Events** tab, verify that the detach pattern is isolated to the affected UE and occurs periodically, indicating an idle timer mismatch rather than an RF or equipment-related issue.

**Resolution**

The issue is resolved when the UE maintains a stable attached session with no unexpected detach events.

**Escalation**

Escalate to GXC Technical Support if the periodic detach pattern persists after confirming that no RF or equipment-related issue exists. Provide the following information:

* Subscriber details page > **Events** tab screenshot showing drop timestamps
* UE make/model
* UE timer configuration (if available)

</details>

<details>

<summary><strong>CBRS SAS Grant Expiry During Active Session</strong></summary>

**Symptoms**

In a CBRS deployment, the UE repeatedly and intermittently loses connectivity to a specific AP, recovering after several minutes each time, and the AP periodically reports SAS-related alerts.

**Indicators**

* **Alerts** > **Active Alerts**: One or more of the following alerts may be active, indicating SAS grant renewal activity:
  * "CBSD Registration Failure"
  * "SAS Connection Failure"
* AP details page > **Overview** tab > **RAN** section > SAS Status: Authorized indicator is not green.

**Possible Causes**

* The SAS is frequently changing the CBRS grant's frequency or power parameters. Each grant change causes the Onyx Edge to push a new configuration to the AP and reboot it, which briefly disconnects all UE served by that AP until it comes back online (typically a few minutes). This differs from a single grant expiry, which would leave the AP offline rather than intermittently cycling.

**Actions**

1. Check the CBRS SAS grant status — In the AP details page > **Overview** tab > **RAN** section > SAS Status, verify whether the Authorized indicator is green. Also, check **Alerts** > **Active Alerts** for "CBSD Registration Failure" and "SAS Connection Failure" alerts over time, which indicate recurring grant changes rather than a single expiry event.
2. Verify the CBSD certificates and identifiers — Verify the following:
   * The CBSD SAS CA certificate, CBSD certificate, and CBSD key are valid and have not expired.
   * The FCC ID and serial number configured on the AP match the values registered with the SAS.
   * For Category B CBSDs, Certified Professional Installer (CPI) validation has been completed. An incomplete CPI validation prevents CBSD registration regardless of certificate validity.
3. Verify connectivity to the SAS server — Verify that the Onyx Edge can resolve and connect to the configured SAS provider. Confirm that DNS resolution is working and that outbound connectivity on the required port is available. A SAS grant failure that appears to be an expired grant can also result from the Onyx Edge being unable to communicate with the SAS.
4. Consider requesting an alternate frequency channel — If the SAS grant has been denied or terminated because of incumbent activity or interference on the current channel, requesting a different frequency channel for the CBSD may restore transmission more quickly than waiting for the incumbent condition to clear.

**Resolution**

The issue is resolved when all of the following conditions are met:

* SAS Status shows Authorized in green.
* No further grant-related connection drops occur.

**Escalation**

Escalate to the SAS Vendor Support if SAS grant renewal failures persist. Provide the following information:

* CBSD ID
* SAS Status screenshot
* Grant request and response logs
* SAS event logs (if available)

</details>

### Low Data Throughput or Poor Performance

<details>

<summary><strong>Poor RF Conditions or Interference</strong></summary>

**Symptoms**

A single UE experiences low throughput while other UE on the same AP perform normally.

**Indicators**

* Alerts:
  * "PHC2SYS Offset is too High" or "TS2PHC Offset is too High" alerts (Warning, Onyx Edge (NR)), or "Early eCPRI Packets," "Late eCPRI Packets," or "eCPRI Rx Down" alerts (Warning, Onyx Edge (NR)), are active. Any of these can indicate a timing or fronthaul condition that degrades throughput and RF KPIs even when the radio link itself looks otherwise healthy.
  * "Cell High DL BLER" or "Cell High UL BLER" alerts (Warning, fires when BLER exceeds 50% for at least 15 minutes) are active.
  * "Insufficient SAS Power" alert (Major) is active — Indicates the SAS granted power is below the AP hardware minimum and transmission has been disabled as a result.
* (5G) Subscriber details page > **Analytics** tab > **Plots** tab > **5G Only KPIs**: Review the full KPI set — DL and UL RSRP, CQI, DL and UL MCS, DL and UL BLER, and DL and UL Rank — rather than downlink metrics alone. Reviewing all graphs helps identify whether the uplink or the downlink is affected before proceeding to *Actions*.
* (4G) A UE diagnostic application reports low RSRP at the UE location.

**Possible Causes**

* Poor RF conditions reduce RSRP or SINR, resulting in a lower Modulation and Coding Scheme (MCS) and reduced throughput.
* (5G) External interference in the TDD band increases the noise floor, reducing SINR and MCS.
* (5G, G105/G505 deployments) MIMO rank degradation — persistent RI=1 on a 4T4R radio typically indicates antenna placement, polarization, or obstruction issues.
* Poor timing synchronization or fronthaul packet loss can degrade throughput and RF-related KPIs independently of RF conditions.
* (Multi-Cell deployments) Two or more cells configured with the same operating frequency can cause self-interference.
* (Multi-Port deployments) Overlapping coverage between adjacent sectors can degrade performance for a UE located within the overlap zone, even when the antennas are correctly oriented.
* Insufficient line of sight, significant RF reflections, or distance beyond the expected range for the configured frequency and power can limit signal quality independently of any hardware, software, or configuration issue.

**Actions**

1. Check RF signal quality for the affected UE — Review the full KPI set described above (both link directions), not DL metrics alone, to determine which link is affected and narrow down the likely cause.
   * (5G) In the Subscriber details page > **Analytics** tab > **Plots** tab > **5G Only KPIs**, review DL/UL RSRP, DL/UL MCS, DL/UL BLER, and DL/UL Rank. Low RSRP or SINR below 10 dB significantly reduces MCS and throughput. Persistent RI=1 on a 4T4R radio typically indicates an antenna placement, polarization, or obstruction issue.
   * (4G) Use a UE diagnostic application to measure RSRP at the UE location.
2. Check for timing and fronthaul alerts — In **Alerts** > **Active Alerts**, check for "PHC2SYS Offset is too High," "TS2PHC Offset is too High," "Early eCPRI Packets," "Late eCPRI Packets," and "eCPRI Rx Down" alerts. Any of these firing can also account for degraded throughput or KPIs and should be ruled out alongside RF conditions.
3. Check for BLER and SAS power alerts — In **Alerts** > **Active Alerts**, check for "Cell High DL BLER," "Cell High UL BLER" (Warning), and "Insufficient SAS Power" (Major). Any of these confirm the condition seen in the KPI graphs rather than requiring a manual read of the raw BLER values.
4. (5G) Run Spectrum Analyzer to check for external interference in the TDD band. Refer to the *5G Spectrum Analyzer Application Note* for performing and interpreting a spectrum scan on the affected RU.
5. Identify high-uplink-consumption UE — When uplink throughput or UL BLER issues affect multiple UE on a cell rather than a single UE, review the per-UE uplink PRB utilization for the affected cell.
   * For each UE with high uplink resource utilization, review the following: RSRP, SINR, UL MCS, Throughput, BLER/HARQ retransmissions, and Power headroom.
   * A UE located near the cell edge with poor signal quality can consume a disproportionate amount of uplink resources, reducing throughput for other UE on the same cell. In this case, additional AP coverage in the weak-signal area is a more effective solution than further RF tuning of the existing cell.
6. Verify the AP transmit power and SAS grant — Verify that the AP transmit power has not been reduced below the configured or supported value for the deployed AP model. Also, verify whether the current SAS grant provides the full authorized bandwidth or has been reduced (for example, following a Carrier Aggregation-to-Single Carrier transition).\
   A reduced SAS grant can produce symptoms similar to RF coverage or interference issues. If the AP is not already transmitting at its maximum supported power, consider increasing the transmit power in incremental steps to determine whether higher power improves signal quality.\
   Skip this step if the AP is already at maximum power, or if the SAS grant is confirmed to be limiting available power. In the AP details page > **Overview** tab > **RAN** section, check **Preferred Max Pwr (dBm)**.
7. Verify multi-cell frequency configuration — In multi-cell deployments, verify that each cell is configured with a distinct operating frequency. The Onyx Portal does not currently prevent two or more cells from being configured with the same frequency; if this occurs, the cells can interfere with each other, which may appear as interference in a spectrum scan even though no external signal is involved.
8. Verify multi-port antenna orientation — In multi-port deployments, verify that antennas are oriented orthogonally to each other. Some coverage overlap between adjacent sectors is expected even with correct orientation; a UE located within an overlap zone may experience degraded performance as a result of this expected overlap rather than a fault.
9. Verify the UE's physical location and line of sight — If no interference is detected and the AP is transmitting at or near its maximum power but signal quality remains poor, verify the UE's location: confirm line of sight to the AP, check for an environment with significant RF reflections or obstructions, and confirm the UE is within the expected coverage distance for the configured frequency and power. Reduced signal quality at long range, given the configured frequency and power, can be an expected result of distance rather than an issue requiring resolution.
10. Physically inspect the antenna installation — As a final step, once all other causes have been ruled out, verify the antenna's mechanical and electrical installation: antenna direction, antenna gain, and antenna connections. This step typically requires an on-site technician.

**Resolution**

The issue is resolved when all of the following conditions are met:

* The UE achieves throughput consistent with the configured subscriber QoS profile.
* Confirm the expected performance with a Subscriber Speed Test.

**Escalation**

Escalate to GXC Technical Support if throughput remains degraded after verifying RF signal quality and checking for interference. Provide the following information:

* Subscriber details page > **Analytics** tab screenshot (**Plots** > **5G Only KPIs**, if applicable)
* AP placement and antenna details

**Reference**

* *5G Spectrum Analyzer Application Note*

</details>

<details>

<summary><strong>(4G) Carrier Aggregation Issues</strong></summary>

**Symptoms**

A 4G UE on a G100/G101/G501 AP is not getting the expected Carrier Aggregation (CA) throughput. This may present as CA never activating, or as throughput that correlates with frequent CA activation/deactivation cycles rather than a hard connectivity drop.

**Indicators**

* **Analytics** page: CA KPIs for the affected AP indicate that CA is not activating, or show frequent CA activation and deactivation cycles.

**Possible Causes**

* GXC 4G APs (G100/G101/G501) support two-component Carrier Aggregation (2CC CA) to increase peak throughput. CA may fail to activate, or may activate and deactivate frequently, for the reasons below — in either case, throughput will be lower than the expected CA-enabled level.

**Actions**

1. Verify both carriers are enabled — In the AP details page > **Overview** tab > **RAN** section, confirm that both the primary and secondary carrier are configured and set to **Transmit**: Enabled. If the secondary carrier is disabled, CA cannot activate regardless of RF conditions.
2. Check the secondary carrier's SAS grant status (CBRS deployments) — In the AP details page > **Overview** tab > **RAN** section > SAS Status, verify that the **Registered**, **Granted**, and **Authorized** indicators are green for the secondary carrier. CA cannot activate without an active grant on the secondary carrier.
3. Confirm UE CA capability — Verify the UE supports 2CC Carrier Aggregation and the specific band combination configured on the AP.
4. Check RF signal quality on the secondary carrier — Poor signal on the secondary carrier alone can prevent activation even when it is enabled and granted. Poor or marginal RF conditions on the secondary carrier can also cause the system to deactivate it automatically once active, producing the frequent activation/deactivation cycles described above; this is expected system behavior in response to degraded conditions, not a fault.
5. Check CA stability — In the Analytics page, review the CA KPIs for the affected AP. Frequent CA activation and deactivation indicate RF instability that may require AP repositioning or transmit power adjustments.

**Resolution**

The issue is resolved when all of the following conditions are met:

* CA activates as expected and remains stable.
* Throughput reaches the expected CA-enabled level, and no longer correlates with CA state changes.

**Escalation**

Escalate to GXC Technical Support if CA does not activate despite confirmed correct AP and UE configuration, or if instability persists after repositioning or transmit power adjustments. Provide the following information:

* Analytics page PRB/CA KPI export for the affected AP
* AP placement and antenna details
* Active Onyx Portal alerts details

</details>

<details>

<summary><strong>(5G) Cell Congestion / Uplink Bandwidth Saturation (High PRB Utilization)</strong></summary>

**Symptoms**

Multiple UE on the same AP experience reduced throughput simultaneously, or all UE across the site share a throughput ceiling that matches the enterprise WAN capacity regardless of radio performance.

**Indicators**

* **Analytics** page (AP-level): **DL PRB Utilization** or **UL PRB Utilization** remains consistently above 80% for the serving AP. PRB Utilization is available only at the AP level and is not displayed in the Subscriber details page > **Analytics** tab.
* Site-wide throughput is consistently limited to the known enterprise WAN bandwidth, independent of RF conditions or Physical Resource Block (PRB) utilization — this points to the Onyx Edge uplink rather than cell congestion (see *Actions*).

**Possible Causes**

* Cell congestion caused by too many UE competing for the available PRBs on the serving AP.
* Onyx Edge uplink bandwidth saturation — The enterprise WAN connection, rather than the radio network, limits throughput.

**Actions**

1. Check the AP PRB utilization — In the **Analytics** page, review the **DL PRB Utilization** and **UL PRB Utilization** for the affected AP. PRB utilization consistently above 80% indicates cell congestion. Consider adding additional APs or redistributing subscribers across neighboring cells to reduce the load on the affected AP.
2. If PRB utilization is within normal range but throughput is limited site-wide to a value consistent with the enterprise WAN capacity, test the Onyx Edge uplink independently. Run iPerf3 between the Onyx Edge and an enterprise server. If the enterprise uplink is the bottleneck, UE throughput cannot exceed the available WAN bandwidth regardless of radio performance.

**Resolution**

The issue is resolved when all of the following conditions are met:

* PRB utilization returns to a sustainable level, or the Onyx Edge uplink is confirmed not to be the bottleneck (or the enterprise WAN capacity is increased to meet the required throughput).
* Throughput for the affected UE returns to the expected level.

**Escalation**

Escalate to GXC Technical Support if PRB utilization is low but throughput remains degraded, with no RF or QoS issue identified, or if the uplink bandwidth is confirmed saturated and the available WAN capacity cannot be increased. Provide the following information:

* Analytics page PRB utilization export for the affected AP

</details>

<details>

<summary><strong>QoS Policy Misconfiguration (MBR Limiting)</strong></summary>

**Symptoms**

Throughput is consistently capped at a fixed rate for a subscriber or subscriber group, regardless of RF conditions or cell load.

**Indicators**

* The observed throughput consistently matches the configured Maximum Bit Rate (MBR) rather than varying with RF conditions or PRB utilization.

**Possible Causes**

* QoS policy misconfiguration causes the configured MBR to limit subscriber throughput.

**Actions**

1. Check subscriber QoS profile — In the Subscriber Group details page, review the following parameters:

   * Aggregate BW (Upload)
   * Aggregate BW (Download)
   * QoS Category

   An overly restrictive MBR limits subscriber throughput regardless of RF conditions. Refer to the *QoS Management Application Note*.

**Resolution**

The issue is resolved when the UE achieves throughput consistent with the intended subscriber QoS profile.

**Escalation**

Escalate to GXC Technical Support if throughput remains below the configured MBR after profile correction. Provide the following information:

* Subscriber group QoS profile details

**Reference**

* *4G Onyx QoS Management Application Note*

</details>

<details>

<summary><strong>Backhaul Bottleneck (Mesh Node)</strong></summary>

**Symptoms**

All UE served through a specific Mesh Node experience reduced throughput simultaneously, rather than a single UE being affected.

**Indicators**

* Reduced throughput is observed across all UE served by the same Mesh Node, rather than being isolated to a single UE.

**Possible Causes**

* Onyx Mesh backhaul capacity is insufficient, reducing the aggregate throughput available to all downstream UE.

**Actions**

* Check Mesh Node backhaul capacity — Review the Mesh Node Interface Status and backhaul link health. The combined throughput of all UE served by the Mesh Node is limited by the available wireless backhaul capacity.
* (5G) A fronthaul-side problem does not present as a distinct "bottleneck" indicator today — it is more likely to appear as poor BLER on the affected UE rather than as a throughput ceiling. If RF conditions and interference have already been ruled out (see Poor RF Conditions or Interference) and BLER remains poor with no other explanation, capture the Analytics plot and contact GXC Technical Support to review fronthaul-side logs; this data is not currently exportable to customers.

**Resolution**

The issue is resolved when all of the following conditions are met:

* Backhaul capacity is no longer the limiting factor.
* Throughput for the affected UE returns to the expected level.

**Escalation**

Escalate to GXC Technical Support if a Mesh Node backhaul bottleneck is confirmed and cannot be resolved by redistribution, or if a fronthaul-side issue is suspected per the note above. Provide the following information:

* Mesh Node's vendor-assigned serial number
* Analytics page throughput export for affected UE

</details>

## Network Outage & Equipment Offline Issues

This section covers equipment-level outages — Access Points, Mesh Nodes, Onyx Edge, and FHM going offline — as distinct from the UE-experience symptoms above.

<details>

<summary><strong>Onyx Edge Offline / Service Down</strong></summary>

**Symptoms**

One or more Onyx Edge components are offline or unavailable, resulting in a site-wide service outage.

**Indicators**

* Alerts: One or more of the following alerts may be active:
  * "Onyx Edge (Core) Offline" (Critical)
  * "Onyx Edge (NR) Offline" (Critical)
  * "Onyx Edge (Core/NR) Service Down" (Critical)
  * "HA Peer Down" (Major)
* Status Indicators: Onyx Edge's Online Status is red.
* All APs and UE at the site lose connectivity simultaneously.

**Impact**

An Onyx Edge outage affects all connected APs, FHMs, and Mesh Nodes. As a result, all attached UE lose service simultaneously. This represents the highest-priority equipment outage.

**Possible Causes**

* Loss of management-plane connectivity between the Onyx Edge and the Onyx Portal.
* One or more critical services have stopped or are repeatedly restarting.
* Disk utilization exceeds 70% on Onyx Edge (Core) / >80% on Onyx Edge (NR), causing the file system to enter read-only mode.
* Both Onyx Edge nodes in an HA pool were rebooted simultaneously, resulting in service initialization or port allocation conflicts.
* The MeshMgr process failed after changing the Mesh Node Assignment Subnet in an HA deployment.
* Physical fronthaul link failure while Interface Status incorrectly remains green (known 5G limitation).
* The Onyx Edge has been added to the Onyx Portal, but the physical equipment has not yet been deployed, resulting in a false offline alert.

**Actions**

1. Check the Online Status and Interface Status — In the Onyx Edge summary page, verify the Online Status and Interface Status.\
   Hover over the Interface Status icon to view:
   * The number of AMF-connected APs
   * The N6 IP address
   * The last reporting time
2. Verify N6 reachability — Ping the Onyx Edge's N6 IP address from the next hop connecting to it. This confirms whether the Onyx Edge is reachable from the network before checking anything else.
3. If the N6 address is reachable, check whether the underlying server or VM is up — for a physical server, confirm the server is powered on; for a VM-based deployment, log in to the hypervisor/host and confirm the VM is in a running state.
4. Run network diagnostics — Log in to the Onyx Edge as *agw\_user* and run *network\_check\_summary.sh* to identify connectivity, DNS, or interface issues between the Onyx Edge and the internet/enterprise network.
5. Restart services from the Onyx Portal — In the Onyx Edge details page, click **Actions** > **Restart Services**. All UE connectivity is interrupted while services restart. Service recovery typically takes 2-5 minutes.
6. Reboot the Onyx Edge — If restarting services does not resolve the issue, reboot the Onyx Edge. Allow approximately 5-10 minutes for the system to restart and for associated APs to reconnect.
7. If the Onyx Edge is reachable but still shown offline in the Onyx Portal, collect diagnostic bundle — In the Onyx Edge details page, click **Actions** > **Trigger Debug Information Collection**. After collection completes, click **Actions** > **List Debug Information Files in OE** to retrieve the diagnostic bundle.

   <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> If the Onyx Edge is completely offline, the <strong>Actions</strong> menu may be unavailable. In this condition, <strong>Restart Services</strong>, <strong>Reboot</strong>, and <strong>Trigger Debug Information Collection</strong> are unavailable. A physical power cycle or on-site intervention is required. If remote or on-site access is unavailable, escalate the issue to GXC Technical Support.</p></div>
8. Check for simultaneous HA pool reboot issue — If both Onyx Edge nodes in an HA pool were rebooted simultaneously, critical services may fail to initialize because of port allocation conflicts. Contact GXC Technical Support before performing additional restart or reboot operations.

**Resolution**

The issue is resolved when all of the following conditions are met:

* The Onyx Edge Online Status, Service Status, and Compute Resource indicators show healthy values.
* All associated APs, FHMs, and Mesh Nodes return to an operational state.

**Escalation**

Escalate to GXC Technical Support if the Onyx Edge remains offline after completing the recovery procedures, or if HA pool service failures continue after recovery attempts. Provide the following information:

* Onyx Edge name
* Onyx Edge software version
* Service Status screenshot
* Compute Resource values
* Diagnostic bundle

</details>

<details>

<summary><strong>Mesh Node Offline</strong></summary>

**Symptoms**

A Mesh Node is offline or unavailable.

**Indicators**

* Alerts: "Mesh Node Offline" alert (Critical) is active.
* Status Indicators: Mesh Node's Online Status is red.
* Excessive alert notification emails are generated because of status fluctuations during periods of high backhaul utilization.

**Dependency**

A Mesh Node outage causes its associated Mesh AP(s) to become unavailable. Always resolve the Mesh Node issue before troubleshooting the Mesh AP — see *Mesh AP Offline*.

**Possible Causes**

* Loss of management-plane connectivity between the Mesh Node and the Onyx Edge.
* CPE-CBSD grant unavailable — The Mesh Node is waiting for a SAS grant.
* Cellular modem failure.
* Watchdog-triggered power cycle following a critical service failure.
* High wireless backhaul utilization causes temporary status fluctuations (known limitation).

**Actions**

1. Check whether the Mesh AP (backhaul UE) is connected — In the Dashboard > Subscribers view, check whether the mesh backhaul UE is shown as connected. Because the Mesh Node itself is offline, this is the minimum check available from the Onyx Portal; none of the CLI-based diagnostics below apply until the Mesh Node is back online.
2. If the backhaul UE is not connected, check its event history — In the Subscriber details page > **Events** tab for the backhaul UE, check whether it is frequently cycling between attached and disconnected states. Frequent cycling indicates a link-level issue rather than a one-time outage.
3. Check the backhaul link quality — During periods of high backhaul utilization, the Mesh AP status may fluctuate (known limitation).\
   Review the backhaul signal quality.
4. Check the Mesh Node CPE status — Connect to the Mesh Node using SSH and run `sudo meshcli cpe_status`. Verify that:
   * The Mesh Node is connected to the intended AP.
   * The reported RSRP is better than -90 dBm.
5. Check the backhaul RSRP in the Onyx Portal — As an alternative to the CLI method above, review the reported RSRP in the Mesh Node details page > **Analytics** tab > **Backhaul Status Details**.
6. Check CPE-CBSD grant status — Review the output of `journalctl -fu magma@cped`. Messages such as "*No channel available*" or "*Grant is not available*" indicate that the Mesh Node is waiting for a SAS grant.
7. Verify the GRE tunnel status — If the Mesh Node Interface Status is red, verify that the GRE tunnel between the Mesh Node and Mesh AP has been successfully established.
8. Run modem recovery commands — Use the following commands as appropriate:
   * `meshcli cpe_reset` — Reboots the modem.
   * `cpe_register` — Forces a registration retry.
   * `cpe_connect` — Attempts to establish the backhaul connection. Use this command only when the modem is Registered and the `cpe_controller` service is not running.
9. Review the Watchdog service status — Critical service failures trigger an automatic power cycle and generate a "Watchdog Powercycle" alert (Minor) that includes the service failure description.
10. Verify Mesh Node-AP Affinity *(if configured)* — If an Allowed Cell is configured, verify that:
    * The preferred cell provides an RSRP better than -90 dBm.
    * Neighboring or undesired cells remain below -110 dBm.
11. Check recovery after a Gateway AP reboot — A Mesh Node typically reconnects within two minutes after the Gateway AP restarts. If recovery takes longer, verify:
    * The GRE tunnel
    * The CPE connection
    * That Mesh AP transmission has not been intentionally disabled

**Resolution**

The issue is resolved when all of the following conditions are met:

* The Mesh Node's Online Status and Interface Status are green.
* The associated Mesh AP's Service Status returns to green.

**Escalation**

Escalate to GXC Technical Support if the Mesh Node remains offline after completing the recovery steps, or if the GRE tunnel cannot be established. Provide the following information:

* Mesh Node's vendor-assigned serial number
* CLI diagnostic output
* Onyx Portal alerts export

Escalate to the SAS Vendor Support if CPE-CBSD grant failures persist. Provide the following information:

* CBSD ID
* Grant request logs (if a CPE-CBSD grant failure has been confirmed)

**Reference**

* *4G Mesh Node Application Note*

</details>

<details>

<summary><strong>Mesh AP Offline</strong></summary>

**Symptoms**

A Mesh AP is offline or is unavailable while its parent Mesh Node is online.

**Indicators**

* Status Indicators: The Mesh AP's Service Status is red, or the Mesh AP appears offline, while the parent Mesh Node's Online Status is green.

**Dependency**

If the parent Mesh Node is also offline, resolve *Mesh Node Offline* first — a Mesh Node outage always takes its Mesh AP down with it.

**Possible Causes**

* GRE tunnel between the Mesh Node and the Mesh AP has not been established.
* Mesh AP transmission has been intentionally or unintentionally disabled.

**Actions**

1. Confirm the parent Mesh Node is online — In the Mesh Node details page, verify that the Mesh Node's Online Status and Interface Status are green. The Mesh AP cannot be online unless its parent Mesh Node is online.
2. The same base checks as [*Access Point Offline*](#access-point-offline) apply to the Mesh AP itself (physical connectivity, power, and portal registration/serial number verification).
3. Verify the GRE tunnel status — If the Mesh Node Interface Status is red, verify that the GRE tunnel between the Mesh Node and Mesh AP has been successfully established.

**Resolution**

The associated Mesh AP's Service Status returns to green.

**Escalation**

Escalate to GXC Technical Support if the Mesh AP remains offline after confirming the parent Mesh Node is online and completing the base AP checks.

</details>

<details>

<summary><strong>Access Point Offline</strong></summary>

**Symptoms**

The AP has no management-plane connectivity to the Onyx Edge — it does not appear online in the Onyx Portal at all.

**Indicators**

* Alerts: Access Point "Management Plane Offline" alert (Major) is active.
* Status Indicators: AP's Online Status is red (or grey).

{% hint style="info" %}
**NOTE:** An AP's Online Status indicates management-plane connectivity and changes to red after approximately 5 minutes of connectivity loss.
{% endhint %}

**Possible Causes**

* The AP is offline, in an alert state, or unable to register with the Onyx Edge.
* The AP was added to the Onyx Portal with an incorrect MAC address or serial number, or was not associated with the correct Onyx Edge.
* The AP has been added to the Onyx Portal, but the physical hardware has not yet been deployed, resulting in a false offline alert.

**Actions**

When an AP is truly offline (no management-plane connectivity), most Onyx Portal-based and CLI-based diagnostics do not apply — there is no *network\_check\_summary.sh* equivalent for a node, and IP reachability can only be checked after logging into the NR or Core, which itself requires the AP to be reachable. The customer-actionable checks are limited to the following two:

1. Verify the AP was added correctly in the Onyx Portal — Confirm the correct MAC address and/or serial number was entered when the AP was added, and that it is associated with the correct Onyx Edge. A mismatched serial number or MAC address will prevent the AP from ever coming online, independent of any physical issue.
2. Check the physical connection to the AP — Verify cabling, switch port, and PoE/PoE++ delivery to the AP. This confirms the physical layer is intact but cannot confirm reachability from the Onyx Edge.

If both checks pass and the AP is still offline, the remaining diagnosis (e.g., confirming actual IP reachability from the network side) requires GXC Technical Support — escalate.

**Resolution**

The issue is resolved when the AP's Online Status returns to green.

**Escalation**

Escalate to GXC Technical Support if the AP remains offline after confirming correct portal registration and physical connectivity. Provide the following information:

* AP's vendor-assigned serial number
* Active alert details
* Onyx Edge diagnostic bundle

</details>

<details>

<summary><strong>Cell Service Down</strong></summary>

**Symptoms**

The AP is online (management-plane connectivity is established) but is not providing cellular service — it is not transmitting, or is transmitting when it should not be. Applies to both 4G and 5G APs.

**Indicators**

* Alerts:
  * "Cell Service Down" alert (Major) is active — The AP cell has not transmitted for at least 15 minutes.
  * "Cell Unwarranted Transmission" alert (Major) is active — The AP is transmitting when it should not be.
  * (5G) "Multiport Cell Service Down" alert (Major) is active — The AP has stopped transmitting because multiport transmission is disabled while transmission is still desired.
* The UE cannot detect the network from the affected AP, even while within the expected coverage area.

{% hint style="info" %}
**NOTE:** An AP's Online Status indicates management-plane connectivity and changes to red after approximately 5 minutes of connectivity loss. Service Status indicates the RF transmission state. An AP can report a green Online Status while Service Status is red. Always verify both indicators. A red Sync Status can also prevent RF transmission even when Online Status and SAS Status are healthy.
{% endhint %}

**Possible Causes**

* Service Status is red because RF transmission is configured as Enabled, but the radio is not transmitting.
* The CBRS SAS grant has expired or could not be obtained.
* Sync Status is red because the AP has lost PTP or GPS synchronization.
* IPSec tunnel failure prevents the AP from re-establishing management-plane connectivity.
* A PLMN or TAC mismatch between the AP and the Onyx Edge configuration prevents the SCTP association from being established.
* (4G) SCTP connection failure in Dual Carrier deployments with SAS enabled.
* (5G) Multiport transmission is disabled while RF transmission is still required.

#### Actions

1. Check for scheduled maintenance — In the Onyx Portal header, click the Notifications icon to verify that no scheduled maintenance is in progress that explains the outage.
2. Check the AP Online and Service Status — In the AP summary page, verify both the Online Status and Service Status. If the Online Status is grey, first resolve the associated Onyx Edge connectivity issue before continuing.
3. Verify the physical-layer indicators:
   * AP's power LED is steady green, confirming PoE or AC power is being supplied correctly.
   * Cell LED behavior:

     * A slow flash indicates that the cell is activated
     * A fast flash indicates active data transmission

     The absence of either can point to a power or hardware issue before deeper investigation is needed.
   * The backhaul Ethernet cable is securely connected.
   * The switch port is active.
4. Verify PLMN and TAC configuration — Verify that the PLMN and TAC configured on the AP match the values configured on the Onyx Edge. A mismatch can prevent the SCTP association between the AP and Onyx Edge from being established, causing the AP to appear offline in the Onyx Portal.
5. Ping the AP from the Onyx Edge — In the Onyx Edge details page, click **Actions** > **Ping**, select the **NR** filter (or **CORE**, if testing the core-side path), enter the AP's management IP address, then click **Ping**.\
   A successful result confirms network-layer connectivity between the Onyx Edge and the AP, helping isolate the issue to the AP, its RAN configuration, or the local switch or VLAN rather than the Onyx Edge.  The result includes Average Response (ms), Error, Host or IP, and packet sent/received/transmitted counts.
6. (CBRS deployments) Check the SAS grant status — In the AP details page > **Overview** tab > SAS Status, verify that the **Registered**, **Granted**, and **Authorized** indicators are all green.
7. Check AP Sync Status — In the AP details page, verify the Sync Status. If the Sync Status is red, verify that the GPS antenna or upstream PTP clock source is connected and operating correctly.
8. Check fronthaul/eCPRI interface status on Onyx Edge — In the Onyx Edge details page, verify the Interface Status. A red status indicates that no APs are AMF-connected or that the N6 interface is unavailable.
9. Check the AP RAN Transmit configuration — In the AP details page > **Overview** tab > **RAN** section, verify that the **Transmit** parameter is set to **Enabled**. If transmission was disabled unintentionally, re-enable it.
10. Check IPSec tunnel status — Verify that the IPSec tunnel is established. If the initial IKE negotiation times out, the AP may not automatically retry. Restart the AP to initiate a new IPSec connection if needed.
11. (4G) Check SCTP connection for Dual Carrier with SAS — If one carrier loses SAS authorization, the SCTP connection may terminate after several minutes. As a workaround, disable SAS and then re-enable SAS for the affected AP through the RAN settings.
12. (5G) Check Multi-Port transmission status — If the "Multiport Cell Service Down" alert (Major) is active, verify whether multi-port transmission was intentionally disabled. If not, re-enable it via the AP's RAN configuration.
13. Reboot the AP — In the AP details page, click **Actions** > **Reboot**. Allow approximately 2-5 minutes for the AP to restart and reconnect.
14. If the AP repeatedly transitions between online and offline rather than remaining persistently offline:

    * Inspect fiber cable ends for contamination or damage
    * Confirm SFP modules are compatible with the AP hardware

    This behavior typically indicates a physical-layer or backhaul issue rather than a configuration or software issue.
15. Collect a diagnostic bundle from the Onyx Edge — In the Onyx Edge details page, click **Actions** > **Trigger Debug Information Collection**. After the collection completes, to retrieve the diagnostic bundle, click **Actions** > **List Debug Information Files in OE**.

**Resolution**

The issue is resolved when all of the following conditions are met:

* The AP's Online Status and Service Status are green.
* The AP is transmitting and serving one or more connected UE.

**Escalation**

Escalate to GXC Technical Support if the AP's Service Status remains red after completing the recovery steps, or if IPSec connectivity cannot be restored. Provide the following information:

* AP's vendor-assigned serial number
* Active alert details
* Onyx Edge diagnostic bundle

Escalate to the SAS Vendor Support if SAS grant failures persist. Provide the following information:

* CBSD ID
* SAS status screenshot
* Grant request and response logs (if SAS grant issue has been confirmed)

#### Reference

* *4G & 5G Firewall Configuration Application Note*

</details>

<details>

<summary><strong>(4G) AP Sync / Timing Not Working</strong></summary>

**Symptoms**

A 4G AP is unable to maintain synchronization with its configured timing source. On 4G, the PTP source is external to the AP, so the customer can additionally check the reachability and status of that external PTP Grandmaster clock.

**Indicators**

* Alerts:&#x20;
  * "Timing Out of Sync" alert (Major) is active.
  * "GPS Signal Not Available" alert (Major) is active.
  * "PHC2SYS TS2PHC Offset Is Too High" or "TS2PHC Offset Is Too High" alerts (Warning) are active.
* Status Indicators:
  * AP's Service Status is red, with no SAS or connectivity issue identified.
  * AP's Sync Status is red or amber.
  * Onyx Edge's Sync Status is red.
* The UE cannot detect or camp on the cell even though the AP is online and SAS authorization is available.

**Possible Causes**

* The external PTP Grandmaster clock is unreachable or unstable.
* The GPS antenna is disconnected, damaged, or does not have an unobstructed view of the sky.
* An unsupported synchronization mode is configured for the deployment (for example, unsupported Dual Carrier/Carrier Aggregation scenarios).
* The AP Management URL is configured with a hostname instead of an IP address, causing DNS resolution failures that appear as synchronization issues.

**Actions**

1. Check AP Sync Status — In the AP summary page or AP details page, review the Sync Status indicator.
2. Verify the sync mode configuration — Verify that the configured synchronization mode is supported for the deployment.
   * PTP over Ethernet in Single Carrier mode is the recommended configuration.
   * PTP over UDP is not supported.
   * When performing handover testing, use GNSS synchronization.
3. Check GPS antenna and cabling — If the "GPS Signal Not Available" alert (Major) is active, inspect the GPS antenna, cabling, and connectors, and confirm the antenna has an unobstructed view of the sky.
4. Check the PTP source — Verify that the external PTP Grandmaster clock is operational and reachable. "PHC2SYS Offset is too High" and "TS2PHC Offset is too High" alerts (Warning) indicate the synchronization offset has exceeded the acceptable threshold.&#x20;
5. Check the AP Management URL configuration — Verify it is configured with the Onyx Edge IP address rather than a hostname.
6. Reboot the AP — If the PTP source has been verified and synchronization has not recovered, reboot the AP to initiate a new PTP synchronization process.

**Resolution**

The issue is resolved when all of the following conditions are met:

* The AP's Sync Status is green.
* The AP resumes RF transmission.
* The UE can successfully detect and attach to the cell.

**Escalation**

Escalate to GXC Technical Support if synchronization cannot be restored after verifying the GPS source, PTP path, and AP configuration. Provide the following information:

* AP serial number
* Sync Status screenshot
* Active alert details

</details>

<details>

<summary><strong>(5G) AP Sync / Timing Not Working</strong></summary>

**Symptoms**

A 5G AP is unable to maintain synchronization with its timing source. On 5G, this source is normally the AP's own internal grandmaster clock (the DU acts as its own grandmaster) rather than an external PTP source, except when GNSS synchronization is used. As a result, the customer cannot check PTP source reachability the way they can on 4G — see *4G AP Sync / Timing Not Working*.

**Indicators**

* Alerts:&#x20;
  * "Timing Out of Sync" alert (Major) is active.
  * "GPS Signal Not Available" alert (Major) is active. This alert can be generated at the AP level or at the Onyx Edge (NR) level.
  * "PHC2SYS TS2PHC Offset Is Too High" or "TS2PHC Offset Is Too High" alerts (Warning) are active.
* Status Indicators:
  * AP's Service Status is red, with no SAS or connectivity issue identified.
  * AP's Sync Status is red or amber.
  * Onyx Edge's Sync Status is red.
* The UE cannot detect or camp on the cell even though the AP is online and SAS authorization is available.

**Possible Causes**

* The GPS antenna is disconnected, damaged, or does not have an unobstructed view of the sky (GNSS-synchronized deployments).
* An unsupported synchronization mode is configured for the deployment (for example, PTP over UDP is not supported; PTP over Ethernet in Single Carrier mode is the recommended and only supported configuration).
* The AP's internal PTP/timing service has stopped.

**Actions**

1. Check AP Sync Status — In the AP summary page or AP details page, review the Sync Status indicator. Verify that the AP has successfully synchronized with its configured PTP or SyncE source.
2. Verify the sync mode configuration — Verify that the configured synchronization mode is supported for the deployment.
   * PTP over Ethernet in Single Carrier mode is the recommended configuration.
   * PTP over UDP is not supported.
   * When performing handover testing, use GNSS synchronization.
3. (GNSS-synchronized deployments) Check the GPS antenna and cabling — If the "GPS Signal Not Available" alert (Major) is active, whether generated by the AP or the Onyx Edge (NR), inspect the GPS antenna, cabling, and connectors, and confirm the antenna has an unobstructed view of the sky.
4. Check whether the AP's internal timing service is running — If the Sync Status shows the timing service itself is down (rather than a GPS or configuration issue), this requires GXC Technical Support to investigate; there is no further customer-side check available today.
5. Reboot the AP — If the synchronization source has been verified and synchronization has not recovered, reboot the AP to initiate a new synchronization process.

**Resolution**

The issue is resolved when all of the following conditions are met:

* The AP's Sync Status is green.
* The AP resumes RF transmission.
* The UE can successfully detect and attach to the cell.

**Escalation**

Escalate to GXC Technical Support if synchronization cannot be restored after verifying the GPS source and AP configuration. Provide the following information:

* AP serial number
* Sync Status screenshot
* Active alert details

</details>

<details>

<summary><strong>General Networking / Firewall Issues</strong></summary>

**Symptoms**

The Onyx equipment cannot communicate with the Onyx Portal or the enterprise network, or is online but specific functionality (logs, speed test) is not working as expected.

**Indicators**

* Status Indicators:&#x20;
  * Equipment's Online Status is red.
  * Onyx Edge's N6 Interface Status is red.
  * Equipment repeatedly transitions between Online and Offline. See the equipment-specific offline sections above for detailed troubleshooting.
* Logs: `network_check_summary.sh` reports connectivity, DNS, routing, or interface failures.
* Equipment is online, but logs do not appear in the Onyx Portal — this can indicate the dedicated log port is blocked, since logs are carried on a separate port from general management traffic.
* Equipment is online, but a Subscriber Speed Test or backhaul speed test does not work — this can indicate the speed test port is blocked.

  &#x20;

**Possible Causes**

* Required firewall ports or traffic flows are blocked between the Onyx equipment and the Onyx Portal. Most management-plane traffic runs on port 443; logs and speed test functionality each use a separate, dedicated port, so a firewall that allows port 443 but blocks the other ports can still result in equipment showing online while logs or speed tests fail.
* The Onyx Edge N6 interface does not have a valid IP address.
* The on-premises security key has expired, preventing management-plane authentication.

**Actions**

1. If logs are not appearing, or a speed test is not working, while the equipment otherwise shows online, contact GXC Technical Support for the current required port list to verify with your network/firewall team.
2. Check Onyx Edge N6 interface status — Hover over the Onyx Edge Interface Status icon and verify that:
   * An N6 IP address is assigned.
   * The Reporting Time is recent.
3. Run comprehensive network diagnostics — Connect to the Onyx Edge using SSH and run `network_check_summary.sh`. Review the output for connectivity, interface, routing, and DNS failures.
4. Check management plane connectivity — Run `checkin_cli.py`. A response of "Success!" confirms that management-plane connectivity to the Onyx Portal is functioning correctly.
5. Check the on-premises security key — If the on-premises security key has expired, contact GXC Technical Support to obtain a replacement. Do not attempt to modify or regenerate the security key manually.

**Resolution**

The issue is resolved when all of the following conditions are met:

* All affected equipment report Online Status as green, and logs and speed test functionality work as expected.
* *network\_check\_summary.sh* completes without reporting connectivity, interface, routing, or DNS failures.

**Escalation**

Escalate to GXC Technical Support if:

* Specific ports have been confirmed open with GXC Technical Support and the issue persists.
* Management-plane connectivity cannot be restored.
* Network diagnostics continue to report failures after completing the troubleshooting steps.

Provide the following information:

* Onyx Edge NR/Core software version
* `network_check_summary.sh` output
* Interface Status screenshot

**Reference**

* *4G & 5G Firewall Configuration Application Note*

</details>


# Onyx Portal Navigation & Indicators Reference

This chapter defines the navigation terminology and status indicator conventions used throughout this guide.

### Onyx Portal Summary & Details Page Navigation

The Onyx Portal provides summary and details pages for several managed resources, including each equipment (Onyx Edge, Access Points, Mesh Nodes, FHMs, and DAS), networks, venues, subscribers, subscriber groups, etc. The following navigation terminology is used throughout this guide:

* Network
  * Networks summary page: Click the ![](https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F1IO6LJxSckyiFVXKHeZJ%2Fimage.png?alt=media\&token=13f3485e-c0e3-4298-8653-ae35ac3c9edc) (Network Switcher) icon
  * Network details page:
    * **Network** (opens the currently selected network's details)
    * Networks summary page > in **Actions** column, click the ⋮ (Options) icon > click **View**
* Venue
  * Venues summary page: **Venues**
  * Venue details page: **Venues** > click venue's name
* Equipment
  * Onyx Edge summary page:&#x20;

    * (5G) **Equipment** > **Onyx Edge (NR+Core)** tab
    * (5G) **Equipment** > **Onyx Edge (Core)** tab
    * **Equipment** > **Onyx Edge** tab

    In 5G networks, the tab names depend on the deployed Onyx Edge type(s).
  * Onyx Edge details page: **Equipment** > Onyx Edge summary page > click Onyx Edge's name
  * AP summary page: **Equipment** > **Access Point** tab
  * AP details page: **Equipment** > **Access Point** tab > click AP's name
  * Mesh Node summary page: **Equipment** > **Mesh Node** tab
  * Mesh Node details page: **Equipment** > **Mesh Node** tab > click Mesh Node's name
  * (5G) FHM summary page: **Equipment** > **FHM** tab
  * (5G) FHM details page: **Equipment** > **FHM** tab > click FHM's serial number
  * (4G) DAS summary page: **Equipment** > **DAS** tab
  * (4G) DAS details page: **Equipment** > **DAS** tab > click DAS' name
* Subscriber
  * Subscriber summary page: **Subscribers** > **Subscriber** tab
  * Subscriber details page: **Subscribers** > **Subscriber** tab > click subscriber's **IMSI**
  * Subscriber group summary page: **Subscribers** > **Subscriber Groups** tab
  * Subscriber group details page: **Subscribers** > **Subscriber Groups** tab > click group's name
* Traffic
  * APN summary page: **Traffic** > **APNs** tab.
  * APN details page: **Traffic** > **APNs** tab > click the APN ID. This opens to the APN edit page.
  * Applications summary page: **Traffic** > **Applications** tab.
  * Application Groups summary page: **Traffic** > **Application Groups** tab.
* Administrator — The Onyx Portal Administrator interface, available only to GXC Administrators and GXC Partner Administrators.
  * To switch to the Administrator interface — In the upper-right corner of the page, click the current Onyx Portal account's name, then click **Select GXC Root**. (GXC Partner Administrators switch by selecting their own partner account instead of GXC Root.)

### Onyx Portal Status Indicators

This section describes the different Onyx Portal status indicators referred to throughout this troubleshooting guide.

#### Access Point Status Indicators

**AP Online Status**

Verify in the AP summary page or AP details page.

<table><thead><tr><th width="149.5555419921875">Indicator</th><th>Description</th></tr></thead><tbody><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FRYtaZyUxRKXbM2bTEYQR%2Ficon-online-status-green.png?alt=media&amp;token=66e8fdf7-c8b8-45cd-9791-627dd8a95249" alt=""> (green)</td><td>AP has checked in with Onyx Portal within the last 5 minutes.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FK6FvgiD6CBnHq0y6m3Ed%2Ficon-online-status-red.png?alt=media&amp;token=784d477f-01a8-408d-909d-851b9c08e776" alt=""> (red)</td><td>AP has not checked in with Onyx Portal within the last 5 minutes, or the last reported time is older than 5 minutes.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FwBS0NFnslhiCVfxlYuLE%2Ficon-online-status-grey.png?alt=media&amp;token=606dac0f-2055-47a2-8084-d6ea8fabf662" alt=""> (grey)</td><td>Associated Onyx Edge is offline.</td></tr></tbody></table>

**AP Interface Status**

Verify in the AP summary page or AP details page.

<table><thead><tr><th width="150.6666259765625">Indicator</th><th>Description</th></tr></thead><tbody><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F7qAWNgl8xYgE2OKngTTj%2Ficon-interface-status-green.png?alt=media&amp;token=6d4d73eb-8afa-4113-a0d5-bd7388acb3a0" alt=""> (green)</td><td>AP fronthaul interface is connected.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0YMKcRoJ5fqmVmsbtIHt%2Ficon-interface-status-red.png?alt=media&amp;token=29ea5369-aa1f-4bc7-8b20-c34fb4026c86" alt=""> (red)</td><td>AP fronthaul interface is disconnected.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FLN4AVrHXfJA34oHaFkug%2Ficon-interface-status-grey.png?alt=media&amp;token=c5d337c6-ba55-4944-be16-a260c2b568d1" alt=""> (grey)</td><td>AP is offline, or the fronthaul interface status is unavailable.</td></tr></tbody></table>

**AP Sync Status**

Verify in the AP summary page or AP details page.

<table><thead><tr><th width="149.5555419921875">Indicator</th><th>Description</th></tr></thead><tbody><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FMjFm3bEl9uHvYdNjFJES%2Ficon-ipsec-status-green.png?alt=media&amp;token=87732d18-c80c-4337-ba5d-916c26dbad19" alt=""> (green)</td><td>AP is in sync with the clock source.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FVjcS2effzrsuaFWSH9b4%2Ficon-ipsec-status-amber.png?alt=media&amp;token=8d177361-c468-4006-997b-52eb88248e3b" alt=""> (amber)</td><td>AP sync with the clock source is degraded.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FPVNbRcmXcwgB1agg3474%2Ficon-ipsec-status-red.png?alt=media&amp;token=58548228-8f42-434a-8565-b4e9929e6317" alt=""> (red)</td><td>AP is not in sync with the clock source. PTP or GPS synchronization has been lost, preventing normal cell transmission.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FNVQtZxGAvhLD3FNddf7Q%2Ficon-ipsec-status-grey.png?alt=media&amp;token=dcf0b66a-ea53-4722-89bb-61570d6417dc" alt=""> (grey)</td><td>Any of the following conditions: the AP is offline; the Onyx Edge associated with the AP is offline; the AP's Sync Mode is set to Free Running; or the AP's sync status is not available.</td></tr></tbody></table>

{% hint style="info" %}
**NOTE**: If the AP Sync Mode is set to Free Running, the AP will always display grey and will not achieve synchronization regardless of the clock source.
{% endhint %}

**AP Service Status**

Verify in the AP summary page or AP details page.

<table><thead><tr><th width="150.3333740234375">RF Tx Desired</th><th width="150.1112060546875">RF Tx Actual</th><th width="125.22216796875">Indicator</th><th>Cell State</th></tr></thead><tbody><tr><td>On</td><td>On</td><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fe3SttFDSZJyhwmhGUtyv%2Ficon-service-status-green.png?alt=media&amp;token=0bec1b10-d5e9-4892-b448-3d5ceee72622" alt=""> (green)</td><td>Healthy</td></tr><tr><td>On</td><td>Off</td><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fo577pHEBD6HBOm6cZ6SG%2Ficon-service-status-red.png?alt=media&amp;token=844b4b7f-b4df-472a-a745-7c472fb0aab2" alt=""> (red)</td><td>Service Down</td></tr><tr><td>Off</td><td>On</td><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FU28zqoZhBLDCzYSCtTf9%2Ficon-service-status-amber.png?alt=media&amp;token=fab7c887-25b9-4ec1-8148-a6f76b175ab3" alt=""> (amber)</td><td>Unwarranted Transmission</td></tr><tr><td>Off</td><td>Off</td><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FUv0sUysPOM2DrnPNUWFQ%2Ficon-service-status-grey.png?alt=media&amp;token=2dc2221a-9752-499c-84ce-efff333631fb" alt=""> (grey)</td><td>Shutdown, the AP is offline, or the associated Onyx Edge is offline.</td></tr></tbody></table>

**AP SAS Status (CBRS deployments only)**

Verify in the AP details page.

| Indicator  | Green                                     | Amber                                                    | Red                       | Grey                     |
| ---------- | ----------------------------------------- | -------------------------------------------------------- | ------------------------- | ------------------------ |
| Registered | All CBSDs are registered.                 | Some CBSDs are registered, some are not.                 | No CBSDs are registered.  | —                        |
| Granted    | Required number of grants are available.  | Some grants are available, but not the required number.  | No grants are available.  | No CBSDs are registered. |
| Authorized | Required number of grants are authorized. | Some grants are authorized, but not the required number. | No grants are authorized. | No grants are available. |

* All indicators green: AP has full spectrum authorization and can transmit normally.
* Any indicator amber: AP has partial spectrum authorization. Transmit capability may be reduced or unavailable depending on the grant state.
* Any indicator red: AP cannot transmit.

#### (5G) Onyx Edge Status Indicators

**Onyx Edge Online Status**

Verify in the Onyx Edge summary page or Onyx Edge details page.

<table><thead><tr><th width="149.5555419921875">Indicator</th><th>Description</th></tr></thead><tbody><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FjXFrNZdMXuvYxHUVbi1O%2Ficon-online-status-green.png?alt=media&amp;token=063a384f-9224-4d01-b125-70417050c2f7" alt=""> (green)</td><td>Onyx Edge has checked in with Onyx Portal within the last 5 minutes.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Ftfx03KRESM3qpd58JjSl%2Ficon-online-status-red.png?alt=media&amp;token=0aecf1f1-70ef-4360-9c6e-c4067249b697" alt=""> (red)</td><td>Onyx Edge has not checked in with Onyx Portal within the last 5 minutes.</td></tr></tbody></table>

**Onyx Edge Interface Status**

Verify in the Onyx Edge summary page or Onyx Edge details page.

<table><thead><tr><th width="149.5555419921875">Indicator</th><th>Description</th></tr></thead><tbody><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FhrEz7Lh22i6ODp4rVMZ0%2Ficon-interface-status-green.png?alt=media&amp;token=6e6c2969-cbf7-407c-82fe-9e0dd009567e" alt=""> (green)</td><td>All APs are AMF-connected to the Onyx Edge, the N6 interface is up and has an IP address, and the N6 link is active.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FiSsHfaDWDyRhSbAMubmJ%2Ficon-interface-status-amber.png?alt=media&amp;token=6cd34b64-bbec-4cdc-952f-db1af58fd0a0" alt=""> (amber)</td><td>At least one AP is AMF-connected, but some are not. The N6 interface is up and has an IP address, and the N6 link is active.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FAMIvAr0AbY1svkzhgy8J%2Ficon-interface-status-red.png?alt=media&amp;token=1d466e75-c742-4968-82e0-d71834e16eb5" alt=""> (red)</td><td>None of the APs are AMF-connected (all APs are AMF-disconnected or management-disconnected), or the N6 interface is not up or not active.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F1aFL1GrdLUjj3yQ8u4Jp%2Ficon-interface-status-grey.png?alt=media&amp;token=dc271906-ff14-48a6-a670-7545229ff4b5" alt=""> (grey)</td><td>Onyx Edge is offline.</td></tr></tbody></table>

**Onyx Edge Service Status**

Verify in the Onyx Edge summary page or Onyx Edge details page.

<table><thead><tr><th width="149.5555419921875">Indicator</th><th>Description</th></tr></thead><tbody><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0U6nN7uyQl0TW17wpXzq%2Ficon-service-status-green.png?alt=media&amp;token=0a46a0dd-4919-4066-8593-4576683f6fe9" alt=""> (green)</td><td>All critical services are up and running, no critical services were restarted in the last 5 minutes, and the Interface Status is green.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FSRaiS8yeWdguVKDHFFPy%2Ficon-service-status-amber.png?alt=media&amp;token=d530e263-4dc3-4c7f-9abb-3e0b4a574521" alt=""> (amber)</td><td>All critical services are up and running, but critical services have restarted up to three times in the last 5 minutes, and the Interface Status is green or amber.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0Wd8RwGwLdsokqpANep9%2Ficon-service-status-red.png?alt=media&amp;token=ac2a2469-ce1a-4877-b3b2-d308c4ec9936" alt=""> (red)</td><td>A critical service has gone down in the last 5 minutes, critical services have restarted more than three times in the last 5 minutes, or the Interface Status is red.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F9wTgB2zePZx2wmqCKP4a%2Ficon-service-status-grey.png?alt=media&amp;token=25ca617f-99b8-4e74-b2e7-911e6fe42c05" alt=""> (grey)</td><td>Onyx Edge is offline, or data is not available.</td></tr></tbody></table>

**Onyx Edge Sync Status**

Verify in the Onyx Edge summary page or Onyx Edge details page.

<table><thead><tr><th width="149.5555419921875">Indicator</th><th>Description</th></tr></thead><tbody><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fs51BfALxKDAJZamVhNdm%2Ficon-ipsec-status-green.png?alt=media&amp;token=88d97fb3-890d-45df-94e4-b3051f05ce5f" alt=""> (green)</td><td>Onyx Edge is in sync with the timing source.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8l4uFFwkjrzyTQ4o2Lmy%2Ficon-ipsec-status-red.png?alt=media&amp;token=5c0386f0-0771-4f36-baf7-d31645a64bd2" alt=""> (red)</td><td>Onyx Edge is out of sync with the timing source.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FAUYhRhHdqDwbNa7dAa51%2Ficon-ipsec-status-grey.png?alt=media&amp;token=f06e1961-56c2-47ca-ade8-f2af4b139ccd" alt=""> (grey)</td><td>Onyx Edge is offline, or sync status is not available.</td></tr></tbody></table>

**Onyx Edge Compute Resource**

Verify in the Onyx Edge summary page or Onyx Edge details page.

<table><thead><tr><th width="150.6666259765625">Indicator</th><th>Description</th></tr></thead><tbody><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fpj13oSXkKT3F1M7mObZV%2Ficon-compute-resource-status-green.png?alt=media&amp;token=73795d11-c53e-4c6f-9b9b-0b008984cdbb" alt=""> (green)</td><td>All parameters (CPU, memory, disk) are below 50%.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJyBCaV2DfPD6XUmWzTbf%2Ficon-compute-resource-status-amber.png?alt=media&amp;token=9cc6dc3e-91ff-4d33-a699-82699e8a772e" alt=""> (amber)</td><td>At least one parameter is above 50% and below 70%.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FE2ccOXDRPwgTSTSWeB52%2Ficon-compute-resource-status-red.png?alt=media&amp;token=5a4d7e17-496d-4285-8c00-8ac54fbb198b" alt=""> (red)</td><td>At least one parameter is above 70%.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FAQXreBOFlqgLQgN06DIE%2Ficon-compute-resource-status-grey.png?alt=media&amp;token=270e83aa-b816-4530-af2f-9217837044cc" alt=""> (grey)</td><td>Onyx Edge is offline.</td></tr></tbody></table>

#### (4G) Onyx Edge Status Indicators

**Onyx Edge Online Status**

Verify in the Onyx Edge summary page or Onyx Edge details page.

<table><thead><tr><th width="149.5555419921875">Indicator</th><th>Description</th></tr></thead><tbody><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fsmi4QR41cO0gv84dE3Nx%2Ficon-online-status-green.png?alt=media&amp;token=bb51c86a-26da-4900-acf7-87ae2d4b12de" alt=""> (green)</td><td>Onyx Edge has checked in with Onyx Portal within the last 5 minutes.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FsfZJ0PiZAASMnmmZZ7Gk%2Ficon-online-status-red.png?alt=media&amp;token=a9f5a734-a710-4094-8311-f5e550060087" alt=""> (red)</td><td>Onyx Edge has not checked in with Onyx Portal within the last 5 minutes.</td></tr></tbody></table>

**Onyx Edge Interface Status**

Verify in the Onyx Edge summary page or Onyx Edge details page.

<table><thead><tr><th width="149.5555419921875">Indicator</th><th>Description</th></tr></thead><tbody><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FOxav13CpNpYXqfjQMT30%2Ficon-interface-status-green.png?alt=media&amp;token=d2c7b061-7219-4503-afa7-a011679f5340" alt=""> (green)</td><td>All APs are MME-connected to the Onyx Edge, the SGi interface is up and has an IP address, and the SGi link is active.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FJxWz2YPjTj7rSZRd5O8z%2Ficon-interface-status-amber.png?alt=media&amp;token=037880f3-bca0-4fa1-b636-fd4f96e0cb88" alt=""> (amber)</td><td>At least one AP is MME-connected, but some are not. The SGi interface is up and has an IP address, and the SGi link is active.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FV0w3imrJEirCjIYDdDGW%2Ficon-interface-status-red.png?alt=media&amp;token=7d353545-2d9d-4522-83a0-8b1cad8490d3" alt=""> (red)</td><td>None of the APs are MME-connected (all APs are MME-disconnected or management-disconnected), or the SGi interface is not up or not active.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F1cMG1FzPOJYrLHouUahL%2Ficon-interface-status-grey.png?alt=media&amp;token=51d401d5-0d13-43ee-bba5-029d50bca3e2" alt=""> (grey)</td><td>Onyx Edge is offline.</td></tr></tbody></table>

**Onyx Edge Service Status**

Verify in the Onyx Edge summary page or Onyx Edge details page.

<table><thead><tr><th width="149.5555419921875">Indicator</th><th>Description</th></tr></thead><tbody><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FsZS6ZmwKR99YVAHw6bzE%2Ficon-service-status-green.png?alt=media&amp;token=24d75def-a1be-4591-8330-8b35b758a09c" alt=""> (green)</td><td>All critical services are up and running, no critical services were restarted in the last 5 minutes, and the Interface Status is green.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FbPl2I3uYHaRfh89vNMdy%2Ficon-service-status-amber.png?alt=media&amp;token=36456cee-dd7a-4500-952e-7401760fc1a6" alt=""> (amber)</td><td>All critical services are up and running, but critical services have restarted up to three times in the last 5 minutes, and the Interface Status is green or amber.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FGkvaJBlVkuWAHbhvxVkc%2Ficon-service-status-red.png?alt=media&amp;token=78c96890-01e5-4727-936f-8026a5753ed5" alt=""> (red)</td><td>A critical service has gone down in the last 5 minutes, critical services have restarted more than three times in the last 5 minutes, or the Interface Status is red.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FwKQ1rkfoJ5g2rVNbkYqb%2Ficon-service-status-grey.png?alt=media&amp;token=80708a3d-4407-44a5-b022-7f41b08faed8" alt=""> (grey)</td><td>Onyx Edge is offline, or data is not available.</td></tr></tbody></table>

**Onyx Edge Compute Resource**

Verify in the Onyx Edge summary page or Onyx Edge details page.

<table><thead><tr><th width="149.5555419921875">Indicator</th><th>Description</th></tr></thead><tbody><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FD8bWn1D47O2KlXjjb3me%2Ficon-compute-resource-status-green.png?alt=media&amp;token=02f7808b-3713-4217-a195-5d8b34776b9b" alt=""> (green)</td><td>All parameters (CPU, memory, disk) are below 50%.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FuHeTrj7yXq2T37iWA083%2Ficon-compute-resource-status-amber.png?alt=media&amp;token=1fe354ab-225b-4b6e-93ff-4284022ac8be" alt=""> (amber)</td><td>At least one parameter is above 50% and below 70%.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FewJ1uHxckZsV9W4fMJua%2Ficon-compute-resource-status-red.png?alt=media&amp;token=d21817a4-f5eb-4e72-bc34-aa60c3bd3efa" alt=""> (red)</td><td>At least one parameter is above 70%.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FC01xt7BY2n2wyhuCnyno%2Ficon-compute-resource-status-grey.png?alt=media&amp;token=65038084-35d6-4538-8cd4-71b70a5009cf" alt=""> (grey)</td><td>Onyx Edge is offline.</td></tr></tbody></table>

**(4G) Onyx Edge IPSec Status**

Verify in the Onyx Edge summary page or Onyx Edge details page.

<table><thead><tr><th width="149.5555419921875">Indicator</th><th>Description</th></tr></thead><tbody><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F1VMPPebb3f9BdfteRe0b%2Ficon-ipsec-status-green.png?alt=media&amp;token=d5d02696-eae7-4d82-a97c-ec5dbc070e32" alt=""> (green)</td><td>Onyx Edge is IPSec-enabled, and all IPSec-enabled APs have active IPSec tunnels with the Onyx Edge.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FWofJg42u3l30p5z9maWX%2Ficon-ipsec-status-amber.png?alt=media&amp;token=8b939a47-a6ed-4f66-8227-cc7903f02a19" alt=""> (amber)</td><td>Onyx Edge is IPSec-enabled, and at least one IPSec-enabled AP has an active IPSec tunnel, but other IPSec-enabled APs are unreported or have a bad IPSec status.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FHPdmaNy7otmMW8B4MQGu%2Ficon-ipsec-status-red.png?alt=media&amp;token=27a6669a-942c-4e00-9115-eafdd2973a09" alt=""> (red)</td><td>Onyx Edge has bad IPSec status, and/or all IPSec-enabled APs are unreported or have a bad IPSec status.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FBu1CtR5O7kt7ERNGf4xW%2Ficon-ipsec-status-grey.png?alt=media&amp;token=4194d64d-1f4c-45f2-82c1-735b10443d0d" alt=""> (grey)</td><td>Onyx Edge is offline, is IPSec-disabled, and/or all APs are IPSec-disabled.</td></tr></tbody></table>

#### (5G) FHM Status Indicators

**FHM Online Status**

Verify in the FHM summary page or FHM details page.

<table><thead><tr><th width="149.5555419921875">Indicator</th><th>Description</th></tr></thead><tbody><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FT5RP1JQxbyYRBSRviIu4%2Ficon-online-status-green.png?alt=media&amp;token=5f5d1c07-375b-4fda-911c-b5922c3e9960" alt=""> (green)</td><td>FHM is management-connected, and the last reported time is less than 5 minutes ago.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FtayydLKEUL4s84qtyV9x%2Ficon-online-status-red.png?alt=media&amp;token=f40fa3ce-f97b-4414-a72f-f304818015d9" alt=""> (red)</td><td>Any of the following conditions: FHM is not management-connected; the last reported time is 5 minutes ago or more; or the FHM is not associated with any Onyx Edge.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FlsHq1aOvSEoFBqmJwGCW%2Ficon-online-status-grey.png?alt=media&amp;token=22c6f629-a788-4de0-8e89-7731fe641337" alt=""> (grey)</td><td>Gateway of the associated Onyx Edge is offline.</td></tr></tbody></table>

**FHM Interface Status**

Verify in the FHM summary page or FHM details page.

<table><thead><tr><th width="149.5555419921875">Indicator</th><th>Description</th></tr></thead><tbody><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fs7Qnh4S4LVMkfnomQyGE%2Ficon-interface-status-green.png?alt=media&amp;token=b275e1f9-045c-414f-9809-57fd61034e50" alt=""> (green)</td><td>Fronthaul passthrough is reported as true for all associated APs.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FADSqnQByao6UlUy62gzO%2Ficon-interface-status-amber.png?alt=media&amp;token=d0f14299-677d-4cb6-8d58-ce88df335774" alt=""> (amber)</td><td>Fronthaul passthrough is reported as false, or status information is unavailable for at least one, but not all, associated APs.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FV8dKxNuUnyRvTFwG65nx%2Ficon-interface-status-red.png?alt=media&amp;token=78afd1cd-2353-4038-833e-480e3d8d75f2" alt=""> (red)</td><td>Fronthaul passthrough is reported as false, or status information is unavailable for all associated APs.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FH8FE3B3f5BQqus1EH3Rd%2Ficon-interface-status-grey.png?alt=media&amp;token=b07a0671-9085-4f2b-bdac-5195d4da177e" alt=""> (grey)</td><td>FHM is not management-connected.</td></tr></tbody></table>

**FHM Service Status**

Verify in the FHM details page.

<table><thead><tr><th width="149.5555419921875">Indicator</th><th>Description</th></tr></thead><tbody><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FMxvusCh6EIwWGHAAVxqy%2Ficon-service-status-green.png?alt=media&amp;token=ee9c0719-7aca-4cb6-b348-9ae5b3d16e68" alt=""> (green)</td><td>RF Tx is on.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fm42fdrUAo8PbwLuFp2g1%2Ficon-service-status-red.png?alt=media&amp;token=cf390c1e-147c-4a4e-9ba8-6f35271f7f99" alt=""> (red)</td><td>RF Tx is off.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FIS4DDwr4aIUaUzBwhqxl%2Ficon-service-status-grey.png?alt=media&amp;token=a7c37816-2dd9-4e2a-8a17-85ab66715d56" alt=""> (grey)</td><td>AP is offline.</td></tr></tbody></table>

**FHM Sync Status**

Verify in the FHM details page.

<table><thead><tr><th width="149.5555419921875">Indicator</th><th>Description</th></tr></thead><tbody><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FALz698L4IvkoruGOqHpK%2Ficon-ipsec-status-green.png?alt=media&amp;token=0432a0bd-7b33-4418-aaac-581a3561a809" alt=""> (green)</td><td>AP timing status is true (IN_SYNC).</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FerzKdFGVZHpddMnIGG8n%2Ficon-ipsec-status-red.png?alt=media&amp;token=432d595c-9d29-4eda-a215-f2263e65390d" alt=""> (red)</td><td>AP timing status is false (LATE or EARLY).</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fbaa0EVcfIprboqSvJpbX%2Ficon-ipsec-status-grey.png?alt=media&amp;token=8fd2d89d-c7d5-40a2-8bd7-176ad3ac2afa" alt=""> (grey)</td><td>AP is offline.</td></tr></tbody></table>

#### (4G) Mesh Node Status Indicators

**Mesh Node Online Status**

Verify in the Mesh Node summary page or Mesh Node details page.

<table><thead><tr><th width="149.5555419921875">Indicator</th><th>Description</th></tr></thead><tbody><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FfJhxdrnCex1Cki5CzRWW%2Ficon-online-status-green.png?alt=media&amp;token=cea209c3-8e7b-48a6-b78e-41bbd6b59122" alt=""> (green)</td><td>Mesh Node is connected to Onyx Portal and last checked in within the last 5 minutes.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FgOFZHfxiReaDXuebjY0p%2Ficon-online-status-red.png?alt=media&amp;token=7b8a0bf1-aead-46eb-97a3-e2b6680da550" alt=""> (red)</td><td>Mesh Node is not connected to Onyx Portal or last checked in more than 5 minutes ago.</td></tr></tbody></table>

**Mesh Node Interface Status**

Verify in the Mesh Node summary page or Mesh Node details page.

<table><thead><tr><th width="149.5555419921875">Indicator</th><th>Description</th></tr></thead><tbody><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fub0fuhXgQTTqG8w18N8p%2Ficon-interface-status-green.png?alt=media&amp;token=7cc1590c-53ea-46ab-b2cd-8bc78506754f" alt=""> (green)</td><td>GRE tunnel status is okay, and Mesh AP is online.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FuaoEOlVIBxKGVXTLCQ9O%2Ficon-interface-status-amber.png?alt=media&amp;token=01fd9154-2c61-40b2-9bc1-161f317ddb6f" alt=""> (amber)</td><td>Mesh Node is online, but Mesh AP is offline, and GRE tunnel status is okay.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FuVBLfexDxqDvVaUXAqc0%2Ficon-interface-status-red.png?alt=media&amp;token=e13942ad-6c8d-467d-b757-319197365a02" alt=""> (red)</td><td>GRE tunnel status is not okay.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FGOu6xu7K3KvLfPNU3QrY%2Ficon-interface-status-grey.png?alt=media&amp;token=2ee377fc-8945-4808-9f21-cacb057bf11f" alt=""> (grey)</td><td>Mesh Node is offline.</td></tr></tbody></table>

**Mesh Node Service Status**

Verify in the Mesh Node summary page or Mesh Node details page.

<table><thead><tr><th width="149.5555419921875">Indicator</th><th>Description</th></tr></thead><tbody><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Ft6sxlDPLWpKL7SjkGdFi%2Ficon-service-status-green.png?alt=media&amp;token=081d146c-8997-460b-97c5-3b86256dcfa2" alt=""> (green)</td><td>Mesh AP cell is in a healthy state.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0gigyexEBIPwhRRutJQa%2Ficon-service-status-red.png?alt=media&amp;token=222ea2d1-5742-442e-ac05-32d40c58f85c" alt=""> (red)</td><td>Mesh AP cell is in a service down state.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FOx3BUUQFEQ8U0OZqfvhJ%2Ficon-service-status-amber.png?alt=media&amp;token=d3d497ee-029e-44f6-96e0-ca623d05b544" alt=""> (amber)</td><td>Mesh AP cell is in an unwarranted transmission state.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FIbMYy7cE94AthHWq4xTc%2Ficon-service-status-grey.png?alt=media&amp;token=2ba19ea1-da46-40d9-b71b-feb93acdaa15" alt=""> (grey)</td><td>Mesh AP cell state is shutdown, AP is offline, or Mesh Node is offline.</td></tr></tbody></table>

**Mesh Node Compute Resource**

Verify in the Mesh Node summary page or Mesh Node details page.

<table><thead><tr><th width="149.5555419921875">Indicator</th><th>Description</th></tr></thead><tbody><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0nCVXlMaFFcO4NGuW6Mz%2Ficon-compute-resource-status-green.png?alt=media&amp;token=f4ad5910-1f37-4e36-b6b0-4344c47156ba" alt=""> (green)</td><td>All parameters (CPU, memory, disk) are at or below 50%.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FBtNzHFDouz68VdZHn3u9%2Ficon-compute-resource-status-amber.png?alt=media&amp;token=45127d19-eead-4dcf-8eed-f04ef4e9fc5f" alt=""> (amber)</td><td>All parameters are at or below 70%, and at least one parameter is above 50%.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FpVsdoMvRUYcIxlLabm9h%2Ficon-compute-resource-status-red.png?alt=media&amp;token=23b870ee-0f28-40b7-ae0c-7eeb1f825646" alt=""> (red)</td><td>At least one parameter is above 70%.</td></tr><tr><td><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F8kFrRlcN6MozExFaMpli%2Ficon-compute-resource-status-grey.png?alt=media&amp;token=c51d5d49-11d0-416e-9925-44322a057553" alt=""> (grey)</td><td>Mesh Node is offline.</td></tr></tbody></table>


# agw\_user CLI Command Reference

*agw\_user* is a restricted, non-root command-line account available on the Onyx Edge, giving users a safe way to run basic diagnostic and maintenance commands — collecting tech dumps, restarting services, rebooting, etc. This reference describes each *agw\_user* command.

<details>

<summary><code>change-passwd</code></summary>

Prompts to change the current password for `agw_user`.

Password changes may be restricted if the Onyx Portal manages credentials.

**Usage:** `change-passwd [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

{% hint style="info" %}
**NOTE:** If the password is managed via the Onyx Portal, this command will display a message and exit without allowing a change.
{% endhint %}

**Example:**

```
onyxedge> change-passwd
```

</details>

<details>

<summary><code>collect-tech-dump</code></summary>

Collects a tech dump from the Onyx Edge and saves it to the tech dump directory.

**Usage:** `collect-tech-dump [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> collect-tech-dump
```

</details>

<details>

<summary><code>gw-poweroff</code></summary>

Powers off the Onyx Edge. Requires confirmation before proceeding.

**Usage:** `gw-poweroff [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

{% hint style="info" %}
**NOTE:** You will be prompted to confirm with `y` before the power off is triggered. This action will shut down the gateway immediately.
{% endhint %}

**Example:**

```
onyxedge> gw-poweroff
Power off AGW. Are you sure (y)?
```

</details>

<details>

<summary><code>gw-reboot</code></summary>

Reboots the Onyx Edge. Requires confirmation before proceeding.

**Usage:** `gw-reboot [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

{% hint style="info" %}
**NOTE:** You will be prompted to confirm with `y` before the reboot is triggered.
{% endhint %}

**Example:**

```
onyxedge> gw-reboot
Reboot AGW. Are you sure (y)?
```

</details>

<details>

<summary><code>gw-restart-services</code></summary>

Triggers a full restart of all Onyx Edge services, including networking, subscriber clearing, and Redis flush.

**Usage:** `gw-restart-services [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

{% hint style="info" %}
**NOTE:** This command restarts all services. Use `show-services` to track recovery status afterward.
{% endhint %}

**Example:**

```
onyxedge> gw-restart-services
```

</details>

<details>

<summary><code>gw-rmfile</code></summary>

Removes one or more files from the Onyx Edge. Files are removed using a secure deletion script.

**Usage:** `gw-rmfile [-h] (--techdump | --core | --pcap) <filenames ...>`

**Positional Arguments:**

* `filenames`: One or more file names to remove (basename only, not full path).

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.
* `--techdump`: Remove files from the tech dump directory.
* `--core`: Remove files from the core dump directory.
* `--pcap`: Remove files from the pcap directory.

**Example:**

```
onyxedge> gw-rmfile --techdump techdump-20240101.tar.gz
onyxedge> gw-rmfile --pcap capture01.pcap capture02.pcap
```

</details>

<details>

<summary><code>gw-tcpdump</code></summary>

Captures network traffic on a specified interface and saves it as a `.pcap` file.

**Usage:** `gw-tcpdump [-h] [-c PKTS] [-s SNAPLEN] <interface> <filename> [filters ...]`

**Positional Arguments:**

* `interface`: Network interface to capture on (e.g., `eth0`).
* `filename`: Name of the output file (must not contain invalid characters; `.pcap` extension added automatically if omitted).

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.
* `-c PKTS`: Stop after capturing this many packets.
* `-s SNAPLEN`: Snap length (bytes per packet to capture).
* `filters`: Additional tcpdump filter expressions.

{% hint style="info" %}
**NOTE:** If a file with the given name already exists, you will be prompted to confirm overwriting it.
{% endhint %}

**Example:**

```
onyxedge> gw-tcpdump eth0 capture01
onyxedge> gw-tcpdump -c 1000 -s 128 eth0 capture01 port 443
```

</details>

<details>

<summary><code>scp-to</code></summary>

Copies a file from the Onyx Edge to a remote host using SCP.

**Usage:** `scp-to [-h] (--techdump FILE | --core FILE | --pcap FILE | --ssh-pubkey) <user> <host> <target_path>`

**Positional Arguments:**

* `user`: Remote username.
* `host`: Remote hostname or IP address.
* `target_path`: Destination path on the remote host.

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.
* `--techdump FILE`: Name of the tech dump file to copy.
* `--core FILE`: Name of the core dump file to copy.
* `--pcap FILE`: Name of the pcap file to copy.
* `--ssh-pubkey`: Copy the Onyx Edge's SSH public key.

{% hint style="info" %}
**NOTE:** Host key checking is disabled for this command.
{% endhint %}

**Example:**

```
onyxedge> scp-to --techdump techdump-20240101.tar.gz admin 192.168.1.100 /tmp/
onyxedge> scp-to --ssh-pubkey admin 192.168.1.100 /home/admin/
```

</details>

<details>

<summary><code>show-authkeys</code></summary>

Displays the contents of the `authorized_keys` file for the `agw_user` account.

**Usage:** `show-authkeys [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> show-authkeys
```

</details>

<details>

<summary><code>show-cores</code></summary>

Lists all available core dump files stored on the Onyx Edge.

**Usage:** `show-cores [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> show-cores
```

</details>

<details>

<summary><code>show-enodebs</code></summary>

Displays information about connected eNodeBs (4G base stations).

**Usage:** `show-enodebs [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> show-enodebs
```

</details>

<details>

<summary><code>show-gnodebs</code></summary>

Displays information about connected gNodeBs (5G base stations).

**Usage:** `show-gnodebs [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> show-gnodebs
```

</details>

<details>

<summary><code>show-gw-info</code></summary>

Displays general Onyx Edge gateway information.

**Usage:** `show-gw-info [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> show-gw-info
```

</details>

<details>

<summary><code>show-networking</code></summary>

Displays network information for the Onyx Edge gateway. Supports multiple sub-commands.

**Usage:** `show-networking [-h] {ipv4,routes,links,data-rates} ...`

**Sub-commands:**

`ipv4` — Displays a brief summary of all IPv4 addresses on the gateway.

```
onyxedge> show-networking ipv4
```

`routes` — Displays the current IP routing table.

```
onyxedge> show-networking routes
```

`links summary` — Displays a summary of all network links.

```
onyxedge> show-networking links summary
```

`links detailed <linkname>` — Displays detailed information for a specific network link using `ethtool`.

* `--driver` / `-i`: Show driver information instead of link details.

```
onyxedge> show-networking links detailed eth0
onyxedge> show-networking links detailed --driver eth0
```

`data-rates {nat-path,vlan-path,<ifc>...}` — Displays data rates for network interfaces using `bps`.

* `-n <num_samples>`: Number of samples to collect.
* `-t <duration>`: Duration of the test.
* `-P`: Display packet counts as numbers.

```
onyxedge> show-networking data-rates nat-path
onyxedge> show-networking data-rates vlan-path
onyxedge> show-networking data-rates eth0 eth1
```

</details>

<details>

<summary><code>show-ntp</code></summary>

Displays the current NTP synchronization status.

**Usage:** `show-ntp [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> show-ntp
```

</details>

<details>

<summary><code>show-pc</code></summary>

Displays the status of the last policy controller request and response (sensitive fields excluded).

**Usage:** `show-pc [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> show-pc
```

</details>

<details>

<summary><code>show-pcaps</code></summary>

Lists all available packet capture (`.pcap`) files stored on the gateway.

**Usage:** `show-pcaps [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> show-pcaps
```

</details>

<details>

<summary><code>show-services</code></summary>

Displays the status of all Onyx Edge services.

**Usage:** `show-services [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> show-services
```

</details>

<details>

<summary><code>show-sshkey</code></summary>

Displays the public SSH key (`id_rsa.pub`) for the `agw_user` account.

**Usage:** `show-sshkey [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> show-sshkey
```

</details>

<details>

<summary><code>show-techdump</code></summary>

Lists all available tech dump files stored on the Onyx Edge.

**Usage:** `show-techdump [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> show-techdump
```

</details>

<details>

<summary><code>show-time</code></summary>

Displays the current system date and time.

**Usage:** `show-time [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> show-time
```

</details>

<details>

<summary><code>show-ues</code></summary>

Displays information about connected User Equipment (UE).

**Usage:** `show-ues [-h] {summary,detailed}`

**Positional Arguments:**

* `summary`: Shows a brief summary of all connected UE.
* `detailed`: Shows detailed information for each UE.

**Example:**

```
onyxedge> show-ues summary
onyxedge> show-ues detailed
```

</details>

<details>

<summary><code>test-ap-speedtest</code></summary>

Runs a speed test to a connected AP by IP address.

**Usage:** `test-ap-speedtest [-h] <ip>`

**Positional Arguments:**

* `ip`: IP address of the target AP.

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> test-ap-speedtest 192.168.1.10
```

</details>

<details>

<summary><code>test-checkin</code></summary>

Tests the Onyx Edge's checkin connectivity to the Orchestrator.

**Usage:** `test-checkin [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> test-checkin
```

</details>

<details>

<summary><code>test-dnslookup</code></summary>

Performs a DNS lookup for a given hostname.

**Usage:** `test-dnslookup [-h] [-s SERVER] <host>`

**Positional Arguments:**

* `host`: The hostname to resolve.

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.
* `-s SERVER`: DNS server to use for the lookup. Uses the system default if omitted.

**Example:**

```
onyxedge> test-dnslookup google.com
onyxedge> test-dnslookup -s 8.8.8.8 google.com
```

</details>

<details>

<summary><code>test-network-health</code></summary>

Runs a comprehensive network health check and displays a summary.

**Usage:** `test-network-health [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> test-network-health
```

</details>

<details>

<summary><code>test-ping</code></summary>

Sends ICMP ping packets to a target host.

**Usage:** `test-ping [-h] [-c COUNT] <host>`

**Positional Arguments:**

* `host`: The target hostname or IP address.

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.
* `-c COUNT`: Number of ping packets to send. If omitted, pings continuously.

**Example:**

```
onyxedge> test-ping 8.8.8.8
onyxedge> test-ping -c 5 8.8.8.8
```

</details>

<details>

<summary><code>test-speedtest</code></summary>

Runs a network speed test from the Onyx Edge.

**Usage:** `test-speedtest [-h] [-d] [-s SERVERS] [-p PORT] [-t TEST_DURATION] [-T TEST_TIMEOUT]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.
* `-d, --download`: Run a download-only speed test.
* `-s SERVERS`: Specify speed test server(s) to use.
* `-p PORT`: Specify the port to use for the test.
* `-t TEST_DURATION`: Duration of the speed test.
* `-T TEST_TIMEOUT`: Timeout for the speed test.

**Example:**

```
onyxedge> test-speedtest
onyxedge> test-speedtest -d -t 30
```

</details>

<details>

<summary><code>test-tcpconn-any</code></summary>

Tests a TCP connection to any specified host and port.

**Usage:** `test-tcpconn-any [-h] <host> <port>`

**Positional Arguments:**

* `host`: The target hostname or IP address.
* `port`: The target TCP port.

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> test-tcpconn-any controller.example.com 443
```

</details>

<details>

<summary><code>test-tcpconn-std</code></summary>

Tests a TCP connection to a set of standard, pre-configured endpoints.

**Usage:** `test-tcpconn-std [-h] {orc8r,bootstrap,logs-server,pserver,bastion-host,artifactory}`

**Positional Arguments:**

* `orc8r`: Tests connectivity to the Orchestrator.
* `bootstrap`: Tests connectivity to the Bootstrap server.
* `logs-server`: Tests connectivity to the Logs server.
* `pserver`: Tests connectivity to the Policy server.
* `bastion-host`: Tests connectivity to the Bastion host on port 22.
* `artifactory`: Tests connectivity to `artifactory.gxc.io` on port 443.

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> test-tcpconn-std orc8r
onyxedge> test-tcpconn-std bastion-host
```

</details>

<details>

<summary><code>test-traceroute</code></summary>

Traces the network path to a target host.

**Usage:** `test-traceroute [-h] [-m MAXHOPS] <host>`

**Positional Arguments:**

* `host`: The target hostname or IP address.

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.
* `-m MAXHOPS`: Maximum number of hops to trace.

**Example:**

```
onyxedge> test-traceroute 8.8.8.8
onyxedge> test-traceroute -m 20 8.8.8.8
```

</details>

<details>

<summary><code>test-url-any</code></summary>

Tests HTTP/HTTPS connectivity to any specified URL.

**Usage:** `test-url-any [-h] [-x EXPECT_CODE] [-i] <url>`

**Positional Arguments:**

* `url`: The target URL to test.

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.
* `-x EXPECT_CODE`: Expected HTTP response code (default may vary).
* `-i, --insecure`: Skip TLS certificate verification.

**Example:**

```
onyxedge> test-url-any https://example.com
onyxedge> test-url-any -x 200 -i https://example.com
```

</details>


# How do I log into my portal account?

View the following video to learn how to log into your account for the first time.

{% embed url="<https://youtu.be/qVFlBu2KZJQ>" %}


# How do I add my iPhone to the GXC Network?

View the following video to add an iPhone to the GXC Network.

{% embed url="<https://youtu.be/57CAteke6eo>" %}

## Walkthrough

### Before you begin

<p align="center">You must have either a Wi-Fi or cellular connection and an image of your QR code.</p>

{% stepper %}
{% step %}

#### Confirm prerequisites.

<p align="center"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FqP7AH6brmr5Qhzug3J06%2FTitle%3A%20step01.jpg%20-%20Description%3A%20Screenshot%20for%20step01.jpg?alt=media&amp;token=023e67f3-1908-463e-a7b6-71cb98e94548" alt="Title: step01.jpg - Description: Screenshot for step01.jpg"></p>

*On-screen caption: You must have either a Wi-Fi or cellular connection and an image of your QR code.*

What to do: Before starting, make sure your iPhone is connected to either Wi-Fi or an existing cellular data connection. Also have the QR code image supplied by your carrier ready — either saved on your device or printed.
{% endstep %}

{% step %}

#### &#x20;Open Settings.

<p align="center"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fu3vsGt3ixAx5DgZNZ7dZ%2FTitle%3A%20step02.jpg%20-%20Description%3A%20Screenshot%20for%20step02.jpg?alt=media&amp;token=b609f024-798e-4d95-b2f5-5eca7ea1a24e" alt="Title: step02.jpg - Description: Screenshot for step02.jpg"></p>

*On-screen caption: Find and select "Settings" on your phone.*

What to do: Locate the Settings icon on your Home Screen (it may be inside the Apple folder as shown) and tap to open it.&#x20;
{% endstep %}

{% step %}

#### Tap Cellular.

<p align="center"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FPgrIjhc9XG9fVRiKjzAT%2FTitle%3A%20step03.jpg%20-%20Description%3A%20Screenshot%20for%20step03.jpg?alt=media&amp;token=f0f0b164-3cf6-4265-9dcd-bcd6c582f71f" alt="Title: step03.jpg - Description: Screenshot for step03.jpg"></p>

*On-screen caption: In Settings, select "Cellular".*

What to do: Scroll to find the Cellular option and tap to open the cellular configuration page.&#x20;
{% endstep %}

{% step %}

#### Set Up Cellular — Use QR Code.

<p align="center"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2Fcczrv9xr1VY4RYbCW8Fw%2FTitle%3A%20step04.jpg%20-%20Description%3A%20Screenshot%20for%20step04.jpg?alt=media&amp;token=e8735e8f-aeed-4ed9-acd8-7a02f6dd6bd3" alt="Title: step04.jpg - Description: Screenshot for step04.jpg"></p>

*On-screen caption: Select "Use QR Code."*

What to do: On the Set Up Cellular screen, choose "Use QR Code" instead of "Transfer From Nearby iPhone."
{% endstep %}

{% step %}

#### Scan your QR code.

<p align="center"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FSbUZB8kYSyIAeI4CUuhG%2FTitle%3A%20step05.jpg%20-%20Description%3A%20Screenshot%20for%20step05.jpg?alt=media&amp;token=99db9b59-8dd2-4c19-ad8f-d39d76152a13" alt="Title: step05.jpg - Description: Screenshot for step05.jpg"></p>

*On-screen caption: Scan your QR code.*

What to do: Position the QR code provided by your carrier inside the scanning frame. If needed, you can tap "Enter Details Manually" at the bottom.&#x20;
{% endstep %}

{% step %}

#### Activate eSIM — tap Continue.

<p align="center"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FOxqVo67oMjCX6SEFuuz8%2FTitle%3A%20step06.jpg%20-%20Description%3A%20Screenshot%20for%20step06.jpg?alt=media&amp;token=624a22cf-35a0-400e-be5e-5e0f24783c00" alt="Title: step06.jpg - Description: Screenshot for step06.jpg"></p>

*On-screen caption: Your new eSIM from GXC is ready to activate — tap Continue.*

What to do: Once the code is recognized, the Activate eSIM screen appears. Tap Continue to begin activation.&#x20;
{% endstep %}

{% step %}

#### Exit the "Connecting to network…" screen.

<p align="center"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FwssJ6yX2lmXKjstjqUhA%2FTitle%3A%20step07.jpg%20-%20Description%3A%20Screenshot%20for%20step07.jpg?alt=media&amp;token=2fc147c2-e528-4959-b516-ed2140b22b7b" alt="Title: step07.jpg - Description: Screenshot for step07.jpg"></p>

*On-screen caption: At this point you will see "Connecting to network…". End this by swiping up from the bottom of the screen.*

What to do: The screen will show a "Connecting to network…" spinner. Do not wait for it to finish — instead, dismiss this screen by swiping up from the bottom of the display to return to the Home Screen.&#x20;
{% endstep %}

{% step %}

#### Reopen Settings.

<p align="center"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FrEQeDZ6z5PPwxtZPsD5P%2FTitle%3A%20step08.jpg%20-%20Description%3A%20Screenshot%20for%20step08.jpg?alt=media&amp;token=5d14573d-cb44-4c0b-8e36-aee538a51a73" alt="Title: step08.jpg - Description: Screenshot for step08.jpg"></p>

*On-screen caption: Reopen "Settings."*

What to do: Tap the Settings icon again to go back into Settings.
{% endstep %}

{% step %}

#### Select the new Non-Public Network entry.

<p align="center"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FrA8WHJJvfJh48oOrKhXi%2FTitle%3A%20step09.jpg%20-%20Description%3A%20Screenshot%20for%20step09.jpg?alt=media&amp;token=bce0d34d-9f96-40a7-80a0-88fecfc2c2f0" alt="Title: step09.jpg - Description: Screenshot for step09.jpg"></p>

*On-screen caption: You will now notice the new entry under "Non-Public Networks". Select this entry.*

What to do: Open Cellular again. Under the "Non-Public Networks" section you will see the newly added Cellular Data line with a long number (e.g. +31 5010003050161). Tap this entry.
{% endstep %}

{% step %}

#### Open Voice & Data.

<p align="center"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FK7vF6SfCF5O2xgLxEvaq%2FTitle%3A%20step10.jpg%20-%20Description%3A%20Screenshot%20for%20step10.jpg?alt=media&amp;token=14f94f6a-c82e-466a-a99e-0c332575df18" alt="Title: step10.jpg - Description: Screenshot for step10.jpg"></p>

*On-screen caption: Select "Voice & Data".*

What to do: Inside the Non-Public Network settings, tap the "Voice & Data" row.
{% endstep %}

{% step %}

#### Enable 5G On and 5G Standalone.

<p align="center"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FXrmLO8KYKLeJ19HY6O5k%2FTitle%3A%20step11.jpg%20-%20Description%3A%20Screenshot%20for%20step11.jpg?alt=media&amp;token=d09619e7-9d1f-4867-a293-9becbcd2c05d" alt="Title: step11.jpg - Description: Screenshot for step11.jpg"></p>

*On-screen caption: Select "5G On" and "5G Standalone" as shown.*

What to do: Pick "5G On" from the list and toggle "5G Standalone" ON. Then use Back to return.
{% endstep %}

{% step %}

#### Add Cellular Plan — Continue.

<p align="center"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FauJ9uXcZEHUC0KnRhlxG%2FTitle%3A%20step12.jpg%20-%20Description%3A%20Screenshot%20for%20step12.jpg?alt=media&amp;token=60ceb0f7-71ae-4212-a6ba-21f826ae65c9" alt="Title: step12.jpg - Description: Screenshot for step12.jpg"></p>

*On-screen caption: A new cellular plan has been detected — tap Continue.*

What to do: A dialog titled "Add Cellular Plan" may appear indicating a new plan was detected. Tap Continue to proceed through the plan setup.
{% endstep %}

{% step %}

#### Cellular Plan Labels.

<p align="center"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F04mT24f3wpKX9wdEGxOV%2FTitle%3A%20step13.jpg%20-%20Description%3A%20Screenshot%20for%20step13.jpg?alt=media&amp;token=811f4745-a46f-46c2-8834-a1de0d97e21c" alt="Title: step13.jpg - Description: Screenshot for step13.jpg"></p>

*On-screen caption: If desired, you may label your cellular plan as I will do in the next slide.*

What to do: The Cellular Plan Labels screen lets you assign a meaningful label to each plan. Tap the label row for the new line to customize it.
{% endstep %}

{% step %}

#### Apply a custom label (e.g. "GXC").

<p align="center"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FH3Giuha8KXOeC442m31X%2FTitle%3A%20step14.jpg%20-%20Description%3A%20Screenshot%20for%20step14.jpg?alt=media&amp;token=4fc3b1c6-d5e1-400c-8764-8f5fccce61ca" alt="Title: step14.jpg - Description: Screenshot for step14.jpg"></p>

*On-screen caption: Here I labeled it "GXC" and selected "Done" to continue.*

What to do: From the list, either pick a preset (Business, Personal, Travel, etc.) or scroll to "Custom Label" and enter a name such as GXC. Tap Done when finished.
{% endstep %}

{% step %}

#### Select Continue again.

<p align="center"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FNt7ct7QcjsL7p8MoBBrj%2FTitle%3A%20step15.jpg%20-%20Description%3A%20Screenshot%20for%20step15.jpg?alt=media&amp;token=e018679f-3b98-41d0-a8f4-9cf07fb3a495" alt="Title: step15.jpg - Description: Screenshot for step15.jpg"></p>

*On-screen caption: Select "Continue" again.*

What to do: Back on the Cellular Plan Labels screen, confirm your labels and tap Continue.
{% endstep %}

{% step %}

#### Choose default cellular data line.

<p align="center"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FxypokTitbRDSf5jHmMft%2FTitle%3A%20step16.jpg%20-%20Description%3A%20Screenshot%20for%20step16.jpg?alt=media&amp;token=558987ba-867e-4c66-ac2f-15c38debf108" alt="Title: step16.jpg - Description: Screenshot for step16.jpg"></p>

*On-screen caption: Choose your default network for "Cellular Data". Here I selected "GXC".*

What to do: Pick which line should carry mobile data by default. In this example GXC is chosen. Leave "Allow Cellular Data Switching" turned off unless you want iOS to fall back to the other line automatically.&#x20;
{% endstep %}

{% step %}

#### Tap Done.

<p align="center"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FY399mVgP1Qyy9XKEzCrJ%2FTitle%3A%20step17.jpg%20-%20Description%3A%20Screenshot%20for%20step17.jpg?alt=media&amp;token=989faece-3b8c-4e88-b3dc-de09d1075a8b" alt="Title: step17.jpg - Description: Screenshot for step17.jpg"></p>

*On-screen caption: Almost done — now select "Done".*

What to do: Tap the blue Done button to finish the eSIM setup wizard.
{% endstep %}

{% step %}

#### Verify from Control Center — swipe down.

<p align="center"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2FMYOYltvFf4x7Pl7V8QON%2FTitle%3A%20step18.jpg%20-%20Description%3A%20Screenshot%20for%20step18.jpg?alt=media&amp;token=10eff56e-8216-407d-b150-552ca8dbf8bc" alt="Title: step18.jpg - Description: Screenshot for step18.jpg"></p>

*On-screen caption: To verify your connection to your new private network, swipe down slightly from the top right-hand corner of your screen.*

What to do: Return to the Home Screen and swipe down from the top-right corner to open Control Center.
{% endstep %}

{% step %}

#### Confirm the private network name.

<p align="center"><img src="https://4071075005-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZc9hpHmiTCrh1sn4mWXn%2Fuploads%2F0I5aeIpX6Yi9Q6cYcTBT%2FTitle%3A%20step19.jpg%20-%20Description%3A%20Screenshot%20for%20step19.jpg?alt=media&amp;token=8ee486ac-ab86-42a9-9285-a368c5f667bb" alt="Title: step19.jpg - Description: Screenshot for step19.jpg"></p>

*On-screen caption: The name of your network will vary depending on how your provider set up the network.*

What to do: At the top of Control Center you will see both lines. Your GXC/private network line (for example "315 010 5G") will appear alongside your public carrier line (for example "T-Mobile"). The exact network name depends on how your provider has configured it.
{% endstep %}
{% endstepper %}


# Voice Calling on iPhone over a Private Network

A private network carries data only, but a user's normal phone calls can still travel over it. That gives you mobile voice coverage where the operator has none.

A private 5G or LTE network carries data only. Apple configures it that way on iPhone and iPad, so the Phone app and SMS keep using the mobile operator, not your network.

That matters less than it first appears, because the operator's calls can travel over your private network when the operator's own signal cannot reach. Users keep their number and their subscription, and get working calls in places that have never had them: inside a plant, deep in a warehouse, in a basement, behind steel and concrete.

Sites deploy private cellular because public coverage is poor. The same deployment fixes the voice coverage as a by-product.

***

## How the call gets through

The iPhone runs two SIMs at once.

|                 | Carries                                 | Over                              |
| --------------- | --------------------------------------- | --------------------------------- |
| **Private SIM** | all data                                | your GXC network                  |
| **Carrier SIM** | calls and SMS, on the user's own number | whichever path below is available |

The feature that carries the call is what Apple calls **Wi-Fi Calling**. The name is historical. It lets an operator's voice service run over any IP connection, and your private cellular network is one.

The handset does not prefer your network for voice. It uses it only when nothing else will carry the call:

|   | Path                       | Used when                                  |
| - | -------------------------- | ------------------------------------------ |
| 1 | The operator's own network | there is operator signal                   |
| 2 | Wi-Fi                      | no operator signal, but Wi-Fi is available |
| 3 | **Your private network**   | neither of the above is available          |

In the yard, the call goes over the operator. In the office, over Wi-Fi. Deep in the plant where there is neither, over your network. Nobody configures anything per location, and the user cannot tell the difference.

***

## What you need

Three things, and only one of them is yours to build.

1. **An operator that supports Wi-Fi Calling**, enabled on the user's subscription. Most major operators do. Confirm this first, because nothing else matters without it.
2. **A dual-SIM iPhone**, with the private eSIM provisioned alongside the user's existing carrier SIM.
3. **Private network coverage** where people need to call from, which is the coverage you planned for data anyway.

No gateway, no extra licence, and nothing further from GXC.

***

## The limits

**You cannot steer voice onto your network.** If a call can reach the operator or a Wi-Fi access point, it will. The private path is a fallback, not a preference, and there is no setting that changes this.

**It costs a subscription per person.** Everyone who needs calls needs their own carrier plan. Across a large fleet of operational handsets, that adds up quickly.

**It depends on the operator.** A lapsed subscription or an operator outage stops calls. Your network cannot substitute for the service it is carrying.

### When to use an application instead

Where the calling is internal, operator to supervisor or team to team, a push-to-talk or VoIP application on your own network answers better. It needs no operator, keeps audio on site, costs nothing per user, and supports group and priority calling, which an ordinary phone call cannot do.

Most sites end up running both: carrier voice to reach the outside world, an application for the floor.

***

## For the people using the phones

Dial as you always have. Your number and your carrier have not changed, and data runs over the private network so apps stay fast on site.

One thing not to change: if you switch the phone to the carrier SIM for cellular data, it returns to the private SIM the next morning by itself. That is intended. If you need it changed for longer, ask your IT team.

***

## Requirements

* **iOS 17 or later** for private 5G and LTE support. **iOS 18 or later** for more than one private network on a device, or for switching by location.
* **An eSIM provisioned for your network**, matching its mobile country code and network code. GXC issues these from Onyx Portal.
* **A device management profile.** iPhone needs one before it will attach to a private network. Apple documents the payload in [Support for private 5G and LTE networks](https://support.apple.com/guide/deployment/support-for-private-5g-and-lte-networks-depac6747317/web).

***

## Related

* [How do I add my iPhone to the GXC Network?](/docs/faqs/how-do-i-add-my-iphone-to-the-gxc-network) : getting a handset onto the network, step by step
* [Manage Subscribers](/docs/network-configuration-and-operations-guides/5g-onyx-portal-4.x-operations/manage-subscribers) : provisioning SIMs and subscriber groups
* [Compatible Devices](https://docs.gxc.io/devices) : which iPhone models are tested, and on which bands

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


# GXC 5G and LTE Hardware

Welcome to the GXC hardware hub. Here you will find information on the hardware and installation information in building your GXC private network

***

## Choose Your Technology!

Use the two cards below to navigate directly to hardware for each technology, or scroll down to browse the full list of available hardware. You can also select the Accessories card to learn about additional hardware used to support equipment installation.

If you have any questions about any of the products below just contact your GXC representative or reach out to us at [gxc.io](https://gxc.io/).

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="image">Cover image</th></tr></thead><tbody><tr><td><a href="#id-5g-hardware">5G Hardware</a></td><td>Appliances, Access Points, Transport, gNBs, and Mobile Kits</td><td data-object-fit="contain"><a href="https://4084968256-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgSxa0NIdBp5aDw7Lf2N9%2Fuploads%2FYm4CBmDYIkyWAvEwiudK%2FChatGPT%20Image%20Mar%207%2C%202026%2C%2003_10_11%20AM-transport-updated-3.png?alt=media&amp;token=50415b9b-1f96-4609-b1ce-ee7497bb2c90">ChatGPT Image Mar 7, 2026, 03_10_11 AM-transport-updated-3.png</a></td></tr><tr><td><a href="#lte-hardware">LTE Hardware</a></td><td>Appliances, Access Points, Mesh Nodes, and Mobile Kits</td><td><a href="https://4084968256-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgSxa0NIdBp5aDw7Lf2N9%2Fuploads%2FiioTwdmpv0fZjAN98lRR%2FChatGPT%20Image%20Mar%207%2C%202026%2C%2002_33_28%20AM-LTE%20updated-cropped.png?alt=media&amp;token=5598aa4a-57bd-4203-b82a-f6f4558974ec">ChatGPT Image Mar 7, 2026, 02_33_28 AM-LTE updated-cropped.png</a></td></tr><tr><td><a href="#hardware-accessories">Accessories</a></td><td>Listing of supporting installation hardware through GXC</td><td><a href="https://4084968256-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgSxa0NIdBp5aDw7Lf2N9%2Fuploads%2FSG8A648bggKSwEY01glB%2FChatGPT%20Image%20Mar%207%2C%202026%2C%2002_51_09%20AM-accessories-1.png?alt=media&amp;token=64dbde1d-38c4-40f2-bb8a-11806eaf59f6">ChatGPT Image Mar 7, 2026, 02_51_09 AM-accessories-1.png</a></td></tr></tbody></table>

***

## 5G Hardware

<details>

<summary>GXC 5G Onyx Architecture Reference Image</summary>

<div data-with-frame="true"><figure><img src="https://4084968256-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgSxa0NIdBp5aDw7Lf2N9%2Fuploads%2FrLeixyJ6VSoAVp2B673j%2Fimage.png?alt=media&amp;token=894113f1-d879-4055-9b14-58b2c1c56257" alt=""><figcaption></figcaption></figure></div>

</details>

### 5G Appliances

<table><thead><tr><th width="250.25">Device</th><th>Description</th></tr></thead><tbody><tr><td><a href="/hw/5g/5g-network-appliances/onyx-es7">Onyx ES7</a></td><td>1U 5G Enterprise Appliance, Core/CU/DU, Intel E810 w/ 4x10/25GbE SFP28 ports, front panel access</td></tr><tr><td><a href="/hw/5g/5g-network-appliances/onyx-es8">Onyx ES8</a></td><td>Outdoor IP65 Appliance, Core/CU/DU, Intel® E810-= w/4x10/25 GbE SFP28 ports + GPS</td></tr><tr><td><a href="/hw/5g/5g-network-appliances/onyx-ng1">Onyx NG1</a></td><td>1U 5G Enterprise Appliance, Core/CU/DU, Intel E810 w/ 4x10/25GbE SFP28 ports, front panel access, rear panel access</td></tr></tbody></table>

### 5G Access Points

<table><thead><tr><th width="250.25"></th><th></th></tr></thead><tbody><tr><td><a href="/hw/5g/5g-access-points/g105">G105</a></td><td>Indoor, TDD n48/n77/n78 (separate models), 2 CC,4T4R, ORAN 7-2x split architecture, supports external antennas (SMA), up to 250 mW (24 dBm) per antenna port, PoE++ injector (included) or AC/DC adapter (optional)</td></tr><tr><td><a href="/hw/5g/5g-access-points/g505">G505</a></td><td>Outdoor (IP65), TDD n48/n58 (separate models), 4T4R, external antenna (n-type), 7-2x split architecture, up to 5W (37 dBm) per antenna port, AC powered</td></tr><tr><td><a href="/hw/5g/5g-access-points/g506">G506</a></td><td>Outdoor (IP65), TDD n77, 4T4R, external antenna (4.3-10) ORAN 7-2x split architecture, 5W (37 dBm) per antenna port, DC powered</td></tr><tr><td><a href="/hw/5g/5g-access-points/g509-n28">G509-n28</a></td><td>Outdoor (IP65), FDD b28, 2T2R, external antenna (4.3-10), ORAN 7-2x split architecture, 40W (46 dBm) per antenna port, -48 DC powered</td></tr><tr><td><a href="/hw/5g/5g-access-points/g509-n41">G509-n41</a></td><td>Outdoor (IP65), TDD b41/n41, 4T4R,  external antenna (4.3-10), ORAN 7-2x split architecture, 40W (46 dBm) per antenna port, -48 DC powered</td></tr></tbody></table>

### Front Haul Multiplexer

<table><thead><tr><th width="250.25">Device</th><th>Description</th></tr></thead><tbody><tr><td><a href="/hw/5g/5g-fronthaul-multiplexer">FHM-001</a></td><td>Networking device for coverage expansion</td></tr></tbody></table>

### Front Haul Switch

<table><thead><tr><th width="250.25">Device</th><th>Description</th></tr></thead><tbody><tr><td><a href="/hw/5g/5g-fronthaul-switch">FHS-001</a></td><td>Networking device for Font haul Switching. 40 SFP+ ports, supporting up to 400 Gbps on select ports</td></tr></tbody></table>

### 5G gNB

<table><thead><tr><th width="250.25">Device</th><th>Description</th></tr></thead><tbody><tr><td><a href="/hw/5g/5g-gnb/g227-n48-n78">G227</a> </td><td>Indoor (IP30), TDD n48/n78 (separate models), 1 CC,2T2R, internal antenna (supports external antennas-SMA), up to 250 mW (24 dBm) per antenna port, PoE++ injector (included) or 12 DC input power plug</td></tr><tr><td><a href="/hw/5g/5g-gnb/g238-n78h-dc">G238-n78H-DC</a></td><td>Outdoor (IP65), TDD n78-High Band (3600MHz-3800MHz), 1 CC, 2T2R, External Antenna (type-N), 3W (35 dBm) per RF antenna port, -48 VDC powered</td></tr><tr><td><a href="/hw/5g/5g-gnb/g243-n78h">G243-n78H</a></td><td>Outdoor (IP65), TDD n78-High Band (3600MHz-3800MHz), 1 CC, 2T2R, External Antenna (type-N), 10W (40 dBm) per RF antenna port, AC powered</td></tr><tr><td><a href="/hw/5g/5g-gnb/g243-n48">G243-n48</a></td><td>Outdoor (IP65), TDD n48), 1 CC, 2T2R, External Antenna (type-N), 5W (37 dBm) per RF antenna port, AC powered</td></tr><tr><td><a href="/hw/5g/5g-gnb/g430-n48-n78">G430</a></td><td>Indoor (IP30), TDD n48/n78 (separate models), 2CC, 4T4R, internal antenna (supports external antennas-SMA), 250 MW (24 dBm) per antenna port, PoE++ injector (included), or 12 VDC power connector</td></tr><tr><td><a href="/hw/5g/5g-gnb/g443-n48-n78">G443</a></td><td>Outdoor (IP65), TDD n48/n78 (separate models), 2CC, 4T4R, External Antenna (type-N), 5W (37dBm) per antenna port, -48 VDC powered</td></tr></tbody></table>

### 5G Mobile Kits

<table><thead><tr><th width="250.25">Device</th><th>Description</th></tr></thead><tbody><tr><td><a href="/hw/5g/5g-network-mobile-kits/mng-00x-mobile-network-gateway">MNG-00x</a></td><td>5G Mobile Kit, TSA Compliant Case (checked-luggage), fully self-contained standalone private "network in a box". Designed for temporary applications requiring a 5G network. Customer can pair this Mobile Network Gateway with any two GXC 5G APs.</td></tr><tr><td><a href="/hw/5g/5g-network-mobile-kits/one-box-solution-gxc-5g-mobile-kit">AIC-8084-0001</a></td><td>The GXC/Askey One-Box Mobile Kits provide an advanced, all-in-one solution for rapidly deploying fully functional private 5G networks.  This is a GXC Core deployed with an Askey gNB.</td></tr></tbody></table>

## LTE Hardware

<details>

<summary>GXC 4G Onyx Architecture Reference Image</summary>

<figure><img src="https://4084968256-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgSxa0NIdBp5aDw7Lf2N9%2Fuploads%2FRPbTzyfpRni7fKeFZPE3%2Fimage.png?alt=media&amp;token=70cb5239-520b-4249-922f-647f8c8db3e1" alt=""><figcaption></figcaption></figure>

</details>

### Appliances

These is the hardware that contains the Onyx Edge Core.

<table><thead><tr><th width="250.25">Appliance</th><th>Description</th></tr></thead><tbody><tr><td><a href="/hw/lte/4g-network-appliances/onyx-es2">Onyx ES2</a></td><td>A compact ruggedized appliance compute platform used for smaller private wireless deployments where space is at a premium.</td></tr><tr><td><a href="/hw/lte/4g-network-appliances/onyx-es4">Onyx ES4</a></td><td>An Enterprise level, rack-mounted solution designed for larger deployments.</td></tr></tbody></table>

### 4G Access Points

<table><thead><tr><th width="250.25">Device</th><th>Description</th></tr></thead><tbody><tr><td><a href="/hw/lte/4g-access-points/g100">G100</a></td><td>Indoor, CA/2CC LTE, b48, 4x250mW (24 dBm)</td></tr><tr><td><a href="/hw/lte/4g-access-points/g101">G101</a></td><td>Outdoor, CA/2CC LTE, b48, 4x250mW (24 dBm)</td></tr><tr><td><a href="/hw/lte/4g-access-points/g501">G501</a></td><td>Outdoor, CA/2CC LTE, b48, 4x1W (30 dBm)</td></tr></tbody></table>

### 4G Mesh Nodes

<table><thead><tr><th width="250.25">Device</th><th>Description</th></tr></thead><tbody><tr><td><a href="/hw/lte/4g-mesh-nodes/gm01">GM01</a></td><td>Outdoor, b48, wireless backhaul extension, CAT 12, up to 2 CA, 2x20 MHz, 1T2R, 20 dBm max RMS, </td></tr><tr><td><a href="/hw/lte/4g-mesh-nodes/gm02">GM02</a></td><td>Outdoor, b48,  wireless backhaul extension, CAT12, up to 2CA DL/UL, 2 x 20 MHz, 1T2R LTE, 2T2R 5G (future), 20 dBm conducted, max 35.2 EIRP, CATB CPE-CBSD</td></tr></tbody></table>

### 4G Mobile Kits

<table><thead><tr><th width="250.25">Device</th><th>Description</th></tr></thead><tbody><tr><td><a href="/hw/lte/4g-network-mobile-kits">MKT-001</a></td><td>LTE Mobile Kit, b48, w/ G100 b48 AP, TSA Carry-on Compliant</td></tr></tbody></table>

## Hardware Accessories

[Link](/hw/hardware-accessories/antennas) to available hardware accessories to support our hardware installations.


# 5G Network Appliances

This section provides information about the available Network Gateways designed for high-performance 5G applications, functioning as both a Centralized Unit (CU) and Distributed Unit (DU) in the Onyx Platform.

<figure><img src="https://4084968256-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgSxa0NIdBp5aDw7Lf2N9%2Fuploads%2Fi9qloGh75VWOR2CORfVM%2Fimage.png?alt=media&amp;token=0c22c860-8a29-4df7-a953-7583f3e7d08d" alt=""><figcaption></figcaption></figure>


# Onyx ES7

<figure><img src="https://4084968256-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgSxa0NIdBp5aDw7Lf2N9%2Fuploads%2FzUpZGpY2qe4oMPuXRAIn%2Fimage.png?alt=media&amp;token=a5ac23a3-dcd5-427a-b893-5a080597f6a1" alt=""><figcaption></figcaption></figure>


# ES7 Specification Sheet

Last Updated: 2025-07-03

<h4 align="center">Onyx ES7 Appliance</h4>

<figure><img src="https://4084968256-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgSxa0NIdBp5aDw7Lf2N9%2Fuploads%2FN0Wjpn5xh7Lg1HZDK6uB%2Fimage1.png?alt=media&amp;token=54bdd221-b428-4ecf-a924-f8c4d9132367" alt=""><figcaption></figcaption></figure>

The ONYX-ES7 is a 1U 5G Appliance designed for high-performance 5G applications, functioning as both a Centralized Unit (CU) and Distributed Unit (DU). Featuring an on-board Broadcom 57504 Quad Port 25GbE SFP28 Network Interface, it offers robust processing power and high-speed connectivity. Built for demanding edge environments, the Onyx-ES7 ensures reliable, low-latency 5G network operations, making it ideal for industrial, remote, and mission-critical applications where durability and performance are essential.

### Technology

<table><thead><tr><th width="250">Parameter</th><th>Specification</th></tr></thead><tbody><tr><td>Front Ports</td><td>1 x iDRAC Direct (Micro-AB USB 2.0) port<br>1 x iDRAC dedicated port<br>1 x USB 3.0 port<br>1 x Serial Port (Micro-AB USB 2.0-compliant)<br>1 x Mini-DisplayPort<br>4 x 25 GbE SFP+ LOM<br>1 x RJ45 for dedicated dry contacts</td></tr><tr><td>Network</td><td>Onboard Broadcom 57504 Quad Port 25GbE SFP28<br>1 x 1GbE RJ45 iDRAC Management Port<br>1 x Intel E810-XXVDA4TGG1 w/ GNSS PCIe, featuring:<br>4 x 10/25GbE SFP28 Ports<br>1 x SMB-GNSS Antenna<br>2 x SMA-1pps IN/OUT</td></tr><tr><td>Synchronization</td><td>1588 PTP/SyncE with bidirectional and NC-SI Support</td></tr><tr><td>Operating Temperature Range</td><td>-5 to 55°C (23 to 131°F)</td></tr><tr><td>Inserted Chassis Dimensions<br>(W x D x H)</td><td>17.08 x 16.4 x 1.68 in (434.0 x 418.3 x 42.8 mm)</td></tr><tr><td>Overall Chassis Dimensions<br>(W x D x H)</td><td>19.0 x 18.4 x 1.68 in (482.6 x 466.1 x 42.8 mm)</td></tr><tr><td>Mounting Options</td><td>Rack-mountable (1U form factor)</td></tr><tr><td>Video Card</td><td>1 x On-Board Matrox Millennium G200 - 16 MB</td></tr><tr><td>Power Supply</td><td>Dual, Hot-plug, Power Supply (1+1), 1400 W</td></tr></tbody></table>

### Included Items

<table><thead><tr><th width="175">Item</th><th width="320">Description</th><th width="74">Qty</th><th>Notes</th></tr></thead><tbody><tr><td>ONYX-ES7 Edge Appliance</td><td>Appliance hardware hosting GXC Core/CU/DU.</td><td>1</td><td>Rack mounted compute platform</td></tr><tr><td>Power Cords</td><td>NEMA 5-15P to C13 Wall Plug, 125 Volt, 15 AMP, 10 ft (3 m), Power Cord, North America</td><td>2</td><td>Included</td></tr><tr><td>SFP+ Transceivers</td><td>10G SFP+, 1310 nm, Single-Mode, Duplex LC, Long Range</td><td>2</td><td>Included</td></tr><tr><td>LC-to-LC Fiber Patch Cable</td><td>LC-to-LC Fiber Patch Cable Single Mode, 10 ft (3 m)</td><td>1</td><td>Included</td></tr><tr><td>Mounting Rail Kit</td><td>Dell A26 ReadyRails™ Static Rails for 2/4-post Racks</td><td>1</td><td>Mounting Rail Kit Carton</td></tr></tbody></table>

### Global Part Numbers

<table><thead><tr><th width="250">Item</th><th>Description</th></tr></thead><tbody><tr><td>GXC-SER-007</td><td>ONYX-ES7 – ONYX 5G Edge Appliance 10/25G</td></tr></tbody></table>

* Images shown are representative and may not reflect the exact product configuration
* Specifications and ID are subject to change without notice.


# Cable Connections Example

The diagram below illustrates the connections to the Core/gNB Appliance and FHM (if used in your deployment). Your configuration will vary depending on your deployment but the diagram below is a representation of what the connections will look like.&#x20;

**Single RU:** Connect the RU directly to the Core/gNB server to s0f3-1 as shown below for a single RU per Cell. A Cell is a port of s0f3, s0f2, or s0f1.&#x20;

Onboard the RU, Refer to the Onyx Portal Operations Guide *(Manage Equipment > Manage APs > Add APs > Add APs to 5G Networks)*

**Multiple RU:** Connect the RUs to the installed Onyx-FHM-001 starting with port 0. Ensure all RUs are of the same model.&#x20;

To edit the FHM. Refer to the Onyx Portal Operations Guide *(Manage Equipment > Manage FHM > Edit FHM*&#x20;

<p align="center"><strong>RU to Core/gNB or FHM</strong></p>

![](https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/vtEUXoX03RqfRW1bvxkv/media/image83.png)


# Onyx ES8

<figure><img src="https://4084968256-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgSxa0NIdBp5aDw7Lf2N9%2Fuploads%2FFLdSWumrYyf0Wmyx41Ux%2Fimage.png?alt=media&amp;token=d935f689-7823-4bb8-933d-265110f52f1f" alt=""><figcaption></figcaption></figure>


# ES8 Specification Sheet

Last Updated: 2025-05-07

#### Onyx Edge ES8 Outdoor Rated Appliance

<figure><img src="https://4084968256-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgSxa0NIdBp5aDw7Lf2N9%2Fuploads%2F3G2Y6W5WkgmwJVZC06uA%2Fimage1.png?alt=media&amp;token=9b02697c-c3f1-47c1-a02d-286ed5705308" alt="" width="226"><figcaption></figcaption></figure>

The GXC ONYX-ES8 ONYX Edge Outdoor Appliance is an IP65-rated outdoor computing platform offering a robust, high-performance edge solution tailored for 5G private wireless networks. Engineered to meet the rigorous demands of industrial and unprotected outdoor telecommunications environments, this platform combines rugged durability with advanced processing power, ensuring reliable performance in challenging conditions.

### Key Features

<table><thead><tr><th width="250">Specification</th><th>Parameter</th></tr></thead><tbody><tr><td>IP65-Rated Enclosure</td><td>Protection against dust and low-pressure water jets from any direction, making it ideal for outdoor and industrial environments.</td></tr><tr><td>Intel® E810 Network Interface Card</td><td>Optimized for high-throughput, low-latency networking, enabling seamless connectivity for 5G private wireless and other demanding applications.</td></tr><tr><td>Flexible Mounting Options</td><td>Can be mounted on walls or poles, allowing for versatile installation across various outdoor and indoor locations.</td></tr></tbody></table>

### Appliance Technical Specifications

<table><thead><tr><th width="250">Parameter</th><th>Specification</th></tr></thead><tbody><tr><td>Appliance Dimensions (W x H x D)</td><td>10.50 x 4.62 x 16.00 in (266.7 x 117.4 x 406.4 mm)</td></tr><tr><td>Weight (approx.)</td><td>18.5 lb (8.16 kg)</td></tr><tr><td>Power Consumption</td><td>600 W (maximum)</td></tr><tr><td>On-Board Network Connectivity</td><td>2 x RJ45 10GBASE-T with Intel® X550-AT2<br>1 x RJ45 1 GbE with Realtek RTL8211F PHY (dedicated IPMI)</td></tr><tr><td>Expansion PCIe Network Interface Card</td><td>1 x Intel® E810-XXVDA4TGG1 4-Port 25 GbE SFP28 - Westport Channel + GPS</td></tr><tr><td>USB Ports</td><td>2 x USB 2.0 Type-A Ports<br>4 x USB 3.2 Gen1 Type-A Ports</td></tr><tr><td>Video Port</td><td>1 x VGA</td></tr><tr><td>Power Supply</td><td>1 x 800 W, 100-240 VAC Input, Redundant Power Supply</td></tr><tr><td>System Cooling</td><td>Fans: 3 x 80 x 80 x 38 mm with System Fan Speed Control</td></tr><tr><td>Operating Temperature</td><td>0°C to 45°C (32°F to 113°F)</td></tr></tbody></table>

### Chassis Technical Specifications

<table><thead><tr><th width="250">Parameter</th><th>Specification</th></tr></thead><tbody><tr><td>Chassis Dimensions (W x H x D)</td><td>12.56 x 32.31 x 10.16 in (319.0 x 820.7 x 258.1 mm)</td></tr><tr><td>Weight (Chassis)</td><td>82.5 lb (37.4 kg)</td></tr><tr><td>Weight (Chassis + Server)</td><td>101.0 lb (45.8 kg)</td></tr><tr><td>Power Consumption<br>(Chassis + Server)</td><td>900 W (maximum)</td></tr><tr><td>Power Distributor</td><td>AC/DC 1400 W, input: 100-240 VAC, DC output: 48 VDC</td></tr><tr><td>System Cooling</td><td>Integrated air-to-air heat exchanger, 3 x waterproof 80 x 80 mm PWM redundant fans</td></tr><tr><td>Operating Temperature</td><td>-40°C to 46°C (-40°F to 114.8°F) + solar load</td></tr><tr><td>Operating Relative Humidity</td><td>8% to 90% (non-condensing)</td></tr><tr><td>Ingress Protection Rating</td><td>IP65</td></tr><tr><td>Mounting Options</td><td>Pole mounting / wall mounting</td></tr></tbody></table>

### Global Part Numbers

<table><thead><tr><th width="250">Item</th><th>Description</th></tr></thead><tbody><tr><td>GXC-SER-008</td><td>ONYX-ES8 ONYX 5G Edge Outdoor IP65-Rated Appliance 25G</td></tr></tbody></table>

* Images shown are representative and may not reflect the exact product configuration
* Specifications and ID are subject to change without notice.


# Onyx NG1

<figure><img src="https://4084968256-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgSxa0NIdBp5aDw7Lf2N9%2Fuploads%2FVTRLJgenXMGfxOFUYnxx%2Fimage.png?alt=media&amp;token=579e4fcb-dd78-4e4d-9933-c5646367f36c" alt=""><figcaption></figcaption></figure>


# NG1 Specification Sheet

Last Updated: 2026-01-05

<h4 align="center">Onyx Network Gateway (NG1)</h4>

<figure><img src="https://4084968256-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgSxa0NIdBp5aDw7Lf2N9%2Fuploads%2FChZ3IwLTQLGr7kjGiUq5%2Fimage3.jpeg?alt=media&amp;token=7cd10a32-fcb9-4ada-b3e2-b7c87c4c7940" alt=""><figcaption></figcaption></figure>

\*Representative images

The Onyx-NG1-5G is a network edge appliance designed for high-performance on-premises 5G service delivery. It provides core network functionality, radio access and control, and grandmaster precision timing synchronization for connected radio units. Built for demanding edge environments, the Onyx-NG1-5G ensures reliable 5G network operations, making it ideal for industrial and mission-critical applications where durability and performance are essential.

### Technology

<table><thead><tr><th width="250">Parameter</th><th>Specification</th></tr></thead><tbody><tr><td>Model Overview</td><td>1U rear port access<br>15.5 inches nominal rack depth<br>Single AC power supply<br>Connectivity for 1 to 3 cells</td></tr><tr><td>Networking</td><td>1 x 1GbE RJ45 management port<br>4 x 10/25GbE SFP28 ports<br>3 ports for radio unit fronthaul<br>1 port for network backhaul<br>1 x SMB-GNSS antenna port<br>2 x SMA-1pps IN/OUT for multi-server synchronization<br>Local PTP grandmaster for IEEE 1588 PTP synchronization and SyncE support</td></tr><tr><td>Operating Temperature Range</td><td>50°F to 95°F (10°C to 35°C)</td></tr><tr><td>Chassis Dimensions<br>(W x D x H)</td><td>16.93 x 15.48 x 1.71 inches<br>430.0 x 393.2 x 43.5 mm</td></tr><tr><td>Mounting Options</td><td>Rack-mountable (1U form factor)</td></tr><tr><td>Power Supply (AC)</td><td>Single</td></tr><tr><td>Power Consumption (W)</td><td>Typical: 180W<br>Maximum 300W</td></tr></tbody></table>

### Included Items

<table><thead><tr><th width="175">Item</th><th width="320">Description</th><th width="75">Qty</th><th>Notes</th></tr></thead><tbody><tr><td>Onyx-NG1-5G</td><td>Network Gateway Hardware</td><td>1</td><td>Network Gateway Appliance</td></tr><tr><td>Power Cords</td><td>NEMA 5-15P to C13 Wall Plug, 125 Volt, 15 AMP, 10 ft (3 m), Power Cord, North America</td><td>1</td><td>Included with Network Gateway</td></tr><tr><td>SFP+ Transceivers</td><td>10G SFP+, 1310 nm, Single-Mode, Duplex LC, Long Range</td><td>2</td><td>Included with Network Gateway</td></tr><tr><td>Fiber Patch Cable</td><td>LC-to-LC Single Mode, 10 ft (3 m)</td><td>1</td><td>Included with Network Gateway</td></tr><tr><td>Mounting Rail Kit</td><td>Static Rails for 2/4-post Racks</td><td>1</td><td>Mounting Rail Kit Carton</td></tr></tbody></table>

### Global Part Numbers

<table><thead><tr><th width="250">Item</th><th>Description</th></tr></thead><tbody><tr><td>GXC-NG1</td><td>Onyx-NG1-5G Network Gateway (rear panel access)</td></tr></tbody></table>

* Images shown are representative and may not reflect the exact product configuration
* Specifications and ID are subject to change without notice.


# Onyx NG2

<figure><img src="https://4084968256-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgSxa0NIdBp5aDw7Lf2N9%2Fuploads%2FVTRLJgenXMGfxOFUYnxx%2Fimage.png?alt=media&amp;token=579e4fcb-dd78-4e4d-9933-c5646367f36c" alt=""><figcaption></figcaption></figure>


# NG2 Specification Sheet

Last Updated: 2026-01-05

<h4 align="center">Onyx Network Gateway (NG2)</h4>

<figure><img src="https://4084968256-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgSxa0NIdBp5aDw7Lf2N9%2Fuploads%2FtktSjmBHVjUJ72YTKvnF%2FNG2_wht_bckgrnd.jpg?alt=media&amp;token=a5a83c32-0c34-4457-bf05-446bee50dba4" alt=""><figcaption></figcaption></figure>

\*Representative images

The Onyx-NG2-5G is a network edge appliance designed for high-performance on-premises 5G service delivery. It provides core network functionality, radio access and control, and grandmaster precision timing synchronization for connected radio units. Built for demanding edge environments, the Onyx-NG2-5G ensures reliable 5G network operations, making it ideal for industrial and mission-critical applications where durability and performance are essential.

### Technology

<table><thead><tr><th width="250">Parameter</th><th>Specification</th></tr></thead><tbody><tr><td>Model Overview</td><td>1U front port access<br>Dual AC/DC power supply<br>Connectivity for 1 to 3 cells</td></tr><tr><td>Networking</td><td>1 x 1GbE RJ45 management port<br>8 x 10GbE SFP+ ports (FH/BH)<br>1 x SMB-GNSS antenna port<br>Local PTP grandmaster for IEEE 1588 PTP Synchronization and SyncE support</td></tr><tr><td>Operating Temperature Range</td><td>23°F to 131°F (-5°C to 55°C)</td></tr><tr><td>Chassis Dimensions<br>(H x W x D)</td><td>1.70 x 17.25 x 16.93 inches<br>43 x 438 x 430 mm</td></tr><tr><td>Mounting Options</td><td>Rack-mountable (1U form factor)</td></tr><tr><td>Power Supply (AC)</td><td>Redundant hot-swappable power supply
<br>AC 100 to 240V, 50/60Hz</td></tr><tr><td>Power Consumption (W)</td><td>Maximum 180 W</td></tr></tbody></table>

### Included Items

<table><thead><tr><th width="175">Item</th><th width="320">Description</th><th width="75">Qty</th><th>Notes</th></tr></thead><tbody><tr><td>Onyx-NG2-5G</td><td>Network Gateway Hardware</td><td>1</td><td>Network Gateway Appliance</td></tr><tr><td>Power Cords</td><td>NEMA 5-15P to C13 Wall Plug, 125 Volt, 15 AMP, 10 ft (3 m), Power Cord, North America</td><td>2</td><td>Included with Network Gateway</td></tr><tr><td>SFP+ Transceivers</td><td>10G SFP+, 1310 nm, Single-Mode, Duplex LC, Long Range</td><td>2</td><td>Included with Network Gateway</td></tr><tr><td>Fiber Patch Cable</td><td>LC-to-LC Single Mode, 10 ft (3 m)</td><td>1</td><td>Included with Network Gateway</td></tr><tr><td>Mounting Rail Kit</td><td>Static Rails for 2/4-post Racks</td><td>1</td><td>Mounting Rail Kit Carton</td></tr></tbody></table>

### Global Part Numbers

<table><thead><tr><th width="250">Item</th><th>Description</th></tr></thead><tbody><tr><td>GXC-NG-002</td><td>Onyx-NG2-5G Network Gateway (front panel access)</td></tr></tbody></table>

* Images shown are representative and may not reflect the exact product configuration
* Specifications and ID are subject to change without notice.


# 5G Access Points

This section provides information about the available 5G Access Points in the Onyx Platform.

<figure><img src="https://4084968256-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgSxa0NIdBp5aDw7Lf2N9%2Fuploads%2FGcZwoJQh5U4DgTG5ryuN%2Fimage.png?alt=media&amp;token=59f4a6ab-35f4-485f-bd3e-fb7cb18ed082" alt=""><figcaption></figcaption></figure>


# G105

<figure><img src="https://4084968256-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgSxa0NIdBp5aDw7Lf2N9%2Fuploads%2F3kMAGK0YH4ouyZgvprnX%2Fimage.png?alt=media&amp;token=8c40230b-8ef9-454f-8bcb-abc31a3f9dc9" alt=""><figcaption></figcaption></figure>


# G105 AP Specification Sheet

Last Updated: 2026-02-23

<p align="center"><strong>G105 Indoor TDD Access Point</strong></p>

<figure><img src="https://4084968256-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgSxa0NIdBp5aDw7Lf2N9%2Fuploads%2FbDSqNNX8wEjtNEPdjmYt%2Fimage.png?alt=media&amp;token=77669c81-6afe-4b32-8ff2-bf889dbbe769" alt=""><figcaption></figcaption></figure>

The GXC G105 is an advanced, O-RAN compliant Access Point designed for seamless 5G connectivity, with:

* 4T4R configuration with 250 mW per antenna port
* IP50 indoor-rated design
* Compliance with 5G NR TDD 3GPP R15 standards
* O-RAN 7-2x split architecture
* Compatible with n48, n77, and n78 bands
* Equipped with internal 6 dBi antennas (supports external antennas)
* Supports 2 Component Carriers (2CC)

## Technology

<table><thead><tr><th width="250">Parameter</th><th>Specification</th></tr></thead><tbody><tr><td>Standard</td><td>5G NR 3GPP TS38.104, Option 7-2a Category A</td></tr><tr><td>Duplex Mode</td><td>TDD</td></tr><tr><td>Frequency Band</td><td>n48: 3550 MHz to 3700 MHz<br>n77: 3700 MHz to 4200 MHz (future release)<br>n77a: 3700 to 3980 MHz<br>n78: 3300 MHz to 3800 MHz</td></tr><tr><td>Channel Bandwidth</td><td>n48: (10, 20, 40) MHz<br>n77: up to 100 MHz (future release)<br>n77a: up to 100<br>n78: up to 100 MHz</td></tr><tr><td>Multiplexing</td><td>MIMO: 4T4R</td></tr><tr><td>Carrier Aggregation</td><td>2CC</td></tr><tr><td>Sub Carrier Spacing (SCS)</td><td>30 kHz / 60 kHz</td></tr></tbody></table>

## Interfaces

<table><thead><tr><th width="249.9998779296875">Parameter</th><th>Specification</th></tr></thead><tbody><tr><td>Ports</td><td>1 x 10 Gbps SFP+ (Fronthaul)<br>1 x 1 GbE RJ45 (802.3bt – Type 3 or Type 4 only)</td></tr><tr><td>Power</td><td>Option 1: Injector (Included), IEEE 802.3bt, Type 3 (PoE++ / UPoE), 60 W<br>Option 2: Adapter, Input: 100-240 VAC, 50-60 Hz 1.5 A Max, Output: 12 VDC, 4.0 A, 48.0 W</td></tr><tr><td>LED Indicators</td><td>Power, S-Plane, Service</td></tr><tr><td>Antenna</td><td>External: 4 x SMA (GXC-APIn48-105, GXC-APIn78-105)<br>Internal: 4 x 6 dBi omni (GXC-APIn48-105i, GXC-APIn78-105i)</td></tr></tbody></table>

## Link Budget

<table><thead><tr><th width="250">Parameter</th><th>Specification</th></tr></thead><tbody><tr><td>Modulation</td><td>256 QAM (UL/DL)</td></tr><tr><td>Max. Transmit Power</td><td>N48:<br>100 mW (20 dBm) @10MHz per RF antenna port<br>125 mW (20 dBm) @20MHz per RF antenna port<br>250 mW (24 dBm) @40MHz per RF antenna port<br>N77/N77a:<br>250 mW (24 dBm) per RF antenna port<br>N78:<br>250 mW (24 dBm) per RF antenna port</td></tr></tbody></table>

## Compliance

<table><thead><tr><th width="250">Parameter</th><th>Specification</th></tr></thead><tbody><tr><td>3GPP</td><td>5G NR TDD R16</td></tr><tr><td>EMC</td><td>EN 301489-1/-50, EN55032/55035, FCC Part 15 Class B (CBRS)<br>EN 301908-1, EN 301908-24, EN 55385 (MPE)<br>FCC Part 96 (CBRS), 5G NR JRL</td></tr><tr><td>Safety</td><td>IEC/EN 60950-1, CB - IEC/EN 62368-1</td></tr></tbody></table>

## Physical

<table><thead><tr><th width="250">Parameter</th><th>Specification</th></tr></thead><tbody><tr><td>Ingress Protection Rating</td><td>IP50</td></tr><tr><td>Operating Temperature</td><td>23 °F to 122 °F (-5 °C to +50 °C), (5 to 95) %RH</td></tr><tr><td>Power Consumption</td><td>&#x3C; 45 W</td></tr><tr><td>Weight</td><td>&#x3C; 8.8 lb (&#x3C; 4 kg)</td></tr><tr><td>Dimensions (H x W x D)</td><td>10.2 x 11.0 x 3.5 in (260 x 280 x 90 mm)</td></tr><tr><td>Installation</td><td>Wall / Pole mount</td></tr></tbody></table>

## Included Items

<table><thead><tr><th width="186.3333740234375">Item</th><th width="317.6666259765625">Description</th><th width="73.3333740234375" align="right">Qty</th><th>Notes</th></tr></thead><tbody><tr><td>G105 Access Point</td><td>Main AP hardware</td><td align="right">1</td><td>Main Acess Point</td></tr><tr><td>Antennas</td><td>Articulating SMA omni dipole antennas</td><td align="right">4</td><td>Included with AP packaging</td></tr><tr><td>Mounting Bracket Kit</td><td>Can be used to mount to walls, ceilings, or poles</td><td align="right">1</td><td>Included with AP packaging</td></tr><tr><td>SFP+ Transceivers</td><td>10 Gbps SFP+, 1310 nm, Single-Mode, Duplex LC, Long Range</td><td align="right">2</td><td>Accessory Carton</td></tr><tr><td>LC-to-LC Fiber Patch Cable</td><td>LC-to-LC Fiber Patch Cable Single Mode 10 ft (3 m)</td><td align="right">1</td><td>Accessory Carton</td></tr><tr><td>PoE Injector</td><td>PoE++ 802.3bt Type 3 AC/DC Midspan Injector, 60 W</td><td align="right">1</td><td>Accessory Carton</td></tr><tr><td>PoE Injector AC Power Cord</td><td>3 ft (1 m) Heavy Duty Power Cord, NEMA 5-15P to C13 AC Power Cord, 15 A, 125 VAC</td><td align="right">1</td><td>Accessory Carton</td></tr><tr><td>CAT6 Patch Cable</td><td>10 ft (3 m) Cat6 24AWG Unshielded Ethernet Network Patch Cable, Blue</td><td align="right">1</td><td>Accessory Carton</td></tr></tbody></table>

## Global Part Numbers

<table><thead><tr><th width="250">Part Number</th><th>Description</th></tr></thead><tbody><tr><td>GXC-APIn48-105</td><td>Indoor Low power 5G Access Point (G105-48) band n48 4x4 MIMO 20 dBm, with external antennas</td></tr><tr><td>GXC-APIn48-105i</td><td>Indoor Low power 5G Access Point (G105i-48) band n48 4x4 MIMO 20 dBm, Internal Antennas</td></tr><tr><td>GXC-APIn77-105</td><td>Indoor Low power 5G Access Point (G105-77) band n77 4x4 MIMO 24 dBm (future release)</td></tr><tr><td>GXC-APIn77a-105</td><td>Indoor Low power 5G Access Point (G105-77a: 3700-3980 MHz) band n77 4x4 MIMO 24dBm</td></tr><tr><td>GXC-APIn78-105</td><td>Indoor Low power 5G Access Point (G105-78) band n78 4x4 MIMO 24 dBm</td></tr><tr><td>GXC-APIn78-105i</td><td>Indoor Low power 5G Access Point (G105i-78) band n78 4x4 MIMO 24 dBm, Internal Antennas</td></tr></tbody></table>

* Specifications and ID are subject to change without notice.


# G105 AP Installation Guide

## About this Guide

This guide provides the information you need to install a GXC G105 RU. It also includes a general description of the unit, guidelines for using it, and an overview of its capabilities.

{% hint style="info" %}
**NOTE:** Installation of this device should only be performed by a licensed Certified Professional Installer (CPI) per limitations set forth in FCC Part 96.
{% endhint %}

In this guide, the GXC G105 may be referred to as an Access Point (AP), Radio Unit (RU), Remote Radio Unit (RRU), and Open Radio Unit (ORU).

### General Active RF Installation Instructions

Only experienced installation professionals who are familiar with local building and safety codes, and wherever applicable, are licensed by the appropriate government regulatory authorities should install RF devices and antennas. Failure to do so may void the product warranty and may expose the end user to legal and financial liabilities. The manufacturer and its resellers or distributors are not liable for injury, damage or regulation violations associated with the installation of RF Devices or antennas.

{% hint style="info" %}
**NOTE:** The G105 AP is designed to be installed and operated indoors to conform to CBSD - FCC specifications.
{% endhint %}

{% hint style="info" %}
**NOTE:** Prior to installation, locate the Product ID Label and record the serial number and MAC Address of the unit and the proposed installation location in a material registry / equipment journal for future reference.
{% endhint %}

### Safety Information

{% hint style="danger" %}

## **WARNING:** Read the installation instructions before connecting the system to its power source.

{% endhint %}

{% hint style="danger" %}

## **WARNING:** Equipment installation must comply with local and national electrical codes

{% endhint %}

{% hint style="danger" %}

## **WARNING:** This product relies on the existing building or structure for short-circuit (overcurrent) protection. Ensure that the protective device is rated no greater than 15A

{% endhint %}

{% hint style="danger" %}

## **WARNING:** Do not operate this wireless network device near unshielded blasting caps or in an explosive environment. Explosions or fires may occur if installed in these environments

{% endhint %}

{% hint style="danger" %}

## **WARNING:** Do not operate this wireless network device near unshielded blasting caps or in an explosive environment. Explosions or fires may occur if installed in these environments

{% endhint %}

{% hint style="danger" %}

## **WARNING:** In order to comply with the United States Federal Communications Commission (FCC) radio frequency (RF) exposure limits, antennas should be located at a minimum of 83 centimeters (33 inches) or more from the body of all persons.

{% endhint %}

### Usage Safety Precautions

* Install or place this device on a stable surface.
* Keep this device far from electronic devices that generate strong magnetic or electric fields, such as microwave ovens, satellite dish antennas, or large appliances.
* Place this device in a cool and well-ventilated indoor area. Do not expose the device to direct sunlight.
* Do not use this device in an area under or over temperatures ranging from 5°C to +50°C.
* Do not cover this device. Reserve a minimum space of 100 mm around this device for heat dissipation.
* Use only the power adapter provided with this O-RAN Unit. Do not use alternative power adapters. Use of other adapters can damage this device.
* Before connecting and disconnecting cables, ensure that your hands are dry.
* To avoid electric shock, damage, and fire resulting from short-circuiting, do not use the product if wet, with wet hands, or while holding or drinking any liquids.
* Only insert relevant cables or devices into the ports, do not insert metal or other foreign objects.
* Do not place naked flame sources, such as lighted candles, on or near this device. Keep this device far from sources of heat and fire, such as a heater or a candle.
* Damage caused by user misuse or not following these instructions is not covered by the warranty.

### Electrical Safety Precautions

{% hint style="warning" %}
**CAUTION:** The power supply cord must be plugged into a socket or outlet that is provided with a suitable earth ground.
{% endhint %}

Refer all repairs of this product to qualified service personnel. Do not modify any part of this device, as this will void the warranty.&#x20;

Disconnect power from this product and return it for service if any of the following conditions apply:

* The product does not function after following the operating instructions outlined in this manual.
* The product has been dropped or impacted and appears physically damaged.

### Base Station Battery Backup

It is recommended to use an uninterruptible power supply (UPS) battery backup system to ensure a reliable and stable power supply to avoid hardware damage due to a power outage.

The GXC G105 is designed for Open 5G Radio Access Network (O-RAN) and is combined with additional O-RAN elements to provide a complete 5G mobile radio communication system provide 5G-NR Sub-6 GHz indoor coverage and optimal 5G network access at throughput speeds of over 1Gbps to satisfy the demands of enterprise, industrial, and commercial campuses.&#x20;

This guide provides information and steps for installing the Radio Unit but is intended for installation by pre-trained personnel only.

## Introduction

### Onyx Platform Features

The G105 AP is a part of the GXC 5G Onyx Platform, which integrates multiple hardware and software elements to bring a full solution to customers. The Onyx Platform provides an enterprise network based on a Cellular Mesh architecture. This private network platform offers high resiliency, flexible deployments, strong coverage in hard-to-reach areas, and a powerful distributed application platform.&#x20;

Key features of the Onyx Platform:

* ORAN Ecosystem, includes Rack-Based CU, DU, and FHMs and both Indoor and Outdoor-rated APs
* On-premises core network
* A robust network management platform tied together with a single-pane-of-glass controller presented as a web portal

### G105 Access Point

The G105 AP is designed for open 5G Radio Access Network (O-RAN) and is combined with additional O-RAN elements to provide a complete 5G mobile radio communication system to provide 5G-NR Sub-6 GHz indoor coverage and optimal 5G network access at throughput speeds of over 1Gbps to satisfy the demands of enterprise, industrial, and commercial campuses.&#x20;

The radio unit is designed with a flexible vRAN solution that reduces costs and increases connection speeds via split fronthaul network implementation. The access point can be mounted on walls, poles, or ceilings and utilizes either adjustable attached antennas (included) or customer specified remote antennas for deployment flexibility. This Radio Unit is based on open interfaces as defined by the O-RAN alliance with the fronthaul interface between the Access Point and the Distributed Unit (DU) that complies with RAN split 7.2a and includes the following signals:

* User plane data (UP)
* Control plane data (CP)
* Synchronization signals (PTP)
* Management plane data (MP)&#x20;

This guide provides information and steps for installing the Access Point but is intended for installation by pre-trained personnel only.&#x20;

<p align="center"><strong>GXC 5G Onyx Platform Architecture</strong></p>

![](https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/EmWoSMunnzkYgX7eIIyl/media/image7.png)

### Specifications <a href="#package-contents" id="package-contents"></a>

[*G105 AP Specification Sheet*](/hw/5g/5g-access-points/g105/g105-ap-specification-sheet)

## Getting Started <a href="#package-contents" id="package-contents"></a>

### Package Contents <a href="#package-contents" id="package-contents"></a>

{% hint style="info" %}
​**NOTE:** This device is designed to allow the connection of the grounded conductor of the DC supply circuit to the grounding conductor on the device.
{% endhint %}

#### G105 RU <a href="#package-contents-g105-ru" id="package-contents-g105-ru"></a>

<p align="center"><strong>GXC-APInxx-105 RU Package Contents</strong></p>

<table><thead><tr><th width="399.4444580078125">Parts</th><th width="99.77783203125">Qty</th><th width="150">Image</th></tr></thead><tbody><tr><td>GXC-APInxx-105 Remote Radio Unit</td><td>1</td><td><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/ypybD3YK0nK2c63waHhD/media/image8.jpeg" alt="image8.jpeg"></td></tr><tr><td>External Dipole Antennas (RP-SMA)</td><td>4</td><td><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/7RYTrAp4OT1m3Rw4gVay/media/image9.png" alt="image9.png"></td></tr><tr><td>1310nm LR (10km) Duplex LC/UPC SFP+ Optical Transceiver Modules</td><td>2</td><td><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/AsFoVbf0QGH2vWcBwOkW/media/image10.png" alt="image10.png"></td></tr><tr><td>IEEE 802.3bt Compliant PoE Injector (Adapter) including AC Power Cord</td><td>2</td><td><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/4jx1tqlPkosR3hj4JFRg/media/image11.png" alt="image11.png"></td></tr><tr><td>1.5m CAT6 LAN Cable</td><td>1</td><td><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/J7XrsCTNC6pxZEUkciAd/media/image12.png" alt="image12.png"></td></tr><tr><td>GXC-APInxx-105 Mounting Bracket Kit</td><td>1</td><td><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/KvTwLfeOZ52iPyym3yzE/media/image13.png" alt="image13.png"></td></tr></tbody></table>

#### GXC-APInxx-105i RU <a href="#package-contents-gxc-apinxx-105i-ru" id="package-contents-gxc-apinxx-105i-ru"></a>

<p align="center"><strong>GXC-APInxx-105i RU Package Contents</strong></p>

<table><thead><tr><th width="400.1112060546875">Parts</th><th width="99.4444580078125">Qty</th><th width="149.5555419921875">Image</th></tr></thead><tbody><tr><td>GXC-APInxx-105i Remote Radio Unit</td><td>1</td><td><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/uFv36vPaa09PbWCk8yzD/media/image14.png" alt="image14.png"></td></tr><tr><td>1310nm LR (10km) Duplex LC/UPC SFP+ Optical Transceiver Modules</td><td>2</td><td><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/ionzE1SW2EqQXd8gvp8q/media/image15.png" alt="image15.png"></td></tr><tr><td>IEEE 802.3bt Compliant PoE Injector (Adapter) including AC Power Cord</td><td>2</td><td><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/GIzOObFDCppsJpi8I3nk/media/image16.png" alt="image16.png"><br><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/d8lyrePZa55vIgyAzcAM/media/image17.png" alt="image17.png"></td></tr><tr><td>1.5m CAT6 LAN Cable</td><td>1</td><td><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/J7XrsCTNC6pxZEUkciAd/media/image12.png" alt="image12.png"></td></tr><tr><td>GXC-APInxx-105 Mounting Bracket Kit</td><td>1</td><td><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/6kYANGuWhmP09lE3dCb2/media/image18.png" alt="image18.png"><br><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/UCEelfHEKmdQgKGUobNa/media/image19.png" alt="image19.png"></td></tr></tbody></table>

#### G105 RU Mounting Bracket

{% hint style="info" %}
**NOTE:** This device is designed to allow the connection of the grounded conductor of the DC supply circuit to the grounding conductor on the device.
{% endhint %}

<p align="center"><strong>G105 RU Mounting Bracket Package Contents</strong></p>

<table><thead><tr><th width="400.1112060546875">Item</th><th width="99.6666259765625">Qty</th><th width="150.4443359375">Image</th></tr></thead><tbody><tr><td>RU Mounting Bracket</td><td>1</td><td><img src="https://4084968256-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgSxa0NIdBp5aDw7Lf2N9%2Fuploads%2FBI5dSVNVaVhBDc4sdBfy%2Fimage.png?alt=media&amp;token=02cec227-7881-4238-8776-6a6a6a87865c" alt="" data-size="original"></td></tr><tr><td>M3.5 x 20 mm Long Screw</td><td>4</td><td><img src="https://4084968256-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgSxa0NIdBp5aDw7Lf2N9%2Fuploads%2FSjxrj88flRSAow9OzjRW%2Fimage.png?alt=media&amp;token=5494891e-3afa-4bef-98e5-e96f78799db8" alt="" data-size="original"></td></tr><tr><td>M4 x 6 mm Long Screw</td><td>4</td><td><img src="https://4084968256-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgSxa0NIdBp5aDw7Lf2N9%2Fuploads%2FmnOEQUJBxUhQBhWRuRbw%2Fimage.png?alt=media&amp;token=53332385-9033-486e-b271-c476c98e1aa3" alt="" data-size="original"></td></tr><tr><td>M3 x 8 mm Long Screw</td><td>8</td><td><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/94LfGoqhdwHqarA2WlER/media/image23.png" alt="image23.png"></td></tr><tr><td>Concrete Screw Anchor</td><td>4</td><td><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/9HbStIZd5xKoX8xWW9oQ/media/image24.png" alt="image24.png"></td></tr><tr><td>Plaster / Drywall Screw Anchor</td><td>4</td><td><img src="https://4084968256-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgSxa0NIdBp5aDw7Lf2N9%2Fuploads%2FB4tPmIuj3Ugq4gvxHR3C%2Fimage.png?alt=media&amp;token=91908386-7161-4049-80af-f2ef8472333c" alt="" data-size="original"></td></tr></tbody></table>

### Other Items (Not Included / User Provided)

<p align="center"><strong>Other Items (Not Included / User Provided)</strong></p>

<table><thead><tr><th width="400.111083984375">Parts</th><th width="99.666748046875">Qty</th><th width="150.4443359375">Image</th></tr></thead><tbody><tr><td>Stainless Steel Pipe Clamps (Size Determined by Dia. of Pipe/Mast)</td><td>2</td><td><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/7veCZQLa6r5wv10Z7PEz/media/image26.png" alt="image26.png"></td></tr><tr><td>12 Volt Output AC/DC PSU – 54-Watt (min), 2.5 mm (+) x 5.5 mm (-)</td><td>1</td><td><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/DKy6eD6g1EKLwfY0C2ic/media/image27.jpeg" alt="image27.jpeg"></td></tr><tr><td>USB 3.0 to Gigabit Ethernet Network Adapter</td><td>1</td><td><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/sHQuHK4iboGRuXtNt2zh/media/image28.jpeg" alt="image28.jpeg"></td></tr></tbody></table>

## Installation Preparation

This document describes the installation process of pole and wall mounting of the GXC G105 5G indoor RU and the recommended location and environment required for optimal performance.

### Pre-Installation Notes

In the process of transportation, handling, and installation of the GXC G105 5G indoor RU the customer or installer must adhere to the following usage requirements:

* Before the installation, it is required to transport the G105 RU to the installation site while still in its shipping packaging. Unpacking or transferring the unit in an unprotected manner could lead to damage of the external connectors or enclosure of the G105 RU. External damage like this will not be covered under the product warranty.
* Avoid collisions between the G105 RU and other components, parts, doors, walls, shelves, and other objects during transportation, handling, and installation processes.
* During transportation, handling, and installation, wear clean protective gloves. It is prohibited to touch parts with bare hands or with dirty gloves. Contamination of the G105 RU’s connectors can lead to deficient performance or product failure.
* Before installing the G105 RU, the installer must be familiar with its exterior, ports, indicators, installation scenarios and installation clearance requirements.

  <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>NOTE:</strong> The following figure shows the GXC-APInxx-105 (External Antenna SKU). These dimensions are identical for the GXC-APInxx-105i (Internal Antenna SKU), with the exception that the four external antennas and antenna connectors are removed.</p></div>

<p align="center"><strong>G105 RU Overall Dimensions (mm)</strong></p>

![](https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/t1UA4IARNXba0o5UP1bI/media/image29.png)

## Installation Procedure

Before installing the radio unit, understand the required safety standards, power requirements, necessary tools, parts, and components available or needed.

<img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/lAwYg966xeyJksS6VpPE/media/image30.png" alt="" width="375">

### External Connector Familiarization

As seen in the following figure, on the top surface of the G105 RU, there are a total of three connector ports. These ports are marked SFP+, Power, and PoE++. Ensure that all covers or caps remain on ports until interconnection or termination is necessary. In addition, if an interconnection or termination is removed from the connector, the installer or technician must apply a proper cover or cap to protect the internal surfaces of the connector.&#x20;

<p align="center"><strong>Top Port View of the G105</strong></p>

<figure><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/9oU2FLSi0bCPY3Ymi8KY/media/image31.png" alt=""><figcaption></figcaption></figure>

<p align="center"><strong>G105 AP Ports</strong></p>

<table><thead><tr><th width="100.111083984375">Item #</th><th width="149.666748046875">Item</th><th>Description</th></tr></thead><tbody><tr><td>1</td><td>“SFP+” Port</td><td>To be used with 10Gb SFP+ Transceiver to connect to FH CUSM Plane. This port can be utilized to access RU M-Plane and provides connection for C/U- and S-Planes.</td></tr><tr><td>2</td><td>“DC Power” Port</td><td>2.5 mm (+) x 5.5 mm (-) DC Power Port. Local power provided by AC/DC Adapter (not included).</td></tr><tr><td>3</td><td>“PoE++” Port</td><td>RJ45 Jack utilizing IEEE 802.3bt-2018 pin-out. This port can be utilized to remotely power the remote from up to 100 meters (328 feet) away from PoE++ Switch using PoE++ rated Ethernet Cable. No network function.</td></tr></tbody></table>

### PoE++ IEEE 802.3bt (Type 3/4) Injector

A single port, AC/DC PoE++ Injector is provided with the G105 RU. This PoE++ Injector is certified to be IEEE 802.3bt (Type 3/4) compliant Power Sourcing Equipment (PSE). This PoE++ Injector has the following specifications.

{% hint style="info" %}
**NOTE:** The equipment is to be connected only to internal PoE++ networks without routing to the outside plant.
{% endhint %}

{% hint style="info" %}
**NOTE:** This product is intended to be supplied by a Listed power supply or PoE++ connector, output rated 54Vdc, min. 1.5A and documented as a Limited Power Source (LPS).
{% endhint %}

#### PoE++ IEEE 802.3bt (Type 3/4) Injector AC Input Ratings / Characteristics

<p align="center"><strong>PoE Injector AC Input Ratings / Characteristics</strong></p>

<table><thead><tr><th width="399.5556640625">Specification</th><th width="199.555419921875">Value/Range</th></tr></thead><tbody><tr><td>Nominal Input Voltage Range</td><td>100 – 240 Volts AC</td></tr><tr><td>Absolute Input Voltage Range</td><td>90 – 264 Volts AC</td></tr><tr><td>Nominal Input AC Frequency</td><td>50 – 60 Hz</td></tr><tr><td>Absolute Input AC Frequency</td><td>47 – 63 Hz</td></tr><tr><td>Input Current</td><td>2.0 Amps Maximum</td></tr><tr><td>Average Efficiency @ 115 Volts AC / 60Hz</td><td>>88% (on board)</td></tr><tr><td>Average Efficiency @ 230 Volts AC / 50Hz</td><td>>89% (on board)</td></tr><tr><td>No Load Power Consumption @ 115 Volts AC / 60Hz</td><td>&#x3C;0.21 Watts</td></tr><tr><td>No Load Power Consumption @ 230 Volts AC / 50Hz</td><td>&#x3C;0.15 Watts</td></tr></tbody></table>

#### PoE++ IEEE 802.3bt (Type 3/4) Injector Output Ratings / Characteristics

<p align="center"><strong>PoE++ IEEE 802.3bt (Type 3/4) Injector Output Ratings / Characteristics</strong></p>

<table><thead><tr><th width="399.5555419921875">Specification</th><th width="199.5555419921875">Value/Range</th></tr></thead><tbody><tr><td>Nominal Rated Voltage</td><td>56 Volts DC</td></tr><tr><td>Voltage Range</td><td>54 - 57 Volts DC</td></tr><tr><td>Current</td><td>0 – 1.161 Amps</td></tr></tbody></table>

### Alternate DC Power Supply Recommended Specifications

The G105 RU provides the option of electrical powering via the integrated 2.5 mm x 5.5 mm DC Power Jack. This jack is designed such that the center conductor (2.5 mm male pin) is to be provided with 12.0 +/- 5% Volts DC and the outer conductor (5.5 mm female receptacle) is to be provided with the 0 Volts DC.&#x20;

A standard AC/DC Power Supply Unit (PSU) should be used to power the G105. The PSU should be capable of producing 12.0 Volt DC Output and supplying a minimum of 4.5 Amperes of current (54 Watts).&#x20;

Other specifications should be equal to or exceed those of the specific application or, at a minimum, meet or exceed the specifications of the G105 RU.

{% hint style="info" %}
**NOTE:** An AC/DC PSU is not supplied with the G105 AP.
{% endhint %}

### Antenna Details

#### Special Port Mapping

In special cases where external antennas (other than those provided with this AP) are used, the following table is provided for cases where a Front Haul Multiplexer (FHM) or a Multi-Port Connect configuration is used.

<p align="center"><strong>Special Port Mapping</strong></p>

<table><thead><tr><th width="227.1112060546875">AP Port Number</th><th>1</th><th>2</th><th>3</th><th>4</th></tr></thead><tbody><tr><td>Antenna polarization<br>(4x4 standard)</td><td>H or +45</td><td>H or +45</td><td>V or -45</td><td>V or -45</td></tr><tr><td>Antenna polarization<br>(4x4 FHM co-located RU)</td><td>V or -45</td><td>V or -45</td><td>H or +45</td><td>H or +45</td></tr><tr><td>Multi-Port Connect :</td><td></td><td></td><td></td><td></td></tr><tr><td>     Antenna#1 2x2 dual</td><td>H or +45</td><td></td><td>V or -45</td><td></td></tr><tr><td>     Antenna#2 2x2 dual</td><td></td><td>H or +45</td><td></td><td>V or -45</td></tr></tbody></table>

{% hint style="info" %}
**NOTE:** This device is designed to allow the connection of the grounded conductor of the DC supply circuit to the grounding conductor on the device.
{% endhint %}

#### GXC-APInxx-105 External Antennas

The G105 RU Kit includes 4 pcs. of an externally mounted dipole terminal antenna. These compact and adjustable antennas provide a gain in the range of 3.2 to 4.3 dBi in a frequency band of 3300 to 3800 MHz.&#x20;

<p align="center"><strong>Typical External Antenna Form Factor and Component Detail</strong></p>

&#x20;

<figure><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/Vo1XYZlPlg4infcbcDX8/media/image32.png" alt=""><figcaption></figcaption></figure>

<p align="center"><strong>External Antenna Specifications</strong></p>

| Frequency         | 3300 to 3800 MHz |
| ----------------- | ---------------- |
| Antenna Type      | Dipole           |
| Radiation Pattern | Omni-Directional |
| Peak Gain         | 3.2              |
| Return Loss       | >8.99            |
| Efficiency        | 50%              |

Installation of the antennas is made by inserting and threading the Hinged Male/Plug SMA Connector (Pin) of the antenna to the mating Female/Jack SMA Connector (Receptacle) presented on the body of the G105 RU. Finger-tighten the finger grips (barrel nut) of the antennas, but do not torque.&#x20;

Adjust the position of the antenna elements such that the preferred coverage pattern is attained. The figure below shows initial suggested antenna orientation for the RU. Adjustment may be necessary. &#x20;

<p align="center"><strong>Front View of G105 Showing Antenna Placement</strong></p>

<figure><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/RjOC7xFytE4SA82JpFhQ/media/image33.png" alt="" width="375"><figcaption></figcaption></figure>

<p align="center"><strong>Front View of G105 Showing Antenna Placement</strong></p>

<table><thead><tr><th width="100.111083984375">Item #</th><th width="99.6666259765625">Item</th><th>Description</th></tr></thead><tbody><tr><td>1</td><td>ANT-1</td><td>SMA adjustable dipole antennas</td></tr><tr><td>2</td><td>ANT-2</td><td>SMA adjustable dipole antennas</td></tr><tr><td>3</td><td>ANT-3</td><td>SMA adjustable dipole antennas</td></tr><tr><td>4</td><td>ANT-4</td><td>SMA adjustable dipole antennas</td></tr></tbody></table>

<p align="center"><strong>G105 External Antenna 2D Radiation Pattern</strong></p>

![](https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/V514DBbSEP4Bfhkmxq69/media/image34.png)

#### GXC-APInxx-105i Internal Antennas

The G105i RU utilizes 4 pcs. of a Planer Inverted-F Antenna (PIFA). These antennas are inaccessible to the customer and have a fixed radiation pattern. This radiation pattern is omni-directional; however, most of the radiating power is hemispherical and is centered on the front face of the RU.

<p align="center"><strong>GXC-APInxx-105i Antenna Specifications</strong></p>

| Frequency         | 3300 to 4200 MHz |
| ----------------- | ---------------- |
| Antenna Type      | PIFA             |
| Radiation Pattern | Hemispherical    |
| Peak Gain         | 3.2              |
| Return Loss       | > 8.99           |
| Efficiency        | > 50%            |

<p align="center"><strong>G105i Internal Antenna 2D Radiation Pattern</strong></p>

<figure><img src="https://4084968256-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgSxa0NIdBp5aDw7Lf2N9%2Fuploads%2F06b4sCjk4BWCOjKpAsle%2Fimage.png?alt=media&amp;token=98f845c8-74f8-4062-a71b-6202919def26" alt=""><figcaption></figcaption></figure>

### LED Indicators

There are 3 light emitting diodes (LEDs) present on the front surface of the G105 RU. These LEDs provide the local user with an indication of the unit’s status and can also be used for troubleshooting. Presented in this guide is a summary of LED behaviors. For further details, please refer to the G105 User Guide.

<p align="center"><strong>LED Indicators</strong></p>

<img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/PeHoxyjQ0TsF6xO6IFE3/media/image36.png" alt="" width="375">

* “Power” LED – Indicates the power status of the G105 RU.
  * Solid Green: Power On
  * Off: Normal - Powered Off
* “S-Plane” LED – Indicates the Precision Time Control (PTP) Lock status of the G105 RU.
  * Green:
    * Solid: PTP Locked
    * Slow Blinking: PTP Holdover – PTP is locked, but there are lost PTP packet(s)
    * Fast Blinking: PTP Freerun – Received PTP/SyncE input, but not yet locked
  * Red:
    * Solid: PTP Freerun – No PTP/SyncE Input
    * Fast Blinking: PTP Freerun – Only SyncE Input
  * Off
    * Off: PTP Service not running
* “Service” LED – Indicates the system CU-Plane and/or M-Plane Status of the G105 RU.
  * Green:
    * Solid: RU is radiating – CU-Plane is configured, and unit is radiating
    * Slow Blinking: RU is initializing – BBU unit is initializing, config, calibration, sync…
    * Fast Blinking: RU ready to radiate – BBU is running; no CU-Plane packet received
  * Red:
    * Solid: RF Component Boot-Up Fail – RF Component failed to properly boot
    * Slow Blinking: Received data, but incorrect or out of receiving window – BBU is running, CU-Plane Packet out of window. Inspect BBU Reception Report Log. Monitor on-time, early, late packet counting. CP: On-time Total < 95% UP: On-time Total < 95%
    * Fast Blinking: M-Plane Call Home Failure Definition TBD
  * Off
    * Off: CU-Plane not running – BBU not running

## G105 Access Point Installation

### Instructions and Limitations

The G105 AP can be mounted on walls, poles, or ceilings, with details as follows. Other installation locations and structures are feasible. However, if alternate structures are utilized, it is the installer or customer’s responsibility to assess and deem these locations as acceptable and to utilize industry standard construction methods to verify the unit’s stability and orientation corresponds with these specifications.

{% hint style="info" %}
**NOTE**: The installation specifications described in this document only define the adaptability of the specific installation components and scenarios pictured and described.
{% endhint %}

{% hint style="warning" %}
**CAUTION**: Prior to installation, assess the strength and reliability of the structure proposed for the unit installation based on the actual weight of the installed equipment.
{% endhint %}

### Application Limitations

To ensure proper air circulation and effective heat dissipation around the G105 RU, limitations on the unit application environment include, but are not limited to, the following points:

* Do not install the G105 AP in indoor or outdoor cabinets that are completely sealed and lack either air exchange or active cooling systems such as heat exchangers, air conditioners, etc., which will ensure the ambient temperature will not exceed the specified temperature range.
* Do not install the G105 AP in equipment rooms or network closets that are completely sealed and do not have active cooling systems as detailed above.

{% hint style="warning" %}
**CAUTION:** To ensure proper air circulation and effective heat dissipation around the radio unit, do not install AP in indoor or outdoor cabinets (such as enclosed camouflage boxes) or closed rooms that lack active cooling systems. Such conditions will cause overheating and may cause the radio unit to malfunction or fail.
{% endhint %}

### Preferred Installation Orientation and Clearance Requirements

The preferred mounting orientations for the G105 AP and the recommended clearances are shown in the following figures. Maintaining these clearances and specified surrounding ambient air temperatures ensures normal operation and ample room for maintenance.&#x20;

The minimum clearance recommended for the G105 AP installation is shown in Figure 9 and Figure 10. Ensure that the ambient air temperature remains in the specified operational temperature range and these clearance dimensions are adhered to, to ensure normal operation and allow ample room for maintenance.&#x20;

<p align="center"><strong>Minimum Clearance Dimension Requirements – Ceiling Mount</strong> </p>

<figure><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/pyS5DCFm1sHmkAyPaJE9/media/image37.png" alt="" width="563"><figcaption></figcaption></figure>

<p align="center"><strong>Minimum Clearance Dimension Requirements – Wall Mount</strong></p>

<img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/IomgoKCeDmNnLtoFWNNB/media/image38.png" alt="" width="375">

### Common Installation Tools

<p align="center"><strong>Common Installation Tools</strong></p>

<table data-header-hidden><thead><tr><th width="221.4443359375"></th><th width="200.444580078125"></th><th></th><th></th></tr></thead><tbody><tr><td><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/5y8N1u8MJNhtELxbDBme/media/image39.png" alt="image39.png"></td><td><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/kSmi9SVv4Z1AGJId8gbC/media/image40.png" alt="image40.png"></td><td><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/2quLNgc18Ny2ZZivzqKi/media/image41.png" alt="image41.png"></td><td><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/IWFCqyG1NaEHhEajKmX8/media/image42.png" alt="image42.png"></td></tr><tr><td>Adjustable Torque Driver</td><td>#2 Phillips Driver Bit</td><td>Percussion Drill or<br>Drill Driver</td><td>Tape Measure</td></tr><tr><td><img src="https://4084968256-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgSxa0NIdBp5aDw7Lf2N9%2Fuploads%2FFRz2VFzA3yTQpQ93cVHK%2Fimage.png?alt=media&amp;token=08d43f2d-474d-45a2-8a13-61b86c7f5883" alt="" data-size="original"></td><td><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/5JZlrR36jXmPM5CRWczZ/media/image44.png" alt="image44.png"></td><td><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/YtqjEnUxDRz624U9zhyz/media/image45.png" alt="image45.png"></td><td><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/FJHEduGaMxjgXtjyBW2Q/media/image46.png" alt="image46.png"></td></tr><tr><td>4 mm Concrete Drill Bit<br>2 mm / 4 mm HSS Drill Bit<br>3/8-Inch HSS Drill Bit</td><td>Level Bar</td><td>Fine Tip Marker</td><td>Clean Work Gloves</td></tr></tbody></table>

### Wall Mount Installation

The G105 is suitable for installation onto well-constructed cement, wood, or plaster/drywall sheathed walls. The following section details the components, tools and process necessary for wall mounting of the G105 RU.

{% hint style="warning" %}
**CAUTION:** Prior to installation onto walls, verify that wall construction is structurally sound and that it can support the weight of the G105 AP and associated additional equipment (approx. 15 kg (33.0 lbs.)
{% endhint %}

#### Wall Mounting Kit Hardware Requirements

The following table details the hardware requirements for various wall mounting applications of the G105 RU.&#x20;

<p align="center"><strong>Wall Mounting Kit Hardware Requirements</strong></p>

| Installation Application | Part / Assembly              | Kit Location         | Quantity Required |
| ------------------------ | ---------------------------- | -------------------- | ----------------- |
| Cement Wall              | G105 RU                      | G105 RU Kit          | 1                 |
| Cement Wall              | Concrete Screw Anchor        | G105 RU Mounting Kit | 4                 |
| Cement Wall              | G105 RU Mounting Bracket     | G105 RU Mounting Kit | 1                 |
| Cement Wall              | M3.5 x 20 mm Long Screw      | G105 RU Mounting Kit | 4                 |
| Cement Wall              | M4 x 6 mm Long Screw         | G105 RU Mounting Kit | 4                 |
| Cement Wall              | M3 x 8 mm Long Screw         | G105 RU Mounting Kit | 2                 |
| Wood Wall                | G105 RU                      | G105 RU Kit          | 1                 |
| Wood Wall                | G105 RU Mounting Bracket     | G105 RU Mounting Kit | 1                 |
| Wood Wall                | M3.5 x 20 mm Long Screw      | G105 RU Mounting Kit | 4                 |
| Wood Wall                | M4 x 6 mm Long Screw         | G105 RU Mounting Kit | 4                 |
| Wood Wall                | M3 x 8 mm Long Screw         | G105 RU Mounting Kit | 2                 |
| Plaster / Drywall Wall   | G105 RU                      | G105 RU Kit          | 1                 |
| Plaster / Drywall Wall   | Plaster/Drywall Screw Anchor | G105 RU Mounting Kit | 4                 |
| Plaster / Drywall Wall   | G105 RU Mounting Bracket     | G105 RU Mounting Kit | 1                 |
| Plaster / Drywall Wall   | M3.5 x 20 mm Long Screw      | G105 RU Mounting Kit | 4                 |
| Plaster / Drywall Wall   | M4 x 6 mm Long Screw         | G105 RU Mounting Kit | 4                 |
| Plaster / Drywall Wall   | M3 x 8 mm Long Screw         | G105 RU Mounting Kit | 2                 |

#### Cement Wall Installation

Take the following steps to mount the G105 RU to a typical concrete wall.

{% stepper %}
{% step %}
Place the G105 Mounting Bracket onto wall in orientation shown in Figure 11 ensuring that top edge is level.
{% endstep %}

{% step %}
Using a fine tip marker, mark the location of each of the indicated holes of the G105 RU Mounting Bracket.
{% endstep %}

{% step %}
Remove the G105 RU Mounting Bracket and verify the vertical and horizontal dimensions of the marked locations to ensure hole alignment.
{% endstep %}

{% step %}
Using a hammer drill and a 4 mm Diameter Concrete (Impact) Drill Bit, drill four holes approximately 25 mm deep and centered on the marked locations.&#x20;

<p align="center"><strong>Drilling Holes for Concrete Anchors</strong><br><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/nVPGqGCu4qQymBlnux9X/media/image47.png" alt="" data-size="original"></p>
{% endstep %}

{% step %}
Insert the nose of a Concrete Anchor into the drilled hole. Repeat for a total of 4 pcs. of the Concrete Anchors. As necessary, use a hammer to lightly tap the anchor until the flange of the anchor is flush to the wall.&#x20;

<p align="center"><strong>Inserting Concrete Anchors into Wall</strong></p>

<figure><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/ISk0Gkyk9otY3X33Gno1/media/image48.png" alt="" width="188"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Insert the 4 pcs. of the M3.5 x 20 mm Long Screws through the indicated holes of the G105 RU Mounting Bracket and into the Concrete Anchors in the order shown below. Tighten each screw to snug (approximately 0.6 Nm (5 in-lbs.)) using a torque screwdriver and #2 Phillips Bit.&#x20;

<p align="center"><strong>Fastening the G105 Mounting Bracket to Concrete Wall</strong></p>

<figure><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/6Ns0ltSPtn0bKrUIuhuV/media/image49.png" alt="" width="375"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Insert 4 pcs. of M4 x 6 mm Long SEMS Screw into threaded bosses of the heatsink of the G105 RU as shown in Figure 14 and torque each of these screws to 1.4 Nm (12 in-lbs.) using a torque driver and Phillips #2 bit, ensuring that the washer of the screw is flush to the cast boss.

<p align="center"><strong>M4 x 6 mm SEMS Screws Installed into G105 RU Heatsink</strong></p>

<figure><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/Ji23WzrUzpiT7bU8mWsW/media/image50.png" alt="" width="563"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Orient the G105 RU such that the connector interface surface is facing upward and align the heads of the 4 pcs. of the M4 x 6 mm SEMS Screws installed in the G105 RU Heatsink with the larger diameter holes of the keyhole slots of the G105 RU Mounting Bracket as shown. Insert the heads of the screws through the large diameter keyholes and slide the unit downward such that the smaller diameter holes of the keyhole slots of the G105 RU Mounting Bracket capture the shanks of the screws, as shown below.&#x20;

<p align="center"><strong>Installation of the G105 RU onto the Mounting Bracket</strong></p>

<figure><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/CSOuDXaZu4hHmsC2nTfk/media/image51.png" alt="" width="563"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Insert 1 pc. of M3 x 8 mm Long Screw through the hole in the tab of the G105 Mounting Bracket and thread into the tab of the G105 RU Heatsink as shown. Torque the M3 x 8 mm Long Screw to 0.6 Nm (5 in-lbs.) using a torque screwdriver and #2 Phillips Bit, as shown below.

<p align="center"><strong>Installing M3 x 8 mm Locking Screw</strong></p>

<figure><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/f25CTBYWOfrp51gWi8VP/media/image52.png" alt="" width="563"><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}

<p align="center"><strong>Completed Concrete Wall Installation</strong></p>

<img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/FvBwdIBNPOSMpwEA0ilS/media/image53.png" alt="" width="375">

#### Drywall / Plaster and Lathe Installation

The G105 RU Mounting Bracket can also be installed onto a wall finished with drywall or plaster and lathe. When installing into these wall materials, the included screw-in anchors can be utilized to mount the bracket and support the unit.

{% stepper %}
{% step %}
Place the G105 Mounting Bracket onto the mounting surface ensuring the top edge is level.
{% endstep %}

{% step %}
Using a fine tip marker, mark the location of each of the indicated holes of the G105 RU Mounting Bracket.
{% endstep %}

{% step %}
Remove the G105 RU Mounting Bracket and verify the vertical and horizontal dimensions of the marked locations to ensure hole alignment.
{% endstep %}

{% step %}
Using a drill driver and a 4 mm Diameter High-Speed Steel (HSS) Drill Bit, drill four holes through the drywall or plaster/lathe material centered on the marked locations.&#x20;

<p align="center"><strong>Drilling Holes for Drywall or Plaster/Lathe Anchors</strong></p>

<figure><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/nVPGqGCu4qQymBlnux9X/media/image47.png" alt="" width="563"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Insert the 4 pcs. of the Screw-In Drywall / Plaster and Lathe Anchors into the 4 mm drilled holes and tighten using drill driver and #2 Phillips Bit until head of the anchors are flush with the surface of the substrate.&#x20;

<p align="center"><strong>Install Screw-In Drywall / Plaster &#x26; Lathe Anchors</strong></p>

<figure><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/ALTEVf0y87Cow22ZXAYX/media/image54.png" alt="" width="375"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Insert the 4 pcs. of the M3.5 x 20 mm Long Screws through the indicated holes of the G105 RU Mounting Bracket and into the installed anchors. Tighten each screw to the point the mounting bracket is flush with the wall and torque to approximately 1.4 Nm (12 in-lbs.)) using a torque screwdriver and #2 Phillips Bit.

<p align="center"><strong>G105 Mounting Bracket Installation</strong></p>

<figure><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/6Ns0ltSPtn0bKrUIuhuV/media/image49.png" alt="" width="375"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Insert 4 pcs. of M4 x 6 mm Long SEMS Screw into threaded bosses of the heatsink of the G105 RU as shown in Figure 20 and torque each of these screws to 1.4 Nm (12 in-lbs.) using a torque driver and Phillips #2 bit, ensuring that the washer of the screw is flush to the cast boss.&#x20;

<p align="center"><strong>M4 x 6 mm SEMS Screws Installed into G105 RU Heatsink</strong></p>

<figure><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/Ji23WzrUzpiT7bU8mWsW/media/image50.png" alt="" width="563"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Orient the G105 RU such that the connector interface surface is facing upward and align the heads of the 4 pcs. of the M4 x 6 mm SEMS Screws installed in the G105 RU Heatsink with the larger diameter holes of the keyhole slots of the G105 RU Mounting Bracket as shown. Insert the heads of the screws through the large diameter keyholes and slide the unit downward such that the smaller diameter holes of the keyhole slots of the G105 RU Mounting Bracket capture the shanks of the screws, as shown below.&#x20;

<p align="center"><strong>Installation of the G105 RU onto the Mounting Bracket</strong></p>

<figure><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/CSOuDXaZu4hHmsC2nTfk/media/image51.png" alt="" width="563"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Insert 1 pc. of M3 x 8 mm Long Screw through the hole in the tab of the G105 Mounting Bracket and thread into the tab of the G105 RU Heatsink as shown. Torque the M3 x 8 mm Long Screw to 0.6 Nm (5 in-lbs.) using a torque screwdriver and #2 Phillips Bit, as shown below.&#x20;

<p align="center"><strong>Installing M3 x 8 mm Locking Screw</strong></p>

<figure><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/f25CTBYWOfrp51gWi8VP/media/image52.png" alt="" width="563"><figcaption></figcaption></figure>

<p align="center"><strong>Completed Drywall / Plaster &#x26; Lathe Wall Installation</strong></p>

<img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/Dkj8891bS2tq8NAQ32AU/media/image55.png" alt="" width="375">
{% endstep %}
{% endstepper %}

#### Wood Wall or Wood Sheathed Wall/Ceiling Installation

Installation onto a structural wood or wood-sheathed wall or ceiling requires the direct mounting of the G105 Mounting Bracket using wood screws. If the spacing of wood structural members does not align with mounting holes of the G105 Mounting Bracket, it is suggested that a plywood or similar material brace is used to span the structural members.&#x20;

The mounting structure or construction of the structural brace must be designed such that it can support the weight of the G105 RU and associated additional equipment (approx. 15 kg (33.0 lbs.)

{% stepper %}
{% step %}
Place the G105 Mounting Bracket onto the wood mounting surface ensuring that the top edge is level.
{% endstep %}

{% step %}
Using a fine tip marker, mark the location of each of the indicated holes of the G105 RU Mounting Bracket.
{% endstep %}

{% step %}
Remove the G105 RU Mounting Bracket and verify the vertical and horizontal dimensions of the marked locations to ensure hole alignment.
{% endstep %}

{% step %}
Using a drill driver and a 2 mm Diameter High-Speed Steel (HSS) Drill Bit, drill four holes through the plywood mounting brace or approximately 40 mm deep into the wooden structure member centered on the marked locations.&#x20;

<p align="center"><strong>Drilling Pilot Holes for Mounting Screws</strong></p>

<figure><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/nVPGqGCu4qQymBlnux9X/media/image47.png" alt="" width="563"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Insert the 4 pcs. of the M3.5 x 20 mm Long Screws through the indicated holes of the G105 RU Mounting Bracket and into the 2 mm pilot holes in the wood substrate. Tighten each screw to the point the mounting bracket is flush with the wall and torque to 1.4 Nm (12 in-lbs.)) using a torque screwdriver and #2 Phillips Bit.

<p align="center"><strong>Fastening the G105 Mounting Bracket to Concrete Wall</strong></p>

<figure><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/Cn4bv9kcLWsJUoHTDJpX/media/image56.png" alt="" width="375"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Insert 4 pcs. of M4 x 6 mm Long SEMS Screw into threaded bosses of the heatsink of the G105 RU as shown below and torque each of these screws to 1.4 Nm (12 in-lbs.) using a torque driver and Phillips #2 bit, ensuring that the washer of the screw is flush to the cast boss.&#x20;

<p align="center"><strong>M4 x 6 mm SEMS Screws Installed into G105 RU Heatsink</strong></p>

<figure><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/Ji23WzrUzpiT7bU8mWsW/media/image50.png" alt="" width="563"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Orient the G105 RU such that the connector interface surface is facing upward and align the heads of the 4 pcs. of the M4 x 6 mm SEMS Screws installed in the G105 RU Heatsink with the larger diameter holes of the keyhole slots of the G105 RU Mounting Bracket as shown. Insert the heads of the screws through the large diameter keyholes and slide the unit downward such that the smaller diameter holes of the keyhole slots of the G105 RU Mounting Bracket capture the shanks of the screws, as shown below.&#x20;

<p align="center"> <strong>Installation of the G105 RU onto the Mounting Bracket</strong></p>

<figure><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/CSOuDXaZu4hHmsC2nTfk/media/image51.png" alt="" width="563"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Insert 1 pc. of M3 x 8 mm Long Screw through the hole in the tab of the G105 Mounting Bracket and thread into the tab of the G105 RU Heatsink as shown. Torque the M3 x 8 mm Long Screw to 0.6 Nm (5 in-lbs.) using a torque screwdriver and #2 Phillips Bit, as shown below.&#x20;

<p align="center"><strong>Installing M3 x 8 mm Locking Screw</strong></p>

<figure><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/f25CTBYWOfrp51gWi8VP/media/image52.png" alt="" width="563"><figcaption></figcaption></figure>

<p align="center"><strong>Completed Concrete Wall Installation</strong></p>

<img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/C6togJUrYLEpgyDf2Zls/media/image57.png" alt="" width="375">
{% endstep %}
{% endstepper %}

## Connection Details

<p align="center"><strong>Top Port View of the G105 RU</strong></p>

&#x20;

<figure><img src="https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/um7cKDJnpWJBD6WCMcfn/media/image58.png" alt=""><figcaption></figcaption></figure>

<p align="center"><strong>Top Port View of the G105 RU</strong></p>

<table><thead><tr><th width="100.33331298828125">Item #</th><th width="199.666748046875">Item</th><th width="450.22222900390625">Description</th></tr></thead><tbody><tr><td>1</td><td>“USB” Type-A Port</td><td>Local (Console) Connector. No default IP Address. When connected to a DHCP Server, IP is assigned, and port can be utilized with SSH to login to RU.</td></tr><tr><td>2</td><td>“SFP+” Port</td><td>To be used with 10Gb SFP+ Transceiver to connect to FH Switch. Can be utilized to access RU M-Plane and provides connection for C/U- and S-Planes.</td></tr><tr><td>3</td><td>“DC Power” Port</td><td>2.5 mm (+) x 5.5 mm (-) DC Power Port. Local power provided by AC/DC Adapter (not included).</td></tr><tr><td>4</td><td>“PoE++” Port</td><td>RJ45 Jack utilizing IEEE 802.3bt-2018 pin-out. Can be utilized to remotely power the remote from up to 100 meters (328 feet) away from PoE++ Switch using PoE++ rated Ethernet Cable.</td></tr></tbody></table>

### Port Connections

<p align="center"><strong>G105 Port Connection Diagram</strong></p>

![](https://content.gitbook.com/content/gSxa0NIdBp5aDw7Lf2N9/blobs/ySa9F1sGUaJlhan7eYWT/media/image59.png)

#### USB Port

The USB Port on the PR1450 is a USB 3.0 Type-A Jack which can be utilized for Ethernet Communication with the powered G105 RU. This USB Jack is used in conjunction with a USB 3.0 to Gigabit Ethernet Adapter and a Cat5E, Cat6 or Cat6A Ethernet Cable to connect the G105 RU to a PC via an SSH Client.

#### SFP+ Port

Insert an SFP+ Transceiver that matches the SFP+ Transceiver used in the associated CU/DU/Server or Fronthaul Multiplexer (FHM). The manufacturer’s instructions for the insertion of the SFP+ Transceiver should be provided with the item.

{% hint style="warning" %}
**CAUTION:** Optical SFP+ Transceivers have optical transmitters and receivers. Take care not to contaminate the optical components. Carefully remove any plug or cover and do not touch any mating optical connectors. Clean mating optical connectors using appropriate fiber optic cleaning tools prior to connection.
{% endhint %}

If an Optical SFP+ Transceiver is utilized, clean the mating duplex optical patch cable connector using manufacturer’s suggested fiber connector cleaning tools and insert it until the molded latches engage with the receptacle of the Optical SFP+ Transceiver.

#### Recommended SFP+ Transceivers

<p align="center"><strong>Recommended SFP+ Transceivers</strong></p>

<table><thead><tr><th width="150.111083984375">Manufacturer</th><th width="350.22216796875">Description</th><th width="249.8890380859375">Manufacturer P/N</th></tr></thead><tbody><tr><td>Intel</td><td>Ethernet SFP+ SR Optical Transceiver</td><td>FTLX8571D3BCL</td></tr><tr><td>Dell</td><td>Ethernet SFP+ SR Optical Transceiver</td><td>LTF8502-BC+-DEN</td></tr><tr><td>Eoptolink</td><td>Ethernet SFP+ SR Optical Transceiver</td><td>EOLP-8596-02-I</td></tr><tr><td>Finisar</td><td>Ethernet SFP+ SR Optical Transceiver</td><td>FTLX8571D3BCL</td></tr><tr><td>Luxshare</td><td>Ethernet SFP+ SR Optical Transceiver</td><td>LUXSHARE-ICT</td></tr><tr><td>Cisco</td><td>Ethernet SFP+ SR Optical Transceiver</td><td>SFP-10G-SR</td></tr><tr><td>JPC</td><td>Ethernet SFP+ SR Optical Transceiver</td><td>TNP199007A00038-7</td></tr><tr><td>JPC</td><td>Ethernet SFP+ SR Optical Transceiver</td><td>TNP199007A00038-A</td></tr><tr><td>Finisar</td><td>Ethernet SFP+ LR Optical Transceiver</td><td>FTLX1471D3BCL</td></tr><tr><td>Luxshare</td><td>Ethernet SFP+ LR Optical Transceiver</td><td>PGN1SSD01-NC-T</td></tr><tr><td>Eoptolink</td><td>Ethernet SFP+ LR Optical Transceiver</td><td>EOLP-1396-10</td></tr><tr><td>Cisco</td><td>Ethernet SFP+ LR Optical Transceiver</td><td>SFP-10G-LR</td></tr><tr><td>JPC</td><td>Ethernet SFP+ LR Optical Transceiver</td><td>TNP14200103A009-A</td></tr><tr><td>JPC</td><td>Ethernet SFP+ LR Optical Transceiver</td><td>TNP14200103A009-7</td></tr></tbody></table>

#### DC Power Port

The DC Power Port of the G105 RU is an integrated 2.5 mm x 5.5 mm DC Power Jack. This jack is used as a powering option for the product. It is designed such that the center conductor (2.5 mm male pin) is to be provided with 12.0 +/- 5% Volts DC and the outer conductor (5.5 mm female receptacle) is to be provided with the 0 Volts DC. A standard AC/DC Power Supply Unit (PSU) should be used to power the G105. The PSU should be capable of producing 12.0 Volt DC Output and supplying a minimum of 4.5 Amperes of current (54 Watts).

{% hint style="warning" %}
**CAUTION:** Use either the DC Power Port or the PoE++ Port for powering the G105RU. Do not use both power options or damage to the product may occur.
{% endhint %}

#### PoE++ Port

The PoE++ Port of the G105 RU is an RJ45 Jack. This jack is only used as a powering option for the product and is not used for Ethernet Communication with the remote.

This port utilizes a 4-pair powering configuration that is compliant with IEEE 802.3bt. The G105RU is a Type 3 PD and features an analog handshake to identify itself to the PoE Injector (PSE).&#x20;

It is suggested that a high-quality category Ethernet cable with a wire gauge sufficient to carry no less than 75 Watts be utilized for the connection between the PoE Injector and the G105 RU. Refer to the earlier PoE Injector section for the necessary specifications to aid in selection.

{% hint style="warning" %}
**CAUTION:** Use either the DC Power Port or the PoE++ Port to power the G105RU. Using both power options simultaneously may damage the device.
{% endhint %}

## Post Installation Steps

After installing the RU, connect it to the Core/gNB server or FHM. Your configuration will be dependent on the use of an ONYX-FHM-001 (Fronthaul Multiplexer) in your network configuration.

* Single RU: Connect the RU directly to the Core/gNB server to s0f3 as shown below for a single RU.
  * Onboard the RU. Refer to the *Onyx Portal Operations Guide* (*Manage Equipment* > *Manage APs* > *Add APs* > *Add APs to 5G Networks*)
* Multiple RU: Connect the RUs to the installed Onyx-FHM-001 starting with port 0. Ensure all RUs are of the same model.
* Edit the FHM. Refer to the *Onyx Portal Operations Guide* (*Manage Equipment > Manage FHM > Edit FHM*)

<p align="center"><strong>RU to Core/gNB Server or FHM</strong></p>

<figure><img src="https://4084968256-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgSxa0NIdBp5aDw7Lf2N9%2Fuploads%2FT1tdt2060lwf5ZfU7RZc%2Fimage.png?alt=media&amp;token=497687c9-8092-4b94-b09c-cdd5f1fe4593" alt=""><figcaption></figcaption></figure>

## Appendix: Regulatory Compliance

### FCC Compliance

This device complies with part 15 of the FCC Rules. Operation is subject to the following two conditions: (1) This device may not cause harmful interference, and (2) this device must accept any interference received, including interference that may cause undesired operation. Any Changes or modifications not expressly approved by the party responsible for compliance could void the user's authority to operate the equipment. This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation. This equipment generates, uses, and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communications. Operation of this equipment in a residential area is likely to cause harmful interference, in which case the user will be required to correct the interference at his own expense.

{% hint style="danger" %}
**WARNING:**&#x54;his equipment complies with FCC radiation exposure limits set forth for an uncontrolled environment. This equipment should be installed and operated with a minimum distance of 33 inches (83 cm) between the radiator and your body.
{% endhint %}

### ISEDC Compliance

This device complies with Innovation, Science, and Economic Development Canada license-exempt RSS standard(s). Operation is subject to the following two conditions: (1) This device may not cause interference, and (2) This device must accept any interference, including interference that may cause undesired operation of the device. The antenna(s) used for this transmitter must be installed to provide a separation distance of at least 33 inches (83 cm) from all persons and must not be collocated or operating in conjunction with any other antenna or transmitter, End-Users must be provided with transmitter operation conditions for satisfying RF exposure compliance.




---

[Next Page](https://docs.gxc.io/llms-full.txt/1)