Table Of Contents
Basic Command-Line Interface Commands
disable
editing
enable
end
exit (EXEC)
exit (global)
full-help
help
history
history size
logout
menu (EXEC)
more begin
more exclude
more include
show begin
show exclude
show history
show include
terminal editing
terminal full-help
terminal history
terminal history size
Basic Command-Line Interface Commands
This chapter describes the commands used to enter and exit the various Cisco IOS configuration command modes. It provides a description of help features, command-line interface (CLI) navigation commands, and the command history feature.
The CLI allows you to enter partial Cisco IOS configuration commands. The software recognizes a command when you enter enough characters of the command to uniquely identify it.
For user interface task information and examples, see the "Using the Command-Line Interface" chapter of the Release 12.2 Cisco IOS Configuration Fundamentals Configuration Guide.
disable
To exit privileged EXEC mode and return to user EXEC mode, or to exit to a lower privilege level, enter the disable EXEC command.
disable [privilege-level]
Syntax Description
privilege-level
|
(Optional) Specific privilege level (other than user EXEC mode).
|
Command Modes
EXEC
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
Up to 16 security levels can be configured using Cisco IOS software. If such levels are configured on a system, using this command with the privilege-level option allows you to exit to a lower security level. If a level is not specified, the user will exit to the user EXEC mode, which is the default.
Note
Five EXEC commands are associated with privilege level 0: disable, enable, exit, help, and logout. If you configure a privilege level greater than 0, these five commands will not be included in the command set for that privilege level.
Examples
In the following example, the user enters privileged EXEC mode using the enable command, then exits back to user EXEC mode using the disable command. Note that the prompt for user EXEC mode is >, and the prompt for privileged EXEC mode is #.
Related Commands
Command
|
Description
|
enable
|
Enables higher privilege level access, such as privileged EXEC mode.
|
editing
To reenable Cisco IOS enhanced editing features for a particular line after they have been disabled, use the editing line configuration command. To disable these features, use the no form of this command.
editing
no editing
Syntax Description
This command has no arguments or keywords.
Defaults
Enabled
Command Modes
Line configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
Enhanced editing features are enabled by default. However, there may be situations in which you need to disable these features. The no form of this command disables these enhanced editing features, and the plain form of the command can be used to reenable these features.
Table 3 provides a description of the keys used to enter and edit commands when the editing features are enabled. Ctrl indicates the Control key, which must be pressed simultaneously with its associated letter key. Esc indicates the Escape key, which must be pressed first, followed by its associated letter key. A comma is used in the following table to indicate a key sequence (the comma key should not be pressed). Keys are not case sensitive. Many letters used for CLI navigation and editing were chosen to provide an easy way of remembering their functions. In the following table (Table 3), characters are bolded in the "Function Summary" column to indicate the relation between the letter used and the function.
Table 3 Command Editing Keys and Functions
Keys
|
Function Summary
|
Function Details
|
Tab
|
Complete command
|
Completes a partial command name entry. When you enter a unique set of characters and press the Tab key, the system completes the command name. If you enter a set of characters that could indicate more than one command, the system beeps to indicate an error. To view the commands which match the set of characters you have entered, enter a question mark (?) immediately following the partial command (no space). The CLI will then list the commands that begin with that string.
|
Return (at the command line)
|
Execute
|
Executes the command.
|
Return (at the --More-- prompt)
|
Continue
|
Displays the next line of output.
|
Space Bar (at the --More-- prompt)
|
Continue
|
Displays the next screen of output. The amount of output you see will depend on the screen depth setting of your terminal.
|
Delete or Backspace
|
Backspace
|
Erases the character to the left of the cursor.
|
Left Arrow1 or Ctrl-B
|
Back character
|
Moves the cursor one character to the left. When you enter a command that extends beyond a single line, you can press the Left Arrow or Ctrl-B keys repeatedly to scroll back toward the system prompt and verify the beginning of the command entry.
|
Right Arrow1 or Ctrl-F
|
Forward character
|
Moves the cursor one character to the right.
|
Esc, B
|
Back word
|
Moves the cursor back one word.
|
Esc, F
|
Forward word
|
Moves the cursor forward one word.
|
Ctrl-A
|
Beginning of line
|
Moves the cursor to the beginning of the line.
|
Ctrl-E
|
End of line
|
Moves the cursor to the end of the command line.
|
Ctrl-D
|
Delete character
|
Deletes the character at the cursor.
|
Esc, D
|
Delete next word
|
Deletes from the cursor to the end of the word .
|
Ctrl-W
|
Delete previous word
|
Deletes the word to the left of the cursor.
|
Ctrl-K
|
Delete line forward
|
Deletes all characters from the cursor to the end of the command line.
|
Ctrl-U or Ctrl-X
|
Delete line backward
|
Deletes all characters from the cursor back to the beginning of the command line.
|
Ctrl-T
|
Transpose characters
|
Transposes the character to the left of the cursor with the character located at the cursor.
|
Ctrl-R or Ctrl-L
|
Redisplay line
|
Redisplays the system prompt and command line.
|
Ctrl-V or Esc, Q
|
Ignore editing
|
Inserts a code to indicate to the system that the keystroke immediately following should be treated as a command entry, not as an editing key.
|
Up Arrow1 or Ctrl-P
|
Previous command
|
Recalls commands in the history buffer, beginning with the most recent command. Repeat the key sequence to recall successively older commands.
|
Down Arrow1 or Ctrl-N (next)
|
Next command
|
Returns to more recent commands in the history buffer (after recalling commands with the Up Arrow or Ctrl-P). Repeat the key sequence to recall successively more recent commands.
|
Ctrl-Y
|
Recall last deleted command
|
Recalls the most recent entry in the delete buffer. The delete buffer contains the last ten items you have deleted or cut. Ctrl-Y can be used in conjunction with Esc Y.
|
Esc, Y
|
Recall next deleted command
|
Recalls the next entry in the delete buffer. The delete buffer contains the last ten items you have deleted. Press Ctrl-Y first to recall the most recent entry. Then press Esc Y up to nine times to recall the remaining entries in the buffer. If you bypass an entry, continue to press Esc Y to cycle back to it.
|
Esc, C
|
Capitalize word
|
Capitalizes the word from the cursor to the end of the word.
|
Esc, U
|
Make word uppercase
|
Changes all letters from the cursor to the next space on the line appear in uppercase letters.
|
Esc, L
|
Make word lowercase
|
Changes the word to lowercase from the cursor to the end of the word.
|
Examples
In the following example, enhanced editing mode is disabled on line 3:
Router(config-line)# no editing
Related Commands
Command
|
Description
|
terminal editing
|
Controls CLI enhanced editing feature for the current terminal session.
|
enable
To enter privileged EXEC mode, or any other security level set by a system administrator, use the enable EXEC command.
enable [privilege-level]
Syntax Description
privilege-level
|
(Optional) Privilege level at which to log in.
|
Defaults
Privilege-level 15 (privileged EXEC)
Command Modes
EXEC
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
Entering privileged EXEC mode enables the use of privileged commands. Because many of the privileged commands set operating parameters, privileged access should be password-protected to prevent unauthorized use. If the system administrator has set a password with the enable password global configuration command, you are prompted to enter it before being allowed access to privileged EXEC mode. The password is case sensitive.
If an enable password has not been set, enable mode only can be accessed through the console connection.
Security levels can be set by an administrator using the enable password and privilege level commands. Up to 16 privilege levels can be specified, using the numbers 0 through 15. Using these privilege levels, the administrator can allow or deny access to specific commands. Privilege level 0 is associated with user EXEC mode, and privilege level 15 is associated with privileged EXEC mode.
For more information on defined privilege levels, see the "Passwords and Privileges" chapters of the Cisco IOS Security Configuration Guide and the Cisco IOS Security Command Reference publications.
If a level is not specified when entering the enable command, the user will enter the default mode of privileged EXEC (level 15).
Examples
In the following example, the user enters privileged EXEC mode using the enable command. The system prompts the user for a password before allowing access to the privileged EXEC mode. The password is not printed to the screen. The user then exits back to user EXEC mode using the disable command. Note that the prompt for user EXEC mode is >, and the prompt for privileged EXEC mode is #.
Router>
Related Commands
Command
|
Description
|
disable
|
Exits from privileged EXEC mode to user EXEC mode, or, if privilege levels are set, to the specified privilege level.
|
enable password
|
Sets a local password to control access to various privilege levels.
|
privilege level (global)
|
Sets a privilege level for a command.
|
privilege level (line)
|
Sets a privilege level for a command for a specific line.
|
end
To end the current configuration session and return to privileged EXEC mode, use the end global configuration command.
end
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
Global configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
This command will bring you back to privileged EXEC mode regardless of what configuration mode or configuration submode you are in.
Note
This global configuration command can be used in any configuration mode.
Use this command when you are done configuring the system and you want to return to EXEC mode to perform verification steps.
Examples
In the following example, the end command is used to exit from ALPS ASCU configuration mode and return to privileged EXEC mode. A show command is used in privileged EXEC mode to verify the configuration.
Router# configure terminal
Router(config)# interface serial 1:1
Router(config-if)# alps ascu 4B
Router(config-alps-ascu)# end
Router# show interface serial 1:1
Related Commands
Command
|
Description
|
exit (global)
|
Exits from the current configuration mode.
|
exit (EXEC)
To close an active terminal session by logging off the router, use the exit command in EXEC mode.
exit
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
EXEC
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
Use the exit (EXEC) command in EXEC mode to exit the active session (log off the device).
Examples
In the following example, the exit (global) command is used to move from global configuration mode to privileged EXEC mode, the disable command is used to move from privileged EXEC mode to user EXEC mode, and the exit (EXEC) command is used to log off (exit the active session):
Related Commands
Command
|
Description
|
disconnect
|
Disconnects a line.
|
end
|
Exits configuration mode, or any of the configuration submodes.
|
exit (global)
|
Exits from the current configuration mode to the next highest configuration mode.
|
exit (global)
To exit any configuration mode to the next highest mode in the CLI mode hierarchy, use the exit command in any configuration mode.
exit
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
All configuration modes
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
The exit command is used in the Cisco IOS CLI to exit from the current command mode to the next highest command mode in the CLI mode hierarchy.
For example, use the exit command in global configuration mode to return to privileged EXEC mode. Use the exit command in interface, line, or router configuration mode to return to global configuration mode. Use the exit command in subinterface configuration mode to return to interface configuration mode. At the highest level, EXEC mode, the exit command will exit the EXEC mode and disconnect from the router interface (see the description of the exit (EXEC) command for details).
Examples
The following example displays an exit from the subinterface configuration mode to return to the interface configuration mode:
Router(config-subif)# exit
The following example displays an exit from the interface configuration mode to return to the global
configuration mode:
Related Commands
Command
|
Description
|
disconnect
|
Disconnects a line.
|
end
|
Exits from any configuration mode to privileged EXEC mode.
|
exit (EXEC)
|
Closes the active terminal session by logging off the router.
|
full-help
To get help for the full set of user-level commands, use the full-help line configuration command.
full-help
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Line configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
The full-help command enables (or disables) an unprivileged user to see all of the help messages available. It is used with the show ? command.
Examples
In the following example, the show ? command is used first with full-help disabled. Then full-help is enabled for the line, and the show ? command is used again to demonstrate the additional help output that is displayed.
bootflash Boot Flash information
calendar Display the hardware calendar
clock Display the system clock
context Show context information
dialer Dialer parameters and statistics
history Display the session command history
hosts IP domain-name, lookup style, nameservers, and host table
kerberos Show Kerberos Values
modemcap Show Modem Capabilities database
ppp PPP parameters and statistics
sessions Information about Telnet connections
terminal Display terminal configuration parameters
users Display information about terminal lines
version System hardware and software status
Router# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# line console 0
Router(config-line)# full-help
%SYS-5-CONFIG_I: Configured from console by console
access-expression List access expression
access-lists List access lists
aliases Display alias commands
apollo Apollo network information
appletalk AppleTalk information
async Information on terminal lines used as router interfaces
bootflash Boot Flash information
bridge Bridge Forwarding/Filtering Database [verbose]
bsc BSC interface information
bstun BSTUN interface information
buffers Buffer pool statistics
calendar Display the hardware calendar
translate Protocol translation information
ttycap Terminal capability tables
users Display information about terminal lines
version System hardware and software status
vlans Virtual LANs Information
whoami Info on current tty line
xremote XRemote statistics
Related Commands
Command
|
Description
|
help
|
Displays a brief description of the help system.
|
help
To display a brief description of the help system, enter the help command.
help
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
All command modes
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
The help command provides a brief description of the context-sensitive help system, which functions as follows:
•
To list all commands available for a particular command mode, enter a question mark (?) at the system prompt.
•
To obtain a list of commands that begin with a particular character string, enter the abbreviated command entry immediately followed by a question mark (?). This form of help is called word help, because it lists only the keywords or arguments that begin with the abbreviation you entered.
•
To list the keywords and arguments associated with a command, enter a question mark (?) in place of a keyword or argument on the command line. This form of help is called command syntax help, because it lists the keywords or arguments that apply based on the command, keywords, and arguments you have already entered.
Examples
In the following example, the help command is used to display a brief description of the help system:
Help may be requested at any point in a command by entering
a question mark '?'. If nothing matches, the help list will
be empty and you must backup until entering a '?' shows the
Two styles of help are provided:
1. Full help is available when you are ready to enter a
command argument (e.g. 'show ?') and describes each possible
2. Partial help is provided when an abbreviated argument is entered
and you want to know what arguments match the input
The following example shows how to use word help to display all the privileged EXEC commands that begin with the letters "co". The letters entered before the question mark are reprinted on the next command line to allow the user to continue entering the command.
The following example shows how to use command syntax help to display the next argument of a partially complete access-list command. One option is to add a wildcard mask. The <cr> symbol indicates that the other option is to press Return to execute the command without adding any more keywords or arguments. The characters entered before the question mark are reprinted on the next command line to allow the user to continue entering the command or to execute that command as it is.
Router(config)# access-list 99 deny 131.108.134.234 ?
A.B.C.D Mask of bits to ignore
Router(config)# access-list 99 deny 131.108.134.234
Related Commands
Command
|
Description
|
full-help
|
Gets help for the full set of user-level commands.
|
history
To enable the command history function, use the history line configuration command. To disable the command history feature, use the no form of this command.
history
no history
Syntax Description
This command has no arguments or keywords.
Defaults
Enabled, ten command lines in buffer
Command Modes
Line configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
The command history feature provides a record of EXEC commands that you have entered. This feature is particularly useful for recalling long or complex commands or entries, including access lists.
To change the number of command lines that the system will record in its history buffer, use the history size line configuration command.
The history command enables the history function with the last buffer size specified or, if there was not a prior setting, with the default of ten lines. The no history command disables the history feature.
The show history EXEC command will list the commands you have entered, but you can also use your keyboard to display individual commands. Table 4 lists the keys you can use to recall commands from the command history buffer.
Table 4 History Keys
Key(s)
|
Functions
|
Ctrl-P or Up Arrow1
|
Recalls commands in the history buffer in a backward sequence, beginning with the most recent command. Repeat the key sequence to recall successively older commands.
|
Ctrl-N or Down Arrow1
|
Returns to more recent commands in the history buffer after recalling commands with Ctrl-P or the Up Arrow. Repeat the key sequence to recall successively more recent commands.
|
Examples
In the following example, line 4 is configured with a history buffer size of 35 lines:
Router(config-line)# history size 35
Related Commands
Command
|
Description
|
history size
|
Sets the command history buffer size for a particular line.
|
show history
|
Lists the commands you have entered in the current EXEC session.
|
terminal history
|
Enables the command history feature for the current terminal session or changes the size of the command history buffer for the current terminal session.
|
history size
To change the command history buffer size for a particular line, use the history size line configuration command. To reset the command history buffer size to ten lines, use the no form of this command.
history size number-of-lines
no history size
Syntax Description
number-of-lines
|
Specifies the number of command lines that the system will record in its history buffer. The range is from 0 to 256. The default is ten.
|
Defaults
Ten command lines
Command Modes
Line configuration
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
The history size command should be used in conjunction with the history and show history commands. The history command enables or disables the command history function. The show history command lists the commands you have entered in the current EXEC session. The number of commands that the history buffer will show is set by the history size command.
Note
The history size command only sets the size of the buffer; it does not reenable the history feature. If the no history command is used, the history command must be used to reenable this feature.
Examples
The following example displays line 4 configured with a history buffer size of 35 lines:
Router(config-line)# history size 35
Related Commands
Command
|
Description
|
history
|
Enables or disables the command history function.
|
show history
|
Lists the commands you have entered in the current EXEC session.
|
terminal history size
|
Enables the command history function for the current terminal session or changes the size of the command history buffer for the current terminal session.
|
logout
To close an active terminal session by logging off the router, use the logout command in user EXEC mode.
logout
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values.
Command Modes
User EXEC
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Examples
In the following example, the exit (global) command is used to move from global configuration mode to privileged EXEC mode, the disable command is used to move from privileged EXEC mode to user EXEC mode, and the logout command is used to log off (exit from the active session):
Related Commands
Command
|
Description
|
exit (global)
|
Exits any configuration mode to the next highest mode in the CLI mode hierarchy.
|
menu (EXEC)
To display a preconfigured user menu, use the menu command in user or privileged EXEC mode.
menu menu-name
Syntax Description
menu-name
|
The name of the menu.
|
Command Modes
EXEC
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
A user menu is a type of user interface where text descriptions of actions to be performed are displayed to the user. The user can use the menu to select services and functions without having to know the details of command-line interface (CLI) commands.
Menus can be created for users in global configuration mode, using the commands listed in the "Related Commands" section. The description of these commands can be found in the "Connection, Menu, and System Banner Commands" chapter of this document.
A menu can be invoked at either the user or privileged EXEC level, but if an item in the menu contains a privileged EXEC command, the user must be logged in at the privileged level for the command to succeed.
Examples
The following example invokes a menu named OnRamp:
Welcome to OnRamp Internet Services
Type a number to select an option;
Related Commands
Command
|
Description
|
menu clear-screen
|
Clears the terminal screen before displaying a menu.
|
menu command
|
Specifies underlying commands for user interface menus.
|
menu default
|
Specifies the menu item to use as the default.
|
menu line-mode
|
Requires the user to press Enter after specifying an option number.
|
menu options
|
Sets options for items in user interface menus.
|
menu prompt
|
Specifies the prompt for a user interface menu.
|
menu single-space
|
Displays menu items single-spaced rather than double-spaced.
|
menu status-line
|
Displays a line of status information about the current user at the top of a menu
|
menu text
|
Specifies the text of a menu item in a user interface menu.
|
menu title
|
Creates a title, or banner, for a user menu.
|
no menu
|
Deletes a specified menu from a menu configuration.
|
more begin
To search the output of any more command, use the more begin command in EXEC mode. This command begins unfiltered output of the more command with the first line that contains the regular expression you specify.
more file-url | begin regular-expression
Syntax Description
file-url
|
The Universal Resource Locator (url) of the file to display. More commands are advanced show commands; for details, see the command reference page in this book for the more command.
|
|
|
A vertical bar (the "pipe" symbol) indicates that an output processing specification follows.
|
regular-expression
|
Any regular expression found in more command output.
|
/
|
Specifies a search at a --More-- prompt that begins unfiltered output with the first line that contains the regular expression.
|
-
|
Specifies a filter at a --More-- prompt that only displays output lines that do not contain the regular expression.
|
+
|
Specifies a filter at a --More-- prompt that only displays output lines that contain the regular expression.
|
Command Modes
EXEC
Command History
Release
|
Modification
|
11.3 AA
|
The more command was introduced.
|
12.0(1)T
|
This extension of the more command was introduced.
|
Usage Guidelines
The regular-expression argument is case sensitive and allows for complex matching requirements.
You can specify a new search at every --More-- prompt.
To search the remaining output of the more command, use the following command at the --More-- prompt:
/regular-expression
To filter the remaining output of the more command, use one of the following commands at the --More-- prompt:
-regular-expression
+regular-expression
When output volume is large, the search can produce long lists of output. To interrupt the output, press Ctrl-^ (Ctrl-Shift-6) or Ctrl-Z.
Note
Once you specify a filter for a more command, you cannot specify another filter at a --More-- prompt. The first specified filter remains until the more command output finishes or until you interrupt the output. The use of the keyword begin does not constitute a filter.
Because prior output is not saved, you cannot search or filter backward through prior output.
Examples
The following is partial sample output of the more nvram:startup-config | begin command that begins unfiltered output with the first line that contain the regular expression "ip." At the --More-- prompt, the user specifies a filter to exclude output lines that contain the regular expression "ip."
router# more nvram:startup-config | begin ip
ip name-server 198.92.30.32
ip name-server 171.69.2.132
isdn switch-type primary-5ess
ip address 5.5.5.99 255.255.255.0
encapsulation frame-relay
isdn switch-type primary-5ess
Related Commands
Command
|
Description
|
more exclude
|
Filters more command output so that it excludes lines that contain a particular regular expression.
|
more include
|
Filters more command output so that it displays only lines that contain a particular regular expression.
|
show begin
|
Searches the output of any show command and displays the output from the first instance of a specified string.
|
show exclude
|
Filters show command output so that it excludes lines that contain a particular regular expression.
|
show include
|
Filters show command output so that it displays only lines that contain a particular regular expression.
|
more exclude
To filter more command output so that it excludes lines that contain a particular regular expression, use the more exclude command in EXEC mode.
more file-url | exclude regular-expression
Syntax Description
file-url
|
The Universal Resource Locator (url) of the file to display. More commands are advanced show commands; for details, see the command reference page in this book for the more command.
|
|
|
A vertical bar (the "pipe" symbol) indicates that an output processing specification follows.
|
regular-expression
|
Any regular expression found in more command output.
|
/
|
Specifies a search at a --More-- prompt that begins unfiltered output with the first line that contains the regular expression.
|
Command Modes
EXEC
Command History
Release
|
Modification
|
11.3 AA
|
The more command was introduced.
|
12.0(1)T
|
This extension of the more command was introduced.
|
Usage Guidelines
The regular-expression argument is case sensitive and allows for complex matching requirements.
You can specify a new search at any --More-- prompt. To search the remaining output of the more command, use the following command at the --More-- prompt:
/regular-expression
When output volume is large, the search can produce long lists of output. To interrupt the output, press Ctrl-^ (Ctrl-Shift-6) or Ctrl-Z.
Because prior output is not saved, you cannot search or filter backward through prior output.
Examples
The following is partial sample output of the more nvram:startup-config | exclude command. The use of | exclude service in the command specifies a filter that excludes lines that contain the regular expression "service." At the --More-- prompt, the user searches for the regular expression "Dialer1," which continues filtered output with the first line that contains "Dialer1."
router# more nvram:startup-config | exclude service
Related Commands
Command
|
Description
|
more begin
|
Begins unfiltered output of the more command with the first line that contains the regular expression you specify.
|
more include
|
Filters more command output so that it displays only lines that contain a particular regular expression.
|
show begin
|
Searches the output of any show command and displays the output from the first instance of a specified string.
|
show exclude
|
Filters show command output so that it excludes lines that contain a particular regular expression.
|
show include
|
Filters show command output so that it displays only lines that contain a particular regular expression.
|
more include
To filter more command output so that it displays only lines that contain a particular regular expression, use the more include command in EXEC mode.
more file-url | include regular-expression
Syntax Description
file-url
|
The Universal Resource Locator (url) of the file to display. More commands are advanced show commands; for details, see the command reference page in this book for the more command.
|
|
|
A vertical bar (the "pipe" symbol) indicates that an output processing specification follows.
|
regular-expression
|
Any regular expression found in more command output.
|
/
|
Specifies a search at a --More-- prompt that begins unfiltered output with the first line that contains the regular expression.
|
Command Modes
EXEC
Command History
Release
|
Modification
|
11.3 AA
|
The more command was introduced.
|
12.0(1)T
|
This extension of the more command was introduced.
|
Usage Guidelines
The regular-expression argument is case sensitive and allows for complex matching requirements.
You can specify a new search at any --More-- prompt. To search the remaining output of the more command, use the following syntax at the --More-- prompt:
/regular-expression
When output volume is large, the search can produce long lists of output. To interrupt the output, press Ctrl-^ (Ctrl-Shift-6) or Ctrl-Z.
Because prior output is not saved, you cannot search or filter backward through prior output.
Examples
The following is partial sample output of the more nvram:startup-config | include command. It only displays lines that contain the regular expression "ip."
router# more nvram:startup-config | include ip
ip name-server 198.92.30.32
ip name-server 171.69.2.132
description ip address 172.21.53.199 255.255.255.0
ip address 172.21.53.199 255.255.255.0
Related Commands
Command
|
Description
|
more begin
|
Begins unfiltered output of the more command with the first line that contains the regular expression you specify.
|
more exclude
|
Filters more command output so that it excludes lines that contain a particular regular expression.
|
show begin
|
Searches the output of any show command and displays the output from the first instance of a specified string.
|
show exclude
|
Filters show command output so that it excludes lines that contain a particular regular expression.
|
show include
|
Filters show command output so that it displays only lines that contain a particular regular expression.
|
show begin
To begin the output of any show command from a specified string, use the show begin command in EXEC mode.
show any-command | begin regular-expression
Syntax Description
any-command
|
Any supported show command.
|
|
|
A vertical bar (the "pipe" symbol) indicates that an output processing specification follows.
|
regular-expression
|
Any regular expression found in show command output. The show output will begin from the first instance of this string (output prior to this string will not be printed to the screen). The string is case-sensitive. Use parenthesis to indicate a literal use of spaces.
|
/
|
Specifies a search at a --More-- prompt that begins unfiltered output with the first line that contains the regular expression.
|
-
|
Specifies a filter at a --More-- prompt that only displays output lines that do not contain the regular expression.
|
+
|
Specifies a filter at a --More-- prompt that only displays output lines that contain the regular expression.
|
Command Modes
EXEC
Command History
Release
|
Modification
|
8.3
|
The show command was introduced.
|
12.0(1)T
|
This extension of the show command was introduced.
|
Usage Guidelines
The regular-expression argument is case sensitive and allows for complex matching requirements. Use parenthesis to indicate a literal use of spaces. For example, | begin u indicates that the show output should begin with any line that contains a u; | begin ( u) indicates that the show output should begin with any line that contains a space and a u together (line has a word that begins with a lowercase u).
To search the remaining output of the show command, use the following command at the --More-- prompt:
/regular-expression
You can specify a filtered search at any --More-- prompt. To filter the remaining output of the show command, use one of the following commands at the --More-- prompt:
-regular-expression
+regular-expression
When output volume is large, the search can produce long lists of output. To interrupt the output, press Ctrl-^ (Ctrl-Shift-6) or Ctrl-z.
Note
Once you specify a filter for a show command, you cannot specify another filter at the next --More-- prompt. The first specified filter remains until the more command output finishes or until you interrupt the output. The use of the keyword begin does not constitute a filter.
Because prior output is not saved, you cannot search or filter backward through prior output.
Note
A few show commands that have long output requirements do not require user input at the --More-- prompt to jump to the next table of output; these types of output require you to enter the same number of Ctrl-^ or Ctrl-Z combinations as there are --More-- prompts to completely abort output.
Examples
The following is partial sample output of the show interface | begin command that begins unfiltered output with the first line that contains the regular expression "Ethernet." At the --More-- prompt, the user specifies a filter to show only the lines in the remaining output that contain the regular expression "Serial."
router# show interface | begin Ethernet
Ethernet0 is up, line protocol is up
Hardware is Lance, address is 0060.837c.6399 (bia 0060.837c.6399)
Description: ip address is 172.1.2.14 255.255.255.0
Internet address is 172.1.2.14/24
0 lost carrier, 0 no carrier
0 output buffer failures, 0 output buffers swapped out
Serial1 is up, line protocol is up
Serial2 is up, line protocol is up
Serial3 is up, line protocol is down
Serial4 is down, line protocol is down
Serial5 is up, line protocol is up
Serial6 is up, line protocol is up
Serial7 is up, line protocol is up
Related Commands
Command
|
Description
|
more begin
|
Begins unfiltered output of the more command with the first line that contains the regular expression you specify.
|
more exclude
|
Filters more command output so that it excludes lines that contain a particular regular expression.
|
more include
|
Filters more command output so that it displays only lines that contain a particular regular expression.
|
show exclude
|
Filters show command output so that it excludes lines that contain a particular regular expression.
|
show include
|
Filters show command output so that it displays only lines that contain a particular regular expression.
|
show exclude
To filter show command output so that it excludes lines that contain a particular regular expression, use the show exclude command in EXEC mode.
show any-command | exclude regular-expression
Syntax Description
any-command
|
Any supported show command.
|
|
|
A vertical bar (the "pipe" symbol) indicates that an output processing specification follows.
|
regular-expression
|
Any regular expression found in show command output.
|
/
|
Specifies a search at a --More-- prompt that begins unfiltered output with the first line that contains the regular expression.
|
Command Modes
EXEC
Command History
Release
|
Modification
|
8.3
|
The show command was introduced.
|
12.0(1)T
|
This extension of the show command was introduced.
|
Usage Guidelines
The regular-expression argument is case sensitive and allows for complex matching requirements.
You can specify a new search at every --More-- prompt. To search the remaining output of the show command, use the following syntax at the --More-- prompt:
/regular-expression
When output volume is large, the search can produce long lists of output. To interrupt the output, press Ctrl-^ (Ctrl-Shift-6) or Ctrl-Z.
Because prior output is not saved, you cannot search or filter backward through prior output.
Note
A few show commands that have long output requirements do not require user input at the --More-- prompt to jump to the next table of output; these types of output require you to enter the same number of Ctrl-^ or Ctrl-Z combinations as there are --More-- prompts to completely abort output.
Examples
The following is partial sample output of the show | exclude command used with the show buffers command. It excludes lines that contain the regular expression "0 misses." At the --More-- prompt, the user searches for the regular expression "Serial0," which continues the filtered output with the first line that contains "Serial0."
router# show buffers | exclude 0 misses
398 in free list (500 max allowed)
Small buffers, 104 bytes (total 50, permanent 50):
50 in free list (20 min, 150 max allowed)
551 hits, 3 misses, 0 trims, 0 created
Big buffers, 1524 bytes (total 50, permanent 50):
49 in free list (5 min, 150 max allowed)
Very Big buffers, 4520 bytes (total 10, permanent 10):
Huge buffers, 18024 bytes (total 0 permanent 0):
0 in free list (0 min, 4 max allowed)
Serial0 buffers, 1543 bytes (total 64, permanent 64):
16 in free list (0 min, 64 max allowed)
Related Commands
Command
|
Description
|
more begin
|
Begins unfiltered output of the more command with the first line that contains the regular expression you specify.
|
more exclude
|
Filters more command output so that it excludes lines that contain a particular regular expression.
|
more include
|
Filters more command output so that it displays only lines that contain a particular regular expression.
|
show begin
|
Searches the output of any show command and displays the output from the first instance of a specified string.
|
show include
|
Filters show command output so that it displays only lines that contain a particular regular expression.
|
show history
To list the commands you have entered in the current EXEC session, use the show history EXEC command.
show history
Syntax Description
This command has no arguments or keywords.
Command Modes
EXEC
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
The command history feature provides a record of EXEC commands you have entered. The number of commands that the history buffer will record is determined by the history size line configuration command or the terminal history size EXEC command.
Table 5 lists the keys and functions you can use to recall commands from the command history buffer.
Table 5 History Keys
Key
|
Function
|
Ctrl-P or Up Arrow1
|
Recalls commands in the history buffer in a backward sequence, beginning with the most recent command. Repeat the key sequence to recall successively older commands.
|
Ctrl-N or Down Arrow1
|
Returns to more recent commands in the history buffer after recalling commands with Ctrl-P or the Up Arrow. Repeat the key sequence to recall successively more recent commands.
|
Examples
The following is sample output from the show history command, which lists the commands the user has entered in EXEC mode for this session:
Related Commands
Command
|
Description
|
history size
|
Enables the command history function, or changes the command history buffer size for a particular line.
|
terminal history size
|
Enables the command history feature for the current terminal session, or changes the size of the command history buffer for the current terminal session.
|
show include
To filter show command output so that it only displays lines that contain a particular regular expression, use the show include command in EXEC mode.
show any-command | include regular-expression
Syntax Description
any-command
|
Any supported show command.
|
|
|
A vertical bar (the "pipe" symbol) indicates that an output processing specification follows.
|
regular-expression
|
Any regular expression found in show command output. Use parenthesis to include spaces in the expression.
|
/
|
Specifies a search at a --More-- prompt that begins unfiltered output with the first line that contains the regular expression.
|
Command Modes
EXEC
Command History
Release
|
Modification
|
8.3
|
The show command was introduced.
|
12.0(1)T
|
This extension of the show command was introduced.
|
Usage Guidelines
The regular-expression argument is case sensitive and allows for complex matching requirements.
You can specify a new search at every --More-- prompt. To search the remaining output of the show command, use the following syntax at the --More-- prompt:
/regular-expression
When output volume is large, the search can produce long lists of output. To interrupt the output, press Ctrl-^ (Ctrl-Shift-6) or Ctrl-Z.
Because prior output is not saved, you cannot search or filter backward through prior output.
Note
A few show commands that have long output requirements do not require user input at the --More-- prompt to jump to the next table of output; these types of output require you to enter the same number of Ctrl-^ or Ctrl-Z combinations as there are --More-- prompts to completely abort output.
Examples
The following is partial sample output of the show interface | include command. It displays only lines that contain the regular expression "( is )." The parentheses force the inclusion of the spaces before and after "is." Use of the parenthesis ensures that only lines containing "is" with a space both before and after it will be included in the output. Lines with words like "disconnect" will be excluded because there are not spaces around the instance of the string "is".
router# show interface | include ( is )
ATM0 is administratively down, line protocol is down
Hardware is ATMizer BX-50
Dialer1 is up (spoofing), line protocol is up (spoofing)
DTR is pulsed for 1 seconds on reset
Ethernet0 is up, line protocol is up
Hardware is Lance, address is 0060.837c.6399 (bia 0060.837c.6399)
Internet address is 172.21.53.199/24
Ethernet1 is up, line protocol is up
Hardware is Lance, address is 0060.837c.639c (bia 0060.837c.639c)
Internet address is 5.5.5.99/24
Serial0:0 is down, line protocol is down
At the --More-- prompt, the user searches for the regular expression "Serial0:13", which continues filtered output with the first line that contains "Serial0:13."
Serial0:13 is down, line protocol is down
Internet address is 11.0.0.2/8
0 output errors, 0 collisions, 2 interface resets
Timeslot(s) Used:14, Transmitter delay is 0 flags
Related Commands
Command
|
Description
|
more begin
|
Begins unfiltered output of the more command with the first line that contains the regular expression you specify.
|
more exclude
|
Filters more command output so that it excludes lines that contain a particular regular expression.
|
more include
|
Filters more command output so that it displays only lines that contain a particular regular expression.
|
show begin
|
Searches the output of any show command and displays the output from the first instance of a specified string.
|
show exclude
|
Filters show command output so that it excludes lines that contain a particular regular expression.
|
terminal editing
To reenable the enhanced editing mode for only the current terminal session, use the terminal editing EXEC command. To disable the enhanced editing mode on the current line, use the no form of this command.
terminal editing
terminal no editing
Syntax Description
This command has no arguments or keywords.
Defaults
Enabled
Command Modes
EXEC
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
This command is identical to the editing EXEC mode command, except that it controls (enables or disables) enhanced editing for only the terminal session you are using. For a description of the available editing keys, see the description of the editing command in this chapter.
Examples
In the following example, enhanced editing mode is reenabled for only the current terminal session:
Related Commands
Command
|
Description
|
editing
|
Controls CLI enhanced editing features for a particular line.
|
terminal full-help
To get help for the full set of user-level commands, use the terminal full-help EXEC mode command.
terminal full-help
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
EXEC
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
The terminal full-help command enables a user to see all of the help messages available from the terminal. It is used with the show ? command.
Examples
In the following example, the difference between the output of the show ? command before and after using the terminal full-help command is shown:
bootflash Boot Flash information
calendar Display the hardware calendar
clock Display the system clock
context Show context information
dialer Dialer parameters and statistics
history Display the session command history
hosts IP domain-name, lookup style, nameservers, and host table
kerberos Show Kerberos Values
modemcap Show Modem Capabilities database
ppp PPP parameters and statistics
sessions Information about Telnet connections
terminal Display terminal configuration parameters
users Display information about terminal lines
version System hardware and software status
Router> terminal full-help
access-expression List access expression
access-lists List access lists
aliases Display alias commands
apollo Apollo network information
appletalk AppleTalk information
async Information on terminal lines used as router interfaces
bootflash Boot Flash information
bridge Bridge Forwarding/Filtering Database [verbose]
bsc BSC interface information
bstun BSTUN interface information
buffers Buffer pool statistics
calendar Display the hardware calendar
clns CLNS network information
clock Display the system clock
cmns Connection-Mode networking services (CMNS) information
compress Show compression statistics.
xremote XRemote statistics
Related Commands
Command
|
Description
|
full-help
|
Gets help for the full set of user-level commands.
|
help
|
Displays a brief description of the help system.
|
terminal history
To enable the command history feature for the current terminal session, use the terminal history command in user EXEC mode or privileged EXEC mode. To disable the command history feature, use the no form of this command.
terminal history
terminal no history
Syntax Description
This command has no arguments or keywords.
Defaults
Enabled, history buffer of 10 lines
Command Modes
EXEC
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
The history feature provides a record of commands you have entered. This feature is particularly useful for recalling long or complex commands or entries for the purposes of modifying them slightly and reexecuting them.
The terminal history command enables the command history feature with the default buffer size or the last buffer size specified using the terminal history size command.
Table 6 lists the keys and functions you can use to recall commands from the history buffer.
Table 6 History Keys
Key(s)
|
Function
|
Ctrl-P or Up Arrow1
|
Recalls commands in the history buffer in a backward sequence, beginning with the most recent command. Repeat the key sequence to recall successively older commands.
|
Ctrl-N or Down Arrow1
|
Returns to more recent commands in the history buffer after recalling commands with Ctrl-P or the Up Arrow. Repeat the key sequence to recall successively more recent commands.
|
Examples
In the following example, the command history feature is disabled for the current terminal session:
Router> terminal no history
Related Commands
Command
|
Description
|
history
|
Enables the command history function, or changes the command history buffer size for a particular line.
|
show history
|
Lists the commands you have entered in the current EXEC session.
|
terminal history size
|
Sets the size of the history buffer for the command history feature for the current terminal session.
|
terminal history size
To change the size of the command history buffer for the current terminal session, use the terminal history size EXEC mode command. To reset the command history buffer to its default size of 10 lines, use the no form of this command.
terminal history size number-of-lines
terminal no history size
Syntax Description
number-of-lines
|
Number of command lines that the system will record in its history buffer. The range is from 0 to 256. The default is 10.
|
Defaults
10 lines of command history
Command Modes
EXEC
Command History
Release
|
Modification
|
10.0
|
This command was introduced.
|
Usage Guidelines
The history feature provides a record of commands you have entered. This feature is particularly useful for recalling long or complex commands or entries for the purposes of modifying them slightly and reissuing them.
The terminal history size command enables the command history feature and sets the command history buffer size. The terminal no history size command resets the buffer size to the default of 10 command lines.
Table 6 lists the keys and functions you can use to recall commands from the history buffer. When you use these keys, the commands recalled will be from EXEC mode if you are in EXEC mode, or from all configuration modes if you are in any configuration mode.
Table 7 History Keys
Key
|
Function
|
Ctrl-P or Up Arrow1
|
Recalls commands in the history buffer in a backward sequence, beginning with the most recent command. Repeat the key sequence to recall successively older commands.
|
Ctrl-N or Down Arrow1
|
Returns to more recent commands in the history buffer after recalling commands with Ctrl-P or the Up Arrow. Repeat the key sequence to recall successively more recent commands.
|
In EXEC mode, you can also use the show history command to show the contents of the command history buffer.
To check the current settings for the command history feature on your line, use the show line command.
Examples
In the following example, the number of command lines recorded is set to 15 for the current terminal session. The user then checks to see what line he/she is connected to using the show users command. The user uses this line information to issue the show line command. (In this example, the user uses the show begin option in the show line command to start the output at the "Editing is enabled/disabled" line.)
Router# terminal history size 15
Line User Host(s) Idle Location
* 50 vty 0 admin idle 00:00:00
! the * symbol indicates the active terminal session for the user (line 50)
Router# show line 50 | begin Editing
! the following line shows the history settings for the line
History is enabled, history size is 15.
DNS resolution in show commands is enabled
Full user help is disabled
Allowed transports are telnet. Preferred is none.
No output characters are padded
No special data dispatching characters
Related Commands
Command
|
Description
|
history
|
Enables the command history function, or changes the command history buffer size for a particular line.
|
show begin
|
Searches the output of any show command and displays the output from the first instance of a specified string.
|
show history
|
Lists the commands you have entered in the current EXEC session.
|
terminal history
|
Enables the command history feature for the current terminal session.
|