-
Cisco IOS Configuration Fundamentals and Network Management Command Reference, Release 12.3
-
Introduction
-
CFR Commands: absolute -- clock timezone
-
CFR Commands: clock update-calendar -- escape-character
-
CFR Commands: exception core-file -- ip ftp passive
-
CFR Commands: ip ftp password -- lsr-path
-
CFR Commands: memory sanity -- periodic
-
CFR Commands: ping -- service sequence numbers
-
CFR Commands: service slave-log -- show
tee -
CFR Commands: show context -- show ip http server
-
CFR Commands: show kron schedule -- show rtr enhanced-history
-
12.3 CF CR Commands: show rtr distributions-statistics -- snmp-server enable informs
-
CFR Commands: snmp-server enable traps -- statistics-distribution-interval
-
CFR Commands: stopbits -- ttl ip
-
CFR Commands: type dhcp - xsm vdm
-
CFR Appendix: ASCII Character Set and Hex Values
-
Table Of Contents
terminal special-character-bits
terminal telnet refuse-negotiations
terminal-queue entry-retry-interval
stopbits
To set the number of the stop bits transmitted per byte, use the stopbits command in line configuration mode. To restore the default value, use the no form of this command.
stopbits {1 | 1.5 | 2}
no stopbits
Syntax Description
Defaults
2 stop bits per byte
Command Modes
Line configuration
Command History
Usage Guidelines
Communication protocols provided by devices such as terminals and modems often require a specific stop-bit setting.
Examples
In the following example, the stop bits transmitted per byte are changed from the default of two stop bits to one stop bit as a performance enhancement for line 4:
Router(config)# line 4Router(config-line)# stopbits 1Related Commands
terminal stopbits
Changes the number of stop bits sent per byte by the current terminal line during an active session.
tag
To create a user-specified identifier for an Service Assurance Agent (SAA) operation, use the tag command in SAA RTR configuration mode. To remove a tag from an operation, use the no form of this command.
tag text
no tag
Syntax Description
Defaults
No operations are tagged.
Command Modes
SAA RTR configuration
Command History
Usage Guidelines
An operation tag is normally used to logically link operations in a group
Tags can be used to support automation (for example, by using the same tag for two different operations on two different routers echoing the same target).
Examples
In the following example, operation 1 is tagged with the label bluebell:
Router(config)# rtr 1Router(config-rtr)# type echo protocol ipIcmpEcho 172.16.1.176Router(config-rtr)# tag bluebellRelated Commands
template (cns)
To specify a list of Cisco Networking Services (CNS) connect templates within a CNS connect profile to be applied to a router's configuration, use the template command in CNS connect configuration mode. To disable this CNS connect template, use the no form of this command.
template name [...name]
no template name [...name]
Syntax Description
Defaults
No CNS connect templates are specified.
Command Modes
CNS connect configuration
Command History
12.3(2)XF
This command was introduced.
12.3(8)T
This command was integrated into Cisco IOS Release 12.3(8)T.
12.3(9)
This command was integrated into Cisco IOS Release 12.3(9).
Usage Guidelines
First use the cns connect command to enter CNS connect configuration mode and define the parameters of a CNS connect profile for connecting to the CNS configuration engine. Then use the following CNS connect commands to create a CNS connect profile:
•
discover
•
A CNS connect profile specifies the discover commands and associated template commands that are to be applied to a router's configuration. The template command specifies the list of CNS connect templates that is to be applied to a router's configuration. The templates in the list are applied one at a time. That is, when the template command is processed, the first template in the list is applied to the router's configuration. The router then tries to ping the CNS configuration engine. If the ping fails, then the first template in the list is removed from the router's configuration and the second template in the list is applied and so on.
The configuration mode in which the CNS connect templates are applied is specified by the immediately preceding discover command. (If there are no preceding discover commands, the templates are applied in global configuration mode.) When multiple discover and template commands are configured in a CNS connect profile, they are processed in the order in which they are entered.
Examples
The following example shows how to create a CNS connect profile named profile-1:
Router (config)# cns connect profile-1Router (config-cns-conn)# discover interface SerialRouter (config-cns-conn)# template temp-A1 temp-A2Router (config-cns-conn)# template temp-B1 temp-B2Router (config-cns-conn)# exitRouter (config)#In this example, the following sequence of events occur for all serial interfaces when the cns connect profile-1 command is processed. Assume all ping attempts to the CNS configuration engine are unsuccessful.
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
Related Commands
terminal databits
To change the number of data bits per character for the current terminal line for this session, use the terminal databits command in EXEC mode.
terminal databits {5 | 6 | 7 | 8}
Syntax Description
5
Five data bits per character.
6
Six data bits per character.
7
Seven data bits per character.
8
Eight data bits per character. This is the default.
Defaults
8 data bits per character
Command Modes
EXEC
Command History
Usage Guidelines
Communication protocols provided by devices such as terminals and modems often require a specific data bit setting. The terminal databits command can be used to mask the high bit on input from devices that generate 7 data bits with parity. If parity is being generated, specify 7 data bits per character. If no parity generation is in effect, specify 8 data bits per character. The other keywords (5 and 6) are supplied for compatibility with older devices and are generally not used.
Examples
In the following example, the databits per character is changed to seven for the current session:
Router# terminal databits 7Related Commands
terminal data-character-bits
To set the number of data bits per character that are interpreted and generated by the Cisco IOS software for the current line and session, use the terminal data-character-bits command in EXEC mode.
terminal data-character-bits {7 | 8}
Syntax Description
Defaults
8 data bits per character
Command Modes
EXEC
Command History
Usage Guidelines
This command is used primarily to strip parity from X.25 connections on routers with the protocol translation software option. The terminal data-character-bits command does not work on hard-wired lines.
Examples
The following example sets the data bits per character to seven on the current line:
Router# terminal data-character-bits 7Related Commands
data-character-bits
Sets the number of data bits per character that are interpreted and generated by the Cisco IOS software.
terminal dispatch-character
To define a character that causes a packet to be sent for the current session, use the terminal dispatch-character command in EXEC mode.
terminal dispatch-character ascii-number [ascii-number2 . . . ascii-number]
Syntax Description
Command Modes
EXEC
Command History
Usage Guidelines
At times, you might want to queue up a string of characters until they fill a complete packet and then transmit the packet to a remote host. This can make more efficient use of a line, because the access server or router normally dispatches each character as it is entered.
Examples
The following example defines the characters Ctrl-D (ASCII decimal character 4) and Ctrl-Y (ASCII decimal character 25) as the dispatch characters:
Router# terminal dispatch-character 4 25Related Commands
terminal dispatch-timeout
To set the character dispatch timer for the current terminal line for the current session, use the terminal dispatch-timeout command in EXEC mode.
terminal dispatch-timeout milliseconds
Syntax Description
Command Modes
EXEC
Command History
Usage Guidelines
Use this command to increase the processing efficiency of the remote host.
The dispatch-timeout line configuration command causes the software to buffer characters into packets for transmission to the remote host. The Cisco IOS software sends a packet a specified amount of time after the first character is put into the buffer. You can use the terminal dispatch-timeout and terminal dispatch-character line configuration commands together. In this case, the software dispatches a packet each time the dispatch character is entered, or after the specified dispatch timeout interval, depending on which condition is met first.
Note
Examples
In the following example, the dispatch timeout timer is set to 80 milliseconds:
Router# terminal dispatch-timeout 80Related Commands
dispatch-timeout
Sets the character dispatch timer for a specified line or group of lines.
terminal download
To temporarily set the ability of a line to act as a transparent pipe for file transfers for the current session, use the terminal download command in EXEC mode.
terminal download
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
EXEC
Command History
Usage Guidelines
You can use this feature to run a program such as KERMIT, XMODEM, or CrossTalk that downloads a file across an access server or router line. This command configures the terminal line to send data and is equivalent to entering all the following commands:
•
•
•
•
•
•
•
Examples
The following example configures a line to act as a transparent pipe:
Router# terminal downloadterminal editing
To reenable the enhanced editing mode for only the current terminal session, use the terminal editing command in EXEC mode. 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
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 document.
Examples
In the following example, enhanced editing mode is reenabled for only the current terminal session:
Router> terminal editingRelated Commands
terminal escape-character
To set the escape character for the current terminal line for the current session, use the terminal escape-character command in EXEC mode.
terminal escape-character ascii-number
Syntax Description
ascii-number
ASCII decimal representation of the escape character or control sequence (for example, Ctrl-P ).
Defaults
Ctrl-^ (Ctrl-Shift-6)
Command Modes
EXEC
Command History
Usage Guidelines
See the "ASCII Character Set and Hexidecimal Values" appendix for a list of ASCII characters and their numerical representation.
This command is useful, for example, if you have the default escape character defined for a different purpose in your keyboard file. Entering the escape character followed by the X key returns you to EXEC mode when you are connected to another computer.
Note
Examples
In the following example, the escape character to Ctrl-P (ASCII decimal character 16) for the current session:
Router# terminal escape-character 16Related Commands
terminal exec-character-bits
To locally change the ASCII character set used in EXEC and configuration command characters for the current session, use the terminal exec-character-bits command in EXEC mode.
terminal exec-character-bits {7 | 8}
Syntax Description
7
Selects the 7-bit ASCII character set. This is the default.
8
Selects the full 8-bit character set.
Defaults
7-bit ASCII character set (unless set otherwise in global configuration mode)
Command Modes
EXEC
Command History
Usage Guidelines
This EXEC command overrides the default-value exec-character-bits global configuration command. Configuring the EXEC character width to 8 bits enables you to view special graphical and international characters in banners, prompts, and so on.
When the user exits the session, the character width is reset to the default value established by the exec-character-bits global configuration command. However, setting the EXEC character width to 8 bits can also cause failures. For example, if a user on a terminal that is sending parity enters the help command, an "unrecognized command" message appears because the system is reading all 8 bits, and the eighth bit is not needed for the help command.
Examples
The following example temporarily configures the system to use a full 8-bit user interface for system banners and prompts, allowing the use of additional graphical and international characters:
Router# terminal exec-character-bits 8Related Commands
exec-character-bits
Configures the character widths of EXEC and configuration command characters.
terminal flowcontrol
To set flow control for the current terminal line for the current session, use the terminal flowcontrol command in EXEC mode.
terminal flowcontrol {none | software [in | out] | hardware}
Syntax Description
Command Modes
EXEC
Command History
Usage Guidelines
Flow control enables you to regulate the rate at which data can be transmitted from one point so that it is equal to the rate at which it can be received at another point. Flow control protects against loss of data because the terminal is not capable of receiving data at the rate it is being sent. You can set up data flow control for the current terminal line in one of two ways: software flow control, which you do with control key sequences, and hardware flow control, which you do at the device level.
For software flow control, the default stop and start characters are Ctrl-S and Ctrl-Q (XOFF and XON). You can change them with the terminal stop-character and terminal start-character EXEC commands.
Examples
In the following example, incoming software flow control is set for the current session:
Router# terminal flowcontrol software inRelated Commands
flowcontrol
Sets the method of data flow control between the terminal or other serial device and the router.
terminal full-help
To get help for the full set of user-level commands, use the terminal full-help command in EXEC mode.
terminal full-help
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
EXEC
Command History
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:
Router> show ?bootflash Boot Flash informationcalendar Display the hardware calendarclock Display the system clockcontext Show context informationdialer Dialer parameters and statisticshistory Display the session command historyhosts IP domain-name, lookup style, nameservers, and host tableisdn ISDN informationkerberos Show Kerberos Valuesmodemcap Show Modem Capabilities databaseppp PPP parameters and statisticsrmon rmon statisticssessions Information about Telnet connectionssnmp snmp statisticsterminal Display terminal configuration parametersusers Display information about terminal linesversion System hardware and software statusRouter> terminal full-helpRouter> show ?access-expression List access expressionaccess-lists List access listsaliases Display alias commandsapollo Apollo network informationappletalk AppleTalk informationarp ARP tableasync Information on terminal lines used as router interfacesbootflash Boot Flash informationbridge Bridge Forwarding/Filtering Database [verbose]bsc BSC interface informationbstun BSTUN interface informationbuffers Buffer pool statisticscalendar Display the hardware calendarcdp CDP informationclns CLNS network informationclock Display the system clockcls DLC user informationcmns Connection-Mode networking services (CMNS) informationcompress Show compression statistics....x25 X.25 informationxns XNS informationxremote XRemote statisticsRelated Commands
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 function with 10 lines for the current terminal session, use the terminal history command in user EXEC or privileged EXEC mode. To disable the command history function, 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
User EXEC
Privileged EXEC
Command History
Usage Guidelines
The history function provides a record of commands you have entered. This function 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 function with the default buffer size or the last buffer size specified using the terminal history size command.
Table 127 lists the keys and functions you can use to recall commands from the history buffer.
Table 127 History Keys
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.
1 The arrow keys function only with ANSI-compatible terminals.
Examples
In the following example, the command history feature is disabled for the current terminal session:
Router> terminal no historyRelated Commands
terminal history size
To change the size of the command history buffer for the current terminal session, use the terminal history size command in EXEC mode. 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
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 128 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 128 History Keys
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.
1 The arrow keys function only with ANSI-compatible terminals.
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 15Router# show usersLine 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 EditingEditing is enabled.! the following line shows the history settings for the lineHistory is enabled, history size is 15.DNS resolution in show commands is enabledFull user help is disabledAllowed transports are telnet. Preferred is none.No output characters are paddedNo special data dispatching charactersRelated Commands
terminal hold-character
To define the hold character for the current session, use the terminal hold-character command in EXEC mode. To return the hold character definition to the default, use the no form of this command.
terminal hold-character ascii-number
terminal no hold-character
Syntax Description
Defaults
The default hold character is defined by the hold-character global configuration command.
Command Modes
EXEC
Command History
Usage Guidelines
You can define a local hold character that temporarily suspends the flow of output on the terminal. When information is scrolling too quickly, you can enter the hold character to pause the screen output, then enter any other character to resume the flow of output.
You cannot suspend output on the console terminal. To send the hold character to the host, precede it with the escape character.
Examples
In the following example, the hold character for the current (local) session is set to Ctrl-P. The show terminal output is included to show the verification of the setting (the value for the hold character is shown in the "Special Characters" listing).
Router# terminal hold-character 16"^P" is the local hold characterRouter# show terminalLine 50, Location: "", Type: "VT220"Length: 24 lines, Width: 80 columnsBaud rate (TX/RX) is 9600/9600Status: PSI Enabled, Ready, Active, No Exit Banner, Automore OnCapabilities: noneModem state: ReadyGroup codes: 0Special Chars: Escape Hold Stop Start Disconnect Activation^^x ^P - - noneTimeouts: Idle EXEC Idle Session Modem Answer Session Dispatch00:10:00 never none not setIdle Session Disconnect WarningneverLogin-sequence User Response00:00:30Autoselect Initial Waitnot setModem type is unknown.Session limit is not set.Time since activation: 00:04:13Editing is enabled.History is enabled, history size is 10....Related Commands
hold-character
Defines the local hold character used to pause output to the terminal screen.
show terminal
Displays settings for terminal operating characteristics.
terminal international
If you are using Telnet to access a Cisco IOS platform and you want to display 8-bit and multibyte international characters (for example, Kanji) and print the Escape character as a single character instead of as the caret and bracket symbols (^[) for a current Telnet session, use the terminal international command in user EXEC or priviledged mode. To display characters in 7-bit format for a current Telnet session, use the no form of this command.
terminal international
no terminal international
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
User EXEC
Privileged EXEC
Command History
Usage Guidelines
If you are configuring a Cisco IOS platform using the Cisco web browser UI, this feature is enabled automatically when you enable the Cisco web browser UI using the ip http server global configuration command.
Examples
The following example enables a Cisco IOS platform to display 8-bit and multibyte characters and print the Escape character as a single character instead of as the caret and bracket symbols (^[) when you are using Telnet to access the platform for the current Telnet session:
Router# terminal internationalRelated Commands
terminal keymap-type
To specify the current keyboard type for the current session, use the terminal keymap-type command in EXEC mode.
terminal keymap-type keymap-name
Syntax Description
Defaults
VT100
Command Modes
EXEC
Command History
Usage Guidelines
You must use this command when you are using a keyboard other than the default of VT100.
Examples
The following example specifies a VT220 keyboard as the current keyboard type:
Router# terminal keymap-type vt220Related Commands
terminal length
To set the number of lines on the current terminal screen for the current session, use the terminal length command in EXEC mode.
terminal length screen-length
Syntax Description
screen-length
Number of lines on the screen. A value of zero disables pausing between screens of output.
Defaults
24 lines
Command Modes
EXEC
Command History
Usage Guidelines
The system uses the length value to determine when to pause during multiple-screen output. A value of zero prevents the router from pausing between screens of output.
Some types of terminal sessions do not require you to specify the screen length because the screen length specified can be learned by some remote hosts. For example, the rlogin protocol uses the screen length to set up terminal parameters on a remote UNIX host.
Examples
In the following example, the system is configured to prevent output from pausing if it exceeds the length of the screen:
Router# terminal length 0Related Commands
terminal monitor
To display debug command output and system error messages for the current terminal and session, use the terminal monitor command in EXEC mode.
terminal monitor
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
EXEC
Command History
Usage Guidelines
Remember that all terminal parameter-setting commands are set locally and do not remain in effect after a session is ended.
Examples
In the following example, the system is configured to display debug command output and error messages during the current terminal session:
Router# terminal monitorterminal notify
To enable terminal notification about pending output from other Telnet connections for the current session, use the terminal notify command in EXEC mode. To disable notifications for the current session, use the no form of this command.
terminal notify
terminal no notify
Syntax Description
This command has no arguments or keywords.
Command Modes
EXEC
Command History
Usage Guidelines
Enabling notifications may be useful if, for example, you want to know when another connection receives mail, or when a process has been completed.
This command enables or disables notifications for only the current session. To globally set these notifications, use the notify line configuration command.
Examples
In the following example, notifications will be displayed to inform the user when output is pending on another connection:
Router# terminal notifyRelated Commands
notify
Enables terminal notification about pending output from other Telnet connections.
terminal padding
To change the character padding on a specific output character for the current session, use the terminal padding command in EXEC mode.
terminal padding
