> 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-edge-on-premises-4.x-installation-and-operations/install-onyx-edge-software.md).
# Install Onyx Edge Software
GXC supplies Onyx-ES hardware with the Onyx Edge software pre-installed and ready for deployment, so customers typically do not need to install the software themselves. However, if reinstallation is required due to hardware replacement, disk corruption, system recovery, etc. use the following procedure to perform a fresh installation of the Onyx Edge software on Onyx-ES hardware.
## Target Machine Requirements
Before beginning installation, ensure the target machine meets the following requirements:
* Boot Configuration – The target machine must be able to boot exactly once from the installation medium (USB or CD) containing the ISO, then automatically revert to hard disk boot.
{% hint style="info" %}
**NOTE:** If automatic boot revert is not possible: during Stage 1 installation, you must monitor the console, and after the first reboot, manually enter BIOS to change the boot priority to Hard Disk/SSD. Failure to do this will cause Stage 1 to repeat indefinitely. Alternatively, just remove the USB drive immediately after the first reboot to prevent Stage 1 installation repeating indefinitely.
{% endhint %}
* Network Interfaces – The target machine must have two network interfaces (eth0 and eth1). For detailed information about network interface specifications, port identification, and configuration requirements, refer to Network Interfaces.
## Installation Workflow
Workflow to install Onyx Edge software:
{% stepper %}
{% step %}
Obtain Onyx Edge Software ISO Image.
{% endstep %}
{% step %}
Create Bootable USB Drive.
{% endstep %}
{% step %}
Verify Target Machine’s Network Connectivity:
* eth0 must have Internet connectivity.
* eth1 must be disconnected during installation.
{% endstep %}
{% step %}
Install Onyx Edge Software from Bootable USB Drive.
{% endstep %}
{% step %}
Post Installation Tasks:
1. Verify Successful Installation.
2. Get eth0 Hardware Address.
3. Label Physical Ports.
4. Connect eth1 to Radio Network.
5. Onboard the Onyx Edge in the Onyx Portal.
6. Verify Successful Onyx Edge Onboarding.
{% endstep %}
{% endstepper %}
### Obtain Onyx Edge Software ISO Image
To obtain the Onyx Edge ISO image, contact GXC Technical Support.
### Create Bootable USB Drive
To create a bootable USB drive with the Onyx Edge software, you will need:
* Onyx Edge ISO image.
* An empty USB drive with at least 4 GB of storage space.
* A tool to flash the Onyx Edge ISO image to the USB drive.
The Balena Etcher is a free open-source utility supported on Windows, LINUX, and Mac OS. You can obtain it from .
**To create a bootable USB drive:**
{% stepper %}
{% step %}
Download the Onyx Edge ISO image to your local computer.
{% endstep %}
{% step %}
Plug in the USB drive.
{% endstep %}
{% step %}
Use the Balena Etcher utility to create the bootable USB:
1. Launch the Balena Etcher utility.
2. Click **Flash from file**, then select the Onyx Edge ISO image.
3. Select the USB drive to flash, then click **Continue**.
4. Click **Flash!** to create the bootable USB flash drive with the default settings. Flashing will take some time depending upon the size of the ISO image, and the speed supported by the USB drive. After Balena Etcher finishes creating the bootable ISO image on the USB, the “Flash Complete!” message is displayed.
5. Exit the Balena Etcher utility.
{% endstep %}
{% step %}
Safely unplug the USB drive.
{% endstep %}
{% endstepper %}
### Install Onyx Edge Software from Bootable USB Drive
{% hint style="warning" %}
**CAUTION:** Reinstalling the Onyx Edge software will erase all existing data on the target machine. Ensure that any required data is backed up before proceeding.
{% endhint %}
To install the Onyx Edge software, you will need:
* Hardware requirements:
* The target machine must have two network interfaces (eth0 and eth1). For complete specifications, see Network Interfaces.
* Ensure eth0 interface has active Internet connectivity.
* Ensure eth1 interface is physically disconnected (not connected to any network).
* The machine must support booting from a USB drive.
* Installation materials:
* A bootable USB drive containing the Onyx Edge ISO image.
* Physical port labels to clearly identify network interface assignments.
* To log on to the Onyx-ES during Stage 2 and 3 of the installation, the following access credentials:
* Host name: onyxedge-agw
* Username: onyxedge
* Password to log on via the terminal: (Provided by GXC Technical Support.)
{% hint style="info" %}
**NOTE:** If you do not have management access to the Onyx-ES, work with your GXC Technical Support representative.
{% endhint %}
The Onyx Edge software installation runs in three stages with three automatic reboots. The bootable USB drive must be configured to boot exactly once, after which the system should automatically revert to booting from the hard disk.
**To install the Onyx Edge software:**
{% stepper %}
{% step %}
Configure BIOS boot settings:
1. Plug in the bootable USB drive and restart the system.
2. Enter the BIOS setup as the system reboots.\
Different machines have different BIOS entry methods. Common keys include F2, F11, F12, or Delete.
3. Set the USB device as the first boot option.\
In the BIOS menu, locate the Boot Order or Boot Priority settings and move the USB drive to the top of the list.\
The boot order determines which device the system checks first when loading an operating system (e.g., hard drive, USB, optical drive).
4. Save and exit the BIOS setup.\
The system reboots and begins the installation from the USB drive.
{% endstep %}
{% step %}
Monitor Stage 1 installation:
The system boots from the USB drive and displays a GRUB screen for 5 seconds.
{% endstep %}
{% step %}
Select the network connection configuration option:
* Option 1 - DHCP Configuration (Default):\
If eth0 should use DHCP, accept the default option: **Install Onyxedge AGW**\
Press Enter or wait 5 seconds to continue.
* Option 2 - Static IP Configuration:
If eth0 requires a static IP address, select: **Install Onyxedge AGW - manual network config**.
{% endstep %}
{% step %}
On the next screen, enter:
* **Subnet** (e.g., 192.168.123.0/24)
* **Address** (e.g., 192.168.123.45)
* **Gateway** (e.g., 192.168.123.1)
* **Name servers** (e.g., 192.168.123.1)
* **Search domains** (e.g., company.comma.separated)
{% endstep %}
{% step %}
VLAN configuration for SGi (if required):
1. Disable the native VLAN.
2. Add a VLAN tag.
3. Set the VLAN to manual mode and configure the IP details.
4. Disable IP address on the SGi interface.
5. After configuring network connections, proceed with the installation.
Stage 1 proceeds automatically.\
You can monitor the console/monitor to track progress.\
After Stage 1 completes, the system performs its first automatic reboot.
{% endstep %}
{% step %}
Immediately take one of the following actions:
{% hint style="info" %}
**NOTE:** If you fail to do this, Stage 1 will repeat indefinitely.
{% endhint %}
* Option A (Recommended): As soon as you see the system rebooting, physically remove the USB drive. This prevents the system from booting from USB again.
* Option B: Change BIOS boot priority:
1. Watch for the reboot to complete.
2. Immediately enter the BIOS setup again.
3. Change the boot priority to Hard Disk/SSD as first boot device.
4. Save and exit BIOS.
This first reboot completes Stage 1 of the installation.
{% endstep %}
{% step %}
Monitor Stage 2 installation:
After the first reboot (with USB removed or BIOS changed), Stage 2 begins automatically.
1. Access the Onyx Edge:
1. Wait for the system to boot.
2. Log in via console/monitor using the following credentials:
Note the IP that is briefly displayed on the screen before it scrolls off.
* Host: onyxedge-agw (or the IP displayed on screen)
* Username: onyxedge
* Password: (provided by GXC Technical Support)
2. Monitor installation progress:
1. Run the `install_progress` command.
The output displays the current installation status.
3. Stage 2 completion:
The system automatically reboots after Stage 2 completes.
You will see: *"agw\_iso\_install.service configured to run on STAGE3"*
The Onyx-ES reboots for the second time.
This second reboot completes Stage 2 of the installation.
4. Monitor Stage 3 installation:
After the second reboot, Stage 3 begins automatically.
1. Log in again using the same credentials as in Step 3.a.2.
2. Monitor installation progress:
1. Run the `install_progress` command.
The output displays the current installation status.
3. Stage 3 completion:
The system automatically reboots after Stage 3 is completed.
This third reboot completes the Onyx Edge software installation.
The system displays: *“Yay! Initial installation of AGW software is successful. Happy gateway'ing”*
Note the Onyx Edge’s eth0 IP and MAC addresses.
{% endstep %}
{% endstepper %}
### Post Installation Tasks
This section describes the tasks to perform after installing the Onyx Edge software.
#### Verify Successful Installation
To verify successful Onyx Edge software installation:
{% stepper %}
{% step %}
After the installation is completed, log on to the Onyx Edge.
{% endstep %}
{% step %}
Confirm the login banner displays the Gateway ID, eth0 and eth1 IP addresses, and list of services with “active” status, as shown below.
```
+------------------------------------------------------------+
| OnyxEdge Access Gateway |
+------------------------------------------------------------+
| Gateway ID: 1fa44d3f-cca5-486f-94ed-5a39e2ddf3c2 |
+------------------------------------------------------------+
| eth0: 192.168.122.165/24 |
| eth1: 10.0.2.1/24 |
| uplink_br0: |
+------------------------------------------------------------+
| Free RAM: 2.1Gi |
| Free SWAP: 0B |
| Free storage: 2G |
+------------------------------------------------------------+
+------------------------------------------------------------+
| OnyxEdge AGW status |
| 1.6.1-151-gxcd-1656008356-4d15f3ed |
+------------------------------------------------------------+
| Subscribers connected: 0 |
+------------------------------------------------------------+
| control_proxy: active |
| ctraced: active |
| directoryd: active |
| dnsd: active |
| enodebd: active |
| envoy_controller: active |
| eventd: active |
| health: active |
| mme: active |
| mobilityd: active |
| monitord: active |
| pipelined: active |
| policydb: active |
| redis: active |
| sessiond: active |
| smsd: active |
| state: active |
| subscriberdb: active |
+------------------------------------------------------------+
```
Verify that all services are in active state. If any service shows a different status, contact GXC Technical Support.
{% endstep %}
{% step %}
Run the install\_progress command.
The output should display:
```
onyxedge@onyxedge-agw:$ install_progress
Yay! Initial installation of AGW software is successful.
Happy gateway'ing
onyxedge@onyxedge-agw:$
```
{% endstep %}
{% endstepper %}
#### Get eth0 Hardware Address
To onboard the Onyx Edge in the Onyx Portal, you will need its eth0 hardware address. If the eth0 hardware address is not available on the hardware label or on the shipping box, to obtain the Onyx Edge’s eth0 hardware address, log on to the Onyx Edge as agw\_user, and run the show networking links command. In the output, note the value against the eth0 parameter.
{% code overflow="wrap" %}
```
Onxyedge> show networking links
1: lo: mtu 65536 qdisc noqueue state UNKNOWN mode DEFAULT group default qlen 1000 link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
2: eth1: mtu 1500 qdisc htb state UP mode DEFAULT group default qlen 1000 link/ether a1:b2:345e:f5 brd ff:ff:ff:ff:ff:ff
3: eth0: mtu 1500 qdisc htb state UP mode DEFAULT group default qlen 1000 link/ether a1:b2:345e:f6 brd ff:ff:ff:ff:ff:ff
...
```
{% endcode %}
#### Connect eth1 to Radio Network
Now that installation is complete, you can connect eth1 to the radio network:
{% stepper %}
{% step %}
Connect the eth1 port to your switch.
OR, if only one AP exists, connect to it directly.
The Onyx Edge will provide DHCP service on this interface (10.0.2.1/24).
{% endstep %}
{% step %}
Verify eth1 connectivity:
1. Run the show networking links command.
2. Verify eth1 shows as "UP" with IP address 10.0.2.1/24.
{% endstep %}
{% endstepper %}
#### Onboard the Onyx Edge in the Onyx Portal
After installing the Onyx Edge, you must onboard it in the Onyx Portal and verify the successful onboarding. For details, see the *4G Onyx Portal Operations Guide > Add Onyx Edge section*.
---
# 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-edge-on-premises-4.x-installation-and-operations/install-onyx-edge-software.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.
