For the complete documentation index, see llms.txt. This page is also available as Markdown.

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 (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:

      • (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.

Indicator
Description

(green)

AP has checked in with Onyx Portal within the last 5 minutes.

(red)

AP has not checked in with Onyx Portal within the last 5 minutes, or the last reported time is older than 5 minutes.

(grey)

Associated Onyx Edge is offline.

AP Interface Status

Verify in the AP summary page or AP details page.

Indicator
Description

(green)

AP fronthaul interface is connected.

(red)

AP fronthaul interface is disconnected.

(grey)

AP is offline, or the fronthaul interface status is unavailable.

AP Sync Status

Verify in the AP summary page or AP details page.

Indicator
Description

(green)

AP is in sync with the clock source.

(amber)

AP sync with the clock source is degraded.

(red)

AP is not in sync with the clock source. PTP or GPS synchronization has been lost, preventing normal cell transmission.

(grey)

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.

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.

AP Service Status

Verify in the AP summary page or AP details page.

RF Tx Desired
RF Tx Actual
Indicator
Cell State

On

On

(green)

Healthy

On

Off

(red)

Service Down

Off

On

(amber)

Unwarranted Transmission

Off

Off

(grey)

Shutdown, the AP is offline, or the associated Onyx Edge is offline.

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.

Indicator
Description

(green)

Onyx Edge has checked in with Onyx Portal within the last 5 minutes.

(red)

Onyx Edge has not checked in with Onyx Portal within the last 5 minutes.

Onyx Edge Interface Status

Verify in the Onyx Edge summary page or Onyx Edge details page.

Indicator
Description

(green)

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.

(amber)

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.

(red)

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.

(grey)

Onyx Edge is offline.

Onyx Edge Service Status

Verify in the Onyx Edge summary page or Onyx Edge details page.

Indicator
Description

(green)

All critical services are up and running, no critical services were restarted in the last 5 minutes, and the Interface Status is green.

(amber)

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.

(red)

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.

(grey)

Onyx Edge is offline, or data is not available.

Onyx Edge Sync Status

Verify in the Onyx Edge summary page or Onyx Edge details page.

Indicator
Description

(green)

Onyx Edge is in sync with the timing source.

(red)

Onyx Edge is out of sync with the timing source.

(grey)

Onyx Edge is offline, or sync status is not available.

Onyx Edge Compute Resource

Verify in the Onyx Edge summary page or Onyx Edge details page.

Indicator
Description

(green)

All parameters (CPU, memory, disk) are below 50%.

(amber)

At least one parameter is above 50% and below 70%.

(red)

At least one parameter is above 70%.

(grey)

Onyx Edge is offline.

(4G) Onyx Edge Status Indicators

Onyx Edge Online Status

Verify in the Onyx Edge summary page or Onyx Edge details page.

Indicator
Description

(green)

Onyx Edge has checked in with Onyx Portal within the last 5 minutes.

(red)

Onyx Edge has not checked in with Onyx Portal within the last 5 minutes.

Onyx Edge Interface Status

Verify in the Onyx Edge summary page or Onyx Edge details page.

Indicator
Description

(green)

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.

(amber)

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.

(red)

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.

(grey)

Onyx Edge is offline.

Onyx Edge Service Status

Verify in the Onyx Edge summary page or Onyx Edge details page.

Indicator
Description

(green)

All critical services are up and running, no critical services were restarted in the last 5 minutes, and the Interface Status is green.

(amber)

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.

(red)

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.

(grey)

Onyx Edge is offline, or data is not available.

Onyx Edge Compute Resource

Verify in the Onyx Edge summary page or Onyx Edge details page.

Indicator
Description

(green)

All parameters (CPU, memory, disk) are below 50%.

(amber)

At least one parameter is above 50% and below 70%.

(red)

At least one parameter is above 70%.

(grey)

Onyx Edge is offline.

(4G) Onyx Edge IPSec Status

Verify in the Onyx Edge summary page or Onyx Edge details page.

Indicator
Description

(green)

Onyx Edge is IPSec-enabled, and all IPSec-enabled APs have active IPSec tunnels with the Onyx Edge.

(amber)

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.

(red)

Onyx Edge has bad IPSec status, and/or all IPSec-enabled APs are unreported or have a bad IPSec status.

(grey)

Onyx Edge is offline, is IPSec-disabled, and/or all APs are IPSec-disabled.

(5G) FHM Status Indicators

FHM Online Status

Verify in the FHM summary page or FHM details page.

Indicator
Description

(green)

FHM is management-connected, and the last reported time is less than 5 minutes ago.

(red)

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.

(grey)

Gateway of the associated Onyx Edge is offline.

FHM Interface Status

Verify in the FHM summary page or FHM details page.

Indicator
Description

(green)

Fronthaul passthrough is reported as true for all associated APs.

(amber)

Fronthaul passthrough is reported as false, or status information is unavailable for at least one, but not all, associated APs.

(red)

Fronthaul passthrough is reported as false, or status information is unavailable for all associated APs.

(grey)

FHM is not management-connected.

FHM Service Status

Verify in the FHM details page.

Indicator
Description

(green)

RF Tx is on.

(red)

RF Tx is off.

(grey)

AP is offline.

FHM Sync Status

Verify in the FHM details page.

Indicator
Description

(green)

AP timing status is true (IN_SYNC).

(red)

AP timing status is false (LATE or EARLY).

(grey)

AP is offline.

(4G) Mesh Node Status Indicators

Mesh Node Online Status

Verify in the Mesh Node summary page or Mesh Node details page.

Indicator
Description

(green)

Mesh Node is connected to Onyx Portal and last checked in within the last 5 minutes.

(red)

Mesh Node is not connected to Onyx Portal or last checked in more than 5 minutes ago.

Mesh Node Interface Status

Verify in the Mesh Node summary page or Mesh Node details page.

Indicator
Description

(green)

GRE tunnel status is okay, and Mesh AP is online.

(amber)

Mesh Node is online, but Mesh AP is offline, and GRE tunnel status is okay.

(red)

GRE tunnel status is not okay.

(grey)

Mesh Node is offline.

Mesh Node Service Status

Verify in the Mesh Node summary page or Mesh Node details page.

Indicator
Description

(green)

Mesh AP cell is in a healthy state.

(red)

Mesh AP cell is in a service down state.

(amber)

Mesh AP cell is in an unwarranted transmission state.

(grey)

Mesh AP cell state is shutdown, AP is offline, or Mesh Node is offline.

Mesh Node Compute Resource

Verify in the Mesh Node summary page or Mesh Node details page.

Indicator
Description

(green)

All parameters (CPU, memory, disk) are at or below 50%.

(amber)

All parameters are at or below 70%, and at least one parameter is above 50%.

(red)

At least one parameter is above 70%.

(grey)

Mesh Node is offline.

Last updated

Was this helpful?