Contents

1   Using the CLI

This document describes the tasks and commands you use to navigate the command-line interface (CLI) to the SmartEdge™ router. It also describes how to display help for a command, recall previous command entries, and edit command entries.

The CLI recognizes abbreviated forms of commands, so it only requires you to enter enough of any command or keyword to uniquely identify it.

The primary administrator interface to the SmartEdge router is the CLI. See Start an Administrative Session for detailed information.

Note:  

In the following descriptions, the term controller card applies to the Cross-Connect Route Processor (XCRP4), including the controller carrier card unless otherwise noted.

The term controller carrier card refers to the controller functions on the carrier card within the SmartEdge 100 chassis. The term I/O carrier card refers to the traffic card functions on the carrier card; these functions are compatible with the similar functions that are implemented on the traffic card that are supported on all other SmartEdge routers.

Note:  

In this section, the command syntax in the task table displays only the root command; for the complete command syntax, search for the command in the Command List to find the command reference documentation with the full description for the command.

1.1   Starting an Administrative Session

The primary administrator interface to the SmartEdge router is the CLI. You access the CLI from the console port or through a remote session (for example, Telnet or Secure Shell [SSH]) to monitor, administer, and troubleshoot the SmartEdge router. To access the SmartEdge router software and its CLI, use either of the following methods:

• Connect to the console port—Located on the controller card and labeled “Craft 2”; you can connect a terminal to this port, either directly or through a terminal server.

  If the console port has been secured, you are prompted to log on; if the console port has not been secured, you initiate your session by simply pressing Enter.

• Connect to the Ethernet management port—Located on the controller card and labeled ENET; you can use this port to connect a terminal to the system over a LAN if remote access using Telnet or SSH has been enabled. SSH and Telnet are enabled on all contexts by default.

  If the Ethernet management port has been configured, you are prompted to log on. For procedures to configure the Ethernet management port, see Performing Basic Configuration Tasks.

1.1.1   Telnet and SSH Sessions

If the management port has been configured, you can establish a Telnet or SSH session to the system. There are many tools that provide Telnet and SSH access to remote systems. These tools are beyond the scope of this document. In general, you must provide the system name (the hostname configured for the system) or IP address (the IP address configured for the system management port), as well as an administrator name and password.

Within the system, the maximum number of concurrent sessions permitted is either 32 or the sum of all sessions permitted for each context, whichever is smaller. If the maximum number of concurrent sessions permitted on the system is greater than the maximum number of permitted SSH sessions, the remaining sessions must be Telnet sessions. See the following configuration commands for more information: aaa authentication administrator and ssh server full-drop.

1.1.2   Console Sessions

The SmartEdge router provides default settings for local console sessions. You can customize these settings for the duration of the current session. To change the settings, see Performing Basic System Tasks. After you are logged on to the system, you have access to the CLI, based on the context to which you are logged on and the privilege level of your account.

1.1.3   Administrator Names and Passwords

To log on to the system using SSH:

• If you are logging on to a router for which the IP address and SSH service are configured in a context different from that of the administrator, enter the administrator name in the following format:

  admin-name@ctx-name

  Replace the ctx-name argument with the name of the context in which the user is configured for authentication.

• If you are logging on to a router for which the IP address and SSH service are configured in the same context as the administrator, enter the administrator name in the following format:

  admin-name

To log on to the system using Telnet:

• If you are logging on to a router that has the administrator configured in a nonlocal context, enter the administrator name in the following format when prompted:

  admin-name@ctx-name

• If you are logging on to a router that has the administrator configured in a local context, enter the administrator name in the following format when prompted:

  admin-name@[ctx-name]

  Note:  

  In this situation, the ctx-name argument is optional.

  
  

Note:  

The separator character between the admin-name and the ctx-name arguments is configurable and can be any of %, -, @, _, \\, #, and /. The default value is @, which is used throughout this document.

When you connect to the system either directly to the console or remotely to the management port, the password you enter is not echoed.

If you forget a password, you must delete the administrator account and create a new one; there is no way to modify the password for an administrator account.

If you forget all passwords on the system, you must perform the password discovery procedure described in Recovering Passwords.

1.2   Displaying Help for a Command

You can access the online Help for the CLI in the following ways:

• Use the ? command when entering a command to display the options available at the current state of the command syntax.
• Use the help command to display how to use the ? character to obtain help.

Table 1 lists these commands; enter either command in any mode.

Note:  

To enter the ? character as part of a command, when it is not a request for online Help, enter the Esc character followed by the ? character.

1.3   Navigating the CLI

To navigate the CLI, perform the tasks described in Table 2.

(1)  Commands to enter various configuration mode. See the Command List or the specific document for the mode you plan to access.

1.4   Recalling Previous Command Entries

Table 3 lists two Emacs-style command keyboard sequences that allow you to step through previously entered commands.

1.5   Editing Command Entries

Table 4 lists additional Emacs-style command keyboard sequences.

For more information on Emacs key bindings, see the GNU Emacs documentation available at http://www.gnu.org.

1.6   Modifying Output of show Commands

All show commands accept a common set of keywords and arguments called modifiers that you can use to refine the command output. For example, you can specify the line number at which the output is to begin, output only lines containing certain patterns, and apply filtering criteria that pass only those lines you want to see.

This section describes the syntax of show command output modifiers and how to get help for the grep command in the CLI. It also provides examples of a show command displaying lines before and after a pattern, a show command displaying lines that include a pattern, and a show command displaying lines that match a grep pattern.

1.6.1   Syntax of show Command Output Modifiers

The syntax for the output modifiers is as follows:

[| {begin [before lines] [after lines] pattern | count | exclude pattern | include pattern | join-lines | {grep [options options] | pattern} | save filename}]

Table 5 describes how each modifier affects the show command output.

1.6.2   Help for the grep Command in the CLI

You can get help for the grep (global regular expression print) command by entering grep ? or grep --help after a show command at the command line. For more information on the grep command options, see the GNU grep documentation available at http://www.gnu.org.

The following example displays using regular CLI help to understand the syntax of the grep command:

[local]Redback#show port counters | grep ?
  WORD     Pattern to match
  options  Grep options starting with a hyphen
[local]Redback#show port counters | grep 4/2 ?
  |     Output Modifiers
<cr>

To get more detailed help, enter the --help keyword after adding the grep command to a show command as in the following example:

[local]Redback#show hardware card 4/1 | grep --help
usage: grep [-[ABC] num] [-EFGHILVZabcdhilnoqrsvwxz] [-D action] [-d action] [-e pattern] [-f file]

Table 6 describes the grep command options:

1.6.3   Example of the show Command Displaying Lines Before and After a Pattern

The following example displays all lines from the output for the show configuration command (in any mode) beginning with the line before the first line that contains the word (pattern), ospf, and including the 6 lines after the first occurrence of the pattern:

[local]Redback#show configuration | begin before 1 after 6 ospf 
router ospf 64001
  spf-timers 1 1
  area 0.0.0.0
   interface 10.100.11.10
  area 0.0.0.11
   interface 10.100.11.27
   interface 10.100.11.49

1.6.4   Example of the show Command Displaying Lines that Include a Pattern

The following example displays all lines in the current configuration file that contain the word (pattern), port:

[local]Redback#show configuration | include port 

card ge-10-port 1
card oc12e-4-port 2
card gigaether-4-port 3
port ethernet 1/1
port ethernet 1/2
port ethernet 1/3
port ethernet 1/4
port pos 2/1
port pos 2/2
port pos 2/3
port pos 2/4

1.6.5   Example of the show Command Displaying Lines that Match a grep Pattern

The following example takes the output of show port counters command with the live keyword and pipes it into the grep command. Next, the grep command filters what it receives and outputs only the lines that contain atm, ethernet, or rate. (The -E option interprets the pattern as an extended regular expression where the pipe character ( | ) is a logical OR operator.) The output of the grep command is received by the exclude keyword, which removes all lines containing the pattern interval and outputs the remainder to the display:

[local]Redback#show port counters live | grep option -E
 'atm|ethernet|rate' | exclude interval 
1/1 atm  
send packet rate : 0.00 send bit rate : 0.00  
recv packet rate : 0.00 recv bit rate : 0.00  
1/2 atm  
send packet rate : 0.00 send bit rate : 0.00
recv packet rate : 0.00 recv bit rate : 0.00
1/3 atm
send packet rate : 0.00 send bit rate : 0.00
recv packet rate : 0.00 recv bit rate : 0.00
1/4 atm  
send packet rate : 0.00 send bit rate : 0.00
recv packet rate : 0.00 recv bit rate : 0.00  

1.6.6   Example of the show Command Displaying Lines using the join-lines Keyword

The following examples display various ways the join-lines keyword can be used to output record entries.

The following output is that of the show circuit count command without the join-lines keyword.

[local]Redback#show circuit count
Circuit                               Packets/Bytes Sent Packets/Bytes Received
1/1                                                    0                      0
                                                       0                      0
4/1:1                                                  0                      0
                                                       0                      0
4/1                                                    0                      0
                                                       0                      0
5/1                                                    0                      0
                                                       0                      0
5/3                                                    0                      0
                                                       0                      0
5/4                                                    0                      0
                                                       0                      0
6/1                                                    0                      6
                                                       0                    360
12/2                                                   0                      0
                                                       0                      0
14/1                                                   0                      0
                                                       0                      0

When the exclude pattern keyword is piped with the join-lines keyword, the record(s) that do not contain the pattern 2 is output.

[local]Redback#show circuit count | join-lines | exclude 2 
Circuit                               Packets/Bytes Sent Packets/Bytes Received
1/1                                                    0                      0
                                                       0                      0
4/1:1                                                  0                      0
                                                       0                      0
4/1                                                    0                      0
                                                       0                      0
5/1                                                    0                      0
                                                       0                      0
5/3                                                    0                      0
                                                       0                      0
5/4                                                    0                      0
                                                       0                      0
6/1                                                    0                      6
                                                       0                    360
14/1                                                   0                      0
                                                       0                      0

When the grep pattern command is piped with the join-lines keyword, the record(s) containing the pattern 00:30:88:01:cc:00 is output.

[local]Redback#show circuit details | join-lines | grep 00:30:88:01:cc:00
Circuit: 6/1, internal id: 1/1/29, state: Up
----------------------------------------------------------
interface bound   : eth10@3
bind type         : interface
admin state       : 0                 hardware address  : 00:30:88:01:cc:00 
media type        : ethernet          encap type        : ethernet          
mode type         : 0x1               port type         : ethernet          
mtu size          : 1500              cfg mtu size      : 1500              
ipv6 mtu size     : 1500              ipv6 cfg mtu size : 1500              
cct speed         : 100000            cct rx speed      : 0                 
cct flags (attr)  : 0x0               cct flags2 (attr) : 0x0               
L3 proto flags    : 0x0               L3 proto valid    : NO                
L3 v4 proto       : DISABLED          L3 v6 proto       : DISABLED          
L3 v4 proto       : DOWN              L3 v6 proto       : DOWN              
slot mask         : 0x0               parent slot mask  : 0x0               
ppa cct clear     : FALSE             
if flags          : 0x0               aaa index         : 0x0               
profile id        : 0                 version           : 270               
nd profile        : 0                 h node id         : 0                 
lg_id             : 0                 spg_id            : 0                 
internal handle   : 2/10:1023:63/1/1/29