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

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.

NOTE: MFA is enabled system-wide for all Onyx Portal users and cannot be disabled.

NOTE: If you log on to Onyx Portal using your customer organization's SSO credentials, you must follow your organization's MFA requirements.

MFA workflow:

1

Install an authenticator app on your mobile phone.

See Install the Authenticator App.

2

Log on to the Onyx Portal and activate your MFA.

See 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.

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.

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.

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.

NOTE: If you have issues with activating your Onyx Portal user account, contact your Onyx Portal Administrator.

To verify your email ID and set your password:

1

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.

2

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: !@#$%^&*

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

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

NOTE: Activating your MFA is a one-time procedure.

To activate your MFA:

1

Using a supported web browser visit https://portal.gxc.io.

The Onyx Portal Login page is displayed.

2

Enter the following details, then click Login:

  • Email – (Required) Your Onyx Portal logon ID (email address).

The GXC IdP Login page is displayed.

3

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.

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.

4

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.

5

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.

To save your MFA backup codes as a text file, in the Activate Multi-Factor Authentication dialog box > Backup Codes section > click (download).

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".

6

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.

Enter the MFA OTP displayed in the authenticator app on your mobile phone and click Submit.

The Onyx Portal Dashboard is displayed.

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 and Reset Your MFA Secrets respectively.

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.

NOTE: The MFA backup codes are single use only and cannot be reused.

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.

NOTE: When you reset your MFA secrets, any previous backup codes will become invalid.

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.

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.

For information to log on with your customer organization SSO credentials, see Log On using Your SSO Credentials.

Log On Using Your Onyx Portal Credentials

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.

1

Open a supported web browser and visit https://portal.gxc.io.

The Onyx Portal Login page is displayed.

2

Enter the following details, then click Login:

  • Email – (Required) Your Onyx Portal logon ID (email address).

The IdP Login page is displayed.

3

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.

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 2FA page is displayed.

4

Enter the six-digit MFA OTP displayed in the authenticator app on your mobile phone, then click Login.

NOTE: The six-digit OTP refreshes every 30 seconds and is valid only for one minute.

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.

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.

Log On Using Your Organization's SSO Credentials

NOTE: If you log on to the Onyx Portal using your customer organization's SSO credentials, you must follow your organization's MFA requirements.

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.

1

From a supported web browser visit https://portal.gxc.io.

The Onyx Portal Login page is displayed.

2

Click the Sign in to an Organization link.

3

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.

NOTE: The Organization Name field is case-sensitive.

4

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.

Log Off from the Onyx Portal

To log off from the Onyx Portal:

1

In the upper-right corner of the page, click the current Onyx Portal account's name, then click Logout.

You are logged out of the Onyx Portal.

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: !@#$%^&*

1

In the Onyx Portal Login page, click the Reset/Forgot Password? link.

The Reset Password page is displayed.

2

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.

3

Click the reset password link in the email.

The Reset Password page is displayed.

4

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.

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: !@#$%^&*

1

In the upper-right corner of the page, click the current Onyx Portal account's name, then click Reset Password.

The Reset Password page is displayed.

2

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.

3

In the upper-right corner of the page, click Reset Password.

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.

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.

To reset your MFA secrets:

1

In the upper-right corner of the page, click the current Onyx Portal account's name, then click Reset MFA Secrets.

NOTE: The Reset MFA Secrets option is enabled only if you have already activated your MFA. For more information, see Activate Your MFA.

A confirmation dialog box is displayed.

2

To reset your MFA secrets, click Yes.

The Reset MFA Secrets dialog box is displayed.

3

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

4

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.

To save your MFA backup codes as a text file, in the Reset MFA Secrets dialog box > Backup Codes section > click (download).

NOTE: When you reset your MFA secrets, any previous backup codes will become invalid.

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".

5

To confirm your MFA secrets are reset (Step 3), click Confirm MFA OTP.

The Confirm MFA OTP dialog box is displayed.

6

Enter the MFA OTP displayed in the authenticator app on your mobile phone and click Submit.

7

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.

After the OTP is authenticated, you are logged in to the Onyx Portal, and the Dashboard page is displayed.

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.

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.

    • indicates the default network has not been selected.

    • indicates the default network is a 4G network.

    • indicates the default network is a 5G network.

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

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

    To view a notification's details, click its title.

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

    • Current Account

      • <current Onyx Portal account's name>

        • <current user's email ID>

    • Other Accounts

      NOTE: 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.

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

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

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

Expanded State:

  • Displays the full menu with icons and labels

  • Provides traditional navigation experience

  • Shows complete menu item names

  • Dashboard – View an overview of the network's key metrics at a glance. For more information, see Administrator Dashboard and 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

NOTE: The Administrator Dashboard is exclusively available to GXC Administrators and GXC Partner Administrators.

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

Expanded State:

  • Displays the full menu with icons and labels

  • Provides traditional navigation experience

  • Shows complete menu item names

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:

NOTE: Verify the selected Onyx Portal account and network in the header area. For more information, see Header Area.

1

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.

      • Green – Indicates all Onyx Edge are online.

      • Amber – Indicates some Onyx Edge are online and others offline.

      • Red – Indicates all Onyx Edge are offline.

      • Grey – Indicates data is loading or is not available.

      To view status per Onyx Edge, hover your cursor over the "Online Status" icon.

      • – Indicates the Onyx Edge is online.

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

      • Green – Indicates services on all Onyx Edge are up and running.

      • Amber – Indicates services on some Onyx Edge are facing manual or unexpected restarts.

      • Red – Indicates services on all Onyx Edge are facing manual or unexpected restarts.

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

      • – Indicates all services are up and running.

      • – Indicates unexpected or manual restart of critical services.

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

      • Green – Indicates all APs are online.

      • Amber – Indicates some APs are online and others offline.

      • Red – Indicates all APs are offline.

      • Grey – Indicates data is loading or is not available.

      To view status per AP, hover your cursor over the "Online Status" icon.

      • – Indicates the AP is online.

      • – Indicates the AP is offline.

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

      • Green – Indicates services on all APs are up and running.

      • Amber – Indicates services on some APs are facing manual or unexpected restarts.

      • Red – Indicates services on all APs are facing manual or unexpected restarts.

      • Grey – Indicates all APs are offline, or data is not available.

      To view status per AP, hover your cursor over the "Service Status" icon.

      • – Indicates all services are up and running.

      • – Indicates unexpected or manual restart of critical services.

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

        • Green – Indicates all FHM are online.

        • Amber – Indicates some FHM are online and some offline.

        • Red – Indicates all FHM are offline.

        • Grey – Indicates data is loading or is not available.

        To view status per FHM, hover your cursor over the "Online Status" icon.

        • – Indicates the FHM is online.

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

        • Green – Indicates services on all FHM are up and running.

        • Amber – Indicates services on some FHM are facing manual or unexpected restarts.

        • Red – Indicates services on all FHM are facing manual or unexpected restarts.

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

        • – Indicates all services are up and running.

        • – Indicates unexpected or manual restart of critical services.

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

        • Green – Indicates all Mesh Nodes are online.

        • Amber – Indicates some Mesh Nodes are online and others offline.

        • Red – Indicates all Mesh Nodes are offline.

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

        • Green – Indicates services on all Mesh Nodes are up and running.

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

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

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

      NOTE: In the APN dropdown, MeshBackhaul is available only to GXC Administrators.

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

2

In the upper-right corner, the panel indicates when the view was last updated.

To refresh the view, click (refresh).

PreviousOverview
NextManage Networks

Last updated

Was this helpful?