> 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/troubleshooting-information.md).

# Troubleshooting Information

This section describes basic Onyx Edge troubleshooting information.

## View Onyx Edge Details

**To view an Onyx Edge’s details:**

{% stepper %}
{% step %}
Open the Onyx Edge's Details page (Onyx Portal, click **Equipment** > **Onyx Edge** tab > Onyx Edge details page > **Overview** tab).

The **Overview** tab displays the selected Onyx Edge's details, including its configuration, status, and connected equipment. For detailed information, see *4G Onyx Portal Operations Guide > View Onyx Edge Details*.
{% endstep %}

{% step %}
To view Onyx Edge's events and alerts, click the **Events & Alerts** tab.

The **Events & Alerts** tab displays alerts and events generated by the Onyx Edge.

The **Alerts** panel lists device alerts with the Date, Status, Alert Name, and Severity, and includes a filter to view specific alert types.

The **Events** panel displays system events for the selected date/time and duration. The table includes the Timestamp, Module, Event Type, Entity, and Event Description, with filtering options for several fields.

For detailed information, see *4G Onyx Portal Operations Guide > View Onyx Edge Details*.
{% endstep %}

{% step %}
To view Onyx Edge's logs, click the **Logs** tab.

The **Logs** tab displays Onyx Edge logs for the selected date/time and duration, and log details including timestamp, service, tag, type, and log text are displayed.

To download the logs in .csv format, click **Download**. In the **Download Logs** dialog box, select the timestamps and the limit, which specifies the maximum number of logs to be included in the .csv file, then click **Save**. The downloaded .csv file contains log details including timestamp, service, tag, type, and log text.

For detailed information, see *4G Onyx Portal Operations Guide > View Onyx Edge Details*.
{% endstep %}
{% endstepper %}

## View Connected APs, Mesh Nodes, and Subscribers

**To view the list of active APs, Mesh nodes, and subscribers connected to an Onyx Edge:**

{% stepper %}
{% step %}
For the list of active APs, view the Onyx Edge’s details page > **Overview** tab > **Connected Access Point** section.
{% endstep %}

{% step %}
For the list of Mesh Nodes, view the Onyx Edge’s details page > **Overview** tab > **Mesh Node** section.
{% endstep %}

{% step %}
For the list of active subscribers, view the Onyx Edge’s details page > **Overview** tab > **Subscribers** section.
{% endstep %}
{% endstepper %}

For detailed information, see *4G Onyx Portal Operations Guide > View Onyx Edge Details.*

## Run Commands on the Onyx Edge

This section describes how to:

* [Run Commands on Onyx Edge from Onyx Portal](#run-commands-on-onyx-edge-from-onyx-portal)
* [Run Commands on Onyx Edge as agw\_user](#run-commands-on-onyx-edge-as-agw_user)

### Run Commands on Onyx Edge from Onyx Portal

**To run generic commands on an Onyx Edge from the Onyx Portal:**

{% stepper %}
{% step %}
In the Onyx Edge’s details page (Onyx Portal > **Equipment** > **Onyx Edge** tab > Onyx Edge details page), in the upper-right corner of the page, click **Actions**.

{% hint style="info" %}
**NOTE:** The Actions button is enabled only when the Onyx Edge is online.
{% endhint %}

* **Upgrade** – (GXC Administrators, Super Administrators, and Administrators only.) Upgrade the Onyx Edge’s software version, move the Onyx Edge to the required target upgrade group. For more information, see the 4G Onyx Portal Operations Guide > Move an Onyx Edge from one Upgrade Group to Another section.
* **Reboot Onyx Edge** – (GXC Administrators, Super Administrators, and Administrators only.) Reboot the Onyx Edge. Services will be down while the equipment reboots.

  A confirmation dialog box is displayed. To confirm, click **Yes**.
* **Restart Services on Onyx Edge** – (GXC Administrators, Super Administrators, and Administrators only.) Restart the Onyx Edge’s core services. All active UE will be detached. Connectivity will be down until the services resume.

  A confirmation dialog box is displayed. To confirm, click **Yes**.
* **Ping** – (GXC Administrators, Super Administrators, and Administrators only.) Ping the Onyx Edge’s host.

  Enter the following details, then click **Ping**.

  * **Host** – (Required) The host’s IP address.
  * **Packets (default 4)** – (Optional) The number of packets to send. Default: 4.
* **Reboot AP** – (GXC Administrators, Super Administrators, and Administrators only.) Reboot all or a specific AP.

  Enter the following details, then click **Execute**.

  * **Reboot AP** – Select to reboot a specific AP in the network.

    In the Select an AP dropdown, select the AP’s serial number.
  * **Reboot All APs** – Select to reboot all APs in the network.
* **Reboot Neighbor Updated AP** – (GXC Administrators, Super Administrators, and Administrators only.) Schedule reboots for APs with pending neighbor changes:
  * Reboot all APs with reboot pending at a chosen time, including immediately.
  * Reboot a specific AP by serial number, if it has a reboot pending, at a chosen time including immediately.
* **Detach Subscriber** – (GXC Administrators, Super Administrators, and Administrators only.) Forcibly detach an active subscriber/UE.

  Enter the following details, then click **Execute**.

  * **Subscriber IMSI** – The subscriber’s IMSI.
* **Force Config Sync** – (GXC Administrators, Super Administrators, and Administrators only.) Trigger a full configuration synchronization.
* **Force Subscriber Config Sync** – (GXC Administrators, Super Administrators, and Administrators only.) Trigger a configuration synchronization for a specific subscriber.
* **Trigger Debug Information Collection** – (GXC Administrators, Super Administrators, and Administrators only.) Collect logs and telemetry from Onyx Edge.
* **List Debug Information Files in OE** – (GXC Administrators, Super Administrators, and Administrators only.) View downloadable debug files available on the Onyx Edge.
* **Generic Command** – (GXC Administrators only.) Run generic commands on the Onyx Edge.

  The **Run Onyx Edge Command** dialog box is displayed.

  Enter the following details, then click **Execute**:

  * **Command** – (Required) The command to run.
  * **Parameters** – (Optional) Parameters for the command.
    {% endstep %}
    {% endstepper %}

### Run Commands on Onyx Edge as agw\_user

As agw\_user, you can SSH into and run the following commands on your Onyx Edge. 

To SSH into an Onyx Edge as agw\_user, run the following command: 

```
ssh agw_user@<ip_address>
```

For more information, see [agw\_user](/docs/network-configuration-and-operations-guides/5g-onyx-portal-4.x-operations.md).

#### Command Descriptions

<details>

<summary><strong>change_password</strong></summary>

Prompts to change the current password for agw\_user.

**Usage:** `change_password [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> change_password
```

</details>

<details>

<summary><strong>collect_tech_dump</strong></summary>

Collects system logs and diagnostic information from the Onyx Edge and creates a tech dump archive in /var/core/tech\_dump/.

**Usage:** `collect_tech_dump [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> collect_tech_dump
```

</details>

<details>

<summary><strong>gateway power-off</strong></summary>

Powers off the Onyx Edge safely.

**Usage:** `gateway power-off [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> gateway power-off
```

</details>

<details>

<summary><strong>gateway reboot</strong></summary>

Reboots the Onyx Edge.

**Usage:** `gateway reboot [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> gateway reboot
```

</details>

<details>

<summary><strong>gateway restore-factory-defaults</strong></summary>

Restores the Onyx Edge to its factory default settings.

**Usage:** `gateway restore-factory-defaults [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> gateway restore-factory-defaults
```

</details>

<details>

<summary><strong>history</strong></summary>

Manages and displays previously entered commands.

**Usage:** `history [-h] [-r] [-e] [-o FILE] [-t TRANSCRIPT_FILE] [-c] [-s] [-v] [-a] [arg]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.
* `-r, --run`: Run selected history items.
* `-e, --edit`: Edit and then run selected history items.
* `-o, --output_file`: Output commands to a script file.
* `-t, --transcript`: Output commands and results to a transcript file.
* `-c, --clear`: Clear all history.
* `-s, --script`: Output commands in script format.
* `-v, --verbose`: Display detailed command information.
* `-a, --all`: Display all commands from previous sessions.<br>

**Example:** This command runs the third command from history.

```
onyxedge> history -r 3
```

</details>

<details>

<summary><strong>ping</strong></summary>

Sends ICMP echo requests to test network connectivity.

**Usage:** **ping \[-h] \[-c COUNT] host**

**Positional Argument:**

* `host`: The host to ping.

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.
* `-c, --count COUNT`: Number of pings to send (for infinite pings use 0).

**Example:** This command sends five ping requests to the host 10.0.0.1.

```
onyxedge> ping -c 5 10.0.0.1
```

</details>

<details>

<summary><strong>quit</strong></summary>

Exits the Onyx Edge CLI application.

**Usage:** `quit [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:**

```
onyxedge> quit
```

</details>

<details>

<summary><strong>scp_to</strong></summary>

Securely copies files to a host using SCP.

**Usage:** `scp_to -u USER -o HOST [-h] [-d TECHDUMP] [-c CORE] [-s] [-t TARGET_PATH]`

**Required Arguments:**

* `-u, --user`: Username to use for SCP.
* `-o, --host`: The target host to SCP to.\
  Optional Arguments:
* `-h, --help`: Displays help information for the command.
* `-d, --techdump`: Specifies the tech dump file to SCP.
* `-c, --core`: Specifies the core file to SCP.
* `-s, --ssh-pubkey`: Copies the Onyx Edge’s SSH public key.
* `-t, --target-path`: Specifies the path on the target host.<br>

**Example:** This command copies the tech dump to the host at 10.0.0.2.

```
onyxedge> scp_to -u admin -o 10.0.0.2 -d /var/log/techdump.tar.gz
```

</details>

<details>

<summary><strong>show authorized-keys</strong></summary>

Displays the SSH authorized keys on the system, which can be used for secure access.

**Usage:** `show authorized-keys`

**Example:**

```
onyxedge> show authorized-keys
```

</details>

<details>

<summary><strong>show files</strong></summary>

Lists available system files such as core dumps and tech dumps.

**Usage:** `show files {cores, tech-dumps}`

**Positional Arguments:**

* `cores`: Lists core dump files (if any).
* `tech-dumps`: Lists tech dump files.

**Example:** Lists all available tech dump files.

```
onyxedge> show files tech-dumps
```

</details>

<details>

<summary><strong>show gateway-info</strong></summary>

Displays detailed Onyx Edge information, including hardware ID and challenge key.

**Usage:** `show gateway-info [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:** Displays the Onyx Edge’s hardware ID and challenge key.

```
onyxedge> show gateway-info
```

</details>

<details>

<summary><strong>show networking</strong></summary>

Displays information about the network interfaces and IPs of the Onyx Edge system.

**Usage:** `show networking [-h] {links, ipv4}`

**Positional Arguments:**

* `links`: Displays the network interface details (e.g., link status, MTU, etc.).
* `ipv4`: Shows the IPv4 addresses associated with network interfaces.\
  Optional Arguments:
* `-h, --help`: Displays help information for the command.

**Examples:**

* Displays detailed information for all network interfaces (e.g., eth0, eth1).

```
onyxedge> show networking links
```

* Displays the IPv4 addresses assigned to interfaces like eth0, eth1, etc.

```
onyxedge> show networking ipv4
```

</details>

<details>

<summary><strong>show services</strong></summary>

Displays the status of all services on the Onyx Edge system.

**Usage:** `show services [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:** Displays the status (e.g., active/inactive) of all services running on the system.

```
onyxedge> show services
```

</details>

<details>

<summary><strong>show ssh-key</strong></summary>

Displays the Onyx Edge’s SSH public key, which can be used for SCP file transfers.

**Usage:** `show ssh-key [-h]`

**Optional Arguments:**

* `-h, --help`: Displays help information for the command.

**Example:** Displays the Onyx Edge’s SSH public key to be added to other hosts for secure transfers.

```
onyxedge> show ssh-key
```

</details>

## Related Documentation

* *4G Onyx Portal Operations Guide*
* *GXC Glossary*

## Contact GXC

To get in touch with GXC, please visit <https://gxc.io/contact-us/>.


---

# 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/troubleshooting-information.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.