Gateway appliance command line interface (CLI) - version 1.10 and newer

Private network

There are several options in the Gateway application private network command line interface (CLI) to help you manage your Gateway server.

This command line interface allows you to manage specific operating system and Gateway application settings; it does not give you direct access to the operating system for the Gateway appliance.

CLI access to the Gateway appliance OS is available with assistance from customer support only.

Note: The CLI on the Gateway public network allows you to reboot the Gateway appliance and view status only.

To access the private network CLI:

1. Connect a computer to the same private network as the Gateway appliance.
2. Use an SSH client to log in to the Gateway command line interface (CLI) using your user credentials, default ssh port 22.

Press Tab after a command to see command suggestions.

 

Built in commands

clear: Clear the shell screen.

exit or quit: Exit the shell

stacktrace: Display the full stacktrace of the last error

versions: Display version information

Backup/restore commands

backup config: View or configure backup settings
backup list: List backups
backup run: Run a backup now
backup schedule: Configure a system schedule to run backups at a regular interval
restore: Restore the Gateway from backup

DHCP server commands

dhcp config: Configures the DHCP server

dhcp leases: Show the DHCP server leases

dhcp service: Controls the DHCP service

dhcp status: Show the DHCP server configuration and status

NTP commands

ntp config: Configures the NTP service

ntp service: Controls the NTP service

ntp sources: Reports the number of NTP servers and peers that are online and offline

ntp sourcestats: Displays information about the drift rate and offset estimation process for each NTP source

ntp status: Displays the current NTP service status

ntp tracking: Displays parameters about the system clock performance

ntp status: Displays the current NTP service status

ntp tracking: Displays parameters about the system clock performance

Gateway appliance commands

appliance config: List appliance configurations

appliance reboot: Reboot the Gateway appliance

appliance reset: Reset the Gateway appliance to factory defaults

appliance shutdown: Shut down the Gateway appliance

File system commands

fs config: Show mounted filesystems
fs mount: Mount remote filesystem (to configure remote backups)
fs show: Show NFS or SAMBA mounts available to the appliance from a remote host
fs unmount: Unmount a mounted remote filesystem

Gateway commands

gateway config: Display the current configuration values of the installed Gateway

gateway install: Install the Gateway service, if not already installed

gateway status: Display current status of the Gateway

gateway uninstall: Remove the Gateway service

Network commands

net config: Configure private or public network DNS and IP addresses

net status: Display the status of both the public and private networks

OS commands

nslookup: nslookup

ping: ping

traceroute: traceroute

view log: Page through or follow the tail of a log file

Shell help

help: Display help

SSHD commands

Accessed with assistance from technical support only

sshd service: Controls the SSHD service

sshd status: Show the SSHD configuration and status

User account commands

change password: Change the password of the user logged into the CLI

Public network

You can access the Gateway application CLI from the public network to reboot the Gateway appliance, view DHCP leases, and see various status. You must use the CLI from the private network to execute other commands.

To access the CLI from the public network:

Use an SSH client to log in to the Gateway CLI using its public IP address and your user credentials, default ssh port 22.

Built in commands

clear: Clear the shell screen.

exit or quit: Exit the shell

stacktrace: Display the full stacktrace of the last error

versions: Display version information

DHCP server commands

dhcp leases: show the DHCP server leases
dhcp status: show the DHCP server configuration and status

ntp commands

ntp status: displays the current NTP service status

appliance commands

appliance reboot: Reboot the Gateway appliance

gateway commands

gateway status: Display current status of the Gateway service

network commands

net status: Display the status of both the public and private networks

shell help

help: Display help

sshd commands

sshd status: Shows the technical support SSHD service configuration and status