Figure 1 Router Software Processes
DIVERT
EVENT
FLUSH
HALT
HELP
INTERCEPT
LOGOUT
MONITOR
RESTART
STATUS
TALK
TELNET
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.
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
% 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.
login: ifr
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.
* 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> |
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> |
Note: The EVENT process does not have a prompt and accepts only the Ctrl P command.
* 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
*
* prompt and close the Telnet connection.
For example: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 theIP Config>exit
Config>ctrl p
* logout%
* 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.
Command line editing
Command completion
Command line recall
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:
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 theConfig>protocol
The choices/prefixes are (a complete list)
IP
ARP
IPX
SNMP
AP2
BRIDGE
HST
* prompt and the following appears:Press Space after a unique part of any command and the software completes the command. For example, enter pr followed by Space at the*
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
+ prompt and the entire name of the command, PROTOCOL, appears immediately:Press Space at the end of an input line and the software searches all commands that start with the present input. One of the following happens:+ pr
+ PROTOCOL
A Tab acts similarly to a Space in most cases. The exception is when you enter a command and there is a default supplied for that command. In this case, Tab completes the default. The Tab is helpful when you enter values rather than commands because you can press Tab repeatedly to enter default values.
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
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
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
config
Config>
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.
divert 2 1*status
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
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
flush 2*status
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
* 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
* prompt appears again.
Syntax: logout
Example: logout
+ 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:
reload
Are you sure you want to reload the gateway? (Yes or no): yes
loading
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Copyright Notices:
Copyright 1985-1997 Proteon, Inc.
Copyright 1984 - 1987, 1989 by J. Noel Chiappa
MOS Operator Control*
restart
Are you sure you want to restart the gateway? (Yes or [no]:yes
Copyright Notices:
Copyright 1985-1997 Proteon, Inc.
Copyright 1984 - 1987, 1989 by J. Noel Chiappa
MOS Operator Control
*
status 7
7 ROpCon IOW TTY1 128.185.46.101
status
Pid Name Status TTY Comments
1 COpCon IOW TTY0
2 Event DET --
3 Tasker RDY --
4 MOSDDT DET --
5 Monitr DET --
6 Config DET --
7 ROpCon IDL TTY1
8 ROpCon RDY TTY2 128.185.19.111
Talk
Switches to other router processes, such as EVENT, MONITOR, or CONFIG. After connecting to a new process, you can send specific commands to and receive output from that process. You cannot talk to the TASKER or OPCON process. To obtain the pid, enter status. Once you are connected to the second-level processes, such as EVENT, MONITOR, or CONFIG, use the intercept character, Ctrl P, to return to the * prompt. For more information about connecting to a process, see Connecting to a Process.
talk 5
+
Two servers, inbound to the router
Three clients, outbound from the router
telnet 128.185.10.30
Trying 128.185.10.30 ...
Connected to 128.185.10.30
Escape character is '^]'
To get to theTrying 128.185.10.30 ...
telnet> prompt, type Ctrl ] at any prompt.
If you telnet into a router, Press Backspace to delete the last character typed on the command line.
Note: If you use a VT100(TM) terminal, do not press Backspace because it inserts invisible characters. Press Delete to delete the last character.
Press Delete or Ctrl u, at the telnet> prompt, to delete the whole command line entry so that you can re-enter a command.
telnet> close
or
telnet> quit*logout