Skip to content

CyberEdge CLI

The Command Line Interface (CLI) offers various utilities for network administrators to oversee the CyberEdge platform and address network issues. Secure access to the CyberEdge CLI is established through SSH and exclusively supports authentication via key pairs. Prior to utilizing the CLI, it's necessary to include your public SSH key in the Remote Access settings. To achieve this, navigate to System > Remote Access > Shell Access > Add SSH key.

Note

  • CyberEdge SSH runs on port 4. The port number is not configurable
  • SSH supports key based authentication only. No alternative authentication methods are available
  • Supported public keys include RSA, ECDSA or Ed25519 only. DSA keys are not permitted
  • RSA keys must be a least 2048 bits. ECDSA and Ed25519 must be a least 256 bits

CyberEdge CLI Access

To access the CyberEdge CLI open a new terminal. You can use either the IP Address or Hostname 

ssh admin@ipaddress -p 4

Supported CyberEdge CLI commands are listed upon successful login. Commands include:

  • category-tool
  • classtool
  • dig
  • healthcheck
  • hosttool
  • logview
  • mtr
  • ncat
  • nettool
  • ping
  • speedtest

CyberEdge CLI Commands

Category Tool

Category tool allows network administrators to quickly check the categorization of a domain. 

category-tool categorize microsoft.com

Output

[Cloud lookup] microsoft.com:
Business / Productivity (Category 10058)
Technology / Windows (Category 10459)
Business / Business Software (Category 10047)

DIG

The DIG command performs a DNS query against the provided input

dig example.com

Output

;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 62349
;; flags: qr rd ra ad; QUERY: 1, ANSWER: 1, AUTHORITY: 0, ADDITIONAL: 1

;; OPT PSEUDOSECTION:
; EDNS: version: 0, flags:; udp: 512
;; QUESTION SECTION:
;example.com.                   IN      A

;; ANSWER SECTION:
example.com.            74660   IN      A       93.184.216.34

;; Query time: 1 msec
;; SERVER: 127.0.0.1#53(127.0.0.1)
;; WHEN: Fri Aug 11 11:45:04 UTC 2023
;; MSG SIZE  rcvd: 56

Healthcheck

Healthcheck performs diagnostic checks for critical systems and services. Healthcheck should be run when diagnosing faults 

 healthcheck Output

=========================       Category Web Filtering  ======================
PASSED: Categories - Categorised google.com
PASSED: Categories - Categorised www.microsoft.com
PASSED: Categories - Categorised www.wikipedia.org
=========================       Hostname Checks ======================
PASSED: hostname - example-host
========================       Auth Providers  ======================
PASSED: Auth Providers - HomeDir
=========================       NTP Checks      ======================
PASSED: NTP - enabled
PASSED: NTP - synchronized
PASSED: NTP - online
=========================       Signature Updates       ======================
PASSED: Signature Updates - Applications last updated 03 August 2023
PASSED: Signature Updates - Categorisation running cloud updates
=========================       DNS - Lookups   ======================
PASSED: configured dns - google.com@1.1.1.1
PASSED: configured dns - updates-repo.slcloud.zone@1.1.1.1
PASSED: configured dns - google.com@8.8.8.8
PASSED: configured dns - updates-repo.slcloud.zone@8.8.8.8
=========================       DNS - Public Resolvers  ======================
PASSED: ping public resolvers - 8.8.8.8
PASSED: ping public resolvers - 1.1.1.1
=========================       HTTP Checks     ======================
PASSED: http - http://example.com
PASSED: http - http://google.com
PASSED: http - http://microsoft.com
PASSED: http - http://apple.com
PASSED: http - http://superloop.com
=========================       HTTP Checks     ======================
PASSED: https - https://example.com
PASSED: https - https://google.com
PASSED: https - https://microsoft.com
PASSED: https - https://apple.com
PASSED: https - https://superloop.com
PASSED: https - https://updates-repo.slcloud.zone
=========================       Ping Checks     ======================
PASSED: ping - google.com
=========================       DNS - Internal Resolvers        ======================
PASSED: ping internal resolvers - 1.1.1.1
PASSED: ping internal resolvers - 8.8.8.8

Healthcheck (V0.16.5 or greater)

=========================  Category Web Filtering  ======================
PASSED: Categories - Categorised google.com
PASSED: Categories - Categorised www.microsoft.com
PASSED: Categories - Categorised www.wikipedia.org
=========================   Hostname Checks ======================
PASSED: hostname - demo9
=========================   Auth Providers  ======================
PASSED: Auth Providers - Totally Legit User Source
PASSED: Auth Providers - Local Dir
=========================   Active Sessions ======================
PASSED: Active Sessions - 321
=========================   Signature Updates   ======================
PASSED: Signature Updates - Applications last updated 09 March 2024
PASSED: Signature Updates - Categorisation running cloud updates
=========================   NTP Checks  ======================
PASSED: NTP - enabled
PASSED: NTP - synchronized
PASSED: NTP - online
=========================   Fast Path Policies Count    ======================
PASSED: Local - 1
PASSED: Internet - 1
PASSED: DMZ - 1
=========================   Connection Counts   ======================
PASSED: Total Tracked Connections - 16432
PASSED: Connection Count (Last 3 minutes) - 256
=========================   DNS - Lookups   ======================
PASSED: configured dns - google.com@172.21.1.1
PASSED: configured dns - updates-repo.slcloud.zone@5.5.5.5
=========================   Access Policies Count   ======================
PASSED: Local->Internet - 16
PASSED: Domain list count - 
Blocked Domains: 4 entries (domain_regex_list) used in Duty of Care (Local -> Internet)
=========================   DNS - Public Resolvers  ======================
PASSED: ping public resolvers - 8.8.8.8
PASSED: ping public resolvers - 1.1.1.1
=========================   HTTP Checks ======================
PASSED: http - http://example.com
PASSED: http - http://google.com
PASSED: http - http://microsoft.com
PASSED: http - http://apple.com
PASSED: http - http://superloop.com
=========================   HTTPS Checks ======================
PASSED: https - https://example.com
PASSED: https - https://google.com
PASSED: https - https://microsoft.com
PASSED: https - https://apple.com
PASSED: https - https://superloop.com
PASSED: https - https://updates-repo.slcloud.zone
=========================   Ping Checks ======================
PASSED: ping - google.com
=========================   DNS - Internal Resolvers    ======================
PASSED: ping internal resolvers - 172.21.1.1

Log View

Log view can be used to view CyberEdge logs. Logs are available via the user interface at Status > Log Viewer 

Logview

Output

[admin@example-host ~]$ logview
auth        : Authentication
bgp         : BGP
connections : Connection Manager
dhcp        : DHCP
dns         : DNS
ipsec       : IPsec
openvpn     : OpenVPN
proxy       : Proxy
alerts      : System Alerts
revproxy    : Reverse Proxy
nginx       : UI Access
smtp_relay  : SMTP Relay

You can view the log data for source as follows

logview <logtype>

MTR

Network administrators can perform a trace route utilising MTR using and IP Address or Hostname 

MTR 1.1.1.1

MRT example.com

Output

                                                                                                                         Packets               Pings
Host                                                                                                                    Loss%   Snt   Last   Avg  Best  Wrst StDev
1. 202-63-66-1.ip4.superloop.au                                                                                         0.0%    70    8.7   9.9   7.6  19.5   1.6
2. bundle-ether13-4041.bdr01-ipt-20wharfs-bne.au.superloop.net.co                                                       0.0%    70    9.9   9.3   8.0  14.3   1.0
3. bundle-ether34-102.bdr02-ipt-47bourke-syd.au.superloop.net.co                                                        1.4%    70  167.7 168.4 165.6 174.2   1.5
4. hundredgige0-0-1-2-120.bdr01-ipt-624sgran-lax.us.superloop.net.co                                                    28.6%   70  167.9 168.0 166.6 172.6   0.8
5. edgecast-networks.as15133.any2ix.coresite.com                                                                        0.0%    70  182.2 170.7 166.9 196.3   5.9
6. ae-85.core1.oxr.edgecastcdn.net                                                                                      0.0%    69  168.2 170.3 166.6 237.7   8.6
7. 93.184.216.34                                                                                                        0.0%    69  167.4 168.0 163.2 179.0   2.0

Ping

Allows a network administrator to ping from the CyberEdge. 

Ping 1.1.1.1

Output

[admin@example-host ~]$ ping 1.1.1.1
PING 1.1.1.1 (1.1.1.1) 56(84) bytes of data.
64 bytes from 1.1.1.1: icmp_seq=1 ttl=61 time=8.52 ms
64 bytes from 1.1.1.1: icmp_seq=2 ttl=61 time=8.40 ms
64 bytes from 1.1.1.1: icmp_seq=3 ttl=61 time=7.80 ms
64 bytes from 1.1.1.1: icmp_seq=4 ttl=61 time=9.22 ms

Speedtest

Perform a speedtest from the CLI. By default, it will select the most appropriate test host 

speedtest-cli

Output

[admin@example-host ~]$ speedtest
Retrieving speedtest.net configuration...
Testing from Superloop (122.199.0.3)...
Retrieving speedtest.net server list...
Selecting best server based on ping...
Hosted by Superloop Australia Pty Ltd (Brisbane) [0.72 km]: 15.649 ms
Testing download speed................................................................................
Download: 103.60 Mbit/s
Testing upload speed..................................................................................
Upload: 38.22 Mbit/s
[admin@example-host ~]$

Note

  • The speedtest host is not manually configurable. Using this tool for link speeds above 1Gbps is not supported

Reference Material

Additional commands and reference material can be found here

  • https://man.cx/ping(8)
  • https://man.cx/mtr
  • https://man.cx/dig(1)