CLI (Command Line Interface)

From LigoWave wiki
Jump to: navigation, search

Contents

Command Line Interface Management

Introduction

The CLI (Command Line Interface) software is a configuration shell for the Ligo based device. CLI is an alternative way for configuring the device. It is not intended to be a main device managing method. Using the CLI, the operator can test authentication parameters, change the administrator’s password, reboot device, reset device to defaults, show the device configuration or view the device status.

All available key combinations in CLI mode are listed in the table below:


Key and/or Combination Function
"<text>" Enter parameter's string with space
<TAB> Complete current keyword or list all the options
<CTRL>+<D> Break out of subshell
<CTRL>+<A> Jump to the beginning of the line
<CTRL>+<E> Jump to the end of the line
<CursUP>/<CursDOWN> Scroll through the history of commands


CLI Access

Use the SSH client application (eg., PuTTY http://www.putty.nl) to access the CLI of the device.

!.png Make sure that SSH server is configured properly


Login

Enter the administrator login settings on the displayed command prompt.

I.png Default administrator logon settings are:
  • User Name: admin
  • Password: admin01
!.png Change the default administrator password as soon as possible.

Clilogin.jpg


After a successful login a list of available commands followed by CLI command prompt will be displayed.

Cli2.jpg

Authentication Check

With the authcheck command you can test configured authentication settings. To get a list of available command parameters type ‘authcheck’ and press enter:

Cliauthcheck.jpg

The authcheck command requires interface name parameter to be specified. Other parameters are optional.

Example:

 authcheck -i ath0 -u testuser -p testpass

This command will try to authenticate with username testuser and password testpass on local interface called ath0.

Test result will be displayed immediately after command execution.


Password

With the passwd command you can change the administrator’s password. To change password you will need to provide the old and the new passwords:

Clipassword.jpg

I.png Passwords will not appear on the screen for safety.
I.png The only way to gain access to the management tool if you forget the administrator’s password is to reset the Ligo device to factory default settings.


Shell

shell starts UNIX Bourne like system shell for the administrator.

Clishell.jpg

Type exit or press Ctrl + D key combination to quit the shell and return to CLI interface.


Show

show command displays current system configuration file


Status

status command displays general device status (device type, firmware version, hardware revision, uptime, memory, average load) and receive/transmit statistics of all interfaces.

Clistatus.jpg


Reboot

Type reboot now to immediately reboot the device.


Reset

To reset the Ligo based device to factory defaults, use reset command. The device is restarted and default values are set.

!.png Note that the administrator password will be set to the factory default.


Quit

Type quit to leave the CLI mode.

Personal tools