> For the complete documentation index, see [llms.txt](https://docs.gxc.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.gxc.io/docs/network-configuration-and-operations-guides/4g-onyx-portal-4.x-operations/manage-subscribers.md).

# 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 %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.gxc.io/docs/network-configuration-and-operations-guides/4g-onyx-portal-4.x-operations/manage-subscribers.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.