-
Cisco IOS Configuration Fundamentals Command Reference
-
Introduction
-
A through B
-
C commands
-
D through E
-
F through K
-
L through mode
-
monitor event-trace through Q
-
R through setup
-
show through show fm summary
-
show gsr through showmon
-
slave auto-sync config through terminal-type
-
test cable-diagnostics through xmodem
-
ASCII Character Set and Hexadecimal Values
-
Table Of Contents
default-value exec-character-bits
default-value special-character-bits
environment-monitor shutdown temperature
environment temperature-controlled
databits
To set the number of data bits per character that are interpreted and generated by the router hardware, use the databits command in line configuration mode. To restore the default value, use the no form of the command.
databits {5 | 6 | 7 | 8}
no databits
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
Eight data bits per character
Command Modes
Line configuration
Command History
10.0
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
The databits line configuration 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 are supplied for compatibility with older devices and generally are not used.
Examples
The following example sets the number of data bits per character to seven on line 4:
Router(config)# line 4Router(config-line)# databits 7Related Commands
data-character-bits
To set the number of data bits per character that are interpreted and generated by the Cisco IOS software, use the data-character-bits command in line configuration mode. To restore the default value, use the no form of this command.
data-character-bits {7 | 8}
no data-character-bits
Syntax Description
Defaults
Eight data bits per character
Command Modes
Line configuration
Command History
10.0
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
The data-character-bits line configuration command is used primarily to strip parity from X.25 connections on routers with the protocol translation software option. The data-character-bits line configuration command does not work on hard-wired lines.
Examples
The following example sets the number of data bits per character to seven on virtual terminal line (vty) 1:
Router(config)# line vty 1Router(config-line)# data-character-bits 7Related Commands
terminal data-character-bits
Sets the number of data bits per character that are interpreted and generated by the Cisco IOS software for the current line and session.
default-value exec-character-bits
To define the EXEC character width for either 7 bits or 8 bits, use the default-value exec-character-bits command in global configuration mode. To restore the default value, use the no form of this command.
default-value exec-character-bits {7 | 8}
no default-value exec-character-bits
Syntax Description
7
Selects the 7-bit ASCII character set. This is the default.
8
Selects the full 8-bit ASCII character set.
Defaults
7-bit ASCII character set
Command Modes
Global configuration
Command History
10.0
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
Configuring the EXEC character width to 8 bits allows you to add graphical and international characters in banners, prompts, and so on. However, setting the EXEC character width to 8 bits can also cause failures. 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, although the eighth bit is not needed for the help command.
Examples
The following example selects the full 8-bit ASCII character set for EXEC banners and prompts:
Router(config)# default-value exec-character-bits 8Related Commands
default-value special-character-bits
To configure the flow control default value from a 7-bit width to an 8-bit width, use the default-value special-character-bits command in global configuration mode. To restore the default value, use the no form of this command.
default-value special-character-bits {7 | 8}
no default-value special-character-bits
Syntax Description
Defaults
7-bit character set
Command Modes
Global configuration
Command History
10.0
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
Configuring the special character width to 8 bits allows you to add graphical and international characters in banners, prompts, and so on.
Examples
The following example selects the full 8-bit special character set:
Router(config)# default-value special-character-bits 8Related Commands
define interface-range
To create an interface-range macro, use the define interface-range command in global configuration mode.
define interface-range macro-name interface-range
Syntax Description
Defaults
This command has no default settings.
Command Modes
Global configuration
Command History
Usage Guidelines
The macro name is a 32-character maximum character string.
Amn interface range for a macro can contain up to five ranges. An interface range cannot span slots. Use this format when entering the interface-range:
•
interface-type slot/first-interface - last-interface
Valid values for card-type are as follows:
•
•
•
•
•
•
•
•
•
•
•
Examples
This example shows how to create a multiple-interface macro:
Router(config)# define interface-range macro1 ethernet 1/2 - 5, fastethernet 5/5 - 10Router(config)#Related Commands
delete
To delete a file on a Flash memory device or NVRAM, use the delete command in EXEC, privileged EXEC, or diagnostic mode.
delete url [/force | /recursive]
Syntax Description
url
Cisco IOS File System URL of the file to be deleted. Include the file system prefix, followed by a colon, and, optionally, the name of a file or directory. See Table 27 for list of supported URLs.
/force
(Optional) Deletes the specified file or directory without prompting you for verification.
Note
/recursive
(Optional) Deletes all files in the specified directory, as well as the directory itself.
Command Modes
EXEC (>)
Privileged EXEC (#)
Diagnostic (diag)
Command History
Usage Guidelines
If you attempt to delete the configuration file or image specified by the CONFIG_FILE or BOOTLDR environment variable, the system prompts you to confirm the deletion. Also, if you attempt to delete the last valid system image specified in the BOOT environment variable, the system prompts you to confirm the deletion.
When you delete a file in Flash memory, the software simply marks the file as deleted, but it does not erase the file. To later recover a "deleted" file in Flash memory, use the undelete EXEC command. You can delete and undelete a file up to 15 times.
To permanently delete all files marked "deleted" on a linear Flash memory device, use the squeeze EXEC command.
Table 27 contains a list of Cisco IOS File System URLs.
Examples
The following example deletes the file named test from the Flash card inserted in slot 0:
Router# delete slot0:testDelete slot0:test? [confirm]Related Commands
diag
To perform field diagnostics on a line card, on the Gigabit Route Processor (GRP), on the Switch Fabric Cards (SFCs), and on the Clock Scheduler Card (CSC) in Cisco 12000 series Gigabit Switch Routers (GSRs), use the diag command in privileged EXEC mode. To disable field diagnostics on a line card, use the no form of this command.
diag slot-number [halt | previous | post | verbose [wait] | wait]
no diag slot-number
Syntax Description
Defaults
No field diagnostics tests are performed on the line card.
Command Modes
Privileged EXEC
Command History
11.2 GS
This command was introduced to support the Cisco 12000 series GSR.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
The diag command must be executed from the GRP main console port.
Perform diagnostics on the CSC only if a redundant CSC is in the router.
Diagnostics will stop and ask you for confirmation before altering the router's configuration. For example, running diagnostics on a SFC or CSC will cause the fabric to go from full bandwidth to one-fourth bandwidth. Bandwidth is not affected by GRP or line card diagnostics.
The field diagnostic software image is bundled with the Cisco IOS software and is downloaded automatically from the GRP to the target line card prior to testing.
Caution
In normal mode, if a test fails, the title of the failed test is displayed on the console. However, not all tests that are performed are displayed. To view all the tests that are performed, use the verbose keyword.
After all diagnostic tests are completed on the line card, a PASSED or TEST FAILURE message is displayed. If the line card sends a PASSED message, the Cisco IOS software image on the line card is automatically reloaded unless the wait keyword is specified. If the line card sends a TEST FAILURE message, the Cisco IOS software image on the line card is not automatically reloaded.
If you want to reload the line card after it fails diagnostic testing, use the microcode reload slot global configuration command.
Note
If the line card fails the test, the line card is defective and should be replaced. In future releases this might not be the case because DRAM and SDRAM SIMM modules might be field replaceable units. For example, if the DRAM test failed you might only need to replace the DRAM on the line card.
For more information, refer to the Cisco 12000 series installation and configuration guides.
Examples
In the following example, a user is shown the output when field diagnostics are performed on the line card in slot 3. After the line card passes all field diagnostic tests, the Cisco IOS software is automatically reloaded on the card. Before starting the diagnostic tests, you must confirm the request to perform these tests on the line card because all activity on the line card is halted. The total/indiv. timeout set to 600/220 sec. message indicates that 600 seconds are allowed to perform all field diagnostics tests, and that no single test should exceed 220 seconds to complete.
Router# diag 3Running Diags will halt ALL activity on the requested slot. [confirm]Router#Launching a Field Diagnostic for slot 3Running DIAG config checkRUNNING DIAG download to slot 3 (timeout set to 400 sec.)sending cmd FDIAG-DO ALL to fdiag in slot 3(total/indiv. timeout set to 600/220 sec.)Field Diagnostic ****PASSED**** for slot 3Field Diag eeprom values: run 159 fial mode 0 (PASS) slot 3last test failed was 0, error code 0sending SHUTDOWN FDIAG_QUIT to fdiag in slot 3Board will reload...Router#In the following example, a user is shown the output when field diagnostics are performed on the line card in slot 3 in verbose mode:
Router# diag 3 verboseRunning Diags will halt ALL activity on the requested slot. [confirm]Router#Launching a Field Diagnostic for slot 3Running DIAG config checkRUNNING DIAG download to slot 3 (timeout set to 400 sec.)sending cmd FDIAG-DO ALL to fdiag in slot 3(total/indiv. timeout set to 600/220 sec.)FDIAG_STAT_IN_PROGRESS: test #1 R5K Internal CacheFDIAG_STAT_PASS test_num 1FDIAG_STAT_IN_PROGRESS: test #2 Sunblock OrderingFDIAG_STAT_PASS test_num 2FDIAG_STAT_IN_PROGRESS: test #3 Dram DatapinsFDIAG_STAT_PASS test_num 3...Field Diags: FDIAG_STAT_DONEField Diagnostic ****PASSED**** for slot 3Field Diag eeprom values: run 159 fial mode 0 (PASS) slot 3last test failed was 0, error code 0sending SHUTDOWN FDIAG_QUIT to fdiag in slot 3Board will reload...Router#Related Commands
diagnostic bootup level
To set the bootup diagnostic level, use the diagnostic bootup level command in global configuration mode. To skip all diagnostic tests, use the no form of this command.
diagnostic bootup level {minimal | complete}
no diagnostic bootup level
Syntax Description
Defaults
minimal
Command Modes
Global configuration
Command History
Usage Guidelines
Setting the diagnostic level determines the level of testing that occurs when the system or module is reset. The two levels are as follows:
•
•
Note
In certain circumstances, you might want to skip the bootup online diagnostics completely. For example, you might skip the bootup online diagnostics to verify that a port is as bad as online diagnostics reports. To skip online diagnostic testing completely, enter the no diagnostic bootup level command.
For information on the diagnostic test types, see the show diagnostic command.
The new level takes effect at the next reload or the next time that an online insertion and removal is performed.
Examples
This example shows how to set the bootup diagnostic level:
Router(config)# diagnostic bootup level completeRouter(config)#Related Commands
show diagnostic bootup level
Displays the coverage level for the configured boot-up diagnostics.
diagnostic cns
To configure the Cisco Networking Services (CNS) diagnostics, use the diagnostic cns command in global configuration mode. To disable sending diagnostic results to the CNS event bus., use the no form of this command.
diagnostic cns {publish | subscribe} [subject]
no diagnostic cns {publish | subscribe} [subject]
Syntax Description
Defaults
This command has no default settings.
Command Modes
Global configuration
Command History
Usage Guidelines
The online diagnostics receive events by subscribing to an event subject name. The subject is the event that you subscribe (receive) or publish (generate) through the CNS bus.
The diagnostic cns publish command sends diagnostic results to a remote network application to make decisions and take corrective actions that are based on the diagnostic results.
The diagnostic cns subscribe command receives messages from remote network applications to perform diagnostic tests or retrieve diagnostic results.
Examples
This example shows how to enable the publishing of diagnostic results:
Router(config)# diagnostic cns publishRouter(config)#This example shows how to receive messages from remote network applications to perform diagnostic tests or retrieve diagnostic results:
Router(config)# diagnostic cns subscribeRouter(config)#This example shows how to set the default to publish:
Router(config)# default diagnostic cns publishRouter(config)#Related Commands
diagnostic event-log size
To modify the diagnostic event-log size dynamically, use the diagnostic event-log size command in global configuration mode. To return to the default settings, use the no form of this command.
diagnostic event-log size size
no diagnostic event-log size
Syntax Description
Defaults
The size is 500 entries.
Command Modes
Global configuration
Command History
Usage Guidelines
The events are dynamically allocated and stored in a circular queue.
You can enter either the default diagnostic event-log size command or the no diagnostic event-log size command to return to the default settings.
Examples
This example shows how to set the diagnostic event-log size:
Router(config)# diagnostic event-log size 600Router(config)#Related Commands
diagnostic level
To turn on power-on diagnostic tests for the network service engines (NSEs) installed in a Cisco 7300 series router, use the diagnostic level command in privileged EXEC configuration mode. There is no no form of this command.
diagnostic level {power-on | bypass}
Syntax Description
power-on
Power-on diagnostic tests are performed at system bootup on the NSEs.
bypass
No diagnostic tests are performed. This is the default.
Defaults
No diagnostic tests are performed.
Command Modes
Privileged EXEC
Command History
Usage Guidelines
Use this command to enable power-on diagnostic tests to run on the installed NSEs of a Cisco 7300 series router when the system is booted. It is recommended that you issue this command only if you are experiencing problems with an NSE and are planning on rebooting the router. Issuing this command causes an increase in the boot time.
Examples
The following example shows how to enable diagnostic power-on tests:
diagnostic level power-onThe following sample output shows the output that is displayed upon system bootup after a power cycle or router crash:
...System Power On DiagnosticsDRAM Size ....................128 MBTesting DRAM..................PassedLevel2 Cache .................PresentTesting Level2 Cache (256 KB)PassedLevel3 Cache .................PresentTesting Level3 Cache (1024 KB)PassedSystem Power On Diagnostics Complete
Note
Related Commands
diagnostic monitor
To configure the health-monitoring diagnostic testing, use the diagnostic monitor command in global configuration mode. To disable testing, use the no form of this command.
diagnostic monitor interval {module num} test {test-id | test-id-range | all} [hour hh] [min mm] [second ss] [millisec ms] [day day]
diagnostic monitor syslog
diagnostic monitor {module num} test {test-id | test-id-range | all}
no diagnostic monitor {interval | syslog}
Syntax Description
Defaults
The defaults are as follows:
•
•
•
Command Modes
Global configuration
Command History
Usage Guidelines
Use these guidelines when scheduling testing:
•
•
•
•
•
•
•
Enter the [no] diagnostic monitor test {test-id | test-id-range | all} command to enable or disable the specified health monitoring test.
When entering the diagnostic monitor {module num} test {test-id | test-id-range | all} command, observe the following:
•
–
–
–
•
–
–
The FIB TCAM test for central PFC3BXL or PFC3B (on the supervisor engine) takes approximately 4 hours and 30 minutes.
The FIB TCAM test for the distributed PFC3BXL or PFC3B (on the DFC module) takes approximately 16 hours.
You can run the FIB TCAM test on multiple DFC3BX modules simultaneously.
Examples
This example shows how to run the specified test every 3 days, 10 hours, and 2 minutes:
Router(config)# diagnostic monitor interval module 1 test 1 day 3 hours 10 min 2Router(config)#This example shows how to enable the generation of a syslog message when any health-monitoring test fails:
Router(config)# diagnostic monitor syslogRouter(config)#Related Commands
show diagnostic content
Displays test information including test ID, test attributes, and supported coverage test levels for each test and for all modules.
diagnostic ondemand
To configure the on-demand diagnostics, use the diagnostic ondemand command in privileged EXEC mode.
diagnostic ondemand {iteration iteration-count | action-on-failure {continue error-count | stop}}
Syntax Description
Defaults
The default settings are as follows:
•
•
•
Command Modes
Privileged EXEC
Command History
Usage Guidelines
Entering 0 for the error-count sets the number of errors that are allowed to unlimited.
Examples
This example shows how to set the ondemand testing iteration count:
Router# diagnostic ondemand iteration 4Router#This example shows how to set the execution action when an error is detected:
Router# diagnostic ondemand action-on-failure continue 2Router#Related Commands
diagnostic schedule test
To set the scheduling of test-based diagnostic testing for a specific module or schedule a supervisor engine switchover, use the diagnostic schedule test command in global configuration mode. To remove the scheduling, use the no form of this command.
diagnostic schedule module {num | active-sup-slot} test {test-id | test-id-range | all} [port {num | num-range | all}] {on mm dd yyyy hh:mm | daily hh:mm} | weekly day-of-week hh:mm}
no diagnostic schedule test
Syntax Description
Defaults
This command has no default settings.
Command Modes
Global configuration
Command History
Usage Guidelines
Use these guidelines when scheduling testing:
•
•
•
•
•
•
•
•
•
Enter the show diagnostic content command to display the test ID list.
You can use the diagnostic schedule module active-sup-slot test test-id command to schedule a switchover from the active supervisor engine to the standby supervisor engine.
Enter the show diagnostic content active-sup-slot command to display the test ID list and look for the test ID in the ScheduleSwitchover field.
You can specify a periodic switchover (daily or weekly) or a single switchover occurrence at a specific time using these commands:
•
•
•
Note
Examples
This example shows how to schedule the diagnostic testing on a specific date and time for a specific module and port:
Router(config)# diagnostic schedule module 1 test 1,2,5-9 port 3 on january 3 2003 23:32Router(config)#This example shows how to schedule the diagnostic testing to occur daily at a certain time for a specific port and module:
Router(config)# diagnostic schedule module 1 test 1,2,5-9 port 3 daily 12:34Router(config)#This example shows how to schedule the diagnostic testing to occur weekly on a certain day for a specific port and module:
Router(config)# diagnostic schedule module 1 test 1,2,5-9 port 3 weekly friday 09:23Router(config)#This example shows how to schedule a switchover for the active supervisor engine every Friday at 10:00 pm, and switch the standby supervisor engine back to the active supervisor engine 10 minutes after the switchover occurs. For this example, these conditions apply:
•
•
•
Related Commands
diagnostic start
To run the specified diagnostic test, use the diagnostic start command in privileged EXEC mode.
diagnostic start module num test {test-id | test-id-range | minimal | complete | basic | per-port | non-disruptive | all} [port {num | port#-range | all}]
diagnostic start system test all
Syntax Description
Defaults
This command has no default settings.
Command Modes
Privileged EXEC
Command History
Usage Guidelines
Note
Do not insert, remove, or power down line cards or the supervisor while the system test is running.
Do not issue any diagnostic command other than the diagnostic stop system test all command while the system test is running.
Make sure no traffic is running in background.
Note
Enter the show diagnostic content command to display the test ID list.
Enter the test-id-range or port#-range as integers separated by a comma and a hyphen (for example, 1,3-6 specifies test IDs 1, 3, 4, 5, and 6).
Use diagnostic stop command to stop the testing process.
Examples
This example shows how to run the specified diagnostic test at the specified slot:
Router# diagnostic start module 1 test 5Module 1:Running test(s) 5 may disrupt normal system operationDo you want to run disruptive tests? [no] yes00:48:14:Running OnDemand Diagnostics [Iteration #1] ...00:48:14:%DIAG-SP-6-TEST_RUNNING:Module 1:Running TestNewLearn{ID=5} ...00:48:14:%DIAG-SP-6-TEST_OK:Module 1:TestNewLearn{ID=5} has completed successfully00:48:14:Running OnDemand Diagnostics [Iteration #2] ...00:48:14:%DIAG-SP-6-TEST_RUNNING:Module 1:Running TestNewLearn{ID=5} ...00:48:14:%DIAG-SP-6-TEST_OK:Module 1:TestNewLearn{ID=5} has completed successfullyRouter#This example shows how to start all online diagnostic tests:
Router# diagnostic start system test all************************************************************************** WARNING: ** 'diagnostic start system test all' will disrupt normal system ** operation. The system requires RESET after the command ** 'diagnostic start system test all' has completed prior to ** normal use. ** ** IMPORTANT: ** 1. DO NOT INSERT, OIR, or POWER DOWN Linecards or ** Supervisor while system test is running. ** ** 2. DO NOT ISSUE ANY DIAGNOSTIC COMMAND except ** "diagnostic stop system test all" while system test ** is running. ** ** 3. PLEASE MAKE SURE no traffic is running in background. **************************************************************************Do you want to continue? [no]:Related Commands
diagnostic stop
Stops the testing process.
show diagnostic
Displays the test results of the online diagnostics and lists the supported test suites.
diagnostic stop
To stop the testing process, use the diagnostic stop command in privileged EXEC mode.
diagnostic stop module num
Syntax Description
Defaults
This command has no default settings.
Command Modes
Privileged EXEC
Command History
Usage Guidelines
Use the diagnostic start command to start the testing process.
Examples
This example shows how to stop the diagnostic test process:
Router# diagnostic stop module 3Router#Related Commands
diagnostic start
Runs the testing process.
show diagnostic
Displays the test results of the online diagnostics and lists the supported test suites.
dir
To display a list of files on a file system, use the dir command in EXEC, privileged EXEC, or diagnostic mode.
dir [/all] [/recursive] [all-filesystems] [filesystem:][file-url]
Syntax Description
Defaults
The default file system is specified by the cd command. When you omit the /all keyword, the Cisco IOS software displays only undeleted files.
Command Modes
EXEC (>)
Privileged EXEC (#)
Diagnostic (diag)Command History
Usage Guidelines
Use the show (flash file system) command to display more detail about the files in a particular file system.
Examples
The following is sample output from the dir command:
Router# dir slot0:Directory of slot0:/1 -rw- 4720148 Dec 29 2003 17:49:36 -08:00 hampton/nitro/c7200-j-mz2 -rw- 4767328 Jan 02 2004 18:42:53 -08:00 c7200-js-mz5 -rw- 639 Jan 03 2004 12:09:32 -08:00 rally7 -rw- 639 Jan 03 2004 12:37:13 -08:00 the_time20578304 bytes total (3104544 bytes free)Router# dir /all slot0:Directory of slot0:/1 -rw- 4720148 Dec 15 2003 17:49:36 -08:00 hampton/nitro/c7200-j-mz2 -rw- 4767328 Jan 02 2004 18:42:53 -08:00 c7200-js-mz3 -rw- 7982828 Jan 02 2004 18:48:14 -08:00 [rsp-jsv-mz]4 -rw- 639 Jan 03 2004 12:09:17 -08:00 the_time]5 -rw- 639 Jan 03 1994 12:09:32 -08:00 rally6 -rw- 639 Jan 03 1994 12:37:01 -08:00 [the_time]7 -rw- 639 Jan 03 1994 12:37:13 -08:00Table 28 describes the significant fields shown in the output.
Related Commands
disable
To exit privileged EXEC mode and return to user EXEC mode, or to exit to a lower privilege level, enter the disable command in EXEC, privileged EXEC, or diagnostic mode.
disable [privilege-level]
Syntax Description
Command Modes
EXEC (>)
Privileged EXEC (#)
Diagnostic (diag)Command History
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
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 #.
Router> enablePassword: <letmein>Router# disableRouter>Related Commands
disconnect-character
To define a character to disconnect a session, use the disconnect-character command in line configuration mode. To remove the disconnect character, use the no form of this command.
disconnect-character ascii-number
no disconnect-character
Syntax Description
Defaults
No disconnect character is defined.
Command Modes
Line configuration
Command History
10.0
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
See the "ASCII Character Set and Hex Values" appendix for a list of ASCII characters.
The Break character is represented by zero; NULL cannot be represented.
To use the session-disconnect character in normal communications, precede it with the escape character.
Examples
The following example defines the disconnect character for virtual terminal line 4 as Escape, which is decimal character 27:
Router(config)# line vty 4Router(config-line)# disconnect-character 27dispatch-character
To define a character that causes a packet to be sent, use the dispatch-character command in line configuration mode. To remove the definition of the specified dispatch character, use the no form of this command.
dispatch-character ascii-number1 [ascii-number2 . . . ascii-number]
no dispatch-character ascii-number1 [ascii-number2 . . . ascii-number]
Syntax Description
Defaults
No dispatch character is defined.
Command Modes
Line configuration
Command History
10.0
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
See the "ASCII Character Set and Hex Values" appendix for a list of ASCII characters.
The dispatch-character command defines one or more dispatch characters that cause a packet to be sent even if the dispatch timer has not expired. Use of a dispatch character causes the Cisco IOS software to attempt to buffer characters into larger-sized packets for transmission to the remote host.
Enable the dispatch-character command from the session that initiates the connection, not from the incoming side of a streaming Telnet session.
This command can take multiple arguments, so you can define any number of characters as dispatch characters.
Examples
The following example defines the Return character (decimal 13) as the dispatch character for virtual terminal line (vty) line 4:
Router(config)# line vty 4Router(config-line)# dispatch-character 13Related Commands
dispatch-machine
To specify an identifier for a TCP packet dispatch state machine on a particular line, use the dispatch-machine command in line configuration mode. To disable a state machine on a particular line, use the no form of this command.
dispatch-machine name
no dispatch-machine
Syntax Description
Defaults
No dispatch state machine identifier is defined.
Command Modes
Line configuration
Command History
10.0
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
When the dispatch-timeout command is specified, a packet being built will be sent when the timer expires, and the state will be reset to zero.
Any dispatch characters specified using the dispatch-character command are ignored when a state machine is also specified.
If a packet becomes full, it will be sent regardless of the current state, but the state will not be reset. The packet size depends on the traffic level on the asynchronous line and the dispatch-timeout value. There is always room for 60 data bytes. If the dispatch-timeout value is greater than or equal to 100 milliseconds, a packet size of 536 (data bytes) is allocated.
Examples
The following example specifies the name linefeed for the state machine:
Router(config)# state-machine linefeed 0 0 9 0Router(config)# state-machine linefeed 0 11 255 0Router(config)# state-machine linefeed 0 10 10 transmitRouter(config)# line 1Router(config-line)# dispatch-machine linefeedRelated Commands
dispatch-timeout
To set the character dispatch timer, use the dispatch-timeout command in line configuration mode. To remove the timeout definition, use the no form of this command.
dispatch-timeout milliseconds
no dispatch-timeout
Syntax Description
Defaults
No dispatch timeout is defined.
Command Modes
Line configuration
Command History
10.0
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
Use this command to increase the processing efficiency for 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 dispatch-timeout and 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
The following example sets the dispatch timer to 80 milliseconds for virtual terminal line (vty) lines 0 through 4:
Router(config)# line vty 0 4Router(config-line)# dispatch-timeout 80Related Commands
do
To execute user EXEC or privileged EXEC commands from global configuration mode or other configuration modes or submodes, use the do command in any configuration mode.
do command
Syntax Description
Command Default
A user EXEC or privileged EXEC command is not executed from a configuration mode.
Command Modes
All configuration modes
Command History
Usage Guidelines
Use this command to execute user EXEC or privileged EXEC commands (such as show, clear, and debug commands) while configuring your routing device. After the EXEC command is executed, the system will return to the configuration mode you were using.
Tip
Caution
You cannot use the do command to execute the configure terminal command because entering the configure terminal command changes the user EXEC mode or privileged EXEC mode to the global configuration mode.
You cannot use the do command to execute copy or write commands in the global configuration or any other configuration mode or submode.
Examples
The following example shows how to enter the show interfaces serial privileged EXEC command from within global configuration mode:
Router(config)# do show interfaces serial 3/0Serial3/0 is up, line protocol is upHardware is M8T-RS232MTU 1500 bytes, BW 1544 Kbit, DLY 20000 usec, rely 255/255, load 1/255Encapsulation HDLC, loopback not set, keepalive set (10 sec)Last input never, output 1d17h, output hang neverLast clearing of "show interface" counters never...The following example shows how to enter the clear vpdn tunnel user EXEC or privileged EXEC command from within VPDN configuration mode:
Router(config-vpdn)# do clear vpdn tunnelRelated Commands
downward-compatible-config
To generate a configuration that is compatible with an earlier Cisco IOS release, use the downward-compatible-config command in global configuration mode. To disable this function, use the no form of this command.
downward-compatible-config version
no downward-compatible-config
Syntax Description
Defaults
Disabled
Command Modes
Global configuration
Command History
11.1
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
In Cisco IOS Release 10.3, IP access lists changed format. Use the downward-compatible-config command to regenerate a configuration in a format prior to Release 10.3 if you are going to downgrade from your software version to version 10.2 or 10.3. The earliest version value this command accepts is 10.2.
When this command is configured, the router attempts to generate a configuration that is compatible with the specified version. Note that this command affects only IP access lists.
Under some circumstances, the software might not be able to generate a fully backward-compatible configuration. In such a case, the software issues a warning message.
Examples
The following example generates a configuration file compatible with Cisco IOS Release 10.2 access lists:
Router(config)# downward-compatible-config 10.2Related Commands
access-list (extended)
Provides extended access lists that allow more detailed access lists.
access-list (standard)
Defines a standard XNS access list.
editing
To reenable Cisco IOS enhanced editing features for a particular line after they have been disabled, use the editing command in line configuration mode. 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
10.0
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
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 29 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 29), characters are bolded in the "Function Summary" column to indicate the relation between the letter used and the function.
Table 29 Command Editing Keys and Functions
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.
1 The arrow keys function only with ANSI-compatible terminals.
Examples
In the following example, enhanced editing mode is disabled on line 3:
Router(config)# line 3Router(config-line)# no editingRelated Commands
terminal editing
Controls CLI enhanced editing feature for the current terminal session.
enable
To change the privilege level for a CLI session or to use a CLI view for a CLI session, use the enable command in either user EXEC, privileged EXEC, or diagnostic mode.
enable [privilege-level] [view [view-name]]
Syntax Description
Defaults
Privilege-level 15 (privileged EXEC)
Command Modes
User EXEC (>)
Privileged EXEC (#)
Diagnostic Mode (diag)
Command History
Usage Guidelines
By default, using the enable command without the privilege-level argument in user EXEC mode causes the router to enter privileged EXEC mode (privilege-level 15).
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 the password before being allowed access to privileged EXEC mode. The password is case sensitive.
If an enable password has not been set, only enable mode 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 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).
Accessing a CLI View
CLI views restrict user access to specified CLI and configuration information. To configure and access CLI views, users must first enter into root view, which is accomplished via the enable view command (without the view-name argument). Thereafter, users are prompted for a password, which is the same password as the privilege level 15 password.
The view-name argument is used to switch from one view to another view.
To prevent dictionary attacks, a user is prompted for a password even if an incorrect view name is given. The user is denied access only after an incorrect view name and password are given.
Examples
In the following example, the user enters privileged EXEC mode (changes to privilege-level 15) by using the enable command without a privilege-level argument. 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 the greater than symbol (>), and the prompt for privileged EXEC mode is the number sign (#).
Router> enablePassword: <letmein>Router# disableRouter>The following example shows which commands are available inside the CLI view "first" after the user has logged into this view:
Router# enable view firstPassword:00:28:23:%PARSER-6-VIEW_SWITCH:successfully set to view 'first'.Router# ?Exec commands:configure Enter configuration modeenable Turn on privileged commandsexit Exit from the EXECshow Show running system informationRouter# show ?ip IP informationparser Display parser informationversion System hardware and software statusRouter# show ip ?access-lists List IP access listsaccounting The active IP accounting databasealiases IP alias tablearp IP ARP tableas-path-access-list List AS path access listsbgp BGP informationcache IP fast-switching route cachecasa display casa informationcef Cisco Express Forwardingcommunity-list List community-listdfp DFP informationdhcp Show items in the DHCP databasedrp Director response protocoldvmrp DVMRP informationeigrp IP-EIGRP show commandsextcommunity-list List extended-community listflow NetFlow switchinghelper-address helper-address tablehttp HTTP informationigmp IGMP informationirdp ICMP Router Discovery Protocol..The following example shows how to use the enable view command to switch from the root view to the CLI view "first":
Router# enable viewRouter#01:08:16:%PARSER-6-VIEW_SWITCH:successfully set to view 'root'.Router#! Enable the show parser view command from the root viewRouter# show parser viewCurrent view is 'root'! Enable the show parser view command from the root view to display all viewsRouter# show parser view allViews Present in System:View Name: firstView Name: second! Switch to the CLI view "first."Router# enable view firstRouter#01:08:09:%PARSER-6-VIEW_SWITCH:successfully set to view 'first'.! Enable the show parser view command from the CLI view "first."Router# show parser viewCurrent view is 'first'Related Commands
end
To end the current configuration session and return to privileged EXEC mode, use the end command in global configuration mode.
end
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
10.0
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
This command will bring you back to privileged EXEC mode regardless of what configuration mode or configuration submode you are in.
Note
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 terminalRouter(config)# interface serial 1:1Router(config-if)# alps ascu 4BRouter(config-alps-ascu)# endRouter# show interface serial 1:1Related Commands
environment-monitor shutdown temperature
To enable monitoring of the environment sensors, use the environment-monitor shutdown temperature command in global configuration mode. To disable monitoring of the environment sensors, use the no form of this command.
environment-monitor shutdown temperature [rommon | powerdown]
no environment-monitor shutdown temperature [rommon | powerdown]
Syntax Description
rommon
(Optional) Places the supervisor engine in ROMMON when a major active alarm is identified.
powerdown
(Optional) Powers down the supervisor engine when a new active major alarm is identified.
Defaults
By default, rommon is enabled.
Command Modes
Global configuration
Command History
Examples
This example shows how to place the supervisor engine in ROMMON when a major active alarm occurs:
Router(config)# environment-monitor shutdown temperature rommonRouter(config)#This example shows how to power down the supervisor engine when a major active alarm occurs:
Router(config)# environment-monitor shutdown temperature powerdownRouter(config)#environment temperature-controlled
To enable the ambient temperature control, use the environment temperature-controlled command in global configuration mode. To disable the ambient temperature control, use the no form of this command.
environment temperature-controlled
no environment temperature-controlled
Syntax Description
This command has no arguments or keywords.
Defaults
This command has no default settings.
Command Modes
Global configuration
Command History
Usage Guidelines
This command does not affect temperature monitoring and alarm thresholds; it only affects whether a module may be powered on. The software does not validate the inlet temperature.
If you enter the no form of this command and the cooling capacity is reduced below the module cooling requirement, a syslog warning (and SNMP alarm) is generated. This module status does not change, and an environmental alarm is not raised when you enter the no form of this command.
Examples
This example shows how to enable the ambient temperature control:
Router(config)# environment temperature-controlledRouter(config)#This example shows how to disable the ambient temperature control:
Router(config)# no environment temperature-controlledRouter(config)#erase
To erase a file system or all files available on a file system, use the erase command in privileged EXEC or diagnostic mode.
erase {/all nvram: | /no-squeeze-reserve-space | filesystem: | startup-config}
Cisco 7600 Series Routers and Cisco ASR1000 Series Routers
erase {/all nvram: | filesystem: | startup-config}
Syntax Description
Command Modes
Privileged EXEC (#)
Diagnostic (#)Command History
Usage Guidelines
The erase nvram: command replaces the write erase command and the erase startup-config command.
Caution
The word help feature is disabled for the erase command. You must enter the complete command name to enable the command. The parser does not complete the command name if you enter partial syntax of the command and press the Tab key. For more information on the word help feature, refer to the Using the Cisco IOS Command-Line Interface feature guide.
The erase command can be used on Class B and Class C flash file systems only.
Class A flash file systems cannot be erased. You can delete individual files using the delete command and then reclaim the space using the squeeze command. You can use the format command to format the flash file system. The format command when used on ATA disk clears the File Allocation Table (FAT) and root directory entries only. The data is not erased.
The erase nvram: command erases NVRAM. On Class A file system platforms, if the CONFIG_FILE variable specifies a file in flash memory, the specified file will be marked "deleted."
The erase /all nvram: command erases all files on NVRAM, including private NVRAM.
The /no-squeeze-reserve-space keyword is available on systems with small amounts of flash memory in order to conserve memory. When a squeeze operation is performed, the last two erase sectors are permanently reserved for the squeeze logs and squeeze buffer. The /no-squeeze-reserve-space keyword prevents the reservation of space that guarantees the ability to run the squeeze command. Disabling the squeeze operation keeps these memory sectors free. If any sectors using squeeze data are detected, they will be erased when the /no-squeeze-reserve-space keyword is used. The /no-squeeze-reserve-space keyword increases the available amount of usable flash space, but you may not be able to run the squeeze command. This is typically fine if the file system (such as flash) is used to store a single, large file. For example, an IOS image.
On Class C flash file systems, space is dynamically reclaimed when you use the delete command. You can also use either the format or erase command to reinitialize a Class C flash file system.
Note
Examples
The following example shows how to erase the NVRAM, including the startup configuration located there:
Router# erase nvram:The following example shows how to erase all of partition 2 in internal flash memory:
Router# erase flash:2System flash directory, partition 2:File Length Name/status1 1711088 dirt/images/c3600-i-mz[1711152 bytes used, 15066064 available, 16777216 total]Erase flash device, partition 2? [confirm]Are you sure? [yes/no]: yesErasing device... eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee ...erasedThe following example shows how to erase flash memory when flash is partitioned, but no partition is specified in the command:
Router# erase flash:System flash partition information:Partition Size Used Free Bank-Size State Copy-Mode1 4096K 2048K 2048K 2048K Read Only RXBOOT-FLH2 4096K 2048K 2048K 2048K Read/Write Direct[Type ?<no> for partition directory; ? for full directory; q to abort]Which partition? [default = 2]The system will prompt only if there are two or more read/write partitions. If the partition entered is not valid or is the read-only partition, the process terminates. You can enter a partition number, a question mark (?) for a directory display of all partitions, or a question mark and a number (?number) for directory display of a particular partition. The default is the first read/write partition.
System flash directory, partition 2:File Length Name/status1 3459720 master/igs-bfpx.100-4.3[3459784 bytes used, 734520 available, 4194304 total]Erase flash device, partition 2? [confirm] <Return>Related Commands
erase bootflash
The erase bootflash: and erase bootflash commands have identical functions. See the description of the erase command in this chapter for more information.
errdisable detect cause
To enable the error-disable detection, use the errdisable detect cause command in global configuration mode. To disable the error-disable detection, use the no form of this command.
errdisable detect cause {all | dtp-flap | l2ptguard | link-flap | packet-buffer-error | pagp-flap | udld}
no errdisable detect cause {all | dtp-flap | l2ptguard | link-flap | pagp-flap | udld}
Syntax Description
Defaults
Enabled for all causes
Command Modes
Global configuration
Command History
Usage Guidelines
Note
A cause (bpduguard, dtp-flap, link-flap, pagp-flap, root-guard, udld) is defined as the reason why the error-disabled state occurred. When a cause is detected on an interface, the interface is placed in an error-disabled state (an operational state that is similiar to the link-down state).
You must enter the shutdown and then the no shutdown commands to recover an interface manually from the error-disable state.
Examples
This example shows how to enable the error-disable detection for the Layer 2 protocol-tunnel guard error-disable cause:
Router(config)# errdisable detect cause l2ptguardRouter(config)#Related Commands
errdisable recovery
To configure the recovery mechanism variables, use the errdisable recovery command in global configuration mode. To return to the default state, use the no form of this command.
errdisable recovery {cause {all | arp-inspection | bpduguard | channel-misconfig | dhcp-rate-limit | dtp-flap | gbic-invalid | l2ptguard | link-flap | pagp-flap | psecure-violation | security-violation | udld | unicast-flood} | interval interval}
no errdisable recovery {cause {all | arp-inspection | bpduguard | channel-misconfig | dhcp-rate-limit | dtp-flap | gbic-invalid | l2ptguard | link-flap | pagp-flap | psecure-violation | security-violation | udld | unicast-flood} | interval interval}
Syntax Description
Command Default
The recovery mechanisms are disabled.
Command Modes
Global configuration
Command History
Usage Guidelines
A cause (bpduguard, channel-misconfig, dhcp-rate-limit, dtp-flap, l2ptguard, link-flap, pagp-flap, psecure-violation, security-violation, udld, or unicast-flood) is defined as the reason why the error-disabled state occurred. When a cause is detected on an interface, the interface is placed in an error-disabled state (an operational state that is similar to the link-down state). If you do not enable error-disable recovery for the cause, the interface stays in the error-disabled state until a shutdown and no shutdown occurs. If you enable recovery for a cause, the interface is brought out of the error-disabled state and allowed to retry operation once all the causes have timed out.
You must enter the shutdown command and then the no shutdown command to manually recover an interface from the error-disabled state.
Note
Examples
This example shows how to enable the recovery timer for the BPDU-guard error-disable cause:
Router(config)# errdisable recovery cause bpduguardThis example shows how to set the recovery timer to 300 seconds:
Router(config)# errdisable recovery interval 300Related Commands
escape-character
To define a system escape character, use the escape-character command in line configuration mode. To set the escape character to Break, use the no or default form of this command.
escape-character {break | char | default | none | soft}
no escape-character [soft]
default escape-character [soft]
Syntax Description
Defaults
The default escape key sequence is Ctrl-Shift-6 (Ctrl-^) or Ctrl-Shift-6, X (^^X). The X is generally only required for modem connections.
The default escape-character command sets the escape character to Break (the default setting for Break is Ctrl-C).
Command Modes
Line configuration
Command History
10.0
This command was introduced.
11.3
The soft keyword was added.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
See the "ASCII Character Set and Hexidecimal Values" appendix for a list of ASCII characters.
The escape character (or key sequence) suspends any actively running processes and returns you to privileged EXEC mode or, if a menu is being used, to the system menu interface. The escape character is used for interrupting or aborting a process started by previously executed command. Examples of processes from which you can escape include Domain-Name lookup, ping, trace, and Telnet sessions initiated from the device to which you are connected.
To view the current setting of the escape sequence for a line, use the show line command followed by the specific line identifier (for example, show line 0, or show line console). The default escape sequence for a line is often displayed as ^^X . The first caret symbol represents the Control (Ctrl) key, the second caret symbol is literal (Shift-6), and the X is literal (for most systems, the X is not required).
To set the escape key for the active terminal line session, use the terminal escape-character command.
The Break key cannot be used as an escape character on a console terminal because the Cisco IOS software interprets Break as an instruction to halt the system. Depending upon the configuration register setting, break commands issued from the console line either will be ignored or cause the server to shut down.
To send an escape sequence over a Telnet connection, press Ctrl-Shift-6 twice.
The escape-character soft form of this command defines a character or character sequence that will cause the system to wait until pending input is processed before suspending the current session. This option allows you to program a key sequence to perform multiple actions, such as using the F1 key to execute a command, then execute the escape function after the first command is executed.
The following restrictions apply when using the soft keyword:
•
•
•
Examples
The following example sets the escape character for the console line to the keyboard entry Ctrl-P, which is represented by the ASCII decimal value of 16:
Router(config)# line consoleRouter(config-line)# escape-character 16The following example sets the escape character for line 1 to !, which is represented in the configuration file as the ASCII number 33:
Router(config)# line 1Router(config-line)# escape-character !Router(config-line)# endRouter# show running-configBuilding configuration......line 1autoselect during-loginautoselect pppmodem InOuttransport preferred nonetransport output telnetescape-character 33Related Commands
exec
To allow an EXEC process on a line, use the exec command in line configuration mode. To turn off the EXEC process for the specified line, use the no form of this command.
exec
no exec
Syntax Description
This command has no arguments or keywords.
Defaults
The EXEC processes is enabled on all lines.
Command Modes
Line configuration
Command History
10.0
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
When you want to allow only an outgoing connection on a line, use the no exec command.
The no exec command allows you to disable the EXEC process for connections which may attempt to send unsolicited data to the router. (For example, the control port of a rack of modems attached to an auxiliary port of router.) When certain types of data are sent to a line connection, an EXEC process can start, which makes the line unavailable.
When a user tries to Telnet to a line with the EXEC process disabled, the user will get no response when attempting to log on.
Examples
The following example disables the EXEC process on line 7.
Router(config)# line 7Router(config-line)# no execexec-banner
To reenable the display of EXEC and message-of-the-day (MOTD) banners on the specified line or lines, use the exec-banner command in line configuration mode. To suppress the banners on the specified line or lines, use the no form of this command.
exec-banner
no exec-banner
Syntax Description
This command has no arguments or keywords.
Defaults
Enabled on all lines
Command Modes
Line configuration
Command History
10.0
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
This command determines whether the router will display the EXEC banner and the message-of-the-day (MOTD) banner when an EXEC session is created. These banners are defined with the banner exec and banner motd global configuration commands. By default, these banner are enabled on all lines. Disable the EXEC and MOTD banners using the no exec-banner command.
This command has no effect on the incoming banner, which is controlled by the banner incoming command.
The MOTD banners can also be disabled by the no motd-banner line configuration command, which disables MOTD banners on a line. If the no exec-banner command is configured on a line, the MOTD banner will be disabled regardless of whether the motd-banner command is enabled or disabled. Table 30 summarizes the effects of the exec-banner command and the motd-banner command.
Table 30 Banners Displayed Based On exec-banner and motd-banner Combinations
MOTD banner
EXEC banner
None
EXEC banner
None
For reverse Telnet connections, the EXEC banner is never displayed. Instead, the incoming banner is displayed. The MOTD banner is displayed by default, but it is disabled if either the no exec-banner command or no motd-banner command is configured. Table 31 summarizes the effects of the exec-banner command and the motd-banner command for reverse Telnet connections.
Examples
The following example suppresses the EXEC and MOTD banners on virtual terminal lines 0 to 4:
Router(config)# line vty 0 4Router(config-line)# no exec-bannerRelated Commands
exec-character-bits
To configure the character widths of EXEC and configuration command characters, use the exec-character-bits command in line configuration mode. To restore the default value, use the no form of this command.
exec-character-bits {7 | 8}
no exec-character-bits
Syntax Description
7
Selects the 7-bit character set. This is the default.
8
Selects the full 8-bit character set for use of international and graphical characters in banner messages, prompts, and so on.
Defaults
7-bit ASCII character set
Command Modes
Line configuration
Command History
10.0
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
Setting the EXEC character width to 8 allows you to use special graphical and international characters in banners, prompts, and so on. However, setting the EXEC character width to 8 bits can cause failures. 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.
Note
Examples
The following example enables full 8-bit international character sets, except for the console, which is an ASCII terminal. It illustrates use of the default-value exec-character-bits global configuration command and the exec-character-bits line configuration command.
Router(config)# default-value exec-character-bits 8Router(config)# line 0Router(config-line)# exec-character-bits 7Related Commands
exec-timeout
To set the interval that the EXEC command interpreter waits until user input is detected, use the exec-timeout command in line configuration mode. To remove the timeout definition, use the no form of this command.
exec-timeout minutes [seconds]
no exec-timeout
Syntax Description
minutes
Integer that specifies the number of minutes. The default is 10 minutes.
seconds
(Optional) Additional time intervals in seconds.
Defaults
10 minutes
Command Modes
Line configuration
Command History
10.0
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
If no input is detected during the interval, the EXEC facility resumes the current connection. If no connections exist, the EXEC facility returns the terminal to the idle state and disconnects the incoming session.
To specify no timeout, enter the exec-timeout 0 0 command.
Examples
The following example sets a time interval of 2 minutes, 30 seconds:
Router(config)# line consoleRouter(config-line)# exec-timeout 2 30The following example sets a time interval of 10 seconds:
Router(config)# line consoleRouter(config-line)# exec-timeout 0 10execute-on
To execute commands on a line card, use the execute-on command in privileged EXEC mode.
execute-on {slot slot-number | all | master} command
Syntax Description
Command Modes
Privileged EXEC
Command History
Usage Guidelines
Use this command to execute a command on one or all line cards to monitor and maintain information on one or more line cards (for example, a line card in a specified slot on a dial shelf). This allows you to issue commands remotely; that is, to issue commands without needing to log in to the line card directly. The all form of the command allows you to issue commands to all the line cards without having to log in to each in turn.
Though this command does not have a no form, note that it is possible to use the no form of the remotely executed commands used in this command.
Tip
Cisco 12000 GSR Guidelines and Restrictions
You can use the execute-on privileged EXEC command only from Cisco IOS software running on the GRP card.
Timesaver
Cisco AS5800 Guidelines and Restrictions
The purpose of the command is to conveniently enable certain commands to be remotely executed on the dial shelf cards from the router without connecting to each line card. This is the recommended procedure, because it avoids the possibility of adversely affecting a good configuration of a line card in the process. The execute-on command does not give access to every Cisco IOS command available on the Cisco AS5800 access server. In general, the purpose of the execute-on command is to provide access to statistical reports from line cards without directly connecting to the dial shelf line cards.
Caution
Using this command makes it possible to accumulate inputs for inclusion in the show tech-support command.
The master form of the command can run a designated command remotely on the router from the DSC card. However, using the console on the DSC is not recommended. It is used for technical support troubleshooting only.
The show tech-support command for each dial shelf card is bundled into the router shelf's show tech-support command via the execute-on facility.
The execute-on command also support interactive commands such as the following:
router: execute-on slave slot slot pingThe execute-on command has the same limitations and restrictions as a vty telnet client has; that is, it cannot reload DSC using the following command:
router: execute-on slave slot slot reloadYou can use the execute-on command to enable remote execution of the commands included in the following partial list:
•
•
•
•
•
•
•
•
Examples
In the following example, the user executes the show controllers command on the line card in slot 4 of a Cisco 12000 series GSR:
Router# execute-on slot 4 show controllers========= Line Card (Slot 4) =======Interface POS0Hardware is BFLC POSlcpos_instance struct 6033A6E0RX POS ASIC addr space 12000000TX POS ASIC addr space 12000100SUNI framer addr space 12000400SUNI rsop intr status 00CRC16 enabled, HDLC enc, int clockno loopInterface POS1Hardware is BFLC POSlcpos_instance struct 6033CEC0RX POS ASIC addr space 12000000TX POS ASIC addr space 12000100SUNI framer addr space 12000600SUNI rsop intr status 00CRC32 enabled, HDLC enc, int clockno loopInterface POS2Hardware is BFLC POSlcpos_instance struct 6033F6A0RX POS ASIC addr space 12000000TX POS ASIC addr space 12000100SUNI framer addr space 12000800SUNI rsop intr status 00CRC32 enabled, HDLC enc, int clockno loopInterface POS3Hardware is BFLC POSlcpos_instance struct 60341E80RX POS ASIC addr space 12000000TX POS ASIC addr space 12000100SUNI framer addr space 12000A00SUNI rsop intr status 00CRC32 enabled, HDLC enc, ext clockno loopRouter#Related Commands
attach
Connects you to a specific line card for the purpose of executing commands using the Cisco IOS software image on that line card.
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
10.0
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
Usage Guidelines
Use the exit command in EXEC mode to exit the active session (log off the device). This command can be used in any EXEC mode (such as User EXEC mode or Privileged EXEC mode) to exit from the EXEC process.
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):
Router(config)# exitRouter# disableRouter> exitRelated Commands
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
10.0
This command was introduced.
12.2(33)SRA
This command was integrated into Cisco IOS Release 12.2(33)SRA.
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 shows how to exit from the subinterface configuration mode and to return to the interface configuration mode:
Router(config-subif)# exitRouter(config-if)#The following example displays an exit from the interface configuration mode to return to the global configuration mode:Router(config-if)# exitRouter(config)#Related Commands
disconnect
Disconnects a line.
end
Ends your configuration session by exiting to privileged EXEC mode.
exit (EXEC)
Closes the active terminal session by logging off the router.
