[Top] [Prev] [Next] [Bottom]

Learning the User Interface and OPCON Commands

All OpenROUTE Networks routers use the same user interface. While the software installation process is slightly different for each, configuring the software and accessing the processes are the same for all routers.

The information in this document includes the following topics:

Using Local and Remote Router Terminals

Using the User Interface

Using the Command Line Interface

Overview of the User Interface

OPCON Commands

Using Local and Remote Router Terminals

The router terminal lets you access the command line interface so you can configure and monitor the router. The router supports local and remote terminals.

Local Terminals

Local terminals connect to the router either directly via the supplied console cable or indirectly via modems. For information on installing and configuring local terminals, see the guide shipped with your router.

You need to use a local terminal in the following situations:

During the initial software installation.
If no one has booted your router, you will see the > prompt at your local terminal.

Remote Terminals

Remote terminals connect to the router via a standard remote terminal protocol. Remote connections provide the same functionality as local connections, except that you must use a local terminal for initial setup and configuration. You can use no more than two remote terminals at the same time on a router. You can connect remote terminals to the router via Telnet, as long as you have enabled IP. See the Protocol Guide for more information on enabling IP. In addition, see Logging In.

Using the User Interface

The following procedures are the same for all OpenROUTE Networks routers:

Logging in
Executing a command
Connecting to a process
Identifying the process by the prompt
Getting help
Getting back to the * prompt
Exiting the router

Logging In

Logging in to a local terminal is the same as logging in to a remote terminal except that on a remote terminal you must first connect to the router by starting Telnet on your host system.

To prepare for remote login,

1. Connect to the router by starting Telnet on your host system. Your host system is the system to which remote terminals are connected. Supply the router's name or Internet Protocol (IP) address. To use router names, your network must have a name server.

% telnet brandenburg
or
%telnet 128.185.132.43

The router supports Telnet client and server. The remote terminal on the router acts as a Telnet server. The router acts as a Telnet client when connecting from the router to either another router or a host using the Telnet command.

From this point on, there is no difference whether you have logged in remotely or locally.

The password controls access to the router.

2. If prompted, enter your login name and password.

If the Password: prompt appears and you have no password configured, press Enter for the * prompt.

Logins are not set automatically. For security, you can set up user names and passwords by entering add user at the Config> prompt. Reload or restart the router to activate logins.

Note: If you do not enter a login name and valid password within a minute of the initial prompt, or if you enter an incorrect password three times in succession, the router drops the Telnet connection.

3. Now, enter commands.

Connecting to a Process

When you start the router for the first time, the screen displays a boot message, then the * prompt. The * prompt is the top-level prompt. From it you can communicate with different processes.

To connect to a process, enter the appropriate command at the * prompt.

Process Command Prompt

EVENT event None

MONITOR monitor +

CONFIG configuration Config>

Process	Command	Prompt
EVENT	event	None
MONITOR	monitor	+
CONFIG	configuration	Config>

Identifying the Process by the Prompt

Each process uses a different prompt. You can tell which process you are connected to by looking at the prompt. If a prompt does not appear, press Enter again.

The following list shows the prompts for the main processes:

Process Prompt

OPCON *

MONITOR +

CONFIG Config>

Process	Prompt
OPCON	`*`
MONITOR	`+`
CONFIG	`Config>`

Note: The EVENT process does not have a prompt and accepts only the Ctrl P command.

Getting Back to the * Prompt

To get back to the * prompt from any main process, such as CONFIG (Config> prompt) or MONITOR (+ prompt), press Ctrl p, which is the intercept character. You must always return to the * prompt before you can go to another main process. For example, if you are at the + prompt and you want to go to the Config> prompt, press Ctrl p to return to the * prompt first.

*config
Config>ctrl p
*monitor
+ctrl p
*

Exiting the Router

Return to the * prompt and close the Telnet connection.

For example:

IP Config>exit
Config>ctrl p
* logout%

You can also use local Telnet commands (such as, exit) on your Telnet client to close the connection.

If you use the intercept character from a third-level process, you exit the third level and return to the * prompt; the next time you use the config or monitor command, or their equivalents, however, you re-enter the third level. This link goes away when the router is re-initialized.

Using the Command Line Interface

The Command Line Interface provides the following capabilities:

Command line editing
Command completion
Command line recall
Note: The arrow keys (up down right left) are VT100/ANSI escape sequences. If your terminal or terminal emulator cannot produce these, use the control keys listed.

Command Line Editing

You can edit lines using the following keys:

Ctrl u or Up arrow
Go up one line.

Ctrl n or Down arrow
Go down one line.

Ctrl b or Left arrow
Go back one character (left of the cursor).

Ctrl f or Right arrow
Go forward one character (right of the cursor).

Ctrl a
Go to the beginning of line.

Ctrl c
Cancel information on the command line.

Ctrl e
Go to the end of the line.

Ctrl d

Delete forward one character.

Ctrl k

Delete from cursor to end of line.

Ctrl t

Transpose character at cursor with previous character.

Backspace or Delete

Delete characters to the left of the cursor.

`Ctrl u` or `Up` arrow	Go up one line.
`Ctrl n` or `Down` arrow	Go down one line.
`Ctrl b` or `Left` arrow	Go back one character (left of the cursor).
`Ctrl f` or `Right` arrow	Go forward one character (right of the cursor).
`Ctrl a`	Go to the beginning of line.
Ctrl c	Cancel information on the command line.
`Ctrl e`	Go to the end of the line.
`Ctrl d`	Delete forward one character.
`Ctrl k`	Delete from cursor to end of line.
`Ctrl t`	Transpose character at cursor with previous character.
`Backspace or Delete`	Delete characters to the left of the cursor.

Press Enter with the cursor at any point in the line, and OpenROUTE displays the entire line.

You can find a list of available command line editing commands by entering help at any prompt.

Command Completion

Press Space (once or twice) from any prompt to display a list of available commands or command options. If you press Space, the software always lists the possible completions for the present input. The lists of completions varies depending on the software running on your router. For example, press Space twice after typing protocol and the following appears:

Config>protocolThe choices/prefixes are (a complete list)
 IP
 ARP
 IPX
 SNMP
 AP2
 BRIDGE
 HST

Press Space on a blank input line, and a list of all commands the software allows at that prompt appears. For example, press Space at the * prompt and the following appears:

The choices/prefixes are (a complete list):
CONFIG -- Enter configuration mode
DIVERT -- Divert output from process
EVENT -- Enter event log monitor mode
FLUSH -- Flush output from process
HALT -- Halt output from process
HELP -- Help about the command line interface
INTERCEPT -- Sets the intercept character (normally control-P)
LOGOUT -- Logout from router
MEMORY -- Memory statistics
MONITOR or M -- Enter monitor mode
RELOAD -- Reload router with new load and restart
RESTART or R -- Restart router with same load
STATUS or S -- Status of process(es)
TALK or T -- Talk to process
TELNET -- Telnet to host

Press Space after a unique part of any command and the software completes the command. For example, enter pr followed by Space at the + prompt and the entire name of the command, PROTOCOL, appears immediately:

+ pr

+ PROTOCOL

Press Space at the end of an input line and the software terminates input and searches all commands that start with the present input. One of the following happens:


If the software finds . . .	Then . . .
A complete match of a command	The space becomes a real space.
A common unique (sub)string of commands greater than the existing input	The software displays all of the commands allowed at that prompt and redisplays the input line. Config>add The choices/prefixes are (a complete list): DEVICE INTERFACE STACK USER Config>add
No unique common (sub)string of commands	The software displays all commands and redisplays present input.

Command Line Recall

You can display up to the last 10 correctly entered command lines using the following keys:


`Ctrl u` or `Up` arrow	Go up the saved command list.
`Ctrl n` or `Down` arrow	Go down the saved command list.

Overview of the User Interface

The processes you use most often are OPCON, EVENT, CONFIG, and MONITOR. Figure 1 shows the processes and how they fit into the structure of the router software.

Figure 1 Router Software Processes

Table 1 is a list of processes on the router, with definitions and prompts.

Table 1 Process Definitions

Process Definition Prompt

OPCON
(First Level)
Operator console.
*

MONITOR
(Second Level)
Allows you to monitor the status and statistics of the router's hardware and software. Provides access to the third-level processes, which allow you to monitor configured protocols and features.
+

CONFIG
(Second Level)
Allows you to configure router parameters for interfaces, protocols, users, and booting. Provides access to third-level processes, which allow you to configure various protocols and features.
Config>

EVENT
(Second Level)
Receives Event Logging System (ELS) messages and messages from the operating system and displays them on the console, according to user-configured criteria.
None

Table 1 Process Definitions
Process	Definition	Prompt
OPCON (First Level)	Operator console.	*
MONITOR (Second Level)	Allows you to monitor the status and statistics of the router's hardware and software. Provides access to the third-level processes, which allow you to monitor configured protocols and features.	+
CONFIG (Second Level)	Allows you to configure router parameters for interfaces, protocols, users, and booting. Provides access to third-level processes, which allow you to configure various protocols and features.	Config>
EVENT (Second Level)	Receives Event Logging System (ELS) messages and messages from the operating system and displays them on the console, according to user-configured criteria.	None

OPCON Commands

If you are using a remote terminal, the name of the process handling it is ROPCON instead of OPCON, but the operation is identical, except that you lose your connection on router restart.

If Console Login is enabled on your router, OpenROUTE first prompts for a username and password. Otherwise, it immediately displays the OPCON prompt.

The OPCON process allows you to configure and monitor all of the router's operating parameters. While in OPCON, the router may be forwarding data traffic. When the router boots and enters OPCON, a copyright logo and an asterisk (*) prompt appear on your terminal. This is the OPCON prompt, the main user interface that allows access to second-level processes.

At the * prompt, there is a set of commands that you can enter to check the status of various internal software processes, monitor the performance of the router's interfaces and packet forwarders, and configure various operational parameters.

Some changes to the router's operating parameters made while in OPCON take effect immediately without requiring re-initializing of the router. If the changes do not take effect, use the restart command at the * prompt.

Figure 2 shows the OPCON command tree. Table 2 is a list of the OPCON commands, including a brief description of each command's function.

Each command includes a description, syntax requirements, and an example. To use them, access the OPCON process and enter the command at the * prompt. Enter help for information about using the command line interface.

Figure 2 OPCON Command Tree

Table 2 OPCON Command Summary

Command Function

Config Enters the configuration process.

Divert Sends output of a process to a console or other terminal.

Event Enters Event Logging System (ELS).

Flush Discards output.

Halt Stops output.

Intercept Sets the intercept character (normally, Ctrl p).

Logout Logs out from a router.

Memory Reports the router's memory usage.

Monitor Enters the monitoring process.

Reload Reloads the router with a new load and restarts.

Restart Restarts the router with the same load.

Status Shows information about all router processes.

Talk Talks to a process.

Telnet Connects to another router.

Table 2 OPCON Command Summary
Command	Function
Config	Enters the configuration process.
Divert	Sends output of a process to a console or other terminal.
Event	Enters Event Logging System (ELS).
Flush	Discards output.
Halt	Stops output.
Intercept	Sets the intercept character (normally, `Ctrl` `p`).
Logout	Logs out from a router.
Memory	Reports the router's memory usage.
Monitor	Enters the monitoring process.
Reload	Reloads the router with a new load and restarts.
Restart	Restarts the router with the same load.
Status	Shows information about all router processes.
Talk	Talks to a process.
Telnet	Connects to another router.

Config

Enters the Configuration process at the Config> prompt. See Table 1 for the configuration commands.

To return to the * prompt, use the intercept character, Ctrl P.

Syntax: config

Example: config

Config>

CONFIG Commands describes the commands available at this prompt.

Divert

Redirects the output from a specified process to a specified terminal. This command allows you to divert the output of several processes to the same terminal so that you can view them simultaneously. Use it to redirect event messages from the EVENT process (pid 2) to the terminal (tty0) so you can see event messages while entering configuration commands. The router allows only certain processes to be redirected.

After typing divert, enter the pid and tty# (number of the output terminal). To obtain these values, use the status command. The terminal number can be the number of either the local terminal (tty0) or one of the remote terminals (tty1 or tty2).

Event messages appear immediately on the screen even though you may be in the middle of typing a command. The display and keyboard have separate buffers to prevent command confusion. The following example shows the EVENT process connected to TTY1 after entering the divert 2 1 command. If you want to stop the output, enter Halt 2 at the * prompt.

Syntax: divert pid tty#

Example: divert 2 1

*status
Pid Name Status TTY Comments 1 COpCon IOW TTY0 2 Event IDL TTY0 3 Tasker RDY -- 4 MOSDDT DET -- 5 Monitr IOW -- 6 Config IOW -- 7 ROpCon IDL TTY1 8 ROpCon RDY TTY2 128.185.19.111 *halt 2

Event

Enters the event log monitor mode. There is no prompt. You receive all messages that you request at the ELS config> prompt or the ELS> prompt. To return to the * prompt, use the intercept character, Ctrl p.

Syntax: event

Example: event

ARP.002: Pkt in 1 1 800 nt 0 int Eth/0
ARP.016: unkn dst prot ad nt 0 int Eth/0
IP.007: 128.185.227.15 -> 128.185.227.0
IP.036: rcv pkt prt 17 frm 128.185.227.15

See Using the Event Logging System for detailed information.

Flush

Clears the output buffers of the EVENT and other processes. Discards accumulated messages. Use before displaying the contents of the EVENT FIFO buffer to prevent messages from scrolling off the screen. The router only allows certain processes to be flushed. To obtain the process ID (pid), use the status command. After the flush 2 command, for example, the router sends the output of the EVENT process to the sink.

Syntax: flush pid

Example: flush 2

*status Pid Name Status TTY Comments 1 COpCon IOW TTY0 2 Event IDL Sink 3 Tasker RDY -- 4 MOSDDT DET -- 5 Monitr IOW -- 6 Config IOW -- 7 ROpCon IDL TTY1 8 ROpCon RDY TTY2 128.185.123.138

Halt

Suspends all subsequent output from a specified process until you enter divert, flush, or talk. The router only allows certain processes to be redirected. Halt is the default state for output from a process. To obtain the pid for this command, use the status command. After you enter halt 2, for example, the router disconnects EVENT from TTY1. Event messages no longer appear on the terminal.

Syntax: halt pid

Example: halt 2

halt 2
*status
Pid Name Status TTY Comments 1 COpCon IOW TTY0 2 Event IDL Sink 3 Tasker RDY -- 4 MOSDDT DET -- 5 Monitr IOW -- 6 Config IOW -- 7 ROpCon IDL TTY1 8 ROpCon RDY TTY2 128.185.123.138

Intercept

Changes the OPCON intercept character. The intercept character is what you enter from other processes to get back to the * prompt. The intercept character must be a control character. Enter the ^ (shift 6) character followed by the letter character that you want. The default intercept character is Ctrl P.

Syntax: intercept character

Example: intercept

Argument to INTERCEPT command must be a control character.
Enter as '^' character followed by another character, e.g., ^P.

*intercept ^u

From this example, you have an intercept character of Ctrl P.

Logout

Ends the current session. If the physical console login option is enabled, this command requires the next user to log in using an authorized userid/password combination. If the login is not enabled, the * prompt appears again.

Syntax: logout

Example: logout

Memory

Gets and displays information, in decimal, about the router's global heap memory usage, which helps you determine if the router is being fully utilized. See Figure 3.

Syntax: memory

Example: memory

Number of bytes:  Busy = 319544, Idle = 1936, Free = 1592


Busy	Number of bytes currently allocated.
Idle	Number of bytes previously allocated but freed and available for reuse. The sum of the Idle and Free memory equals the total available heap memory.
Free	Number of bytes that were never allocated from the initial free storage area. The sum of the Idle and Free memory equals the total available memory.

Figure 3 Memory Command

Monitor

Enters the monitoring process at the + prompt. See Table 1 for the monitoring commands.

To return to the * prompt, use the intercept character, Ctrl P.

Syntax: monitor

Example: monitor

See Monitoring the System for information about the monitoring process.

Reload

Functions like restart but causes the router to load a new copy of its software. When you use this command from a remote terminal, it closes the remote session. This command runs the same functions as pressing the reset button except that the router does not dump (if so configured). Before the reload takes effect, the software prompts you to confirm the reload.

The software does the following:

: 1. Sets software counters to zero.
: 2. Causes connected networks to self-test.
: 3. Clears all routing tables.
: 4. Drops packets until reload is completed.
: 5. Loads and runs a new copy of the software.

Syntax: reload

Example: reload

Note: You can enter reload y in the example above to pre-answer Yes to the prompt.; Note: To use the telnet command in a pure bridging environment, you must enable Host Services.

Pid	Process ID. This is the number of the process.
Name	Process name. Different router models have additional processes besides those listed in the example. You see these processes listed when you use the status command on your router.
Status	Shows the state of the process: IDL Idle and waiting for completion of some external event, such as asynchronous I/O. RDY Ready to run and is waiting to use the CPU. IOW Waiting for synchronous I/O, usually the expected standard input, to complete. DET Output ready to be displayed, and process is waiting either to be attached to a display terminal or to have its output diverted to a specified terminal. FZN Frozen due to an error. This usually means the process is trying to use a device that is faulty or incorrectly configures the processes listed when you use the status command on your router.
TTY	Shows the output terminal, if any, to which the process is currently connected. TTY0 Local terminal TTY1 or TTY2 Telnet terminals SINK Process has been flushed Two dashes (- -) Process has been halted (default condition)
Comments	Shows the login IP address when you log in using Telnet (ROpCon).