agw_user CLI Command Reference
agw_user is a restricted, non-root command-line account available on the Onyx Edge, giving users a safe way to run basic diagnostic and maintenance commands — collecting tech dumps, restarting services, rebooting, etc. This reference describes each agw_user command.
change-passwd
Prompts to change the current password for agw_user.
Password changes may be restricted if the Onyx Portal manages credentials.
Usage: change-passwd [-h]
Optional Arguments:
-h, --help: Displays help information for the command.
NOTE: If the password is managed via the Onyx Portal, this command will display a message and exit without allowing a change.
Example:
onyxedge> change-passwdcollect-tech-dump
Collects a tech dump from the Onyx Edge and saves it to the tech dump directory.
Usage: collect-tech-dump [-h]
Optional Arguments:
-h, --help: Displays help information for the command.
Example:
onyxedge> collect-tech-dumpgw-poweroff
Powers off the Onyx Edge. Requires confirmation before proceeding.
Usage: gw-poweroff [-h]
Optional Arguments:
-h, --help: Displays help information for the command.
NOTE: You will be prompted to confirm with y before the power off is triggered. This action will shut down the gateway immediately.
Example:
onyxedge> gw-poweroff
Power off AGW. Are you sure (y)?gw-reboot
Reboots the Onyx Edge. Requires confirmation before proceeding.
Usage: gw-reboot [-h]
Optional Arguments:
-h, --help: Displays help information for the command.
NOTE: You will be prompted to confirm with y before the reboot is triggered.
Example:
onyxedge> gw-reboot
Reboot AGW. Are you sure (y)?gw-restart-services
Triggers a full restart of all Onyx Edge services, including networking, subscriber clearing, and Redis flush.
Usage: gw-restart-services [-h]
Optional Arguments:
-h, --help: Displays help information for the command.
NOTE: This command restarts all services. Use show-services to track recovery status afterward.
Example:
onyxedge> gw-restart-servicesgw-rmfile
Removes one or more files from the Onyx Edge. Files are removed using a secure deletion script.
Usage: gw-rmfile [-h] (--techdump | --core | --pcap) <filenames ...>
Positional Arguments:
filenames: One or more file names to remove (basename only, not full path).
Optional Arguments:
-h, --help: Displays help information for the command.--techdump: Remove files from the tech dump directory.--core: Remove files from the core dump directory.--pcap: Remove files from the pcap directory.
Example:
gw-tcpdump
Captures network traffic on a specified interface and saves it as a .pcap file.
Usage: gw-tcpdump [-h] [-c PKTS] [-s SNAPLEN] <interface> <filename> [filters ...]
Positional Arguments:
interface: Network interface to capture on (e.g.,eth0).filename: Name of the output file (must not contain invalid characters;.pcapextension added automatically if omitted).
Optional Arguments:
-h, --help: Displays help information for the command.-c PKTS: Stop after capturing this many packets.-s SNAPLEN: Snap length (bytes per packet to capture).filters: Additional tcpdump filter expressions.
NOTE: If a file with the given name already exists, you will be prompted to confirm overwriting it.
Example:
scp-to
Copies a file from the Onyx Edge to a remote host using SCP.
Usage: scp-to [-h] (--techdump FILE | --core FILE | --pcap FILE | --ssh-pubkey) <user> <host> <target_path>
Positional Arguments:
user: Remote username.host: Remote hostname or IP address.target_path: Destination path on the remote host.
Optional Arguments:
-h, --help: Displays help information for the command.--techdump FILE: Name of the tech dump file to copy.--core FILE: Name of the core dump file to copy.--pcap FILE: Name of the pcap file to copy.--ssh-pubkey: Copy the Onyx Edge's SSH public key.
NOTE: Host key checking is disabled for this command.
Example:
show-authkeys
Displays the contents of the authorized_keys file for the agw_user account.
Usage: show-authkeys [-h]
Optional Arguments:
-h, --help: Displays help information for the command.
Example:
show-cores
Lists all available core dump files stored on the Onyx Edge.
Usage: show-cores [-h]
Optional Arguments:
-h, --help: Displays help information for the command.
Example:
show-enodebs
Displays information about connected eNodeBs (4G base stations).
Usage: show-enodebs [-h]
Optional Arguments:
-h, --help: Displays help information for the command.
Example:
show-gnodebs
Displays information about connected gNodeBs (5G base stations).
Usage: show-gnodebs [-h]
Optional Arguments:
-h, --help: Displays help information for the command.
Example:
show-gw-info
Displays general Onyx Edge gateway information.
Usage: show-gw-info [-h]
Optional Arguments:
-h, --help: Displays help information for the command.
Example:
show-networking
Displays network information for the Onyx Edge gateway. Supports multiple sub-commands.
Usage: show-networking [-h] {ipv4,routes,links,data-rates} ...
Sub-commands:
ipv4 — Displays a brief summary of all IPv4 addresses on the gateway.
routes — Displays the current IP routing table.
links summary — Displays a summary of all network links.
links detailed <linkname> — Displays detailed information for a specific network link using ethtool.
--driver/-i: Show driver information instead of link details.
data-rates {nat-path,vlan-path,<ifc>...} — Displays data rates for network interfaces using bps.
-n <num_samples>: Number of samples to collect.-t <duration>: Duration of the test.-P: Display packet counts as numbers.
show-ntp
Displays the current NTP synchronization status.
Usage: show-ntp [-h]
Optional Arguments:
-h, --help: Displays help information for the command.
Example:
show-pc
Displays the status of the last policy controller request and response (sensitive fields excluded).
Usage: show-pc [-h]
Optional Arguments:
-h, --help: Displays help information for the command.
Example:
show-pcaps
Lists all available packet capture (.pcap) files stored on the gateway.
Usage: show-pcaps [-h]
Optional Arguments:
-h, --help: Displays help information for the command.
Example:
show-services
Displays the status of all Onyx Edge services.
Usage: show-services [-h]
Optional Arguments:
-h, --help: Displays help information for the command.
Example:
show-sshkey
Displays the public SSH key (id_rsa.pub) for the agw_user account.
Usage: show-sshkey [-h]
Optional Arguments:
-h, --help: Displays help information for the command.
Example:
show-techdump
Lists all available tech dump files stored on the Onyx Edge.
Usage: show-techdump [-h]
Optional Arguments:
-h, --help: Displays help information for the command.
Example:
show-time
Displays the current system date and time.
Usage: show-time [-h]
Optional Arguments:
-h, --help: Displays help information for the command.
Example:
show-ues
Displays information about connected User Equipment (UE).
Usage: show-ues [-h] {summary,detailed}
Positional Arguments:
summary: Shows a brief summary of all connected UE.detailed: Shows detailed information for each UE.
Example:
test-ap-speedtest
Runs a speed test to a connected AP by IP address.
Usage: test-ap-speedtest [-h] <ip>
Positional Arguments:
ip: IP address of the target AP.
Optional Arguments:
-h, --help: Displays help information for the command.
Example:
test-checkin
Tests the Onyx Edge's checkin connectivity to the Orchestrator.
Usage: test-checkin [-h]
Optional Arguments:
-h, --help: Displays help information for the command.
Example:
test-dnslookup
Performs a DNS lookup for a given hostname.
Usage: test-dnslookup [-h] [-s SERVER] <host>
Positional Arguments:
host: The hostname to resolve.
Optional Arguments:
-h, --help: Displays help information for the command.-s SERVER: DNS server to use for the lookup. Uses the system default if omitted.
Example:
test-network-health
Runs a comprehensive network health check and displays a summary.
Usage: test-network-health [-h]
Optional Arguments:
-h, --help: Displays help information for the command.
Example:
test-ping
Sends ICMP ping packets to a target host.
Usage: test-ping [-h] [-c COUNT] <host>
Positional Arguments:
host: The target hostname or IP address.
Optional Arguments:
-h, --help: Displays help information for the command.-c COUNT: Number of ping packets to send. If omitted, pings continuously.
Example:
test-speedtest
Runs a network speed test from the Onyx Edge.
Usage: test-speedtest [-h] [-d] [-s SERVERS] [-p PORT] [-t TEST_DURATION] [-T TEST_TIMEOUT]
Optional Arguments:
-h, --help: Displays help information for the command.-d, --download: Run a download-only speed test.-s SERVERS: Specify speed test server(s) to use.-p PORT: Specify the port to use for the test.-t TEST_DURATION: Duration of the speed test.-T TEST_TIMEOUT: Timeout for the speed test.
Example:
test-tcpconn-any
Tests a TCP connection to any specified host and port.
Usage: test-tcpconn-any [-h] <host> <port>
Positional Arguments:
host: The target hostname or IP address.port: The target TCP port.
Optional Arguments:
-h, --help: Displays help information for the command.
Example:
test-tcpconn-std
Tests a TCP connection to a set of standard, pre-configured endpoints.
Usage: test-tcpconn-std [-h] {orc8r,bootstrap,logs-server,pserver,bastion-host,artifactory}
Positional Arguments:
orc8r: Tests connectivity to the Orchestrator.bootstrap: Tests connectivity to the Bootstrap server.logs-server: Tests connectivity to the Logs server.pserver: Tests connectivity to the Policy server.bastion-host: Tests connectivity to the Bastion host on port 22.artifactory: Tests connectivity toartifactory.gxc.ioon port 443.
Optional Arguments:
-h, --help: Displays help information for the command.
Example:
test-traceroute
Traces the network path to a target host.
Usage: test-traceroute [-h] [-m MAXHOPS] <host>
Positional Arguments:
host: The target hostname or IP address.
Optional Arguments:
-h, --help: Displays help information for the command.-m MAXHOPS: Maximum number of hops to trace.
Example:
test-url-any
Tests HTTP/HTTPS connectivity to any specified URL.
Usage: test-url-any [-h] [-x EXPECT_CODE] [-i] <url>
Positional Arguments:
url: The target URL to test.
Optional Arguments:
-h, --help: Displays help information for the command.-x EXPECT_CODE: Expected HTTP response code (default may vary).-i, --insecure: Skip TLS certificate verification.
Example:
Last updated
Was this helpful?