Command line session

exec

Summary/usage

Execute commands from file.

Description

Executes a sequence of CLI commands which are read from a file.

If a command is unrecognised or otherwise invalid then the usual CLI feedback will be generated, however execution of subsequent commands from the file will continue.

Declaration and implementation

Declaration: cli_exec (src/vlib/unix/cli.c line 2642)

Implementation: unix_cli_exec.

history

Summary/usage

Show current session command history.

Description

Displays the command history for the current session, if any.

Declaration and implementation

Declaration: cli_unix_cli_show_history (src/vlib/unix/cli.c line 2754)

Implementation: unix_cli_show_history.

quit

Summary/usage

Exit CLI.

Description

Terminates the current CLI session.

If VPP is running in interactive mode and this is the console session (that is, the session on stdin) then this will also terminate VPP.

Declaration and implementation

Declaration: unix_cli_quit_command (src/vlib/unix/cli.c line 2569)

Implementation: unix_cli_quit.

set terminal ansi

Summary/usage

set terminal ansi [on|off].

Description

Enables or disables the use of ANSI control sequences by this terminal. The default will vary based on terminal detection at the start of the session.

ANSI control sequences are used in a small number of places to provide, for example, color text output and to control the cursor in the pager.

Declaration and implementation

Declaration: cli_unix_cli_set_terminal_ansi (src/vlib/unix/cli.c line 2978)

Implementation: unix_cli_set_terminal_ansi.

set terminal history

Summary/usage

set terminal history [on|off] [limit <lines>].

Description

Enables or disables the command history function of the current terminal. Generally this defaults to enabled.

This command also allows the maximum size of the history buffer for this session to be altered.

Declaration and implementation

Declaration: cli_unix_cli_set_terminal_history (src/vlib/unix/cli.c line 2940)

Implementation: unix_cli_set_terminal_history.

set terminal pager

Summary/usage

set terminal pager [on|off] [limit <lines>].

Description

Enables or disables the terminal pager for this session. Generally this defaults to enabled.

Additionally allows the pager buffer size to be set; though note that this value is set globally and not per session.

Declaration and implementation

Declaration: cli_unix_cli_set_terminal_pager (src/vlib/unix/cli.c line 2877)

Implementation: unix_cli_set_terminal_pager.

show terminal

Summary/usage

Show current session terminal settings.

Description

Displays various information about the state of the current terminal session.

Example usage

vpp# show terminal

Terminal name:   unix-cli-stdin
Terminal mode:   char-by-char
Terminal width:  123
Terminal height: 48
ANSI capable:    yes
History enabled: yes
History limit:   50
Pager enabled:   yes
Pager limit:     100000
CRLF mode:       LF

Declaration and implementation

Declaration: cli_unix_cli_show_terminal (src/vlib/unix/cli.c line 2821)

Implementation: unix_cli_show_terminal.

show unix-errors

Summary/usage

Show Unix system call error history.

Declaration and implementation

Declaration: cli_unix_show_errors (src/vlib/unix/cli.c line 2718)

Implementation: unix_show_errors.