Enapter Handbook

# Chapter 2: User Interface Options

Warning

This documentation is out of date. For more information please check Gateway Documentation at Software part of the Handbook.

Two ways available for interfacing with the Enapter system: a command-line interface from web and from local Keyboard/Video/Mouse connection.

As both ways using CLI are mostly the same, all instructions in this guide applicable for both cases

# The Command-Line Interface (CLI)

This section presents the following topics:

  • Command Modes
  • CLI Help
  • Command Completion

# Enapter Shell

The CLI of the Enapter system includes two families of commands:

  • Enapter-specific commands for operating and configuring the Enapter system.
  • Commands provided by the Linux operating system shell in which the Enapter CLI operates.

All users have access to operating system commands as well as Enapter shell commands.

# Command Modes

The are two command modes in Enapter CLI: operational mode and configuration mode.

  • Operational mode provides access to operational commands for showing help information, exiting CLI, run bash, etc.
  • Configuration provides access to commands for creating, modifying, deleting, committing and showing configuration information, as well as commands for navigating through the configuration hierarchy.

When you log on to the system, the system is in operational mode.

  • To enter configuration mode from operational mode, issue the configure command.
  • To return to operational mode from configuration mode, issue the exit command. If there are uncommitted configuration changes, you must either commit the changes using the commit command, or enter exit to discard the changes.

# Enter Configuration Mode

In configuration mode you can set, delete and show information. Enter configuration mode by typing configure at the command prompt in operational mode.

[d0a09d] $ configure
[d0a09d] conf $

[d0a09d] conf $ exit
[d0a09d] $

Notice how the command prompt changes to remind you what mode you are in.

# Command Completion

Pressing the <Tab> key provides command completion. You can use the <Tab> to show:

  • All available commands
  • All valid completions for a command partially typed in
  • The next available set of options for a command. You can use the <Tab> key iteratively in this way to discover complete command syntax.

Example 2-1 Use command completion on an unambiguous command

The following example requests command completion for the typed string sh. In this example, the command to be completed is unambiguous.

[d0a09d] conf $ sh <tab>
[d0a09d] conf $ show

# List of Possible Commands in Operational Mode.

Command Description
exit Exit shell
help Display help message
services Services operations
show Show system information
bash Run Bash shell
configure Enter configuration mode
reboot Reboot server

Chapter 3: Configuration