> 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-equipment/manage-onyx-edge/manage-onyx-edge-high-availability.md).
# Manage Onyx Edge High Availability
The MME, a crucial component of the Onyx Core Network, plays a key role in the handling of control plane traffic, including signaling messages related to call setup, handovers, and session management. Enabling MME/Onyx Edge High Availability (HA) ensures uninterrupted and reliable MME services, even in the face of failures or disruptions.
MME/Onyx Edge Pooling is the technique used to achieve HA for the MME/Onyx Edge in a network. It involves grouping the Onyx Edge in a network into a pool and associating APs with the pool. All Onyx Edge in a pool have equal capacity and function in Active-Active mode. If an Onyx Edge in a pool experiences failures, the UE registered on that Onyx Edge are moved to the other Onyx Edge in the pool. If the Onyx Edge designated as the Primary "Automatic Configuration Server" (ACS) fails, a Standby ACS Onyx Edge takes over the Primary ACS responsibility. This helps minimize service disruptions due to failures, making the network more reliable.
{% hint style="info" %}
**NOTE:** Onyx Edge HA is supported only in 4G networks.
{% endhint %}
{% hint style="info" %}
**NOTE:** Onyx Edge HA is supported only with Onyx Edge On-Premises.
{% endhint %}
{% hint style="info" %}
**NOTE:** Each pool can have a maximum of three Onyx Edge associated with it.
{% endhint %}
{% hint style="info" %}
**NOTE:** Each Onyx Edge can be associated only with one pool at any time.
{% endhint %}
{% hint style="info" %}
**NOTE:** Each AP can be associated only with one pool at any time.
{% endhint %}
{% hint style="info" %}
**NOTE:** IPSec is not supported in conjunction with HA/Onyx Edge pools. IPSec-enabled Onyx Edge and APs must not be associated with an Onyx Edge pool. IPSec must not be enabled on Onyx Edge and APs already associated with a pool.
{% endhint %}
## Onyx Edge Pool Architecture
The following diagram illustrates the Onyx Edge pool architecture.
Onyx Edge Pool Architecture
* The MME/Onyx Edge pool is the overarching entity that groups together the MME/Onyx Edge.
* MME/Onyx Edge 1, MME/Onyx Edge 2, and MME/Onyx Edge 3 represent the individual MME/Onyx Edge within the pool. The Onyx Edge share the same pool identity and configuration. The MME/Onyx Edge 1 is configured as the Primary ACS and manages AP management traffic (AP configuration and AP status).
Automatic Configuration Server (ACS) Redundancy: The Onyx Edge with the highest ACS priority in a pool acts as the Primary ACS Onyx Edge within the pool. The Primary ACS Onyx Edge anchors the ACS endpoint address configured in the pool and manages AP management traffic to pass on configuration to and read status from the APs. If the Primary ACS Onyx Edge fails, a Standby ACS Onyx Edge takes over the Primary ACS responsibility ensuring continuity of service thereby further improving the network's reliability.
* AP1, AP2, through AP*n* represent the APs associated with the pool. Each of the AP associated with a pool can talk to any operational MME/Onyx Edge within the pool. The APs direct UE traffic to the Onyx Edge in the pool based on the current load on each Onyx Edge. This balancing helps ensure no single Onyx Edge becomes overloaded while others remain underutilized.
In the Onyx Edge pool architecture:
{% stepper %}
{% step %}
An Onyx Edge pool groups the Onyx Edge and has APs associated with it.
{% endstep %}
{% step %}
The APs associated with a pool direct UE traffic to the Onyx Edge in the pool based on the current load on each Onyx Edge.
Onyx Edge Pool Load Balancing
{% endstep %}
{% step %}
If an Onyx Edge in a pool experiences failures, the UE registered on that Onyx Edge are moved to the other Onyx Edge within the pool.
Onyx Edge Pool High Availability
{% endstep %}
{% step %}
The Onyx Edge with the highest ACS priority acts as the Primary ACS within the pool. The Primary ACS Onyx Edge manages the AP management traffic.
Onyx Edge Pool ACS Redundancy
If the Primary ACS Onyx Edge fails, an operational Standby ACS Onyx Edge with the highest priority takes over the Primary ACS responsibility.
Onyx Edge Pool ACS Redundancy – Primary ACS Switch
This basic architecture forms the foundation for MME/Onyx Edge Pooling, providing redundancy and reliability in core network functions.
{% endstep %}
{% endstepper %}
## Networking Requirements
This section describes the networking configurations recommended for the Onyx Edge associated with an Onyx Edge pool.
* When deploying multiple Onyx Edge for HA, you must allocate an additional IP address within the same S1 subnet as those assigned to each individual Onyx Edge. This extra IP address serves as the "Virtual IP" and is used to centrally manage APs in the Onyx Edge pool as a unified entity from the Onyx Orchestrator.
* It is also required to avoid deploying the Onyx Edge in "S1 same as SGi" mode. If the network layout follows the "flat networking model", a separate RAN network will be required to run the eth1/S1 network separate from eth0/SGi interfaces. This can be accomplished by segregating the S1/RAN network traffic on its own unique VLAN to maintain traffic separation.
* **S1 Interface IP** – The subnet must be the same across all the Onyx Edge in a pool. The S1 interface should be static and different and should be in the same subnet as the TR069 HA IP. Recommended configuration: 10.0.2.1, 10.0.2.2, 10.0.2.3.
It is not possible to change the S1 subnet of the Onyx Edge in a pool or the VIP in the pool configuration. You can only edit them to a different IP address. If the subnet must be changed, then the SOP requires:
1. Disassociating all the Onyx Edge from the pool.
2. Editing the VIP in the pool configuration.
3. Editing the S1 subnet (use the same subnet for all Onyx Edge).
4. Associating the Onyx Edge back with the pool.
* **Access Point DHCP Service** – The Start IP address must be a host inside the S1 IP/Subnet and must be the same across all the Onyx Edge in a pool. Recommended configuration: **Start IP**:10.0.2.240, **No. of IP**: 15.
* **Onyx Edge Tunnel Anchoring Subnet** – The Onyx Edge Tunnel Anchoring subnet must be different across all the Onyx Edge in a pool. Recommended configuration: 192.168.133.0/28, 192.168.151.0/28, 192.168.152.0/28.
* **Mesh Node Assignment Subnet** – The Mesh Node Assignment subnet must be the same across all the Onyx Edge in a pool.
* **Mesh UE IP Subnet** – Applicable for VLAN mode. The Mesh UE IP subnet must be different across all the Onyx Edge in a pool. Recommended configuration: 192.168.129.0/24, 192.168.160.0/24, 192.168.161.0/24.
* **Per APN Per Onyx Edge Config** – Applicable for VLAN mode. Except for the **Local IP** (which must be different across all Onyx Edge and from the same subnet), all the other parameters (**Default GW IP**, **VLAN ID**, and **Default GW MAC**) must be the same across all the Onyx Edge in a pool.
## Manage Onyx Edge Pools
This section describes how to create and manage Onyx Edge pools.
{% hint style="info" %}
**NOTE:** You can create and manage Onyx Edge pools only if you are a GXC Administrator, Customer Administrator, or an Administrator.
{% endhint %}
**Workflow to create and configure Onyx Edge pools:**
Onyx Edge Pool Configuration Workflow
{% stepper %}
{% step %}
Create the Onyx Edge pool.
See [*Create Onyx Edge Pools*](#create-onyx-edge-pools).
{% endstep %}
{% step %}
If the Onyx Edge that you want to associate with the pool already exist:
1. Remove any direct Onyx Edge – AP associations.
See [*Remove Direct Onyx Edge – AP Associations*](#remove-direct-onyx-edge-ap-associations).
2. Update Onyx Edge configurations for pool requirements.
See [*Networking Requirements*](#networking-requirements).
{% endstep %}
{% step %}
Add any new Onyx Edge to associate with the pool.
See [*Add Onyx Edge*](#add-onyx-edge).
{% endstep %}
{% step %}
Associate the Onyx Edge with the pool.
See [*Associate or Disassociate Onyx Edge with Pools*](#associate-or-disassociate-onyx-edge-with-pools).
{% endstep %}
{% step %}
Set the ACS priorities for the Onyx Edge in the pool.
See [*Edit Onyx Edge Pools*](#edit-onyx-edge-pools).
{% endstep %}
{% step %}
Add any new APs to associate with the pool.
See [*Add APs*](#add-aps).
{% endstep %}
{% step %}
Associate the APs with the pool.
See [*Edit Onyx Edge Pools*](#edit-onyx-edge-pools).
{% endstep %}
{% endstepper %}
### View Onyx Edge Pool Details
This section describes how to view Onyx Edge pool details.
#### View the Dashboard View of All Onyx Edge Pools
{% hint style="info" %}
**NOTE:** The Dashboard view of Onyx Edge pools is displayed only if at least one Onyx Edge Pool exists in the network.
{% endhint %}
**To view the Dashboard display of all Onyx Edge pools in the network:**
{% stepper %}
{% step %}
In the navigation pane, click **Dashboard**.
The Dashboard page is displayed.
{% endstep %}
{% step %}
The **Onyx Edge Pool** panel displays the number of Onyx Edge pools in the network, the pool names, and their HA connectivity status.
Onyx Edge pool's HA connectivity status:
* Green – One Onyx Edge is functioning as the Primary ACS, and the others as Standby ACS.
* Amber – One Onyx Edge is functioning as the Primary ACS, but one or more of the other Onyx Edge are non-functional.
* Red – All Onyx Edge are non-functional, or their status is not available.
* Grey – All Onyx Edge are offline.
To view which Onyx Edge are designated as the Primary and Standby ACS, hover your cursor over the "HA Connectivity Status" icon.
{% endstep %}
{% step %}
To view a pool's details, click its name.
The ***\*** page displays the Onyx Edge pool's details.
{% endstep %}
{% endstepper %}
#### View Summary Details of all Onyx Edge Pools in the Network
**To view the summary details of all Onyx Edge pools in the network:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page > **Onyx Edge** tab displays the summary details of all Onyx Edge configured in the network. At the bottom of the page, the **Onyx Edge Pool (n)** panel lists the existing pools.
* **Onyx Edge Pool (n)**
* Status – The Onyx Edge pool's HA connectivity status.
* Green – One Onyx Edge is functioning as the Primary ACS, and the others as Standby ACS.
* Amber – One Onyx Edge is functioning as the Primary ACS, but one or more of the other Onyx Edge are non-functional.
* Red – All Onyx Edge are non-functional, or their status is not available.
* Grey – All Onyx Edge are offline.
To view which Onyx Edge are designated as the Primary and Standby ACS, hover your cursor over the "HA Connectivity Status" icon.
* **Name** – The Onyx Edge pool's name.
* **HA IP Address** – The virtual management IP address used to anchor TR069 endpoint in the Primary ACS Onyx Edge.
* **Associated Onyx Edge** – The number of Onyx Edge associated with the pool.
* **Associated Access Points** – The number of APs associated with the pool.
* **Actions** – Options to view details, edit, and delete the Onyx Edge pool.
{% endstep %}
{% endstepper %}
#### View an Onyx Edge Pool's Details
**To view an Onyx Edge pool's details:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page > **Onyx Edge** tab displays the summary details of all Onyx Edge configured in the network. At the bottom of the page, the **Onyx Edge Pool (n)** panel lists the existing pools.
{% endstep %}
{% step %}
To view the details of a particular pool, click its name.
The \ page displays the pool's details.
* **Pool Details**
* **Name** – The pool's name.
* **ID** – The pool's ID. This ID is system-generated.
* **MME Group ID** – Uniquely identifies the pool that the MME/Onyx Edge is associated with.
* **HA IP Address** – The virtual management IP address.
* **HA Connectivity Status** – The Onyx Edge pool's HA connectivity status.
* Green – One Onyx Edge is functioning as the Primary ACS, and the others as Standby ACS.
* Amber – One Onyx Edge is functioning as the Primary ACS, but one or more of the other Onyx Edge are non-functional.
* Red – All Onyx Edge are non-functional, or their status is not available.
* Grey – All Onyx Edge are offline.
To view which Onyx Edge are designated as the Primary and Standby ACS, hover your cursor over the "HA Connectivity Status" icon.
* **Associated Onyx Edge** – The list of Onyx Edge associated with this pool.
* **Priority** – The Onyx Edge's ACS priority within the pool. The ACS priority indicates the probability of an Onyx Edge functioning as the Primary ACS relative to the other Onyx Edge in the pool. Priority 1 is the highest priority and 3 the lowest. If the Primary ACS Onyx Edge fails, an operational Standby ACS Onyx Edge with the highest priority will take over as the Primary.
* **Name** – The Onyx Edge's name.
* **Access Point** – The APs associated with the Onyx Edge.
* **Subscribers** – The number of subscribers associated with the Onyx Edge.
* **Online** – Indicates the Onyx Edge's online status, determined by its reachability from the Onyx Portal.
* Green – The Onyx Edge has checked in with the Onyx Portal in the last five minutes.
* Red – The Onyx Edge has not checked in with the Onyx Portal in the last five minutes.
* **ACS** – Indicates the Onyx Edge's current ACS status.
* Green – The Onyx Edge holds the Virtual IP, and it manages and provides AP configuration to the APs.
* Amber – The Onyx Edge's ACS status is not available.
* Red – The Onyx Edge is configured with the highest ACS priority (priority 1) but is not the Primary ACS.
*  Grey – The Onyx Edge is configured with a lower ACS priority and is not the Primary ACS as expected.
* **Interface Status** – Indicates the SGi and RAN (S1) interface connection status.
* Green – All APs are MME-connected to the Onyx Edge, the SGi interface is up and has IP, and the SGi link is active (periodic ICMP checks every five minutes).
* Amber – At least one AP is MME-connected, but some are not, the SGi interface is UP and has IP (SGi link is active).
* Red – None of the APs are MME-connected (that is all APs are MME-disconnected or management-disconnected (MME status is unknown)), or the SGi interface is not up or is not active (SGi link activity check through ICMP).
* Grey – The Onyx Edge is offline, or data is not available.
* **Associated Access Points** – The APs associated with the pool.
* **Name** – The AP's name.
* **B/W 1 (MHz)** – Cell 1's bandwidth in MHz.
* **Freq 1 (MHz)** – Cell 1's frequency cell 1 in MHz.
* **Cell ID 1** – Cell 1's cell ID.
* **PCI 1** – Cell 1's Physical Cell ID (PCI). The PCI is used for cell identity during the cell selection procedure and is used by UE to decode physical layer data being transmitted by the AP.
* **Pwr 1 (dBm)** – Cell 1's power in dBm.
* **Online** – Indicates the AP's online status, which is determined by its reachability from the Onyx Portal.
* Green – The AP has checked in with the Onyx Portal in the last five minutes.
* Red – The AP has not checked in with the Onyx Portal in the last five minutes. Or, the time reported is older than five minutes.
* Grey – The associated Onyx Edge is offline.
To view the last check-in timestamp, hover your cursor over the "Online Status" icon.
* **Interface Status** – Indicates the AP's interface status.
* Green – The AP is MME-connected.
* Red – The AP is MME-disconnected.
* Grey – The AP is offline.
To view the MME status and the Onyx Edge that the AP is connected to, hover your cursor over the "Interface Status" icon.
To include or exclude additional details from the list, click (additional details) and select or clear from the following additional parameters:
* **IP Address** – The AP's IP address.
* **Model** – The AP equipment's model.
* **Software Version** – The AP's software version.
* **Up Time** – The duration for which the AP has been continuously operational without any downtime or interruptions.
* **FSM State** – The Finite State Machine (FSM) state.
* **GPS Latitude** – The AP equipment's GPS latitude coordinate.
* **GPS Longitude** – The AP equipment's GPS longitude coordinate.
* **Access Mode** – The UE access mode. By default, **Open Access**—authorized UE will have access to any cell in the network.
{% endstep %}
{% endstepper %}
### Create Onyx Edge Pools
This section describes how to create Onyx Edge pools.
{% hint style="info" %}
**NOTE:** You can create Onyx Edge pools only if you are a GXC Administrator, Customer Administrator, or an Administrator.
{% endhint %}
{% hint style="info" %}
**NOTE:** Each pool can have a maximum of three Onyx Edge associated with it.
{% endhint %}
{% hint style="info" %}
**NOTE:** An AP can only be associated with one pool at a time.
{% endhint %}
**To create an Onyx Edge pool:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page > **Onyx Edge** tab displays the summary details of all Onyx Edge configured in the network. At the bottom of the page, the **Onyx Edge Pool (n)** panel lists the existing pools.
{% endstep %}
{% step %}
In the **Onyx Edge Pool** panel, click **Add Pool**.
The **Create Onyx Edge Pool** page is displayed.
{% endstep %}
{% step %}
Enter the following details:
* **Name** – (Required) The pool's name. The Onyx Portal automatically populates the pool name, which you can edit if required. The pool name must be unique within the network and must be an alphanumeric string of 1–64 characters.
* **HA IP Address** – (Required) The TR069 anchoring endpoint address.
{% hint style="info" %}
**NOTE:** The HA IP address must be in the same subnet as the S1 interface of the Onyx Edge to be associated with this pool.
{% endhint %}
* **Associated Access Points** – To associate an AP with this pool, select the corresponding checkbox. To simultaneously associate all available APs with this pool, select the **Select All** checkbox.
To disassociate an AP currently associated with the pool, clear the corresponding checkbox. To simultaneously disassociate all APs currently associated with the pool, click the icon. A confirmation dialog box is displayed. To confirm, click **Yes**.
{% hint style="info" %}
**NOTE:** An AP can only be associated with one Onyx Edge pool at any time. Only APs that are not associated with any Onyx Edge pool are available for association.
{% endhint %}
{% hint style="info" %}
**NOTE:** IPSec is not supported in conjunction with HA/Onyx Edge pools. IPSec-enabled APs must not be associated with an Onyx Edge pool.
{% endhint %}
{% endstep %}
{% step %}
Click **Save Onyx Edge Pool**.
The pool is created and is listed in the **Equipment** > **Onyx Edge** tab > **Onyx Edge Pool (n)** panel.
{% endstep %}
{% step %}
Associate the Onyx Edge with this pool. For more information, see [*Associate or Disassociate Onyx Edge with Pools*](#associate-or-disassociate-onyx-edge-with-pools).
{% endstep %}
{% step %}
Set the ACS priority order of the Onyx Edge within the pool, for which you must edit the pool's details. For more information, see [*Edit Onyx Edge Pools*](#edit-onyx-edge-pools).
{% endstep %}
{% endstepper %}
### Edit Onyx Edge Pools
{% hint style="info" %}
**NOTE:** You can edit Onyx Edge pools only if you are a GXC Administrator, Customer Administrator, or an Administrator.
{% endhint %}
**To edit an Onyx Edge pool:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page > **Onyx Edge** tab displays the summary details of all Onyx Edge configured in the network. At the bottom of the page, the **Onyx Edge Pool** panel lists the existing pools.
{% endstep %}
{% step %}
For the pool that you want to edit, in the **Onyx Edge Pool (n)** panel > **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.
The **Edit Onyx Edge Pool** page is displayed.
{% endstep %}
{% step %}
Edit the following details as required:
* **Name** – (Required) The pool's name. The pool name must be unique within the network and must be an alphanumeric string of 1–64 characters.
* **HA IP Address** – (Required) The TR069 anchoring endpoint address.
{% hint style="info" %}
**NOTE:** The HA IP address must be in the same subnet as the S1 interface of the Onyx Edge associated with this pool.
{% endhint %}
* **Associated Access Points** – To associate an AP with this pool, select the corresponding checkbox. To simultaneously associate all available APs with this pool, select the **Select All** checkbox.
To disassociate an AP currently associated with this pool, clear the corresponding checkbox. To simultaneously disassociate all APs currently associated with this pool, click the icon. A confirmation dialog box is displayed. To confirm, click **Yes**.
{% hint style="info" %}
**NOTE:** IPSec is not supported in conjunction with HA/Onyx Edge pools. IPSec-enabled APs must not be associated with an Onyx Edge pool.
{% endhint %}
{% endstep %}
{% step %}
To save your edits, click **Save Onyx Edge Pool**.
{% endstep %}
{% step %}
Associate/disassociate Onyx Edge with the pool. For more information, see [*Associate or Disassociate Onyx Edge with Pools*](#associate-or-disassociate-onyx-edge-with-pools).
{% endstep %}
{% step %}
Set the ACS priority order of the Onyx Edge within the pool.
**Onyx Edge Priority** – The Onyx Edge's ACS priority within the pool. The ACS priority indicates the probability of an Onyx Edge functioning as the Primary ACS relative to the other Onyx Edge in the pool. Priority 1 is the highest priority and 3 the lowest. If the Primary ACS Onyx Edge fails, an operational Standby ACS Onyx Edge with the current highest priority will take over as the Primary.
1. To change the ACS priority of an Onyx Edge in the pool, drag and drop the corresponding row up or down as required.
2. To save your changes, click **Save Priority**.
{% endstep %}
{% endstepper %}
### Delete Onyx Edge Pools
This section describes how to delete Onyx Edge pools.
{% hint style="info" %}
**NOTE:** You can delete Onyx Edge pools only if you are a GXC Administrator, Customer Administrator, or an Administrator.
{% endhint %}
{% hint style="info" %}
**NOTE:** Before you delete an Onyx Edge pool, you must disassociate any Onyx Edge and APs associated with it. For information on disassociating Onyx Edge from pools, see [*Associate or Disassociate Onyx Edge with Pools*](#associate-or-disassociate-onyx-edge-with-pools). For information, on disassociating APs from a pool, see [*Edit Onyx Edge Pools*](#edit-onyx-edge-pools).
{% endhint %}
**To delete an Onyx Edge pool:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page > **Onyx Edge** tab displays the summary details of all Onyx Edge configured in the network. At the bottom of the page, the **Onyx Edge Pool** panel lists the configured Onyx Edge pools.
{% endstep %}
{% step %}
For the Onyx Edge pool that you want to delete, in the **Onyx Edge Pool (n)** panel > **Actions** column, click the corresponding ⋮ (options) icon, then click **Delete**.
A confirmation dialog box is displayed.
{% endstep %}
{% step %}
To confirm, click **Yes**.
{% endstep %}
{% endstepper %}
### Remove Direct Onyx Edge – AP Associations
{% hint style="info" %}
**NOTE:** You can disassociate APs associated with Onyx Edge only if you are a GXC Administrator, Partner Administrator, Super Administrator, or an Administrator.
{% endhint %}
Before you associate an existing Onyx Edge (added pre-1.4.0 release) with a pool, you must disassociate any APs that are directly associated with the Onyx Edge.
**To disassociate any APs directly associated with an Onyx Edge:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page > **Onyx Edge** tab displays the summary details of all Onyx Edge configured in the network.
{% endstep %}
{% step %}
For the Onyx Edge that you want to edit, in the **Onyx Edge (n)** panel > **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.
The **Edit Onyx Edge (*****\*****)** page displays the Onyx Edge's details.
{% endstep %}
{% step %}
In the **RAN** tab > **Associated Access Point** section, click the **Associated Access Point** dropdown and clear any selected APs.
{% endstep %}
{% step %}
To save your edits, in the upper-right corner of the page, click **Save Onyx Edge**.
{% endstep %}
{% endstepper %}
### Associate or Disassociate Onyx Edge with Pools
{% hint style="info" %}
**NOTE:** You can associate and disassociate Onyx Edge with a pool only if you are a GXC Administrator, Customer Administrator, or an Administrator.
{% endhint %}
{% hint style="info" %}
**NOTE:** Onyx Edge HA is supported only for Onyx Edge On-Premises AGWs.
{% endhint %}
{% hint style="info" %}
**NOTE:** Each pool can have a maximum of three Onyx Edge associated with it.
{% endhint %}
{% hint style="info" %}
**NOTE:** An Onyx Edge can be associated only with one pool at any time.
{% endhint %}
{% hint style="info" %}
**NOTE:** Before associating an Onyx Edge with a pool, ensure that there are no APs directly associated with it. Before associating the Onyx Edge with a pool, remove any existing AP associations. The Orchestrator manages the AP associations with the Onyx Edge.
{% endhint %}
{% hint style="info" %}
**NOTE:** After associating an Onyx Edge with a pool, you must not directly associate APs with it.
{% endhint %}
{% hint style="info" %}
**NOTE:** When you dissociate an Onyx Edge from a pool, the Onyx Edge is also dissociated from the APs associated with the pool.
{% endhint %}
{% hint style="info" %}
**NOTE:** IPSec is not supported in conjunction with HA/Onyx Edge pools. IPSec-enabled Onyx Edge must not be associated with an Onyx Edge pool.
{% endhint %}
You can associate an Onyx Edge with a pool either when you add the Onyx Edge, or later by editing the Onyx Edge's details.
**To associate or disassociate an existing Onyx Edge with a pool:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page > **Onyx Edge** tab displays the summary details of all Onyx Edge configured in the network.
{% endstep %}
{% step %}
For the Onyx Edge that you want to associate with a pool, in the **Onyx Edge (n)** panel > **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.
{% hint style="info" %}
**NOTE:** Onyx Edge HA is supported only for Onyx Edge On-Premises.
{% endhint %}
The **Edit Onyx Edge (*****\*****)** page displays the Onyx Edge's details.
{% endstep %}
{% step %}
In the **Onyx Edge** tab:
* To associate the Onyx Edge with a pool, turn on the **Enable Onyx Edge Pool** toggle button, then in the dropdown, select the pool's name.
The dropdown is displayed only when the **Enable Onyx Edge Pool** toggle button is turned on.
If there are no Onyx Edge pools available, the **Enable Onyx Edge Pool** toggle button is disabled.
* To disassociate the Onyx Edge from a pool, turn off the **Enable Onyx Edge Pool** toggle button. A confirmation dialog box is displayed. To confirm, click **Yes**.
{% endstep %}
{% step %}
To save your edits, in the upper-right corner of the page, click **Save Onyx Edge**.
{% endstep %}
{% endstepper %}
---
# 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-equipment/manage-onyx-edge/manage-onyx-edge-high-availability.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
Green – One Onyx Edge is functioning as the Primary ACS, and the others as Standby ACS.
* 
Amber – One Onyx Edge is functioning as the Primary ACS, but one or more of the other Onyx Edge are non-functional.
* 
Red – All Onyx Edge are non-functional, or their status is not available.
* 
Grey – All Onyx Edge are offline.
To view which Onyx Edge are designated as the Primary and Standby ACS, hover your cursor over the "HA Connectivity Status" icon.
{% endstep %}
{% step %}
To view a pool's details, click its name.
The ***\
Green – One Onyx Edge is functioning as the Primary ACS, and the others as Standby ACS.
* 
Amber – One Onyx Edge is functioning as the Primary ACS, but one or more of the other Onyx Edge are non-functional.
* 
Red – All Onyx Edge are non-functional, or their status is not available.
* 
Grey – All Onyx Edge are offline.
To view which Onyx Edge are designated as the Primary and Standby ACS, hover your cursor over the "HA Connectivity Status" icon.
* **Name** – The Onyx Edge pool's name.
* **HA IP Address** – The virtual management IP address used to anchor TR069 endpoint in the Primary ACS Onyx Edge.
* **Associated Onyx Edge** – The number of Onyx Edge associated with the pool.
* **Associated Access Points** – The number of APs associated with the pool.
* **Actions** – Options to view details, edit, and delete the Onyx Edge pool.
{% endstep %}
{% endstepper %}
#### View an Onyx Edge Pool's Details
**To view an Onyx Edge pool's details:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page > **Onyx Edge** tab displays the summary details of all Onyx Edge configured in the network. At the bottom of the page, the **Onyx Edge Pool (n)** panel lists the existing pools.
{% endstep %}
{% step %}
To view the details of a particular pool, click its name.
The \
Green – One Onyx Edge is functioning as the Primary ACS, and the others as Standby ACS.
* 
Amber – One Onyx Edge is functioning as the Primary ACS, but one or more of the other Onyx Edge are non-functional.
* 
Red – All Onyx Edge are non-functional, or their status is not available.
* 
Grey – All Onyx Edge are offline.
To view which Onyx Edge are designated as the Primary and Standby ACS, hover your cursor over the "HA Connectivity Status" icon.
* **Associated Onyx Edge** – The list of Onyx Edge associated with this pool.
* **Priority** – The Onyx Edge's ACS priority within the pool. The ACS priority indicates the probability of an Onyx Edge functioning as the Primary ACS relative to the other Onyx Edge in the pool. Priority 1 is the highest priority and 3 the lowest. If the Primary ACS Onyx Edge fails, an operational Standby ACS Onyx Edge with the highest priority will take over as the Primary.
* **Name** – The Onyx Edge's name.
* **Access Point** – The APs associated with the Onyx Edge.
* **Subscribers** – The number of subscribers associated with the Onyx Edge.
* **Online** – Indicates the Onyx Edge's online status, determined by its reachability from the Onyx Portal.
* 
Green – The Onyx Edge has checked in with the Onyx Portal in the last five minutes.
* 
Red – The Onyx Edge has not checked in with the Onyx Portal in the last five minutes.
* **ACS** – Indicates the Onyx Edge's current ACS status.
* 
Green – The Onyx Edge holds the Virtual IP, and it manages and provides AP configuration to the APs.
* 
Amber – The Onyx Edge's ACS status is not available.
* 
Red – The Onyx Edge is configured with the highest ACS priority (priority 1) but is not the Primary ACS.
*  Grey – The Onyx Edge is configured with a lower ACS priority and is not the Primary ACS as expected.
* **Interface Status** – Indicates the SGi and RAN (S1) interface connection status.
* 
Green – All APs are MME-connected to the Onyx Edge, the SGi interface is up and has IP, and the SGi link is active (periodic ICMP checks every five minutes).
* 
Amber – At least one AP is MME-connected, but some are not, the SGi interface is UP and has IP (SGi link is active).
* 
Red – None of the APs are MME-connected (that is all APs are MME-disconnected or management-disconnected (MME status is unknown)), or the SGi interface is not up or is not active (SGi link activity check through ICMP).
* 
Grey – The Onyx Edge is offline, or data is not available.
* **Associated Access Points** – The APs associated with the pool.
* **Name** – The AP's name.
* **B/W 1 (MHz)** – Cell 1's bandwidth in MHz.
* **Freq 1 (MHz)** – Cell 1's frequency cell 1 in MHz.
* **Cell ID 1** – Cell 1's cell ID.
* **PCI 1** – Cell 1's Physical Cell ID (PCI). The PCI is used for cell identity during the cell selection procedure and is used by UE to decode physical layer data being transmitted by the AP.
* **Pwr 1 (dBm)** – Cell 1's power in dBm.
* **Online** – Indicates the AP's online status, which is determined by its reachability from the Onyx Portal.
* 
Green – The AP has checked in with the Onyx Portal in the last five minutes.
* 
Red – The AP has not checked in with the Onyx Portal in the last five minutes. Or, the time reported is older than five minutes.
* 
Grey – The associated Onyx Edge is offline.
To view the last check-in timestamp, hover your cursor over the "Online Status" icon.
* **Interface Status** – Indicates the AP's interface status.
* 
Green – The AP is MME-connected.
* 
Red – The AP is MME-disconnected.
* 
Grey – The AP is offline.
To view the MME status and the Onyx Edge that the AP is connected to, hover your cursor over the "Interface Status" icon.
To include or exclude additional details from the list, click 
(additional details) and select or clear from the following additional parameters:
* **IP Address** – The AP's IP address.
* **Model** – The AP equipment's model.
* **Software Version** – The AP's software version.
* **Up Time** – The duration for which the AP has been continuously operational without any downtime or interruptions.
* **FSM State** – The Finite State Machine (FSM) state.
* **GPS Latitude** – The AP equipment's GPS latitude coordinate.
* **GPS Longitude** – The AP equipment's GPS longitude coordinate.
* **Access Mode** – The UE access mode. By default, **Open Access**—authorized UE will have access to any cell in the network.
{% endstep %}
{% endstepper %}
### Create Onyx Edge Pools
This section describes how to create Onyx Edge pools.
{% hint style="info" %}
**NOTE:** You can create Onyx Edge pools only if you are a GXC Administrator, Customer Administrator, or an Administrator.
{% endhint %}
{% hint style="info" %}
**NOTE:** Each pool can have a maximum of three Onyx Edge associated with it.
{% endhint %}
{% hint style="info" %}
**NOTE:** An AP can only be associated with one pool at a time.
{% endhint %}
**To create an Onyx Edge pool:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page > **Onyx Edge** tab displays the summary details of all Onyx Edge configured in the network. At the bottom of the page, the **Onyx Edge Pool (n)** panel lists the existing pools.
{% endstep %}
{% step %}
In the **Onyx Edge Pool** panel, click **Add Pool**.
The **Create Onyx Edge Pool** page is displayed.
icon. A confirmation dialog box is displayed. To confirm, click **Yes**.
{% hint style="info" %}
**NOTE:** An AP can only be associated with one Onyx Edge pool at any time. Only APs that are not associated with any Onyx Edge pool are available for association.
{% endhint %}
{% hint style="info" %}
**NOTE:** IPSec is not supported in conjunction with HA/Onyx Edge pools. IPSec-enabled APs must not be associated with an Onyx Edge pool.
{% endhint %}
{% endstep %}
{% step %}
Click **Save Onyx Edge Pool**.
The pool is created and is listed in the **Equipment** > **Onyx Edge** tab > **Onyx Edge Pool (n)** panel.
{% endstep %}
{% step %}
Associate the Onyx Edge with this pool. For more information, see [*Associate or Disassociate Onyx Edge with Pools*](#associate-or-disassociate-onyx-edge-with-pools).
{% endstep %}
{% step %}
Set the ACS priority order of the Onyx Edge within the pool, for which you must edit the pool's details. For more information, see [*Edit Onyx Edge Pools*](#edit-onyx-edge-pools).
{% endstep %}
{% endstepper %}
### Edit Onyx Edge Pools
{% hint style="info" %}
**NOTE:** You can edit Onyx Edge pools only if you are a GXC Administrator, Customer Administrator, or an Administrator.
{% endhint %}
**To edit an Onyx Edge pool:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page > **Onyx Edge** tab displays the summary details of all Onyx Edge configured in the network. At the bottom of the page, the **Onyx Edge Pool** panel lists the existing pools.
{% endstep %}
{% step %}
For the pool that you want to edit, in the **Onyx Edge Pool (n)** panel > **Actions** column, click the corresponding ⋮ (options) icon, then click **Edit**.
icon. A confirmation dialog box is displayed. To confirm, click **Yes**.
{% hint style="info" %}
**NOTE:** IPSec is not supported in conjunction with HA/Onyx Edge pools. IPSec-enabled APs must not be associated with an Onyx Edge pool.
{% endhint %}
{% endstep %}
{% step %}
To save your edits, click **Save Onyx Edge Pool**.
{% endstep %}
{% step %}
Associate/disassociate Onyx Edge with the pool. For more information, see [*Associate or Disassociate Onyx Edge with Pools*](#associate-or-disassociate-onyx-edge-with-pools).
{% endstep %}
{% step %}
Set the ACS priority order of the Onyx Edge within the pool.
**Onyx Edge Priority** – The Onyx Edge's ACS priority within the pool. The ACS priority indicates the probability of an Onyx Edge functioning as the Primary ACS relative to the other Onyx Edge in the pool. Priority 1 is the highest priority and 3 the lowest. If the Primary ACS Onyx Edge fails, an operational Standby ACS Onyx Edge with the current highest priority will take over as the Primary.
1. To change the ACS priority of an Onyx Edge in the pool, drag and drop the corresponding row up or down as required.
2. To save your changes, click **Save Priority**.
{% endstep %}
{% endstepper %}
### Delete Onyx Edge Pools
This section describes how to delete Onyx Edge pools.
{% hint style="info" %}
**NOTE:** You can delete Onyx Edge pools only if you are a GXC Administrator, Customer Administrator, or an Administrator.
{% endhint %}
{% hint style="info" %}
**NOTE:** Before you delete an Onyx Edge pool, you must disassociate any Onyx Edge and APs associated with it. For information on disassociating Onyx Edge from pools, see [*Associate or Disassociate Onyx Edge with Pools*](#associate-or-disassociate-onyx-edge-with-pools). For information, on disassociating APs from a pool, see [*Edit Onyx Edge Pools*](#edit-onyx-edge-pools).
{% endhint %}
**To delete an Onyx Edge pool:**
{% stepper %}
{% step %}
In the navigation pane, click **Equipment**.
The **Equipment** page > **Onyx Edge** tab displays the summary details of all Onyx Edge configured in the network. At the bottom of the page, the **Onyx Edge Pool** panel lists the configured Onyx Edge pools.
{% endstep %}
{% step %}
For the Onyx Edge pool that you want to delete, in the **Onyx Edge Pool (n)** panel > **Actions** column, click the corresponding ⋮ (options) icon, then click **Delete**.
