Follow

CLI Common Commands Reference

A new command-line interface was introduced with the 8.3.x firmware releases as a replacement to the text menu interface used for terminal sessions (serial, SSH, or telnet). The purpose of this document is to provide fundamental commands for configuration and management of the Ecessa appliance. 

 

Using the Command-Line Interface (CLI)

The sub-command display can show the working configuration (configuration pending activated changes) or the running configuration (configuration currently in use).

 

IMPORTANT: By default, any changes made in the CLI are not activated immediately. To activate changes made in the command-line interface, use the command commit. When changes are activated, they affect the running configuration but will be lost if the Ecessa appliance is rebooted as they have not been permanently saved. To activate changes and save the configuration, use the command commit save.

 

Command syntax:

The commands are structured like so:

command keyword argument

Depending on the command, multiple keywords / arguments may be used. Here is a simple example of this:

lan add {alias ALIAS} [ip IP/MASK] [port ETH_PORT]


Additionally, multiple commands can be entered by using a semicolon (;) as a delimiter, like so:


Help menu Usage format:

The help menu for a given command will display the various configuration options and will note them as follows:

Keywords or arguments shown in braces "{}" are required.

Keywords or arguments shown in brackets "[]" are optional.

Command assistance:

The command-line interface has different functions to provide information and assist command completion. 

help

 

Displays the help menu for the given command. If used by itself, the Ecessa Help menu will be displayed which lists the various commands

Syntax: {COMMAND} help

Tab key

Can be used to complete a command, display available sub-commands, or cycle through sub-commands

history

Displays a list of recently used commands.

Syntax: history


Examples:

[ClariLink00000000] # dns help

dns - configure dns.

USAGE:

    dns help

    dns display [working | running]


[ClariLink00000000] # wan <TAB> <TAB>

add      delete   display  help     modify

 

[ClariLink00000000] # wan m<TAB>

[ClariLink00000000] # wan modify

 

[ClariLink00000000] # wan d<TAB>

delete   display

 

Keep pressing the Tab key to auto-fill and cycle through the options:

[ClariLink00000000] # wan delete

[ClariLink00000000] # wan display

 

[ClariLink00000000] # history

1  lan display

2  lan delete alias LAN

3  lan display running

4  wan display

5  wan add alias WAN1 ip 10.20.20.2/24 gateway 10.20.20.1 port 2 tp1 8.8.8.8 uplink 10000 downlink 10000

6  commit

7  hwfo enable

8  hwfo set mode secondary local 100.10.10.2 remote 100.10.10.1

9  hwfo display

10  commit

11  services http disable; services http port 8080 access LAN

12  services https enable; services https port 8081 access ALL

13  services ssh enable; services ssh port 2322 access ALL

14  services telnet disable; services telnet port 2323 access LAN

15  commit save

16  system reboot

 

Common Configuration Commands

wan add

 

 

Creates a new WAN with the configured parameters.

 Required Parameters:

{alias} {ip and gateway (or enable dhcp)}  {tp1}   {port}

wan modify

 

 

 

Modifies the existing WAN with the configured parameters. WAN is identified by the alias.

 Required Parameters: 

{alias}

wan delete

 

 

Deletes the existing WAN identified by the alias.

 Required Parameters: 

{alias}

wan display

 

 

Displays the working configuration unless the running parameter is used.

 Required Parameters:

None

lan add

 

 

Creates a new LAN with the configured parameters.

 Required Parameters:

{alias}

lan modify

 

 

 

Modifies the existing LAN with the configured parameters. LAN is identified by the alias.

 Required Parameters:

{alias}

lan delete

 

 

Deletes the existing LAN identified by the alias.

 Required Parameters:

{alias}

lan display

 

 

Displays the working configuration unless the running parameter is used.

 Required Parameters:

None

services display

 

 

Displays the working configuration unless the running parameter is used.

 Required Parameters:

None

services http

 

 

Configures the http service (access to web interface via HTTP).

 Required Parameters:

None

services https

 

 

Configures the http service (access to web interface via HTTPS).

 Required Parameters:

None

services ssh

 

 

Configures the http service (access to CLI via SSH).

 Required Parameters:

None

services telnet

 

 

Configures the telnet service (access to CLI via telnet).

NOTE: Telnet is permanently disabled in versions 8.3.x and above

services dns

 

 

 

 

Configures the DNS resolvers used by the Ecessa appliance. The DNS server(s) IP address is configured using the primary and/or secondary parameter.

 Required Parameters:

None

 

Managing Configuration Files

config save

Saves the configuration file. If the backup parameter is used, the configuration is saved to the backup configuration file.

config load

Loads the configuration file. If the backup parameter is used, the configuration is loaded from the backup configuration file.

config reset

Resets the configuration to the factory default settings.

NOTE: This command does not require a commit before changes are active

config import

 

 

Imports and loads a configuration file from the specified FTP server.

 Required Parameters:

{ftp-server-url}

config export

 

 

Exports a copy of the configuration file to the specified FTP server.

 Required Parameters:

{ftp-server-url}

 

 Upgrading Firmware Versions

The command system update is used to initiate the firmware upgrade process. The Ecessa appliance needs Internet connectivity and configured DNS resolvers to access update.ecessa.com for the upgrade to complete properly.

After initiating the upgrade, a list should be displayed with the available firmware versions. At the prompt, enter the number from the list for the appropriate version or type ‘M’ to enter a version manually. If entering a version manually please enter the full version number (Example: 8.4.25).

 

System Management Commands

date

Displays the current date, time, and time zone.

system info

Displays system information such as: model, firmware version, serial number, and system uptime.

system reboot

Reboots the Ecessa appliance.

system update-sk

Updates the available features based on the provided software key.

system passwd

Changes the password for the specified user. If no user is specified, the root user is default.

system user

Displays the current state of the admin and user accounts. The enable and disable sub-commands can be used to change the state for the specified account

exit or bye

Logs out of the terminal session.

 

Please contact Ecessa Technical Support at help@ecessa.com or or call (800) 669-6242 x 2 with any questions.

Was this article helpful?
1 out of 1 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.