Cisco IOS Configuration Fundamentals

Command Reference

Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
CONTENTS

Introduction 1
Cisco IOS IFS Command Syntax 2
Obtaining Documentation Obtaining Support and Security Guidelines 4
A through B 5
activation-character 6
alias 7
archive 11
archive config 13
archive log config persistent save 16
archive tar 18
async-bootp 21
attach 24
autobaud 27
auto-sync 28
autoupgrade disk-cleanup 31
autoupgrade ida url 33
autoupgrade status email 35
banner exec 37
banner incoming 40
banner login 43
banner motd 46
banner slip-ppp 49
boot 52
boot bootldr 57
boot bootstrap 59
boot config 62
boot host 65
boot network 68
boot system 71

Cisco IOS Configuration Fundamentals Command Reference

ii
Contents

boot-end-marker 78
boot-start-marker 81
C commands 85
cd 87
clear archive log config 89
clear catalyst6000 traffic-meter 91
clear configuration lock 92
clear diagnostic event-log 94
clear ip http client cache 96
clear logging 98
clear logging system 100
clear logging xml 102
clear memory low-water-mark 104
clear mls statistics 105
clear parser cache 107
clear parser statistics 109
clear platform netint 111
clear processes interrupt mask 112
clear scp accounting 114
clear tcp 115
clear vlan counters 117
clock 118
clock initialize nvram 120
config-register 121
configure check syntax 123
configuration mode exclusive (Deprecated as of the 15.0S and T releases. It's still available on the
M train.) 124
configure confirm 131
configure memory 133
configure network 135
configure overwrite-network 136
configure replace 137
configure revert 142
configure terminal 144
confreg 147

Cisco IOS Configuration Fundamentals Command Reference

iii
 Contents

continue (ROM monitor) 149

copy 151
copy erase flash 170
copy http 171
copy https 172
copy logging system 173
copy xmodem 175
copy ymodem 177
copy noverify 179
D through E 185
databits 187
data-character-bits 189
default-value data-character-bits 191
default-value exec-character-bits 193
default-value modem-interval 195
default-value special-character-bits 196
define interface-range 198
delete 200
diag 203
diagnostic bootup level 207
diagnostic cns 209
diagnostic event-log size 211
diagnostic level 213
diagnostic monitor 215
diagnostic ondemand 220
diagnostic schedule module 222
diagnostic start 225
diagnostic stop 230
dir 233
disable 237
disconnect-character 239
dispatch-character 240
dispatch-machine 242
dispatch-timeout 244
do 246

Cisco IOS Configuration Fundamentals Command Reference

iv
Contents

downward-compatible-config 248
editing 250
enable 254
enable last-resort 258
end 259
environment-monitor shutdown temperature 261
environment temperature-controlled 262
erase 264
erase bootflash 268
errdisable detect cause 269
errdisable recovery 271
escape-character 274
exec 277
exec-banner 278
exec-character-bits 280
exec-timeout 282
execute-on 284
exit (EXEC) 289
exit (global) 291
F through K 293
file prompt 294
file verify auto 295
format 297
fsck 301
full-help 307
help 309
hidekeys 311
history 313
history size 315
hold-character 317
hostname 319
hw-module reset 321
hw-module shutdown 322
insecure 323
international 324

Cisco IOS Configuration Fundamentals Command Reference

v
 Contents

ip bootp server 326

ip finger 328
ip ftp passive 330
ip ftp password 331
ip ftp source-interface 333
ip ftp username 335
ip rarp-server 337
ip rcmd domain-lookup 339
ip rcmd rcp-enable 341
ip rcmd remote-host 343
ip rcmd remote-username 346
ip rcmd rsh-enable 348
ip rcmd source-interface 350
ip telnet source-interface 352
ip tftp blocksize 354
ip tftp boot-interface 355
ip tftp min-timeout 356
ip tftp source-interface 357
ip wccp web-cache accelerated 359
L through mode 361
length 363
load-interval 365
location 367
lock 368
lockable 370
log config 372
logging buginf 374
logging enable 376
logging esm config 378
logging event bundle-status 380
logging event link-status (global configuration) 382
logging event link-status (interface configuration) 384
logging event subif-link-status 386
logging event trunk-status 388
logging reload 389

Cisco IOS Configuration Fundamentals Command Reference

vi
Contents

logging ip access-list cache (global configuration) 391

logging ip access-list cache (interface configuration) 394
logging persistent (config-archive-log-cfg) 396
logging persistent reload (config-archive-log-cfg) 398
logging size 400
logging synchronous 402
logging system 405
logout 407
logout-warning 408
macro (global configuration) 410
macro (interface configuration) 412
maximum 414
memory cache error-recovery 416
memory cache error-recovery options 418
memory free low-watermark 420
memory lite 422
memory reserve 423
memory reserve critical 425
memory sanity 427
memory scan 429
memory-size iomem 431
menu (EXEC) 433
menu menu-name single-space 435
menu clear-screen 437
menu command 439
menu default 442
menu line-mode 444
menu options 446
menu prompt 448
menu status-line 450
menu text 452
menu title 454
microcode (12000) 456
microcode (7000/7500) 458
microcode (7200) 460

Cisco IOS Configuration Fundamentals Command Reference

vii
 Contents

microcode reload (12000) 462

microcode reload (7000 7500) 464
microcode reload (7200) 466
mkdir 468
mkdir disk0: 470
mode 472
monitor event-trace through Q 477
monitor event-trace (EXEC) 478
monitor event-trace (global) 482
monitor event-trace dump-traces 486
monitor pcm-tracer capture-destination 488
monitor pcm-tracer delayed-start 490
monitor pcm-tracer profile 491
monitor permit-list 492
monitor session egress replication-mode 494
monitor session type 496
mop device-code 505
mop retransmit-timer 507
mop retries 509
more 511
more url begin 514
more url exclude 517
more url include 520
more flh:logfile 522
motd-banner 524
name-connection 526
no menu 528
notify 530
notify syslog 531
padding 533
parity 535
parser cache 537
parser command serializer 539
parser config cache interface 541
parser config partition 543

Cisco IOS Configuration Fundamentals Command Reference

viii
Contents

parser maximum 545

partition 547
path (archive configuration) 549
periodic 553
ping 556
ping (privileged) 562
ping ip 566
ping srb 571
ping vrf 572
platform shell 576
power enable 577
power redundancy-mode 579
printer 581
private 583
process cpu statistics limit entry-percentage 585
process cpu threshold type 587
process-max-time 589
prompt 590
prompt config 592
pwd 593
R through setup 595
refuse-message 596
regexp optimize 598
reload 599
remote command 604
remote login 606
remote-span 608
rename 610
request platform software package describe file 612
request platform software package expand file 618
request platform software package install commit 621
request platform software package install file 623
request platform software package install rollback 631
request platform software package install snapshot 633
request platform software process release 635

Cisco IOS Configuration Fundamentals Command Reference

ix
 Contents

request platform software system shell 637

request platform software shell session output format 639
request platform software snapshot 642
request platform software vty attach 644
revision 646
rmdir 648
rommon-pref 650
route-converge-interval 652
rsh 654
scheduler allocate 656
scheduler heapcheck poll 658
scheduler heapcheck process 659
scheduler interrupt mask profile 661
scheduler interrupt mask size 663
scheduler interrupt mask time 665
scheduler interval 667
scheduler isr-watchdog 669
scheduler max-sched-time 671
scheduler process-watchdog 673
scheduler timercheck process 675
scheduler timercheck system context 677
send 678
service compress-config 680
service config 682
service counters max age 684
service decimal-tty 686
service exec-wait 687
service finger 688
service hide-telnet-address 689
service linenumber 691
service nagle 693
service prompt config 694
service sequence-numbers 696
service slave-log 698
service tcp-keepalives-in 699

Cisco IOS Configuration Fundamentals Command Reference

x
Contents

service tcp-keepalives-out 700

service tcp-small-servers 701
service telnet-zeroidle 703
service timestamps 705
service udp-small-servers 710
service-module apa traffic-management 712
service-module wlan-ap bootimage 714
service-module wlan-ap reload 716
service-module wlan-ap reset 718
service-module wlan-ap session 720
service-module wlan-ap statistics 722
service-module wlan-ap status 724
session slot 726
set memory debug incremental starting-time 727
setup 729
show through show fm summary 735
show 737
show command append 739
show command begin 741
show command exclude 744
show command include 746
show command redirect 749
show command section 751
show command tee 753
show (Flash file system) 755
show aliases 764
show alignment 765
show archive 768
show archive config differences 771
show archive config incremental-diffs 774
show archive config rollback timer 776
show archive log config 778
show as5400 782
show async bootp 785
show autoupgrade configuration unknown 787

Cisco IOS Configuration Fundamentals Command Reference

xi
 Contents

show bcm560x 789

show bootflash: 790
show bootvar 793
show buffers 797
show c2600 807
show c7200 811
show catalyst6000 813
show cls 816
show config id 818
show configuration id 820
show configuration lock 822
show context 826
show controllers (GRP image) 830
show controllers (line card image) 833
show controllers logging 842
show controllers tech-support 844
show coverage history 846
show data-corruption 847
show debugging 849
show declassify 852
show derived-config 854
show diagnostic cns 857
show diagnostic sanity 859
show disk 863
show disk0: 865
show disk1: 868
show environment 871
show environment alarm 899
show environment connector 902
show environment cooling 904
show environment status 906
show environment temperature 909
show errdisable detect 912
show errdisable recovery 914
show fastblk 916

Cisco IOS Configuration Fundamentals Command Reference

xii
Contents

show file descriptors 918

show file information 920
show file systems 922
show flh-log 925
show fm inspect 926
show fm interface 928
show fm reflexive 931
show fm summary 932
show funi 934
show identity policy 938
show identity profile 939
show platform software snapshot status 941
show gsr through show monitor event trace 943
show gsr 945
show gt64010 (7200) 947
show hardware 949
show health-monitor 951
show history 952
show history all 954
show hosts 957
show html 961
show idb 963
show idprom 965
show inventory 971
show location 975
show logging 978
show logging count 985
show logging history 988
show logging system 991
show logging xml 994
show memory 996
show memory allocating-process 1003
show memory dead 1006
show memory debug incremental 1008
show memory debug leaks 1011

Cisco IOS Configuration Fundamentals Command Reference

xiii
 Contents

show memory debug references 1017

show memory debug unused 1019
show memory detailed 1021
show memory ecc 1029
show memory events 1031
show memory failures alloc 1033
show memory fast 1035
show memory fragment 1038
show memory lite-chunks 1041
show memory multibus 1043
show memory pci 1045
show memory processor 1047
show memory scan 1052
show memory statistics history 1054
show memory traceback 1057
show memory transient 1059
show microcode 1061
show mls statistics 1063
show module 1066
show monitor event-trace 1069
show monitor permit list through show process memory 1075
show monitor permit-list 1077
show monitor session 1078
show msfc 1083
show pagp 1087
show parser dump 1089
show parser macro 1100
show parser statistics 1102
show pci 1105
show pci hardware 1107
show perf-meas 1109
show platform 1111
show platform bridge 1121
show platform cfm 1123
show platform diag 1125

Cisco IOS Configuration Fundamentals Command Reference

xiv
Contents

show platform hardware capacity 1128

show platform isg 1134
show platform oam 1136
show platform redundancy 1138
show platform software filesystem 1141
show platform software memory 1144
show platform software mount 1150
show platform software process list 1154
show platform process slot 1164
show platform software snapshot status 1167
show platform software tech-support 1169
show platform subscriber-group 1172
show platform supervisor 1174
show power 1175
show processes 1179
show processes cpu 1187
show processes detailed 1199
show processes interrupt mask buffer 1203
show processes interrupt mask detail 1205
show processes memory 1207
show protocols through showmon 1221
show protocols 1223
show region 1226
show registry 1229
show reload 1232
show resource-pool queue 1233
show rhosts 1235
show rom-monitor 1237
show rom-monitor slot 1240
show running identity policy 1242
show running identity profile 1243
show running-config 1244
show running-config control-plane 1253
show running-config map-class 1255
show running-config partition 1258

Cisco IOS Configuration Fundamentals Command Reference

xv
 Contents

show scp 1263

show slot 1266
show slot0: 1269
show slot1: 1272
show software authenticity file 1275
show software authenticity keys 1278
show software authenticity running 1280
show stacks 1283
show startup-config 1285
show subsys 1286
show sup-bootflash 1288
show system jumbomtu 1291
show tech-support 1292
show template 1300
show usb controllers 1301
show usb device 1303
show usb driver 1306
show usb port 1308
show usb tree 1309
show usbtoken 1310
show version 1312
show warm-reboot 1338
show wiretap 1339
show whoami 1341
showmon 1342
slave auto-sync config through terminal-type 1345
slave auto-sync config 1347
slave default-slot 1349
slave image 1351
slave reload 1353
slave sync config 1355
slave terminal 1357
special-character-bits 1359
squeeze 1361
stack-mib portname 1364

Cisco IOS Configuration Fundamentals Command Reference

xvi
Contents

state-machine 1365
stopbits 1367
storm-control level 1369
sync-restart-delay 1371
systat 1373
system flowcontrol bus 1374
system jumbomtu 1376
tdm clock priority 1378
terminal databits 1381
terminal data-character-bits 1383
terminal dispatch-character 1385
terminal dispatch-timeout 1386
terminal download 1388
terminal editing 1389
terminal escape-character 1390
terminal exec-character-bits 1392
terminal flowcontrol 1394
terminal full-help 1396
terminal history 1398
terminal history size 1400
terminal hold-character 1403
terminal international 1405
terminal keymap-type 1407
terminal length 1408
terminal monitor 1410
terminal notify 1411
terminal padding 1412
terminal parity 1414
terminal rxspeed 1416
terminal special-character-bits 1418
terminal speed 1420
terminal start-character 1421
terminal stopbits 1422
terminal stop-character 1423
terminal telnet break-on-ip 1424

Cisco IOS Configuration Fundamentals Command Reference

xvii
 Contents

terminal telnet refuse-negotiations 1426

terminal telnet speed 1427
terminal telnet sync-on-break 1429
terminal telnet transparent 1430
terminal terminal-type 1431
terminal txspeed 1433
terminal width 1435
terminal-queue entry-retry-interval 1437
terminal-type 1438
test cable-diagnostics through xmodem 1439
test cable-diagnostics 1441
test flash 1443
test interfaces 1444
test memory 1446
test memory destroy 1447
test platform police get 1449
test platform police set 1450
tftp-server 1452
tftp-server system 1456
time-period 1457
trace (privileged) 1459
trace (user) 1464
traceroute 1467
traceroute mac 1471
undelete 1475
unprofile 1477
upgrade automatic abortversion 1478
upgrade automatic getversion 1480
upgrade automatic runversion 1483
upgrade filesystem monlib 1485
upgrade rom-monitor 1487
upgrade filesystem monlib 1492
upgrade rom-monitor preference 1494
vacant-message 1496
verify 1498

Cisco IOS Configuration Fundamentals Command Reference

xviii
Contents

vtp 1503
warm-reboot 1507
where 1509
width 1511
write core 1513
write erase 1515
write memory 1516
write mib-data 1517
write network 1519
write terminal 1521
xmodem 1522
ASCII Character Set and Hexadecimal Values 1525

Cisco IOS Configuration Fundamentals Command Reference

xix
 Introduction
The Cisco IOS Configuration Fundamentals Command Reference provides command documentation
associated with the following tasks:
• Using the Cisco IOS Command-Line Interface (CLI)
• Configuration Using Setup and AutoInstall
• Configuring Operating Characteristics for Terminals
• Managing Connections, Logins, Menus, and System Banners
◦ Configure user menus and banners
• Using the Cisco Web Browser User Interface (UI)
◦ Using the HTTP server-based UI as an alternative to the CLI
• Using the Cisco IOS Integrated File System (IFS)
◦ The basics of filesystem use and Cisco IOS software’s filesystem infrastructure
• Configuring Basic File Transfer Services
◦ Copy, move, and delete files locally or across the network
• Managing Configuration Files
• Loading, Maintaining, and Upgrading System Images
• Rebooting
For further information about performing these tasks, refer to the Cisco IOS Configuration Fundamentals
Configuration Guide for your release.

Note Some commands previously documented in this Command Reference have been moved to other books:
Commands related to system management and network monitoring can be found in the Cisco IOS
Network Management Command Reference . Command reference documentation for the Cisco IOS
software feature “Service Assurance Agent (SAA)” can be found in the the Cisco IOS IP SLAs Command
Reference

• Cisco IOS IFS Command Syntax, page 2

• Obtaining Documentation Obtaining Support and Security Guidelines, page 4

Cisco IOS Configuration Fundamentals Command Reference

1
 Introduction
Cisco IOS IFS Command Syntax

Cisco IOS IFS Command Syntax

Some commands in this book use URLs (uniform resource locators) as part of the command syntax. URLs
used in the Cisco IOS Integrated File System (IFS) contain two parts: a file system or network prefix, and a
file identification suffix. The following tables list URL keywords that can be used in the source-url and
destination-url arguments for all commands in this book. The prefixes listed below can also be used in the
filesystem arguments in this document.
The following table lists common URL network prefixes used to indicate a device on the network.

Table 1 Network Prefixes for Cisco IFS URLs

Prefix Description
ftp: Specifies a File Transfer Protocol (FTP) network
server.

rcp: Specifies an remote copy protocol (rcp) network

server.

tftp: Specifies a TFTP server.

The following table lists the available suffix options (file indentification suffixes) for the URL prefixes
used in the previous table.

Table 2 File ID Suffixes for Cisco IFS URLs

Prefix Suffix Options

ftp: [[//[username[:password]@]location]/directory]/
filename
For example:
ftp://network-config (prefix ://filename )
ftp://user1:[email protected]/config-
files

rcp: rcp:[[//[username@]location]/directory]/filename

tftp: tftp:[[//location]/directory]/filename

The following table lists common URL prefixes used to indicate memory locations on the system.

Table 3 File System Prefixes for Cisco IFS URLs

Prefix Description
bootflash: Boot flash memory.

disk0: Rotating disk media.

Cisco IOS Configuration Fundamentals Command Reference

2
Introduction
Cisco IOS IFS Command Syntax

Prefix Description
flash: partition-number Flash memory. This prefix is available on all
platforms. For platforms that do not have a device
named flash:, the prefix flash: is aliased to slot0:.
Therefore, you can use the prefix flash: to refer to
the main Flash memory storage area on all
platforms.

flh: Flash load helper log files.

null: Null destination for copies. You can copy a remote

file to null to determine its size.

nvram: NVRAM. This is the default location for the

running-configuration file.

slavebootflash: Internal Flash memory on a slave RSP card of a

router configured with Dual RSPs.

slavenvram: NVRAM on a slave RSP card.

slaveslot0: First PCMCIA card on a slave RSP card.

slaveslot1: Second PCMCIA card on a slave RSP card.

slot0: First PCMCIA Flash memory card.

slot1: Second PCMCIA Flash memory card.

xmodem: Obtain the file from a network machine using the

Xmodem protocol.

ymodem: Obtain the file from a network machine using the

Ymodem protocol.

For details about the Cisco IOS IFS, and for IFS configuration tasks, refer to the “Using the Cisco IOS
Integrated File System (IFS)” chapter in the latest Cisco IOS Configuration Fundamentals Configuration
Guide appropriate for your release version.

Cisco IOS Configuration Fundamentals Command Reference

3
 Introduction
Obtaining Documentation Obtaining Support and Security Guidelines

Obtaining Documentation Obtaining Support and Security

Guidelines
For information on obtaining documentation, obtaining support, providing documentation feedback,
security guidelines, and also recommended aliases and general Cisco documents, see the monthly What’s
New in Cisco Product Documentation , which also lists all new and revised Cisco technical documentation,
at:
http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

Cisco IOS Configuration Fundamentals Command Reference

4
A through B
• activation-character, page 6
• alias, page 7
• archive, page 11
• archive config, page 13
• archive log config persistent save, page 16
• archive tar, page 18
• async-bootp, page 21
• attach, page 24
• autobaud, page 27
• auto-sync, page 28
• autoupgrade disk-cleanup, page 31
• autoupgrade ida url, page 33
• autoupgrade status email, page 35
• banner exec, page 37
• banner incoming, page 40
• banner login, page 43
• banner motd, page 46
• banner slip-ppp, page 49
• boot, page 52
• boot bootldr, page 57
• boot bootstrap, page 59
• boot config, page 62
• boot host, page 65
• boot network, page 68
• boot system, page 71
• boot-end-marker, page 78
• boot-start-marker, page 81

Cisco IOS Configuration Fundamentals Command Reference

5
 A through B
activation-character

activation-character
To define the character you ent er at a vacant terminal to begin a terminal session, use the activation-
character command in line configuration mode. To make any character activate a terminal, use the no
form of this command.

activation-character ascii-number
no activation-character

Syntax Description ascii-number Decimal representation of the activation character.

Command Default Return (decimal 13)

Command Modes Line configuration (config-line)

Command History Release Modification

10.0 This command was introduced.
This command is supported in all Cisco IOS
software Releases.

Usage Guidelines See the “ASCII Character Set and Hexadecimal Values” document for a list of ASCII characters.

Note If you are using the autoselect function, set the activation character to the default, Return, and exec-
character-bits to 7. If you change these defaults, the application will not recognize the activation request.

Examples The following example shows how to set the activation character for the console to Delete, which is
decimal character 127:

Router(config)# line console

Router(config-line)# activation-character 127

Cisco IOS Configuration Fundamentals Command Reference

6
 A through B
alias

alias
To create a command alias, use the alias command in global configuration mode. To delete all aliases in a
command mode or to delete a specific alias, and to revert to the original command syntax, use the no form
of this command.

alias mode command-alias original-command

no alias mode [command-alias]

Syntax Description mode Command mode of the original and alias

commands.

command-alias Command alias.

original-command Original command syntax.

Command Default A set of six basic EXEC mode aliases are enabled by default. See the “Usage Guidelines” section of this
command for a list of default aliases.

Command Modes Global configuration

Command History Release Modification

10.3 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

15.0M The command alias ip-vrf has been replaced with

alias vrf-af.

Usage Guidelines You can use simple words or abbreviations as command aliases.
The table below lists the basic EXEC mode aliases that are enabled by default.

Table 4 Default Command Aliases

Command Alias Original Command

h help

Cisco IOS Configuration Fundamentals Command Reference

7
 A through B
alias

Command Alias Original Command

lo logout

p ping

r resume

s show

w where

The default aliases in the table above are predefined. These default aliases can be disabled with the no alias
exec command.
Common keyword aliases (which cannot be disabled) include running-config (keyword alias for
system:running-config) and startup-config (keyword alias for nvram:startup-config). See the
description of the copy command for more information about these keyword aliases.
Note that aliases can be configured for keywords instead of entire commands. You can create, for example,
an alias for the first part of any command and still enter the additional keywords and arguments as normal.
To determine the value for the mode argument, enter the command mode in which you would issue the
original command (and in which you will issue the alias) and enter the ? command. The name of the
command mode should appear at the top of the list of commands. For example, the second line in the
following sample output shows the name of the command mode as “Interface configuration”:

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# interface e0
Router(config-if)# ?
Interface configuration commands:
access-expression Build a bridge boolean access expression
.
.
.

To match the name of the command mode to the acceptable mode keyword for the alias command, issue
the alias ? command. As shown in the following sample output, the keyword needed to create a command
alias for the access-expression command is interface:

Router(config)# alias ?
accept-dialin VPDN group accept dialin configuration mode
accept-dialout VPDN group accept dialout configuration mode
address-family Address Family configuration mode
call-discriminator Call Discriminator Configuration
cascustom Cas custom configuration mode
clid-group CLID group configuration mode
configure Global configuration mode
congestion Frame Relay congestion configuration mode
controller Controller configuration mode
cptone-set custom call progress tone configuration mode
customer-profile customer profile configuration mode
dhcp DHCP pool configuration mode
dnis-group DNIS group configuration mode
exec Exec mode
flow-cache Flow aggregation cache config mode
fr-fr FR/FR connection configuration mode
interface Interface configuration mode
.
.
.
Router(config)# alias interface express access-expression

Cisco IOS Configuration Fundamentals Command Reference

8
 A through B
alias

When you use online help, command aliases are indicated by an asterisk (*), and displayed in the following
format:
*command-alias =original-command
For example, the lo command alias is shown here along with other EXEC mode commands that start with
“lo”:

Router# lo?
*lo=logout lock login logout

When you use online help, aliases that contain multiple keyword elements separated by spaces are
displayed in quotes, as shown here:

Router(config)#alias exec device-mail telnet device.cisco.com 25

Router(config)#end
Router#device-mail?
*device-mail=”telnet device.cisco.com 25"

To list only commands and omit aliases, begin your input line with a space. In the following example, the
alias td is not shown, because there is a space before the t?command line.

Router(config)#alias exec td telnet device

Router(config)#end
Router# t?
telnet terminal test tn3270 trace

To circumvent command aliases, use a space before entering the command. In the following example, the
command alias express is not recognized because a space is used before the command.

Router(config-if)#exp?
*express=access-expression
Router(config-if)# express ?

% Unrecognized command

As with commands, you can use online help to display the arguments and keywords that can follow a
command alias. In the following example,the alias td is created to represent the command telnet device.
The /debugand /lineswitchescan be added to telnet device to modify the command:

Router(config)#alias exec td telnet device

Router(config)#end
Router#td ?
/debug Enable telnet debugging mode
/line Enable telnet line mode
...
whois Whois port
<cr>
Router# telnet device

You must enter the complete syntax for the command alias. Partial syntax for aliases is not accepted. In the
following example, the parser does not recognize the command t as indicating the alias td:

Router# t

% Ambiguous command: “t”

Examples In the following example, the alias fixmyrtis configured for the clear iproute 192.168.116.16 EXEC mode
command:

Router(config)#alias exec fixmyrt clear ip route 192.168.116.16

Cisco IOS Configuration Fundamentals Command Reference

9
 A through B
alias

In the following example, the alias express is configured for the first part of the access-expression
interface configuration command:

Router#configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)#interface e0
Router(config-if)#?
Interface configuration commands:
access-expression Build a bridge boolean access expression
.
.
.
Router(config-if)#exit
Router(config)#alias ?
accept-dialin VPDN group accept dialin configuration mode
accept-dialout VPDN group accept dialout configuration mode
address-family Address Family configuration mode
call-discriminator Call Discriminator Configuration
cascustom Cas custom configuration mode
clid-group CLID group configuration mode
configure Global configuration mode
congestion Frame Relay congestion configuration mode
controller Controller configuration mode
cptone-set custom call progress tone configuration mode
customer-profile customer profile configuration mode
dhcp DHCP pool configuration mode
dnis-group DNIS group configuration mode
exec Exec mode
flow-cache Flow aggregation cache config mode
fr-fr FR/FR connection configuration mode
interface Interface configuration mode
.
.
.
Router(config)#alias interface express access-expression
Router(config)#int e0
Router(config-if)#exp?
*express=access-expression
Router(config-if)#express ?
input Filter input packets
output Filter output packets
!Note that the true form of the command/keyword alias appears on the screen after issuing
!the express ? command.
Router(config-if)#access-expression ?
input Filter input packets
output Filter output packets
Router(config-if)#ex?
*express=access-expression exit
!Note that in the following line, a space is used before the ex? command
!so the alias is not displayed.
Router(config-if)# ex?
exit
!Note that in the following line, the alias cannot be recognized because
!a space is used before the command.
Router#(config-if)# express ?
% Unrecognized command
Router(config-if)# end
Router# show alias interface
Interface configuration mode aliases:
express access-expression

Related Commands Command Description

show aliases Displays command aliases.

Cisco IOS Configuration Fundamentals Command Reference

10
 A through B
archive

archive
To enter archive configuration mode, use the archive command in global configuration mode.

archive

Syntax Description This command has no arguments or keywords.

Command Default None

Command Modes Global configuration

Command History Release Modification

12.3(4)T This command was introduced.

12.2(25)S This command was integrated into Cisco IOS

Release 12.2(25)S.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2(33)SB This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco
10000 series.

Examples The following example shows how to place the router in archive configuration mode:

Router# configure terminal

!
Router(config)# archive
Router(config-archive)#

Related Commands Command Description

log config Enters configuration change logger configuration
mode.

logging enable Enables the logging of configuration changes.

Cisco IOS Configuration Fundamentals Command Reference

11
 A through B
archive

Command Description
maximum Sets the maximum number of archive files of the
running configuration to be saved in the Cisco IOS
configuration archive.

path Specifies the location and filename prefix for the

files in the Cisco IOS configuration archive.

time-period Sets the time increment for automatically saving an

archive file of the current running configuration in
the Cisco IOS configuration archive.

Cisco IOS Configuration Fundamentals Command Reference

12
 A through B
archive config

archive config
To save a copy of the current running configuration to the Cisco IOS configuration archive, use the archive
config command in privileged EXEC mode.

archive config

Syntax Description This command has no arguments or keywords.

Command Modes Privileged EXEC (#)

Command History Release Modification

12.3(7)T This command was introduced.

12.2(25)S This command was integrated into Cisco IOS

Release 12.2(25)S.

12.2(28)SB This command was integrated into Cisco IOS

Release 12.2(28)SB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2(31)SB2 This command was implemented on the Cisco

10000 series.

12.2(33)SXH This command was integrated into Cisco IOS

Release 12.2(33)SXH.

12.2(33)SB This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco
10000 series.

Usage Guidelines

Note Before using this command, you must configure the path command in order to specify the location and
filename prefix for the files in the Cisco IOS configuration archive.

The Cisco IOS configuration archive is intended to provide a mechanism to store, organize, and manage an
archive of Cisco IOS configuration files to enhance the configuration rollback capability provided by the
configure replace command. Before this feature was introduced, you could save copies of the running
configuration using the copy running-config destination-url command, storing the target file either locally
or remotely. However, this method lacked any automated file management. On the other hand, the

Cisco IOS Configuration Fundamentals Command Reference

13
 A through B
archive config

Configuration Replace and Configuration Rollback feature provides the capability to automatically save
copies of the running configuration to the Cisco IOS configuration archive. These archived files serve as
checkpoint configuration references and can be used by the configure replace command to revert to
previous configuration states.
The archive config command allows you to save Cisco IOS configurations in the configuration archive
using a standard location and filename prefix that is automatically appended with an incremental version
number (and optional time stamp) as each consecutive file is saved. This functionality provides a means for
consistent identification of saved Cisco IOS configuration files. You can specify how many versions of the
running configuration are kept in the archive. After the maximum number of files has been saved in the
archive, the oldest file is automatically deleted when the next, most recent file is saved. The show archive
command displays information for all configuration files saved in the Cisco IOS configuration archive.

Examples The following example shows how to save the current running configuration to the Cisco IOS configuration
archive using the archive config command. Before using the archive config command, you must configure
the path command to specify the location and filename prefix for the files in the Cisco IOS configuration
archive. In this example, the location and filename prefix are specified as disk0:myconfig as follows:

configure terminal
!
archive
path disk0:myconfig
end

You then save the current running configuration in the configuration archive, as follows:

archive config

The show archive command displays information on the files saved in the configuration archive as shown
in the following sample output:

Router# show archive

There are currently 1 archive configurations saved.
The next archive file will be named disk0:myconfig-2
Archive # Name
0
1 disk0:myconfig-1 <- Most Recent
2
3
4
5
6
7
8
9
10

Related Commands Command Description

archive Enters archive configuration mode.

configure confirm Confirms replacement of the current running

configuration with a saved Cisco IOS configuration
file.

Cisco IOS Configuration Fundamentals Command Reference

14
A through B
archive config

Command Description
configure replace Replaces the current running configuration with a
saved Cisco IOS configuration file.

maximum Sets the maximum number of archive files of the

running configuration to be saved in the Cisco IOS
configuration archive.

path Specifies the location and filename prefix for the

files in the Cisco IOS configuration archive.

show archive Displays information about the files saved in the

Cisco IOS configuration archive.

time-period Sets the time increment for automatically saving an

archive file of the current running configuration in
the Cisco IOS configuration archive.

Cisco IOS Configuration Fundamentals Command Reference

15
 A through B
archive log config persistent save

archive log config persistent save

To save the persisted commands in the configuration log to the Cisco IOS secure file system, use the
archive log config persistent save command in privileged EXEC mode.

archive log config persistent save

Syntax Description This command has no arguments or keywords.

Command Default If this command is not entered, the persisted configuration commands in the archive log are not saved to the
Cisco IOS secure file system.

Command Modes Privileged EXEC (#).

Command History Release Modification

12.2(33)SRA This command was introduced.

12.4(11)T This command was integrated into Cisco IOS

Release 12.4(11)T.

12.2(33)SXH This command was integrated into Cisco IOS

Release 12.2(33)SXH.

12.2(33)SB This command was integrated into Cisco IOS

Release 12.2(33)SB.

Usage Guidelines If the router is in the persistent periodic mode, the persistent timer is restarted.

Examples The following example saves the persisted commands in the archive log to the Cisco IOS secure file
system:

Router# archive log config persistent save

Cisco IOS Configuration Fundamentals Command Reference

16
 A through B
archive log config persistent save

Related Commands Command Description

log config Enters configuration change logger configuration
mode.

logging enable Enables the logging of configuration changes.

logging persistent Enables the configuration logging persistent

feature.

Cisco IOS Configuration Fundamentals Command Reference

17
 A through B
archive tar

archive tar
To create a TAR file, to list files in a TAR file, or to extract the files from a TAR file, use the archive tar
command in privileged EXEC mode.

archive tar {/create destination-urlflash:/file-url | /table source-url | /xtract source-urlflash:/file-

url [dir/file...]}

Syntax Description /create destination-url flash:/ file-url Creates a new TAR file on the local or network file
system.
For destination-url, specify the destination URL
alias for the local or network file system and the
name of the TAR file to create. The following
options are supported:
• flash: --Syntax for the local flash file system.
• ftp: [[// username[: password]@ location]/
directory]/ tar-filename.tar-- Syntax for FTP.
• rcp: [[// username @ location]/ directory]/
tar-filename.tar--Syntax for Remote Copy
Protocol (RCP).
• tftp: [[// location]/ directory]/ tar-
filename.tar--Syntax for TFTP.
The tar-filename.tar is the name of the TAR file to
be created.
For flash:/ file-url, specify the location on the local
flash file system from which the new TAR file is
created.
An optional list of files or directories within the
source directory can be specified to write to the
new TAR file. If none is specified, all files and
directories at this level are written to the newly
created TAR file.

Cisco IOS Configuration Fundamentals Command Reference

18
 A through B
archive tar

/table source-url Display the contents of an existing TAR file to the

screen.
For source-url, specify the source URL alias for the
local or network file system. The following options
are supported:
• flash: --Syntax for the local flash file system.
• ftp: [[// username[: password]@ location]/
directory]/ tar-filename.tar-- Syntax for FTP.
• rcp: [[// username @ location]/ directory]/
tar-filename.tar--Syntax for Remote Copy
Protocol (RCP).
• tftp: [[// location]/ directory]/ tar-
filename.tar--Syntax for TFTP.
The tar-filename.tar is the name of the TAR file to
be created.

/xtract source-url flash:/ file-url [dir/file...] Extracts files from a TAR file to the local file
system.
For source-url, specify the source URL alias for the
local file system. These options are supported:
• flash: --Syntax for the local flash file system.
• ftp: [[// username[: password]@ location]/
directory]/ tar-filename.tar-- Syntax for FTP.
• rcp: [[// username @ location]/ directory]/
tar-filename.tar--Syntax for Remote Copy
Protocol (RCP).
• tftp: [[// location]/directory]/tar-filename.tar--
Syntax for TFTP.
The tar-filename.tar is the name of the TAR file to
be created.

Command Default The TAR archive file is not created.

Command Modes Privileged EXEC (#)

Command History Release Modification

12.1(13)AY This command was introduced.

12.2(33)SXH This command was integrated into Cisco IOS

Release 12.2(33)SXH.

Cisco IOS Configuration Fundamentals Command Reference

19
 A through B
archive tar

Release Modification
12.4(22)YB This command was integrated into Cisco IOS
Release 12.4(22)YB.

12.4(24)T This command was integrated into Cisco IOS

Release 12.4(24)T.

Usage Guidelines Filenames, directory names, and image names are case sensitive.
The TAR file is an archive file from which you can extract files by using the archive tarcommand.

Examples The following example shows how to create a TAR file. The command writes the contents of the new-
configs directory on the local flash device to a file named saved.tar on the TFTP server at 172.20.136.9.

Switch# archive tar /create tftp:172.20.136.9/saved.tar flash:/new-configs

The following example shows how to display the contents of the c2940-tv0-m.tar file that is in flash
memory. The contents of the TAR file appear on the screen.

Switch# archive tar /table flash:c2940-tv0-m.tar

info (219 bytes)

c2940-tv0-mz-121/ (directory)
c2940-tv0-mz-121/html/ (directory)
c2940-tv0-mz-121/html/foo.html (0 bytes)
c2940-tv0-mz-121/vegas-tv0-mz-121.bin (610856 bytes)
c2940-tv0-mz-121/info (219 bytes)
info.ver (219 bytes)

The following example shows how to extract the contents of a TAR file on the TFTP server at
172.20.10.30. This command extracts only the new-configs directory into the root directory on the local
flash file system. The remaining files in the saved.tar file are ignored.

Switch# archive tar /xtract tftp:/172.20.10.30/saved.tar flash:/ new-configs

Cisco IOS Configuration Fundamentals Command Reference

20
 A through B
async-bootp

async-bootp
To configure extended BOOTP requests for asynchronous interfaces as defined in RFC 1084, use the
async-bootp command in global configuration mode. To restore the default, use the noform of this
command.

async-bootp tag [:hostname] data

no async-bootp

Syntax Description tag Item being requested; expressed as filename,

integer, or IP dotted decimal address. See the table
below for possible keywords.

: hostname (Optional) This entry applies only to the specified

host. The :hostname argument accepts both an IP
address and a logical host name.

data List of IP addresses entered in dotted decimal

notation or as logical host names, a number, or a
quoted string.

Table 5 tag Keyword Options

Keyword Description
bootfile Specifies use of a server boot file from which to
download the boot program. Use the
optional :hostname argument and the data argument
to specify the filename.

subnet-mask mask Dotted decimal address specifying the network and

local subnetwork mask (as defined by RFC 950).

time-offset offset Signed 32-bit integer specifying the time offset of

the local subnetwork in seconds from Coordinated
Universal Time (UTC).

gateway address Dotted decimal address specifying the IP addresses

of gateways for this subnetwork. A preferred
gateway should be listed first.

time-server address Dotted decimal address specifying the IP address of

time servers (as defined by RFC 868).

IEN116-server address Dotted decimal address specifying the IP address of

name servers (as defined by IEN 116).

nbns-server address Dotted decimal address specifying the IP address of

Windows NT servers.

Cisco IOS Configuration Fundamentals Command Reference

21
 A through B
async-bootp

Keyword Description
DNS-server address Dotted decimal address specifying the IP address of
domain name servers (as defined by RFC 1034).

log-server address Dotted decimal address specifying the IP address of

an MIT-LCS UDP log server.

quote-server address Dotted decimal address specifying the IP address of

Quote of the Day servers (as defined in RFC 865).

lpr-server address Dotted decimal address specifying the IP address of

Berkeley UNIX Version 4 BSD servers.

impress-server address Dotted decimal address specifying the IP address of

Impress network image servers.

rlp-server address Dotted decimal address specifying the IP address of

Resource Location Protocol (RLP) servers (as
defined in RFC 887).

hostname name The name of the client, which may or may not be
domain qualified, depending upon the site.

bootfile-size value A two-octet value specifying the number of 512-

octet (byte) blocks in the default boot file.

Command Default If no extended BOOTP commands are entered, the Cisco IOS software generates a gateway and subnet
mask appropriate for the local network.

Command Modes Global configuration

Command History Release Modification

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 show async-bootp EXEC command to list the configured parameters. Use the no async-bootp
command to clear the list.

Cisco IOS Configuration Fundamentals Command Reference

22
 A through B
async-bootp

Examples The following example illustrates how to specify different boot files: one for a PC, and one for a
Macintosh. With this configuration, a BOOTP request from the host on 172.30.1.1 results in a reply listing
the boot filename as pcboot. A BOOTP request from the host named “mac” results in a reply listing the
boot filename as “macboot.”

async-bootp bootfile :172.30.1.1 “pcboot”

async-bootp bootfile :mac “macboot”

The following example specifies a subnet mask of 255.255.0.0:

async-bootp subnet-mask 255.255.0.0

The following example specifies a negative time offset of the local subnetwork of 3600 seconds:

async-bootp time-offset -3600

The following example specifies the IP address of a time server:

async-bootp time-server 172.16.1.1

Related Commands Command Description

show async bootp Displays the extended BOOTP request parameters
that have been configured for asynchronous
interfaces.

Cisco IOS Configuration Fundamentals Command Reference

23
 A through B
attach

attach
To connect to a specific line card or module from a remote location for the purpose of executing
monitoring and maintenance commands on that line card or module, use the attach command in privileged
EXEC mode. To exit from the Cisco IOS software image on the line card and return to the Cisco IOS
image on the main (Supervisor) module, use the exit command.

Cisco 12000 Series

attach slot-number

Cisco 7600 Series and Catalyst 6500 Series

attach module-number

Syntax Description slot-number Slot number of the line card to which you wish to
connect.
If you omit the slot number, you will be prompted
for it.

module-number Module number; see the “Usage Guidelines”

section for valid values.

Command Default No default behavior or values.

Command Modes Privileged EXEC

Command History Release Modification

11.2GS This command was introduced on the Cisco 12000
series.

12.2(14)SX This command was implemented on the Supervisor

Engine 720.

12.2(17d)SXB Support was added for the Supervisor Engine 2.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Cisco IOS Configuration Fundamentals Command Reference

24
 A through B
attach

Usage Guidelines Cisco 12000 Series

You must first use the attach privileged EXEC command to access the Cisco IOS software image on a line
card before using line card-specific show EXEC commands. Alternatively, you can use the execute-on
privileged EXEC command to execute a show command on a specific line card.
After you connect to the Cisco IOS image on the line card using the attach command, the prompt changes
to LC-Slotx# , where x is the slot number of the line card.
The commands executed on the line card use the Cisco IOS image on that line card.
You can also use the execute-on slot privileged EXEC command to execute commands on one or all line
cards.

Note Do not execute the configEXEC command from the Cisco IOS software image on the line card.

Cisco 7600 Series and Catalyst 6500 Series

Caution After you enter the attach or remote login command to access another console from your switch, if you
enter global or interface configuration mode commands, the switch might reset.

Th e v alid values for the module-number argument depend on the chassis that is used. For example, if you
have a 13-slot chassis, valid values for the module number are from 1 to 13.
This command is supported on Distributed Forwarding Card (DFC)-equipped modules, FlexWan modules,
and the supervisor engine only.
When you execute the attach module-number command, the prompt changes to Router-dfcx# or Switch-
sp#, depending on the type of module to which you are connecting.
The behavior of the attach command is identical to that of the remote login module numcommand.
There are two ways to end this session:
• You can enter the exit command as follows:

Router-dfc3# exit
[Connection to Switch closed by foreign host]
Router#

• You can press Ctrl-C three times as follows:

Router-dfc3# ^C
Router-dfc3# ^C
Router-dfc3# ^C
Terminate remote login session? [confirm] y
[Connection to Switch closed by local host]
Router#

Examples In the following example, the user connects to the Cisco IOS image running on the line card in slot 9, gets a
list of valid show commands, and returns the Cisco IOS image running on the GRP:

Router# attach 9
Entering Console for 4 Port Packet Over SONET OC-3c/STM-1 in Slot: 9
Type exit to end this session
Press RETURN to get started!

Cisco IOS Configuration Fundamentals Command Reference

25
 A through B
attach

LC-Slot9# show ?
cef Cisco Express Forwarding
clock Display the system clock
context Show context information about recent crash(s)
history Display the session command history
hosts IP domain-name, lookup style, nameservers, and host table
ipc Interprocess communications commands
location Display the system location
sessions Information about Telnet connections
terminal Display terminal configuration parameters
users Display information about terminal lines
version System hardware and software status
LC-Slot9# exit
Disconnecting from slot 9.
Connection Duration: 00:01:04
Router#

Note Because not all statistics are maintained on line cards, the output from some of show commands may be
inconsistent.

The following example shows how to log in remotely to the DFC-equipped module:

Console#
attach 3
Trying Switch ...
Entering CONSOLE for Switch
Type "^C^C^C" to end this session
Router-dfc3#

Related Commands Command Description

attach shelf Connects you to a specific (managed) shelf for the
purpose of remotely executing commands on that
shelf only.

execute-on slot Executes commands remotely on a specific line

card, or on all line cards simultaneously.

remote login Accesses the Cisco 7600 series router console or a

specific module.

Cisco IOS Configuration Fundamentals Command Reference

26
 A through B
autobaud

autobaud
To set the line for automatic baud rate detection (autobaud), use the autobaudcommand in line
configuration mode. To disable automatic baud detection, use the noform of this command.

autobaud
no autobaud

Syntax Description This command has no arguments or keywords.

Command Default Autobaud detection is disabled. Fixed speed of 9600 bps.

Command Modes Line configuration

Command History Release Modification

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 autobaud detection supports a range from 300 to 19200 baud. A line set for autobaud cannot be used
for outgoing connections, nor can you set autobaud capability on a line using 19200 baud when the parity
bit is set (because of hardware limitations).

Note Automatic baud detection must be disabled by using the no autobaud command prior to setting the txspeed,
rxspeed, or speed commands.

Examples In the following example, the auxiliary port is configured for autobaud detection:

Router(config)# line aux

Router(config-line)# autobaud

Cisco IOS Configuration Fundamentals Command Reference

27
 A through B
auto-sync

auto-sync
To enable automatic synchronization of the configuration files in NVRAM, use the auto-sync command in
main-cpu redundancy configuration mode. To disable automatic synchronization, use the no form of this
command.

auto-sync {startup-config | config-register | bootvar | running-config | standard}

no auto-sync {startup-config | config-register | bootvar | standard}

Syntax Description startup-config Specifies synchronization of the startup

configuration files.

config-register Specifies synchronization of the configuration

register values.

bootvar Specifies synchronization of the following boot

variables:
• BOOT--Set by the boot
systemdevice:filename command.
• CONFIG_FILE--Set by the boot
configdevice:filename command.
• BOOTLDR--Set by the boot
bootldrdevice:filename command.

running-config Specifies synchronization of the running

configuration files.

standard Specifies synchronization of all of the system files

(startup configuration, boot variables, and config
configuration registers).

Command Default For the Performance Routing Engines (PREs) on the Cisco uBR10012 universal broadband router, the
system defaults to synchronizing all system files on the (auto-sync standard).
For the Supervisor Engines on the Cisco 7600 series routers, the system defaults to synchronizing the
running configuration. (running-config).
At the Cisco RF Gateway 10 chassis level, all the system files are synchronized by default.
Redundancy configuration (config-r)

Command Modes Main CPU redundancy configuration (config-r-mc)

Cisco IOS Configuration Fundamentals Command Reference

28
 A through B
auto-sync

Command History Release Modification

12.2(4)XF1 This command was introduced on the Cisco
uBR10012 universal broadband router.

12.2(14)SX This command was integrated into the Supervisor

Engine 720.

12.2(17d)SXB Support was added for the Supervisor Engine 2.

12.2(18)SXD Support for this command on the Cisco 7600 series

routers was removed.

12.3BC This command was integrated into Cisco IOS

Release 12.3BC for the Cisco uBR10012 router.

12.2(33)SCA This command is obsolete on the Cisco uBR10012

universal broadband router.

12.2(44)SQ This command was integrated into Cisco IOS

Release 12.2(44)SQ. Support for the Cisco RF
Gateway 10 was added.

Usage Guidelines Cisco 7600 Series Routers

If you enter the no auto-sync standard command, no automatic synchronizations occur. If you want to
enable any of the keywords, you have to enter the appropriate command for each keyword.
The auto-synccommand is not supported in RPR+ mode.
Cisco uBR10012 Universal Broadband Router
By default, the system synchronizes all system files, which is the typical setting for most applications.
However, you might want exclude certain files from synchronization for specialized applications.
For example, if you have configured the active and standby PRE1 (or PRE2) modules to run different
versions of Cisco IOS software, you might want to use different configuration files as well. In this case,
you would not synchronize the startup configuration file.
Cisco RF Gateway 10
We recommend that you use the auto-sync standard command to ensure that all system files are
synchronized between the two Supervisor modules. The no auto-sync command is not used in production
plants.

Examples
Cisco 7600 Series Routers
The following example shows how (from the default configuration) to enable automatic synchronization of
the configuration register in the main CPU:

Router#
configure terminal
Router (config)#
redundancy

Cisco IOS Configuration Fundamentals Command Reference

29
 A through B
auto-sync

Router (config-r)#
main-cpu
Router (config-r-mc)#
no auto-sync standard
Router (config-r-mc)#
auto-sync config-register

Cisco uBR10012 Universal Broadband Router

The following example shows the system being configured to synchronize only the startup configuration
file:

router(config)# redundancy
router(config-r)# main-cpu
router(config-r-mc)# auto-sync startup-config
router(config-r-mc)# exit

router(config-r)# exit

The following example shows how to configure the system to synchronize all system files except for the
startup configuration file. This typically is done when the two PRE1 (or PRE2) modules are running
different software images.

router(config)# redundancy
router(config-r)# main-cpu
router(config-r-mc)# no auto-sync startup-config
router(config-r-mc)# auto-sync config-register
router(config-r-mc)# auto-sync bootvar
router(config-r-mc)# exit

router(config-r)# exit

Cisco RF Gateway 10
The following example shows the synchronization of all system files on the Cisco RFGW-10 chassis:

Router#configure terminal
Router(config)#redundancy
Router(config-red)#main-cpu
Router(config-r-mc)#auto-sync standard
Router(config-r-mc)#exit
Router(config-red)#exit

Related Commands Command Description

redundancy Enters redundancy configuration mode.

main-cpu Enters main CPU redundancy configuration mode.

Cisco IOS Configuration Fundamentals Command Reference

30
 A through B
autoupgrade disk-cleanup

autoupgrade disk-cleanup
To configure the Cisco IOS Auto-Upgrade Manager disk cleanup utility, use the autoupgrade disk-
cleanup command in global configuration mode. To disable this configuration, use the no form of this
command.

autoupgrade disk-cleanup [crashinfo | core | image | irrecoverable]

no autoupgrade disk-cleanup [crashinfo | core | image | irrecoverable]

Syntax Description crashinfo (Optional) Deletes crashinfo files during disk-

cleanup before an image is downloaded.

core (Optional) Deletes core files during disk-cleanup

before an image is downloaded.

image (Optional) Deletes the Cisco IOS images, except

the default boot image and the current image,
during disk-cleanup before an image is
downloaded.

irrecoverable (Optional) Deletes files irretrievably (in a file-

system that supports the undelete operation) during
disk-cleanup before an image is downloaded.

Command Default By default, the crashinfo files, the core files, and the Cisco IOS software images are deleted by the Cisco
IOS Auto-Upgrade Manager disk cleanup utility, and the filesystems that support the undelete operation are
not cleaned up.

Command Modes Global configuration (config)

Command History Release Modification

12.4(15)T This command was introduced.

Examples The following example shows how to clean-up filesystems that support undelete operation:

Router(config)# autoupgrade disk-cleanup irrecoverable

The following example shows how to avoid deleting the Cisco IOS software images:

Router(config)# no autoupgrade disk-cleanup image

Cisco IOS Configuration Fundamentals Command Reference

31
 A through B
autoupgrade disk-cleanup

Related Commands Command Description

autoupgrade ida url Configures the URL of the server on
www.cisco.com where the image download
requests will be sent by Auto-Upgrade Manager.

autoupgrade status email Configures the address to which the status email is
to be sent.

upgrade automatic getversion Downloads a Cisco IOS software image directly

from www.cisco.com or from a non-Cisco server.

Cisco IOS Configuration Fundamentals Command Reference

32
 A through B
autoupgrade ida url

autoupgrade ida url

To configure the URL of the Intelligent Download Application (IDA) running on www.cisco.com, use the
autoupgrade ida url command in global configuration mode. The router will send the image download
requests to the configured URL. To disable this URL, use the no form of this command.

autoupgrade ida url url

no autoupgrade ida url url

Syntax Description url URL of the IDA server.

Command Default Default URL: https://www.cisco.com/cgi-bin/ida/locator/locator.pl

Command Modes Global configuration (config)

Command History Release Modification

12.4(15)T This command was introduced.

Usage Guidelines Use the autoupgrade ida url command to configure a new URL for the IDA server, if it is not present in
the default location.

Examples The following example shows how to configure the URL for the IDA server:

Router(config)# autoupgrade ida url https://www.cisco.com/cgi-bin/ida/locator/locator.pl

Related Commands Command Description

autoupgrade disk-cleanup Configures the Cisco IOS Auto-Upgrade Manager
disk cleanup utility.

autoupgrade status email Configures the address to which the status email is
to be sent.

Cisco IOS Configuration Fundamentals Command Reference

33
 A through B
autoupgrade ida url

Command Description
upgrade automatic getversion Downloads a Cisco IOS software image directly
from www.cisco.com or from a non-Cisco server.

Cisco IOS Configuration Fundamentals Command Reference

34
 A through B
autoupgrade status email

autoupgrade status email

To configure the address to which status email is to be sent and the outgoing email server, use the
autoupgrade status email command in global configuration mode. To disable status email, use the no
form of this command.

autoupgrade status email [recipient [email-address]] [smtp-server [smtp-server]]

no autoupgrade status email [recipient [email-address]] [smtp-server [smtp-server]]

Syntax Description recipient The address to which the Cisco IOS Auto-Upgrade
Manager (AUM) status is to be sent.

smtp-server The outgoing email server to which the AUM email

is sent.

email-address The email address to which the AUM status is to be

sent.

Command Default Status email is not sent unless the address is configured. The recipient email address and SMTP server have
to be configured in order to receive AUM status email.

Command Modes Global configuration (config)

Command History Release Modification

12.4(15)T This command was introduced.

Usage Guidelines Use this command to configure the email-address where AUM status email can be sent.

Examples The following example shows how to configure the address to which status email is to be sent:

Router(config)# autoupgrade status email recipient [email protected]

Router(config)# autoupgrade status email smtp-server smtpserver.abc.com

Cisco IOS Configuration Fundamentals Command Reference

35
 A through B
autoupgrade status email

Related Commands Command Description

autoupgrade disk-cleanup Configures the Cisco IOS Auto-Upgrade Manager
disk cleanup utility.

autoupgrade ida url Configures the URL of the server running on

www.cisco.com to which the router sends the
image download requests.

upgrade automatic getversion Downloads a Cisco IOS software image directly

from www.cisco.com or from a non-Cisco server.

Cisco IOS Configuration Fundamentals Command Reference

36
 A through B
banner exec

banner exec
To specify and enable a message to be displayed when an EXEC process is created (an EXEC banner), use
the banner exec command in global configuration mode. To delete the existing EXEC banner, use the no
form of this command.

banner exec d message d

no banner exec

Syntax Description d Delimiting character of your choice--a pound sign

(#), for example. You cannot use the delimiting
character in the banner message.

message Message text. You can include tokens in the form $

(token ) in the message text. Tokens will be
replaced with the corresponding configuration
variable. Tokens are described in the table below.

Command Default Disabled (no EXEC banner is displayed).

Command Modes Global configuration

Command History Release Modification

10.0 This command was introduced.

11.3(7.5)AA Token functionality was introduced.

12.0(3)T Token functionality was integrated into Cisco IOS

Release 12.0(3)T.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command specifies a message to be displayed when an EXEC process is created (a line is activated, or
an incoming connection is made to a vty). Follow this command with one or more blank spaces and a
delimiting character of your choice. Then enter one or more lines of text, terminating the message with the
second occurrence of the delimiting character.
When a user connects to a router, the message-of-the-day (MOTD) banner appears first, followed by the
login banner and prompts. After the user logs in to the router, the EXEC banner or incoming banner will be

Cisco IOS Configuration Fundamentals Command Reference

37
 A through B
banner exec

displayed, depending on the type of connection. For a reverse Telnet login, the incoming banner will be
displayed. For all other connections, the router will display the EXEC banner.
To disable the EXEC banner on a particular line or lines, use the no exec-banner line configuration
command.
To customize the banner, use tokens in the form $(token ) in the message text. Tokens will display current
Cisco IOS configuration variables, such as the router’s host name and IP address. The tokens are described
in the table below.

Table 6 banner exec Tokens

Token Information Displayed in the Banner

$(hostname) Displays the host name for the router.

$(domain) Displays the domain name for the router.

$(line) Displays the vty or tty (asynchronous) line number.

$(line-desc) Displays the description attached to the line.

Examples The following example sets an EXEC banner that uses tokens. The percent sign (%) is used as a delimiting
character. Notice that the $(token ) syntax is replaced by the corresponding configuration variable.

Router(config)# banner exec %

Enter TEXT message. End with the character '%'.
Session activated on line $(line), $(line-desc). Enter commands at the prompt.
%

When a user logs on to the system, the following output is displayed:

User Access Verification

Username: joeuser
Password: <password>
Session activated on line 50, vty default line. Enter commands at the prompt.
Router>

Related Commands Command Description

banner incoming Defines a customized banner to be displayed when
there is an incoming connection to a terminal line
from a host on the network.

banner login Defines a customized banner to be displayed before

the username and password login prompts.

banner motd Defines a customized message-of-the-day banner.

banner slip-ppp Defines a customized banner to be displayed when

a serial-line IP or point-to-point connection is
made.

Cisco IOS Configuration Fundamentals Command Reference

38
A through B
banner exec

Command Description
exec-banner Controls (enables or disables) the display of EXEC
banners and message-of-the-day banners on a
specified line or lines.

Cisco IOS Configuration Fundamentals Command Reference

39
 A through B
banner incoming

banner incoming
To define and enable a banner to be displayed when there is an incoming connection to a terminal line from
a host on the network, use the banner incoming command in global configuration mode. To delete the
incoming connection banner, use the no form of this command.

banner incoming d message d

no banner incoming

Syntax Description d Delimiting character of your choice--a pound sign

(#), for example. You cannot use the delimiting
character in the banner message.

message Message text. You can include tokens in the form $

(token ) in the message text. Tokens will be
replaced with the corresponding configuration
variable. Tokens are described in the table below.

Command Default Disabled (no incoming banner is displayed).

Command Modes Global configuration

Command History Release Modification

10.0 This command was introduced.

11.3(7.5)AA Token functionality was introduced.

12.0(3)T Token functionality was integrated into Cisco IOS

Release 12.0(3)T.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Follow the banner incomingcommand with one or more blank spaces and a delimiting character of your
choice. Then enter one or more lines of text, terminating the message with the second occurrence of the
delimiting character.
An incoming connection is one initiated from the network side of the router. Incoming connections are also
called reverse Telnet sessions. These sessions can display MOTD banners and incoming banners, but they

Cisco IOS Configuration Fundamentals Command Reference

40
 A through B
banner incoming

do not display EXEC banners. Use the no motd-banner line configuration command to disable the MOTD
banner for reverse Telnet sessions on asynchronous lines.
When a user connects to the router, the message-of-the-day (MOTD) banner (if configured) appears first,
before the login prompt. After the user successfully logs in to the router, the EXEC banner or incoming
banner will be displayed, depending on the type of connection. For a reverse Telnet login, the incoming
banner will be displayed. For all other connections, the router will display the EXEC banner.
Incoming banners cannot be suppressed. If you do not want the incoming banner to appear, you must delete
it with the no banner incoming command.
To customize the banner, use tokens in the form $(token ) in the message text. Tokens will display current
Cisco IOS configuration variables, such as the router’s host name and IP address. The tokens are described
in the table below.

Table 7 banner incoming Tokens

Token Information Displayed in the Banner

$(hostname) Displays the host name for the router.

$(domain) Displays the domain name for the router.

$(line) Displays the vty or tty (asynchronous) line number.

$(line-desc) Displays the description attached to the line.

Examples The following example sets an incoming connection banner. The pound sign (#) is used as a delimiting
character.

Router(config)# banner incoming #

This is the Reuses router.
#

The following example sets an incoming connection banner that uses several tokens. The percent sign (%)
is used as a delimiting character.

darkstar(config)# banner incoming %

Enter TEXT message. End with the character '%'.
You have entered $(hostname).$(domain) on line $(line) ($(line-desc)) %

When the incoming connection banner is executed, the user will see the following banner. Notice that the $
(token ) syntax is replaced by the corresponding configuration variable.

You have entered darkstar.ourdomain.com on line 5 (Dialin Modem)

Related Commands Command Description

banner exec Defines a customized banner to be displayed
whenever the EXEC process is initiated.

Cisco IOS Configuration Fundamentals Command Reference

41
 A through B
banner incoming

Command Description
banner login Defines a customized banner to be displayed before
the username and password login prompts.

banner motd Defines a customized message-of-the-day banner.

banner slip-ppp Defines a customized banner to be displayed when

a serial-line IP or point-to-point connection is
made.

Cisco IOS Configuration Fundamentals Command Reference

42
 A through B
banner login

banner login
To define and enable a customized banner to be displayed before the username and password login
prompts, use the banner login command in global configuration mode. To disable the login banner, use no
form of this command.

banner login d message d

no banner login

Syntax Description d Delimiting character of your choice--a pound sign

(#), for example. You cannot use the delimiting
character in the banner message.

message Message text. You can include tokens in the form $

(token) in the message text. Tokens will be replaced
with the corresponding configuration variable.
Tokens are described in the table below.

Command Default Disabled (no login banner is displayed).

Command Modes Global configuration

Command History Release Modification

10.0 This command was introduced.

11.3(7.5)AA Token functionality was introduced.

12.0(3)T Token functionality was integrated into Cisco IOS

Release 12.0(3)T.

12.2(14)SX This command was integrated into Cisco IOS

Release 12.2(14)SX.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Follow the banner login command with one or more blank spaces and a delimiting character of your
choice. Then enter one or more lines of text, terminating the message with the second occurrence of the
delimiting character.

Cisco IOS Configuration Fundamentals Command Reference

43
 A through B
banner login

When a user connects to the router, the message-of-the-day (MOTD) banner (if configured) appears first,
followed by the login banner and prompts. After the user successfully logs in to the router, the EXEC
banner or incoming banner will be displayed, depending on the type of connection. For a reverse Telnet
login, the incoming banner will be displayed. For all other connections, the router will display the EXEC
banner.
To customize the banner, use tokens in the form $(token ) in the message text. Tokens will display current
Cisco IOS configuration variables, such as the router’s host name and IP address. The tokens are described
in the table below.

Table 8 banner login Tokens

Token Information Displayed in the Banner

$(hostname) Displays the host name for the router.

$(domain) Displays the domain name for the router.

$(line) Displays the vty or tty (asynchronous) line number.

$(line-desc) Displays the description attached to the line.

Examples The following example sets a login banner. Double quotes (") are used as the delimiting character.

Router# banner login " Access for authorized users only. Please enter your username and
password. "

The following example sets a login banner that uses several tokens. The percent sign (%) is used as the
delimiting character.

darkstar(config)# banner login %

Enter TEXT message. End with the character '%'.
You have entered $(hostname).$(domain) on line $(line) ($(line-desc)) %

When the login banner is executed, the user will see the following banner. Notice that the $(token) syntax
is replaced by the corresponding configuration variable.

You have entered darkstar.ourdomain.com on line 5 (Dialin Modem)

Related Commands Command Description

banner exec Defines a customized banner to be displayed
whenever the EXEC process is initiated.

banner incoming Defines a customized message to be displayed

when there is an incoming connection to a terminal
line from a host on the network.

banner motd Defines a customized message-of-the-day banner.

Cisco IOS Configuration Fundamentals Command Reference

44
A through B
banner login

Command Description
banner slip-ppp Defines a customized banner to be displayed when
a serial-line IP or point-to-point connection is
made.

Cisco IOS Configuration Fundamentals Command Reference

45
 A through B
banner motd

banner motd
To define and enable a message-of-the-day (MOTD) banner, use the banner motd command in global
configuration mode. To delete the MOTD banner, use the no form of this command.
banner motd d message d
no banner motd

Syntax Description d Delimiting character of your choice--a pound sign

(#), for example. You cannot use the delimiting
character in the banner message.

message Message text. You can include tokens in the form $

(token ) in the message text. Tokens will be
replaced with the corresponding configuration
variable.

Command Default Disabled (no MOTD banner is displayed).

Command Modes Global configuration

Command History Release Modification

10.0 This command was introduced.

11.3(7.5)AA Token functionality was introduced.

12.0(3)T Token functionality was integrated into Cisco IOS

Release 12.0(3)T.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Follow this command with one or more blank spaces and a delimiting character of your choice. Then enter
one or more lines of text, terminating the message with the second occurrence of the delimiting character.
This MOTD banner is displayed to all terminals connected and is useful for sending messages that affect all
users (such as impending system shutdowns). Use the no exec-banner or no motd-banner command to
disable the MOTD banner on a line. The no exec-banner command also disables the EXEC banner on the
line.
When a user connects to the router, the MOTD banner appears before the login prompt. After the user logs
in to the router, the EXEC banner or incoming banner will be displayed, depending on the type of

Cisco IOS Configuration Fundamentals Command Reference

46
 A through B
banner motd

connection. For a reverse Telnet login, the incoming banner will be displayed. For all other connections,
the router will display the EXEC banner.
To customize the banner, use tokens in the form $(token ) in the message text. Tokens will display current
Cisco IOS configuration variables, such as the router’s host name and IP address. The tokens are described
in the table below.

Table 9 banner motd Tokens

Token Information Displayed in the Banner

$(hostname) Displays the host name for the router.

$(domain) Displays the domain name for the router.

$(line) Displays the vty or tty (asynchronous) line number.

$(line-desc) Displays the description attached to the line.

Examples The following example configures an MOTD banner. The pound sign (#) is used as a delimiting character.

Router# banner motd # Building power will be off from 7:00 AM until 9:00 AM this coming
Tuesday.

The following example configures an MOTD banner with a token. The percent sign (%) is used as a
delimiting character.

darkstar(config)# banner motd %

Enter TEXT message. End with the character '%'.
Notice: all routers in $(domain) will be upgraded beginning April 20
%

When the MOTD banner is executed, the user will see the following. Notice that the $(token ) syntax is
replaced by the corresponding configuration variable.

Notice: all routers in ourdomain.com will be upgraded beginning April 20

Related Commands Command Description

banner exec Defines and enables a customized banner to be
displayed whenever the EXEC process is initiated.

banner incoming Defines and enables a customized message to be

displayed when there is an incoming connection to
a terminal line from a host on the network.

banner login Defines and enables a customized banner to be

displayed before the username and password login
prompts.

Cisco IOS Configuration Fundamentals Command Reference

47
 A through B
banner motd

Command Description
banner slip-ppp Defines and enables a customized banner to be
displayed when a serial-line IP or point-to-point
connection is made.

exec-banner Controls (enables or disables) the display of EXEC

banners and message-of-the-day banners on a
specified line or lines.

motd-banner Controls (enables or disables) the display of

message-of-the-day banners on a specified line or
lines.

Cisco IOS Configuration Fundamentals Command Reference

48
 A through B
banner slip-ppp

banner slip-ppp
To customize the banner that is displayed when a Serial Line Internet Protocol (SLIP) or PPP connection is
made, use the banner slip-ppp command in global configuration mode. To restore the default SLIP or PPP
banner, use the no form of this command.

banner slip-ppp d message d

no banner slip-ppp

Syntax Description d Delimiting character of your choice--a pound sign

(#), for example. You cannot use the delimiting
character in the banner message.

message Message text. You can include tokens in the form $

(token ) in the message text. Tokens will be
replaced with the corresponding configuration
variable.

Command Default The default SLIP or PPP banner message is:

Entering encapsulation mode.

Async interface address is unnumbered (Ethernet0)
Your IP address is 10.000.0.0 MTU is 1500 bytes

The banner message when using the service old-slip-prompt command is:

Entering encapsulation mode.

Your IP address is 10.100.0.0 MTU is 1500 bytes

where encapsulation is SLIP or PPP.

Command Modes Global configuration

Command History Release Modification

12.0(3)T This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Follow this command with one or more blank spaces and a delimiting character of your choice. Then enter
one or more lines of text, terminating the message with the second occurrence of the delimiting character.

Cisco IOS Configuration Fundamentals Command Reference

49
 A through B
banner slip-ppp

Use this command to define a custom SLIP or PPP connection message. This is useful when legacy client
applications require a specialized connection string. To customize the banner, use tokens in the form $
(token ) in the message text. Tokens will display current Cisco IOS configuration variables, such as the
routers host name, IP address, encapsulation type, and Maximum Transfer Unit (MTU) size. The banner
tokens are described in the table below.

Table 10 banner slip-ppp Tokens

Token Information Displayed in the Banner

$(hostname) Displays the host name of the router.

$(domain) Displays the domain name of the router.

$(peer-ip) Displays the IP address of the peer machine.

$(gate-ip) Displays the IP address of the gateway machine.

$(encap) Displays the encapsulation type (SLIP, PPP, and so

on).

$(encap-alt) Displays the encapsulation type as SL/IP instead of

SLIP.

$(mtu) Displays the MTU size.

Examples The following example sets the SLIP/PPP banner using several tokens and the percent sign (%) as the
delimiting character:

Router(config)# banner slip-ppp %

Enter TEXT message. End with the character '%'.
Starting $(encap) connection from $(gate-ip) to $(peer-ip) using a maximum packet size of
$(mtu) bytes... %

The new SLIP/PPP banner will now be displayed when the slip EXEC command is used. Notice that the $
(token ) syntax is replaced by the corresponding configuration variable.

Router# slip
Starting SLIP connection from 172.16.69.96 to 192.168.1.200 using a maximum packet size
of 1500 bytes...

Related Commands Command Description

banner exec Defines and enables a customized banner to be
displayed whenever the EXEC process is initiated.

banner incoming Defines and enables a customized message to be

displayed when there is an incoming connection to
a terminal line from a host on the network.

Cisco IOS Configuration Fundamentals Command Reference

50
A through B
banner slip-ppp

Command Description
banner motd Defines and enables a customized message-of-the-
day banner.

ppp Initiates a connection to a remote host using PPP.

slip Initiates a connection to a remote host using SLIP.

Cisco IOS Configuration Fundamentals Command Reference

51
 A through B
boot

boot
To boot the router manually, use the bootcommand in ROM monitor mode. The syntax of this command
varies according to the platform and ROM monitor version.

boot
boot file-url
boot filename [tftp-ip-address]
boot flash [flash-fs:] [partition-number:] [filename]

Cisco 7000 Series, 7200 Series, 7500 Series Routers

boot flash-fs : [filename]

Cisco 1600 and Cisco 3600 Series Routers

boot [flash-fs:] [partition-number:] [filename]

Cisco 1800 Series, 2800 Series, and 3800 Series Routers

boot usbflash0 [:filename]

Syntax Description file-url URL of the image to boot (for example, boot tftp://
172.16.15.112/routertest).

Cisco IOS Configuration Fundamentals Command Reference

52
A through B
boot

filename When used in conjunction with the ip-address

argument, the filename argument is the name of the
system image file to boot from a network server.
The filename is case sensitive.
When used in conjunction with the flash keyword,
the filename argument is the name of the system
image file to boot from Flash memory.
On all platforms except the Cisco 1600 series,
Cisco 3600 series, and Cisco 7000 family routers,
the system obtains the image file from internal
Flash memory.
On the Cisco 1600 series, Cisco 3600 series and
Cisco 7000 family routers, the flash-fs : argument
specifies the Flash memory device from which to
obtain the system image. (See the flash-fs :
argument later in this table for valid device values.)
The filename is case sensitive. Without the
filenameargument , the first valid file in Flash
memory is loaded.
If the filename is not specified, the first file in the
partition or file system is used. (A USB Flash uses
the first image in (compact) Flash as the boot loader
and loads the image from USB Flash.)

tftp-ip-address (optional) IP address of the TFTP server on which

the system image resides. If omitted, this value
defaults to the IP broadcast address of
255.255.255.255.

flash Boots the router from Flash memory. Note that this
keyword is required in some boot images.

usbflash0 Boot the first file in USB Flash 0. If the optional

filename argument is used, the router boots the
specified image from USB Flash.
Note This option uses the first image in (compact)
Flash as the boot loader and loads the image
from USB Flash.

Cisco IOS Configuration Fundamentals Command Reference

53
 A through B
boot

flash-fs : (Optional) Specifying the Flash file system is

optional for all platforms except the Cisco 7500
series routers. Possible file systems are:
• flash: --Internal Flash memory.
• bootflash: --Internal Flash memory on the
Cisco 7000 family.
• slot0: --Flash memory card in the first
PCMCIA slot on the Cisco 7000 family and
Cisco 3600 series routers.
• slot1: --Flash memory card in the second
PCMCIA slot on the Cisco 7000 family and
Cisco 3600 series routers.

partition-number : (Optional) Specifies the partition number of the file

system the file should be loaded from. This
argument is not available on all platforms. If the
partition-number is not specified, the first partition
is used.

Command Default For most platforms, if you enter the boot command and press Enter, the router boots from ROM by default.
However, for some platforms, such as the Cisco 3600 series routers, if you enter the boot command and
press Enter, the router boots the first image in Flash memory. Refer to the documentation for your platform
for information about the default image.

Command Modes ROM monitor

Command History Release Modification

10.3 The command was introduced.

12.3(14)T The usbflash0keyword was added to support

booting an image from an external USB Flash
drive.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines To determine which form of this command to use, refer to the documentation for your platform or use the
CLI help (?) feature.
Use this command only when your router cannot find the boot configuration information needed in
NVRAM. To enter ROM monitor mode, use one of the following methods:
• Enter the reload EXEC command, then press the Break key during the first 60 seconds of startup.

Cisco IOS Configuration Fundamentals Command Reference

54
 A through B
boot

• Set the configuration register bits 0 to 3 to zero (for example, set the configuration register to 0x0) and
enter the reload command.
The ROM Monitor prompt is either “>” or, for newer platforms, “rommon x >”. Enter only lowercase
commands.
These commands work only if there is a valid image to boot. Also, from the ROM monitor prompt, issuing
a prior reset command is necessary for the boot to be consistently successful.
In Cisco IOS Release 12.3(4)T, MONLIB was modified to search in media for a valid Cisco IOS image.
This change prevents boot failures that result when the first file read in disk or flash is not a valid Cisco
IOS image.
Refer to your hardware documentation for information on correct jumper settings for your platform.

Note For some platforms the flash keyword is now required. If your attempts to use the boot command are
failing using the older boot flash:x:[filename ] syntax, try using the boot flash flash:x:[filename ] syntax.

Examples In the following example, a router is manually booted from ROM:

> boot
F3:
(ROM Monitor copyrights)

In the following example, a router boots the file named routertest from a network server with the IP address
172.16.15.112 using the file-url syntax:

> boot tftp://172.16.15.112/routertest

F3
(ROM Monitor copyrights)

The following example shows the boot flash command without the filename argument. The first valid file
in Flash memory is loaded.

> boot flash

F3: 1858656+45204+166896 at 0x1000
Booting gs7-k from flash memory RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR
RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR
RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR
RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR
RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR
RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR [OK - 1903912/13765276 bytes]
F3: 1858676+45204+166896 at 0x1000
(ROM Monitor copyrights)

The following example boots from Flash memory using the file named gs7-k:

> boot flash gs7-k

F3: 1858656+45204+166896 at 0x1000
Booting gs7-k from flash memory RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR
RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR
RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR
RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR
RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR
RRRRRRRRRRRRRR [OK - 1903912/13765276 bytes]
F3: 1858676+45204+166896 at 0x1000
(ROM Monitor copyrights)

Cisco IOS Configuration Fundamentals Command Reference

55
 A through B
boot

In the following example, the boot flash flash: command boots the relocatable image file named igs-bpx-l
from partition 2 in Flash memory:

> boot flash flash:2:igs-bpx-l

F3: 3562264+98228+303632 at 0x30000B4
(ROM Monitor copyrights)

In the following command, the Cisco 7000 family router accepts the flash keyword for compatibility but
ignores it, and boots from slot 0:

> boot flash slot0:gs7-k-mz.103-9

F3: 8468+3980384+165008 at 0x1000

In the following example, the command did not function because it must be entered in lowercase:

rommon 10 > BOOT

command “BOOT” not found

The following example boots the first file in the first partition of internal Flash memory of a Cisco 3600
series router:

> boot flash:

The following example boots the first image file in the first partition of the Flash memory card in slot 0 of a
Cisco 3600 series router:

> boot slot0:

The following example shows the ROM monitor booting the first file in the first Flash memory partition on
a Cisco 1600 series router:

> boot flash:

Related Commands Command Description

continue Returns to EXEC mode from ROM monitor mode
by completing the boot process.

Cisco IOS Configuration Fundamentals Command Reference

56
 A through B
boot bootldr

boot bootldr
To specify the location of the boot image that ROM uses for booting, use the boot bootldr command in
global configuration mode. To remove this boot image specification, use the no form of this command.

boot bootldr file-url boot bootldr command

no boot bootldr

Syntax Description file-url URL of the boot image on a Flash file system.

Command Default Refer to your platform documentation for the location of the default boot image.

Command Modes Global configuration (config)

Command History Release Modification

11.0 The command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The boot bootldr command sets the BOOTLDR variable in the current running configuration. You must
specify both the Flash file system and the filename.

Note When you use this global configuration command, you affect only the running configuration. You must
save the variable setting to your startup configuration to place the information under ROM monitor control
and to have the variable function as expected. Use the copy system:running-config nvram:startup-config
command to save the variable from your running configuration to your startup configuration.

Note The default length of the bootstring filename is 64 characters. Depending on the platform a longer
bootstring filename can be used and supported.

The no form of the command sets the BOOTLDR variable to a null string. On the Cisco 7000 family
routers , a null string causes the first image file in boot Flash memory to be used as the boot image that
ROM uses for booting.
Use the show boot command to display the current value for the BOOTLDR variable.

Cisco IOS Configuration Fundamentals Command Reference

57
 A through B
boot bootldr

Examples In the following example, the internal Flash memory contains the boot image:

boot bootldr bootflash:boot-image

The following example specifies that the Flash memory card inserted in slot 0 contains the boot image:

boot bootldr slot0:boot-image

Related Commands Command Description

copy system:running-config nvram:startup- Copies any file from a source to a destination.
config

show (flash file system) Displays the layout and contents of a Flash memory
file system.

show bootvar Displays the contents of the BOOT variable, the

name of the configuration file pointed to by the
CONFIG_FILE variable, the contents of the
BOOTLDR variable, and the configuration register
setting.

Cisco IOS Configuration Fundamentals Command Reference

58
 A through B
boot bootstrap

boot bootstrap
To configure the filename that is used to boot a secondary bootstrap image, use the boot bootstrap
command in global configuration mode. To disable booting from a secondary bootstrap image, use the no
form of this command.

boot bootstrap file-url

no boot bootstrap file-url
boot bootstrap flash [filename]
no boot bootstrap flash [filename]
boot bootstrap [tftp] filename [ip-address]
no boot bootstrap [tftp] filename [ip-address]
boot bootstrap mop filename [interface-type interface-number]
no boot bootstrap mop filename [interface-type interface-number]

Syntax Description file-url URL of the bootstrap image.

flash Boots the router from flash memory.

filename (Optional with flash) Name of the system image to

boot from a network server or from flash memory.
If you omit the filename when booting from flash
memory, the router uses the first system image
stored in flash memory.

tftp (Optional) Boots the router from a system image

stored on a TFTP server.

ip-address (Optional) IP address of the TFTP server on which

the system image resides. If the ip-address
argument is omitted, this value defaults to the IP
broadcast address of 255.255.255.255.

mop Boots the router from a DECnet Maintenance

Operation Protocol (MOP) server.

interface-type (Optional) Interface type. For more information,

use the question mark (?) online help function.

interface-number (Optional) Interface or subinterface number. For

more information about the numbering syntax for
your networking device, use the question mark (?)
online help function.

Cisco IOS Configuration Fundamentals Command Reference

59
 A through B
boot bootstrap

Command Default No secondary bootstrap is configured.

Command Modes Global configuration (config)

Command History Release Modification

10.0 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

15.0(1)M This command was modified in a release earlier

than Cisco IOS Release 15.0(1)M. The
mopkeyword and interface-type interface-
numberarguments were added.

12.2(33)SXI This command was integrated into a release earlier

than Cisco IOS Release 12.2(33)SXI.

Cisco IOS XE Release 2.1 This command was implemented on the Cisco ASR
1000 Series Aggregation Services Routers.

Usage Guidelines The boot bootstrap command causes the router to load a secondary bootstrap image from the specied
URL, such as from a remote server. After the bootstrap image is loaded, the bootstrap image loads the
specified system image file. See the appropriate hardware installation guide for details on setting the
configuration register and secondary bootstrap filename.
Use this command when you have attempted to load a system image but have run out of memory even after
compressing the system image. Secondary bootstrap images allows you to load a larger system image
through a smaller secondary image.

Examples The following example shows how to load the system image file named sysimage-2 by using a secondary
bootstrap image:

Router# configure terminal

Router(config)# boot bootstrap bootflash:sysimage-2

Related Commands Command Description

boot Boots the router manually.

Cisco IOS Configuration Fundamentals Command Reference

60
A through B
boot bootstrap

Command Description
boot system Specifies the system image that the router loads at
startup.

Cisco IOS Configuration Fundamentals Command Reference

61
 A through B
boot config

boot config
To s pecify the device and filename of the configuration file from which the system configures itself during
initialization (startup), use the boot config command in global configuration mode. To return to the default
location for the configuration file, use the no form of this command.

Platforms Other than Cisco 7600 Series Router

boot config file-system-prefix : [directory/] filename [nvbypass]
no boot config

Cisco 7600 Series Router

boot config device : filename [nvbypass]
no boot config

Syntax Description file-system-prefix : File system, followed by a colon (for example,

nvram:, flash:, slot0:, usbflash 0 9 :, or usbtoken
0 9 :). The default is nvram:.

directory/ (Optional) File system directory where the

configuration file is located, followed by a forward
slash (/).

filename Name of the configuration file.

device : Device identification, followed by a colon; see the

“Usage Guidelines” section for a list of the valid
values.

nvbypass (Optional) Specifies that the distilled configuration

is not written to nonvolatile random access memory
(NVRAM).

Command Default The default location for the configuration file is NVRAM (nvram:).

Command Modes Global configuration (config)

Command History Release Modification

12.2(33)SRA This command was integrated into Cisco IOS
Release 12.2(33)SRA.

Cisco IOS Configuration Fundamentals Command Reference

62
A through B
boot config

Release Modification
12.2(14)SX Support for this command was added for the Cisco
7600 Supervisor Engine 720.

12.2(17d)SXB Support for this command on the cisco 7600

Supervisor Engine 2 was extended to Release
12.2(17d)SXB.

11.0 This command was introduced.

12.3(14)T Support for Class B file system platforms and the

following file system prefix options were added:
usbflash 0 9 :and usbtoken 0 9 :

Supported Platforms Other than Cisco 7600 Series Router

This command is available only on Class A and Class B file system platforms.
You set the CONFIG_FILE environment variable in the current running memory when you use the boot
config command. This variable specifies the configuration file used for initialization (startup). The
configuration file must be an ASCII file located in either NVRAM or flash memory.

Cisco 7600 Series Router

The valid values for the device :argument and colonare as follows:
• For systems that are configured with a Supervisor Engine 2, the valid values are bootflash:,
const_nvram:, flash:, nvram:, slot0:, sup-slot0:, and sup-bootflash:
• For systems that are configured with a Supervisor Engine 720, the valid values are disk0: and disk1:
The configuration file must be an ASCII file that is located in the specified file system.
The disk0: and disk1: keywords are for Class C file systems.
The bootflash:, slot0:, and sup-bootflash: keywords are for Class A file systems.
For Class A flash file systems, the CONFIG_FILE environment variable specifies the file system and
filename of the configuration file to use for initialization (startup). You set the CONFIG_FILE environment
variable in the current running memory when you use the boot config command. This variable specifies the
configuration file used for initialization (startup).

All Supported Platforms

When you use the boot config command, you affect only the running configuration. You must save the
environment variable setting to your startup configuration to place the information under ROM monitor
control and to have the environment variable function as expected. Use the copy system:running-config
nvram:startup-config command to save the environment variable from your running configuration to your
startup configuration.
The software displays an error message and does not update the CONFIG_FILE environment variable in
the following situations:
• You specify nvram: as the file system, and it contains only a distilled version of the configuration. (A
distilled configuration is one that does not contain access lists.)
• You specify a configuration file in the filename argument that does not exist or is not valid.

Cisco IOS Configuration Fundamentals Command Reference

63
 A through B
boot config

The router uses the NVRAM configuration during initialization when the CONFIG_FILE environment
variable does not exist or when it is null (such as at first-time startup). If the software detects a problem
with NVRAM or the configuration it contains, the device enters setup mode.
When you use the no form of this command, the router returns to using the default NVRAM configuration
file as the startup configuration.
You can display the contents of the BOOT, BOOTLDR, and the CONFIG_FILE environment variables
using the show bootvar command. This command displays the settings for these variables as they exist in
the startup configuration and in the running configuration if a running configuration setting differs from a
startup configuration setting.
When the boot config command is used, the distilled configuration is written into NVRAM and the system
configuration is written into the file specified by the boot config command. If the distilled configuration
exceeds the size of NVRAM, the system configuration gets truncated. Use the nvbypass keyword to
prevent the system configuration from being truncated when the distilled configuration is larger than the
size of NVRAM.

Examples The following example shows how to set the configuration file that is located in internal flash memory to
configure itself during initialization. The third line copies the specification to the startup configuration,
ensuring that this specification will take effect upon the next reload.

Router(config)# boot config flash:router-config

Router(config)# end
Router# copy system:running-config nvram:startup-config

The following example instructs a Cisco 7500 series router to use the configuration file named router-
config located on the flash memory card inserted in the second Personal Computer Memory Card Industry
Association (PCMCIA) slot of the Route Switch Processor (RSP) card during initialization. The third line
copies the specification to the startup configuration, ensuring that this specification will take effect upon
the next reload.

Router (config)# boot config slot1:router-config

Router (config)# end
Router# copy system:running-config nvram:startup-config

Related Commands Command Description

copy system:running-config nvram:startup- Saves the environment variable from the running
config configuration to the startup configuration.

show bootvar Displays the contents of the BOOT environment

variable, the name of the configuration file pointed
to by the CONFIG_FILE environment variable, the
contents of the BOOTLDR environment variable,
and the configuration register setting.

Cisco IOS Configuration Fundamentals Command Reference

64
 A through B
boot host

boot host
To specify the host-specific configuration file to be used at the next system startup, use the boot host
command in global configuration mode. To restore the host configuration filename to the default, use the
no form of this command.

boot host commandboot host remote-url

no boot host remote-url

Syntax Description remote-url Location of the configuration file. Use the

following syntax:
• ftp: [[[//[username[: password]@]location]/
directory]/ filename]
• rcp: [[[//[username @]location]/ directory]/
filename]
• tftp: [[[// location]/ directory]/ filename]

Command Default If you do not specify a filename using this command, the router uses its configured host name to request a
configuration file from a remote server. To form the configuration filename, the router converts its name to
all lowercase letters, removes all domain information, and appends -confg or -config.

Command Modes Global configuration

Command History Release Modification

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 instructs the system to “Boot using host-specific configuration file x ,” where x is the
filename specified in the remote-url argument. In other words, this command specifies the remote location
and filename of the host-specific configuration file to be used at the next system startup, as well as the
protocol to be used to obtain the file.
Before using the boot host command, use the service config global configuration command to enable the
loading of the specified configuration file at reboot time. Without this command, the router ignores the
boot host command and uses the configuration information in NVRAM. If the configuration information in
NVRAM is invalid or missing, the service config command is enabled automatically.

Cisco IOS Configuration Fundamentals Command Reference

65
 A through B
boot host

The network server will attempt to load two configuration files from remote hosts. The first is the network
configuration file containing commands that apply to all network servers on a network. Use the boot
network command to identify the network configuration file. The second is the host configuration file
containing commands that apply to one network server in particular. Use the boot host command to
identify the host configuration file.

Note Usually, the service config command is used in conjunction with the boot host or boot network command.
You must enter the service config command to enable the router to automatically configure the system
from the file specified by the boot host or boot network command. With IOS software versions 12.3(2)T ,
12.3(1)B, and later, you no longer have to specify the service config command for the boot host or boot
network command to be active. If you specify both the no service config command and the boot host
command, the router attempts to find the specified host configuration file. The service config command can
also be used without the boot host or boot network command. If you do not specify host or network
configuration filenames, the router uses the default configuration files. The default network configuration
file is network-confg. The default host configuration file is host-confg, where host is the hostname of the
router. If the Cisco IOS software cannot resolve its hostname, the default host configuration file is router-
confg.

Loading a Configuration File Using rcp

The rcp software requires that a client send the remote username on each rcp request to the network server.
If the server has a directory structure (such as UNIX systems), the rcp implementation searches for the
configuration files starting in the directory associated with the remote username.

When you load a configuration file from a server using rcp, the Cisco IOS software sends the first valid
username in the following list:
1 The username specified in the file-URL, if a username is specified.
2 The username set by the ip rcmd remote-username command, if the command is configured.
3 The router host name.

Note An account for the username must be defined on the destination server. If the network administrator of the
destination server did not establish an account for the username, this command will not execute
successfully.

Loading a Configuration File Using FTP

The FTP protocol requires a client to send a remote username and password on each FTP request to a
server. The username and password must be associated with an account on the FTP server. If the server has
a directory structure, the configuration file or image copied from the directory is associated with the
username on the server. Refer to the documentation for your FTP server for more details.
When you load a configuration file from a server using FTP, the Cisco IOS software sends the first valid
username in the following list:
1 The username specified in the boot host command, if a username is specified.
2 The username set by the ip ftp username command, if the command is configured.
3 Anonymous.
The router sends the first valid password in the following list:
1 The password specified in the boot host command, if a password is specified.
2 The password set by the ip ftp password command, if the command is configured.

Cisco IOS Configuration Fundamentals Command Reference

66
 A through B
boot host

3 The router forms a password username @routername .domain . The variable username is the username
associated with the current session, routername is the configured host name, and domain is the domain
of the router.

Examples The following example sets the host filename to wilma-confg at address 192.168.7.19:

Router(config)# boot host tftp://192.168.7.19/usr/local/tftpdir/wilma-confg

Router(config)# service config

Related Commands Command Description

boot network Specifies the remote location and filename of the
network configuration file to be used at the next
system boot (startup).

service config Enables autoloading of configuration files from a

network server.

Cisco IOS Configuration Fundamentals Command Reference

67
 A through B
boot network

boot network
To change the default name of the network configuration file from which to load configuration commands,
use the boot network command in global configuration mode. To restore the network configuration
filename to the default, use the no form of this command.

boot network remote-url

no boot network remote-url

Syntax Description remote-url Location of the configuration file. Use the

following syntax:
• ftp: [[[//[username[: password]@]location]/
directory]/ filename]
• rcp: [[[//[username @]location]/ directory]/
filename]
• tftp: [[[// location]/ directory]/ filename]

Command Default The default filename is network-config.

Command Modes Global configuration

Command History Release Modification

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 instructs the system to “Boot using network configuration file x ,” where x is the filename
specified in the remote-url argument. This command specifies the remote location and filename of the
network configuration file to be used at the next system startup, as well as the protocol to be used to obtain
the file.
When booting from a network server, routers ignore routing information, static IP routes, and bridging
information. As a result, intermediate routers are responsible for handling FTP, rcp, or TFTP requests.
Before booting from a network server, verify that a server is available by using the ping command.
Use the service config command to enable the loading of the specified configuration file at reboot time.
Without this command, the router ignores the boot network command and uses the configuration

Cisco IOS Configuration Fundamentals Command Reference

68
A through B
boot network

information in NVRAM. If the configuration information in NVRAM is invalid or missing, the service
config command is enabled automatically.
The network server will attempt to load two configuration files from remote hosts. The first is the network
configuration file containing commands that apply to all network servers on a network. Use the boot
network command to identify the network configuration file. The second is the host configuration file
containing commands that apply to one network server in particular. Use the boot host command to
identify the host configuration file.

Note Usually, the service config command is used in conjunction with the boot host or boot network command.
You must enter the service config command to enable the router to automatically configure the system
from the file specified by the boot host or boot network command. With IOS software versions 12.3(2)T ,
12.3(1)B, and later, you no longer have to specify the service config command for the boot host or boot
network command to be active. If you specify both the no service config command and the boot host
command, the router attempts to find the specified host configuration file. The service config command can
also be used without the boot host or boot network command. If you do not specify host or network
configuration filenames, the router uses the default configuration files. The default network configuration
file is network-confg. The default host configuration file is host-confg, where host is the hostname of the
router. If the Cisco IOS software cannot resolve its hostname, the default host configuration file is router-
confg.

Loading a Configuration File Using rcp

The rcp software requires that a client send the remote username on each rcp request to the network server.
If the server has a directory structure (such as UNIX systems), the rcp implementation searches for the
configuration files starting in the directory associated with the remote username.
When you load a configuration file from a server using rcp, the Cisco IOS software sends the first valid
username in the following list:
1 The username specified in the file-URL, if a username is specified.
2 The username set by the ip rcmd remote-username command, if the command is configured.
3 The router host name.

Note An account for the username must be defined on the destination server. If the network administrator of the
destination server did not establish an account for the username, this command will not execute
successfully.

Loading a Configuration File Using FTP

The FTP protocol requires a client to send a remote username and password on each FTP request to a
server. The username and password must be associated with an account on the FTP server. If the server has
a directory structure, the configuration file or image copied from the directory associated with the username
on the server. Refer to the documentation for your FTP server for more details.
When you load a configuration file from a server using FTP, the Cisco IOS software sends the first valid
username in the following list:
1 The username specified in the boot network command, if a username is specified.
2 The username set by the ip ftp username command, if the command is configured.
3 Anonymous.

Cisco IOS Configuration Fundamentals Command Reference

69
 A through B
boot network

The router sends the first valid password in the following list:
1 The password specified in the boot network command, if a password is specified.
2 The password set by the ip ftp password command, if the command is configured.
3 The router forms a password username @routername .domain . The variable username is the username
associated with the current session, routername is the configured host name, and domain is the domain
of the router.

Examples The following example changes the network configuration filename to bridge_9.1 and uses the default
broadcast address:

Router(config)# boot network tftp:bridge_9.1

Router(config)# service config

The following example changes the network configuration filename to bridge_9.1, specifies that rcp is to be
used as the transport mechanism, and gives 172.16.1.111 as the IP address of the server on which the
network configuration file resides:

Router(config)# service config

Router(config)# boot network rcp://172.16.1.111/bridge_9.1

Related Commands Command Description

boot host Specifies the remote location and filename of the
host-specific configuration file to be used at the
next system boot (startup).

service config Enables autoloading of configuration files from a

remote host.

Cisco IOS Configuration Fundamentals Command Reference

70
 A through B
boot system

boot system
To specify the system image that the router loads at startup, use one of the following boot system
command in global configuration mode. To remove the startup system image specification, use the no form
of this command.

Loading System Image from a URL or a TFTP File

boot system {file-url | filename}
no boot system {file-url | filename}

Booting from a System Image in Internal Flash

boot system flash [flash-fs:] [partition-number:] [filename]
no boot system flash [flash-fs:] [partition-number:] [filename]

Booting from a MOP Server

boot system mop filename [mac-address] [interface]
no boot system mop filename [mac-address] [interface]

Booting from ROM

boot system rom
no boot system rom

Booting a System Image from a Network, TFTP, or FTP Server

boot system {rcp | tftp | ftp} filename [ip-address]
no boot system {rcp | tftp | ftp} filename [ip-address]

Syntax Description file-url The URL of the system image to load at system
startup.

filename The TFTP filename of the system image to load at

system startup.

Cisco IOS Configuration Fundamentals Command Reference

71
 A through B
boot system

flash On all platforms except the Cisco 1600 series,

Cisco 3600 series, and Cisco 7000 family routers,
this keyword boots the router from internal flash
memory. If you omit all arguments that follow this
keyword, the system searches internal Flash for the
first bootable image.
On the Cisco 1600 series, Cisco 3600 series, and
Cisco 7000 family routers, this keyword boots the
router from the flash system specified by the flash-
fs : argument. On the Cisco 1600 series and Cisco
3600 series routers, if you omit all optional
arguments, the router searches internal flash
memory for the first bootable image. On the Cisco
7000 family routers, when you omit all arguments
that follow this keyword, the system searches the
Personal Computer Memory Card Industry
Association (PCMCIA) slot 0 for the first bootable
image.

flash-fs : (Optional) Flash file system containing the system

image to load at startup. The colon is required.
Valid file systems are as follows:
• flash: --Internal flash memory on the Cisco
1600 series and Cisco 3600 series routers. For
the Cisco 1600 series and Cisco 3600 series
routers, this file system is the default if you do
not specify a file system. This is the only valid
file system for the Cisco 1600 series.
• bootflash: --Internal flash memory in the
Cisco 7000 family.
• slot0: --First PCMCIA slot on the Cisco 3600
series and Cisco 7000 family routers . For the
Cisco 7000 family routers , this file system is
the default if you do not specify a file system.
• slot1: --Flash memory card in the second
PCMCIA slot on the Cisco 3600 series and
Cisco 7000 family routers.
On the Cisco 2600 series routers, a file system
should be specified. Otherwise, the router may
attempt to load the Cisco IOS software twice with
unexpected results.

partition-number : (Optional) Number of the flash memory partition

that contains the system image to boot, specified by
the optional filename argument. If you do not
specify a filename, the router loads the first valid
file in the specified partition of flash memory. This
argument is valid only on routers that can be
partitioned.

Cisco IOS Configuration Fundamentals Command Reference

72
A through B
boot system

filename (Optional when used with the boot system flash

command) Name of the system image to load at
startup. This argument is case sensitive. If you do
not specify a value for the filenameargument, the
router loads the first valid file in the following:
• The specified flash file system
• The specified partition of flash memory
• The default flash file system if you also
omitted the flash-fs : argument

mop Boots the router from a system image stored on a

DECNET Maintenance Operations Protocol (MOP)
server. Do not use this keyword with the Cisco
3600 series or Cisco 7000 family routers .

mac-address (Optional) MAC address of the MOP server

containing the specified system image file. If you
do not include the MAC address argument, the
router sends a broadcast message to all MOP boot
servers. The first MOP server to indicate that it has
the specified file is the server from which the router
gets the boot image.

interface (Optional) Interface the router uses to send out

MOP requests to the MOP server. The interface
options are async, dialer, ethernet, serial, and
tunnel. If you do not specify the interface
argument, the router sends a request out on all
interfaces that have MOP enabled. The interface
that receives the first response is the interface the
router uses to load the software.

rom Boots the router from ROM. Do not use this

keyword with the Cisco 3600 series or the Cisco
7000 family routers .

rcp Boots the router from a system image stored on a

network server using rcp.

tftp Boots the router from a system image stored on a

TFTP server.

ftp Boots the router from a system image stored on an

FTP server.

ip-address (Optional) IP address of the server containing the

system image file. If omitted, this value defaults to
the IP broadcast address of 255.255.255.255.

Cisco IOS Configuration Fundamentals Command Reference

73
 A through B
boot system

Command Default If you configure the router to boot from a network server but do not specify a system image file with the
boot system command, the router uses the configuration register settings to determine the default system
image filename. The router forms the default boot filename by starting with the word cisco and then
appending the octal equivalent of the boot field number in the configuration register, followed by a hyphen
(-) and the processor type name (cisconn-cpu). Refer to the appropriate hardware installation guide for
details on the configuration register and default filename. See also the config-register or confreg
command.

Command Modes Global configuration

Command History Release Modification

10.0 This command was introduced.

12.2(14)SX Support for this command was added for the

Supervisor Engine 720.

12.2(17d)SXB Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2(31)SB2 This command was integrated into Cisco IOS

Release 12.2(31)SB.

12.2(33)SXH This command was integrated into Cisco IOS

Release 12.2(33)SXH.

Usage Guidelines For this command to work, the config-register command must be set properly.
Create a comma-delimited list of several boot system commands to provide a fail-safe method for booting
your router. The router stores and executes the boot system commands in the order in which you enter
them in the configuration file. If you enter multiple boot commands of the same type--for example, if you
enter two commands that instruct the router to boot from different network servers--the router tries them in
the order in which they appear in the configuration file. If a boot system command entry in the list
specifies an invalid device, the router omits that entry. Use the boot system rom command to specify use
of the ROM system image as a backup to other boot system commands in the configuration.

Note After a list of several images are specified with the boot system command, running the command again
results in the list being appended, not removed.

For some platforms, the boot image must be loaded before the system image is loaded. However, on many
platforms, the boot image is loaded only if the router is booting from a network server or if the flash file
system is not specified. If the file system is specified, the router will boot faster because it need not load the
boot image first.

Cisco IOS Configuration Fundamentals Command Reference

74
A through B
boot system

This section contains the following topics:

• Changing the List of Boot System Commands
• Booting Compressed Images
• Understanding rcp
• Understanding TFTP
• Understanding FTP
• Stopping Booting and Entering ROM Monitor Mode
• Cisco 1600 Series, Cisco 3600 Series, Cisco 7000 Family, and Cisco 7600 Series Router Notes
Changing the List of Boot System Commands
To remove a single entry from the bootable image list, use the no form of the command with an argument.
For example, to remove the entry that specifies a bootable image on a flash memory card inserted in the
second slot, use the no boot system flash slot1: filename] command. All other entries in the list remain.
To eliminate all entries in the bootable image list, use the no boot system command. At this point, you can
redefine the list of bootable images using the previous boot system commands. Remember to save your
changes to your startup configuration by issuing the copy system:running-config nvram:startup-config
command.
Each time you write a new software image to flash memory, you must delete the existing filename in the
configuration file with the no boot system flash filename command. Then add a new line in the
configuration file with the boot system flash filename command.

Note If you want to rearrange the order of the entries in the configuration file, you must first issue the no boot
system command and then redefine the list.

Booting Compressed Images

You can boot the router from a compressed image on a network server. When a network server boots
software, both the image being booted and the running image must be able to fit into memory. Use
compressed images to ensure that enough memory is available to boot the router. You can compress a
software image on any UNIX platform using the compress command. Refer to your UNIX platform’s
documentation for the exact usage of the compress command. (You can also uncompress data with the
UNIX uncompress command.)
Understanding rcp
The rcp requires that a client send the remote username in an rcp request to a server. When the router
executes the boot system rcp command, the Cisco IOS software sends the hostname as both the remote
and local usernames by default. Before the rcp can execute properly, an account must be defined on the
network server for the remote username configured on the router.
If the server has a directory structure, the rcp software searches for the system image to boot from the
remote server relative to the directory of the remote username.
By default, the router software sends the hostname as the remote username. You can override the default
remote username by using the ip rcmd remote-username command. For example, if the system image
resides in the home directory of a user on the server, you can specify that user’s name as the remote
username.
Understanding TFTP
You need a TFTP server running to retrieve the router image from the host.
Understanding FTP

Cisco IOS Configuration Fundamentals Command Reference

75
 A through B
boot system

You need an FTP server running to retrieve the router image from the host. You also need an account on
the server or anonymous file access to the server.
Stopping Booting and Entering ROM Monitor Mode
During the first 60 seconds of startup, you can force the router to stop booting by pressing the Break key.
The router will enter ROM monitor mode, where you can change the configuration register value or boot
the router manually.
Cisco 1600 Series, Cisco 3600 Series, Cisco 7000 Family, and Cisco 7600 Series Router Notes
For the Cisco 3600 series and Cisco 7000 family, the boot system command modifies the BOOT variable
in the running configuration. The BOOT variable specifies a list of bootable images on various devices.

Note When you use the boot system command on the Cisco 1600 series, Cisco 3600 series, Cisco 7000 family,
and Cisco 7600 series, you affect only the running configuration. You must save the BOOT variable
settings to your startup configuration to place the information under ROM monitor control and to have the
variable function as expected. Use the copy system:running-config nvram:startup-config privileged
EXEC command to save the variable from your running configuration to your startup configuration.

To display the contents of the BOOT variable, use the show bootvar EXEC command.

Examples The following example illustrates a configuration that specifies two possible internetwork locations for a
system image, with the ROM software being used as a backup:

Router(config)# boot system tftp://192.168.7.24/cs3-rx.90-1

Router(config)# boot system tftp://192.168.7.19/cs3-rx.83-2

Router(config)# boot system rom

The following example boots the system boot relocatable image file named igs-bpx-l from partition 2 of the
flash device:

Router(config)# boot system flash:2:igs-bpx-l

The following example instructs the router to boot from an image located on the flash memory card
inserted in slot 0:

Router(config)# boot system slot0:new-config

The following example specifies the file named new-ios-image as the system image for a Cisco 3600 series
router to load at startup. This file is located in the fourth partition of the flash memory card in slot 0.

Router(config)# boot system slot0:4:dirt/images/new-ios-image

This example boots from the image fi le named c1600-y-l in part ition 2 of flash memory of a Cisco 1600
series router:

Router(config)# boot system flash:2:c1600-y-l

Cisco IOS Configuration Fundamentals Command Reference

76
 A through B
boot system

Related Commands Command Description

boot Boots the router manually.

config-register Changes the configuration register settings.

confreg Changes the configuration register settings while in

ROM monitor mode.

copy Copies any file from a source to a destination.

copy system:running-config nvram:startup- Copies the running configuration to the startup

config configuration.

ip rcmd remote username Configures the remote username to be used when

requesting a remote copy using rcp.

show bootvar Displays the contents of the BOOT variable, the

name of the configuration file pointed to by the
CONFIG_FILE variable, the contents of the
BOOTLDR variable, and the configuration register
setting.

Cisco IOS Configuration Fundamentals Command Reference

77
 A through B
boot-end-marker

boot-end-marker
The boot-start-marker and boot-end-marker flags, which can be seen in Cisco IOS software
configuration files, are not CLI commands. These markers are written to configuration files automatically
to flag the beginning and end of the boot commands (boot statements). By flagging boot statements, these
markers allow the router to more reliably load Cisco IOS images during bootup.
A boot statement is one or more lines in a configuration file that tells the router which software image to
load after a powercycling (reboot). The boot-start-marker and boot-end-marker flags will appear around
any boot commands, including:
• boot bootstrap
• boot config
• boot host
• boot network
• boot system
Note, however, that these markers will always appear in the output of the show running-configor more
system:running-config commands, regardless of whether any actual boot commands have been entered.
This means that no boot commands will appear between the markers if no boot commands have been
entered, or if all boot commands have been removed from the configuration, as shown in the “Examples”
section.
The boot-start-marker and boot-end-markerflags cannot be removed or modified using the CLI. These
markers are written to the startup configuration file whenever a copy running-config startup-config
command is issued.
These flags were also introduced to circumvent errors in the configuration file, such as a leading space
before a boot command (such as those sometimes introduced by manually edited configuration files), or the
use of text strings that include the word “boot” in banners or other user-specified text.
If the “boot start-marker” flag is not found in the configuration file, the system will use the traditional
method to identify the boot commands. However, if you are manually creating configuration files, or
copying from older Cisco IOS software releases, the addition of these markers is recommended.

Command History Release Modification

12.3(3), 12.3(4)T, 12.0(26)S, 12.0(27)SV, The boot-start-marker and boot-end-marker
12.3(3)B, flags were introduced.

Examples In the following example, a boot command is entered, and the boot-start-marker and boot-end-marker flags
are shown in the context of the startup configuration file:

Router# configure terminal

Enter configuration commands, one per line. End with the end command.
Router(config)# boot system slot0:

Router(config)# end

Router# copy running-config startup-config

Router# show startup-config

Cisco IOS Configuration Fundamentals Command Reference

78
 A through B
boot-end-marker

Using 1398 out of 129016 bytes

!
version 12.3
service timestamps debug uptime
service timestamps log uptime
no service password-encryption
!
hostname C3660-2
!
boot-start-marker
boot system slot0:
boot-end-marker
!
logging count
.
.
.

In the following example, the boot-start-marker and boot-end-marker flags appear in the configuration file
even though no boot commands have been entered:

Router# show running-configuration

Current configuration :3055 bytes

!
! No configuration change since last restart
!
version 12.3
service timestamps debug datetime msec
service timestamps log datetime msec
no service password-encryption
!
hostname Router
!
boot-start-marker
boot-end-marker
!
.
.
.

Related Commands Command Description

boot bootstrap Specifies the filename and location of a secondary
bootstrap image (to be used if a valid software
image cannot be loaded).

boot config Specifies the device and filename of the

configuration file from which the router boots
during startup (for Class A filesytems).

boot host Specifies a remote host location for the host-

specific (router-specific) configuration file to be
used at the next system startup.

boot network Specifies a remote location for the network

(network-wide) configuration file to be used at the
next system startup.

boot system Specifies the system software image that the router
loads at startup.

Cisco IOS Configuration Fundamentals Command Reference

79
 A through B
boot-end-marker

Cisco IOS Configuration Fundamentals Command Reference

80
 A through B
boot-start-marker

boot-start-marker
The boot-start-marker and boot-end-marker flags, which can be seen in Cisco IOS software
configuration files, are not CLI commands. These markers are written to configuration files automatically
to flag the beginning and end of the boot commands (boot statements). By flagging boot statements, these
markers allow the router to more reliably load Cisco IOS images during bootup.
A boot statement is one or more lines in a configuration file that tells the router which software image to
load after a powercycling (reboot). The boot-start-marker and boot-end-marker flags will appear around
any boot commands, including:
• boot bootstrap
• boot config
• boot host
• boot network
• boot system
Note, however, that these markers will always appear in the output of the show running-configor more
system:running-config commands, regardless of whether any actual boot commands have been entered.
This means that no boot commands will appear between the markers if no boot commands have been
entered, or if all boot commands have been removed from the configuration, as shown in the “Examples”
section.
The boot-start-marker and boot-end-markerflags cannot be removed or modified using the CLI. These
markers are written to the startup configuration file whenever a copy running-config startup-config
command is issued.
These flags were also introduced to circumvent errors in the configuration file, such as a leading space
before a boot command (such as those sometimes introduced by manually edited configuration files), or the
use of text strings that include the word “boot” in banners or other user-specified text.
If the “boot start-marker” flag is not found in the configuration file, the system will use the traditional
method to identify the boot commands. However, if you are manually creating configuration files, or
copying from older Cisco IOS software releases, the addition of these markers is recommended.

Command History Release Modification

12.3(3), 12.3(4)T, 12.0(26)S, 12.0(27)SV, 12.3(3)B The boot-start-marker and boot-end-marker
flags were introduced.

Examples In the following example, a boot command is entered, and the boot-start-marker and boot-end-marker flags
are shown in the context of the startup configuration file:

Router# configure terminal

Enter configuration commands, one per line. End with the end command.
Router(config)# boot system slot0:

Router(config)# end

Router# copy running-config startup-config

Router# show startup-config

Cisco IOS Configuration Fundamentals Command Reference

81
 A through B
boot-start-marker

Using 1398 out of 129016 bytes

!
version 12.3
service timestamps debug uptime
service timestamps log uptime
no service password-encryption
!
hostname C3660-2
!
boot-start-marker
boot system slot0:
boot-end-marker
!
logging count
.
.
.

In the following example, the boot-start-marker and boot-end-marker flags appear in the configuration file
even though no boot commands have been entered:

Router# show running-configuration

Current configuration :3055 bytes

!
! No configuration change since last restart
!
version 12.3
service timestamps debug datetime msec
service timestamps log datetime msec
no service password-encryption
!
hostname Router
!
boot-start-marker
boot-end-marker
!
.
.
.

Related Commands Command Description

boot bootstrap Specifies the filename and location of a secondary
bootstrap image (to be used if a valid software
image cannot be loaded).

boot config Specifies the device and filename of the

configuration file from which the router boots
during startup (for Class A filesytems).

boot host Specifies a remote host location for the host-

specific (router-specific) configuration file to be
used at the next system startup.

boot network Specifies a remote location for the network

(network-wide) configuration file to be used at the
next system startup.

boot system Specifies the system software image that the router
loads at startup.

Cisco IOS Configuration Fundamentals Command Reference

82
A through B
boot-start-marker

Cisco IOS Configuration Fundamentals Command Reference

83
 A through B
boot-start-marker

Cisco IOS Configuration Fundamentals Command Reference

84
C commands
• cd, page 87
• clear archive log config, page 89
• clear catalyst6000 traffic-meter, page 91
• clear configuration lock, page 92
• clear diagnostic event-log, page 94
• clear ip http client cache, page 96
• clear logging, page 98
• clear logging system, page 100
• clear logging xml, page 102
• clear memory low-water-mark, page 104
• clear mls statistics, page 105
• clear parser cache, page 107
• clear parser statistics, page 109
• clear platform netint, page 111
• clear processes interrupt mask, page 112
• clear scp accounting, page 114
• clear tcp, page 115
• clear vlan counters, page 117
• clock, page 118
• clock initialize nvram, page 120
• config-register, page 121
• configure check syntax, page 123
• configuration mode exclusive (Deprecated as of the 15.0S and T releases. It's still available on the M
train.), page 124
• configure confirm, page 131
• configure memory, page 133
• configure network, page 135
• configure overwrite-network, page 136
• configure replace, page 137
• configure revert, page 142
• configure terminal, page 144
• confreg, page 147
• continue (ROM monitor), page 149
• copy, page 151
• copy erase flash, page 170

Cisco IOS Configuration Fundamentals Command Reference

85
 C commands

• copy http, page 171

• copy https, page 172
• copy logging system, page 173
• copy xmodem, page 175
• copy ymodem, page 177
• copy noverify, page 179

Cisco IOS Configuration Fundamentals Command Reference

86
 C commands
cd

cd
To change the default directory or file system, use the cd command in user EXEC or privileged EXEC
mode.

cd [filesystem:] [directory]

Syntax Description filesystem : (Optional) The URL or alias of the directory or file
systems followed by a colon.

directory (Optional) Name of the directory.

Command Default The initial default file system is flash:. For platforms that do not have a physical device named flash:, the
keyword flash: is aliased to the default Flash device.
For the Supervisor Engine, the initial default file system is disk0 :
If you do not specify a directory on a file system, the default is the root directory on that file system.

Command Modes User EXEC

Privileged EXEC

Command History Release Modification

11.0 This command was introduced.

12.2(14)SX This command was integrated into Cisco IOS

Release 12.2(14)SX, and support was introduced on
the Supervisor Engine 720.

12.2(17d)SXB Support was added for the Supervisor Engine 2.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The valid values for filesystem :are as follows:

• For systems that are configured with a Supervisor Engine 2, valid values are bootflash:,
const_nvram:, disk0:, flash:, nvram:, slot0:, sup-slot0:, and sup-bootflash:
• For systems that are configured with a Supervisor Engine 720, valid values are disk0: and disk1:
For all EXEC commands that have an optional filesystemargument, the system uses the file system
specified by the cd command when you omit the optional filesystemargument. For example, the

Cisco IOS Configuration Fundamentals Command Reference

87
 C commands
cd

dircommand, which displays a list of files on a file system, contains an optional filesystemargument. When
you omit this argument, the system lists the files on the file system specified by the cd command.
If you do not specify a directory on a file system, the default is the root directory on that file system.

Examples In the following example, the cd command is used to set the default file system to the Flash memory card
inserted in slot 0:

Router# pwd

bootflash:/
Router# cd slot0:

Router#
pwd

slot0:/

Cisco 7600 Series

This example sets the default file system to the Flash PC card that is inserted in disk 0:

Router# cd disk0:
Router#
pwd
disk0:/

Related Commands Command Description

copy Copies any file from a source to a destination.

delete Deletes a file on a Flash memory device.

dir Displays a list of files on a file system.

mkdir disk0: Creates a new directory in a Flash file system.

pwd Displays the current setting of the cd command.

show file systems Lists available file systems and their alias prefix
names.

undelete Recovers a file marked “deleted” on a Class A or

Class B Flash file system.

Cisco IOS Configuration Fundamentals Command Reference

88
 C commands
clear archive log config

clear archive log config

To purge the configuration logging database entries, use the clear archive log configcommand in
privileged EXEC mode.

clear archive log config [force | persistent]

Syntax Description force (Optional) Eliminates the confirm step before the
contents of the archive log are cleared.

persistent (Optional) Purges the configuration logging

persistent-command database entries.

Command Default If this command is not used, the database entries accumulate in the archive log.

Command Modes Privileged EXEC (#)

Command History Release Modification

12.2(33)SRA This command was introduced.

12.4(11)T This command was integrated into Cisco IOS

Release 12.4(11)T.

12.2(33)SXH This command was integrated into Cisco IOS

Release 12.2(33)SXH.

12.2(33)SB This command was integrated into Cisco IOS

Release 12.2(33)SB.

Usage Guidelines When the clear archive log configcommand is entered, only the entries in the configuration logging
database file are deleted. The file itself is not deleted; it will be used in the future to log new entries as they
occur.

Examples The following example clears the database entries that have been saved to the config log without asking
you to confirm the action before the entries are cleared:

Router# clear archive log config force

Cisco IOS Configuration Fundamentals Command Reference

89
 C commands
clear archive log config

Related Commands Command Description

show archive log config all persistent Displays the persisted commands in configlet
format.

Cisco IOS Configuration Fundamentals Command Reference

90
 C commands
clear catalyst6000 traffic-meter

clear catalyst6000 traffic-meter

To clear the traffic meter counters, use the clear catalyst6000 traffic-metercommand in privileged EXEC
mode.

clear catalyst6000 traffic-meter

Syntax Description This command has no arguments or keywords.

Command Default This command has no default settings.

Command Modes Privileged EXEC

Command History Release Modification

12.2(17a)SX Support for this command was introduced on the
Supervisor Engine 720.

12.2(17d)SXB Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Examples This example shows how to clear the traffic meter counters:

Router# clear catalyst6000 traffic-meter

Router#

Cisco IOS Configuration Fundamentals Command Reference

91
 C commands
clear configuration lock

clear configuration lock

To clear the lock on the running configuration file, use the clear configuration lockcommand in privileged
EXEC mode.

clear configuration lock

Syntax Description This command has no arguments or keywords.

Command Modes Privileged EXEC

Command History Release Modification

12.2(25)S This command was introduced.

12.3(14)T This command was enhanced to allow the exclusive

configuration lock to be cleared during erratic or
abnormal behavior.

12.0(31)S This command was integrated into Cisco IOS

Release 12.0(31)S.

12.2(28)SB This command was integrated into Cisco IOS

Release 12.2(28)SB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2(33)SXH This command was integrated into Cisco IOS

Release 12.2(31)SXH.

Examples The following is sample output from the clear configuration lockcommand when the running
configuration file is not locked by the configure replace command:

Router# clear configuration lock

Parser Config not locked.

The following is sample output from the clear configuration lockcommand when the running
configuration file is locked by the configure replace command:

Router# clear configuration lock

Process <3> is holding the EXCLUSIVE lock !

Do you want to clear the lock?[confirm] y

Cisco IOS Configuration Fundamentals Command Reference

92
 C commands
clear configuration lock

The following example shows how to use the clear configuration lock command to display the owner or
process ID of the lock and prompt the user for confirmation:

Router# clear configuration lock

Process <46> is holding the EXCLUSIVE lock.
Do you want to clear the lock?[confirm] y

After the lock is cleared, a message will be sent to the terminal if the owner of the lock is a TTY user:

Router(config)# The configuration lock was cleared by user <steve> from terminal <5>

Related Commands Command Description

configuration mode exclusive Enables single-user (exclusive) access functionality
for the Cisco IOS CLI.

debug configuration lock Enables debugging of the Cisco IOS configuration

lock.

show configuration lock Displays information about the lock status of the
running configuration file during a configuration
replace operation.

Cisco IOS Configuration Fundamentals Command Reference

93
 C commands
clear diagnostic event-log

clear diagnostic event-log

To clear the diagnostic event logs for a specific module or event type, use the clear diagnostic event-
logcommand in privileged EXEC mode.

clear diagnostic event-log {event-type {error | info | warning} | module {num | slot subslot | all}}

Syntax Description event-type error Specifies clearing error events.

event-type info Specifies clearing informative events.

event-type warning Specifies clearing warning events.

module num | slot subslot Specifies clearing events for a specific module.

module all Specifies clearing all linecards.

Command Default This command has no default settings.

Command Modes Privileged EXEC (#)

Command History Release Modification

12.2(33)SXH This command was introduced on the Supervisor
Engine 720.

Usage Guidelines The clear diagnostic event-log command clears all the events for all the modules.
The clear diagnostic event-log module num command clears events only for a specific module.
The clear diagnostic event-log event-typecommand clears only specific event types such as error,
informative, or warning events.

Examples This example shows how to clear error event logs:

Router# clear diagnostic event-log event-type error

This example shows how to clear event logs on module 3:

Router# clear diagnostic event-log module 3

Cisco IOS Configuration Fundamentals Command Reference

94
 C commands
clear diagnostic event-log

This example shows how to clear error event logs on all the modules:

Router# clear diagnostic event-log module all

Related Commands Command Description

show diagnostic events Displays the diagnostic event log

Cisco IOS Configuration Fundamentals Command Reference

95
 C commands
clear ip http client cache

clear ip http client cache

To remove information from the HTTP client cache, use the clear ip http client cache command in
privileged EXEC mode.

clear ip http client cache {all | session session-name | url complete-url}

Syntax Description cache all Removes all HTTP client cache entries.

cache session session-name Removes HTTP client cache entries of the HTTP
client application session specified by the session-
name argument.

cache url complete-url Removes the HTTP client cache entry whose
location is specified by the complete-url argument,
a Cisco IOS File System (IFS) Uniform Resource
Locator (URL), and that consists of HTML files
used by an HTTP server.

Command Default None

Command Modes Privileged EXEC

Command History Release Modification

12.2(31)SB2 This command was introduced.

Usage Guidelines Use this command to clear entries from the HTTP client cache pool: all the entries, all the entries owned by
a specific session, or only the entry associated with a specific request from an HTTP server.

Examples The following example clears all entries in the HTTP client cache:

Router# clear ip http client cache all

The following example removes HTTP client cache entries that belong to the HTTP Client File System
(CFS) application:

Router# clear ip http client cache session HTTP CFS

Cisco IOS Configuration Fundamentals Command Reference

96
 C commands
clear ip http client cache

The following example removes HTTP client cache entries at the location http://myrouter.cisco.com/flash:/:

Router# clear ip http client cache url http://myrouter.cisco.com/flash:/

Related Commands Command Description

ip http path Specifies the base path used to locate files for use
by the HTTP server.

show ip http client Displays a report about the HTTP client.

Cisco IOS Configuration Fundamentals Command Reference

97
 C commands
clear logging

clear logging
To clear messages from the logging buffer, use the clear logging command in privileged EXEC mode.

clear logging [persistent [url filesystem:/directory]]

Syntax Description persistent (Optional) Deletes persistent logging files.

url (Optional) Specifies the URL for storing logging

messages.

filesystem: The file system followed by a colon.

/directory The directory on the filesystem. The slash is

required.

Command Modes Privileged EXEC (#)

Command History Release Modification

11.2 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Cisco IOS XE Release 2.4 This command was modified. The persistentand
url keywords, and the filesystem:/directory
arguments were added.

Usage Guidelines The clear logging persistent command is used to remove stored audit records. This action can be
performed by the audit administrator only. The clear logging persistentcommand clears only log files
stored in the directory but does not remove the directory itself. If no log URL is not specified for logging,
this command clears files from the location as specified in the logging persistent command.

Examples In the following example, the logging buffer is cleared:

Router# clear logging

Clear logging buffer [confirm]
The following example shows how to clear persistent logging files:

Router# clear logging persistent

Cisco IOS Configuration Fundamentals Command Reference

98
 C commands
clear logging

Delete persistent logging files from bootflash:/audit_log ? [confirm]

Router# dir bootflash:/audit_log
Directory of bootflash:/audit_log/
No files in directory

The following example shows how to clear persistent logging files from a specific directory:

Router# clear logging persistent url harddisk:/log-persistant

Delete persistent logging files from harddisk:/log-persistent ? [confirm]
Router# dir harddisk:/log-persistant
Directory of harddisk:////log-persistent/
No files in directory

Related Commands Command Description

logging buffered Logs messages to an internal buffer.

logging persistent Enables the storage of logging messages on the

router’s ATA disk.

show logging Displays the state of logging (syslog).

Cisco IOS Configuration Fundamentals Command Reference

99
 C commands
clear logging system

clear logging system

To clear event records stored in the System Event Archive (SEA) log file sea_log.dat, use the clear logging
system command in user EXEC mode.

clear logging system [disk name]

Syntax Description disk name (Optional) Stores the system event log in the
specified disk.

Command Default This command has no default settings.

Command Modes User EXEC (>)

Command History Release Modification

12.2(33)SXH This command was introduced.

12.2(33)SCC This command was introduced for the Cisco

uBR10012 router in the Cisco IOS Software
Release 12.2(33)SCC.

Usage Guidelines SEA is supported on switches that have a Supervisor Engine 32 or Supervisor Engine 720 with a compact
flash adapter and a Compact Flash card (WS-CF-UPG= for Supervisor Engine 720).
Cisco Universal Broadband Router 10012
The SEA feature is used to address debug trace and system console constraints. SEA is a logging feature
that allows the modules in the system to report major and critical events to the route processor (RP). The
events occurring on the line card or jacket card are also sent to the RP using Inter-Process Communication
(IPC) capability. Use the clear logging system command to clear the event records stored in the SEA log
file.

Note To store the system event logs, the SEA requires either the PCMCIA ATA disk or Compact Flash Disk in
compact flash adapter for PRE2.

Cisco IOS Configuration Fundamentals Command Reference

100
 C commands
clear logging system

Examples This example shows how to clear the SEA:

Router# clear logging system

Clear logging system operation will take a while.
Do you want to continue? [no]: yes
Router#

Related Commands copy logging system Copies the archived system events to another
location.

logging system Enables or disables the SEA logging system.

show logging system Displays the SEA logging system disk.

Cisco IOS Configuration Fundamentals Command Reference

101
 C commands
clear logging xml

clear logging xml

To clear the contents of the XML system message logging (syslog) buffer, use the clear logging xml
command in User EXEC or Priviledged EXEC mode..

clear logging xml

Syntax Description This command has no arguments or keywords.

Command Default No default behavior or values.

Command Modes User EXEC Privileged EXEC

Command History Release Modification

12.2(15)T This command was introduced.

12.2(28)SB This command was integrated into Cisco IOS

Release 12.2(28)SB.

12.2(33)SRE This command was integrated into Cisco IOS

Release 12.2(33)SRE .

Usage Guidelines This command clears the contents of the XML-formatted logging buffer, but does not clear the contents of
the standard logging buffer. The system will prompt you to confirm the action before clearing the buffer.

Examples In the following example, the XML-specific buffer is cleared:

Router# clear logging xml

Clear XML logging buffer [confirm]?y

Related Commands Command Description

logging buffered xml Enables system message logging (syslog) to the
XML-specific buffer in XML format.

Cisco IOS Configuration Fundamentals Command Reference

102
C commands
clear logging xml

Command Description
show logging xml Displays the state of XML-formatted system
message logging, followed by the contents of the
XML-specific buffer.

Cisco IOS Configuration Fundamentals Command Reference

103
 C commands
clear memory low-water-mark

clear memory low-water-mark

To clear the low-water-mark memory, use the clear memory low-water-markcommand in
privilegedEXEC mode.

clear memory low-water-mark

Syntax Description This command has no arguments or keywords.

Command Modes Privileged EXEC (#)

Command History Release Modification

15.0(1)M This command was introduced into a release earlier
than Cisco IOS Release 15.0(1)M.

12.2(33)SRB This command was integrated into a release earlier

than Cisco IOS Release 12.2(33)SRB.

12.2(33)SXI This command was integrated into a release earlier

than Cisco IOS Release 12.2(33)SXI.

Cisco IOS XE Release 2.1 This command was implemented on the Cisco ASR
1000 Series Aggregation Services Routers.

Usage Guidelines This command clears all processor threshold values and the input/output memory threshold values, if any.

Examples The following example shows how to clear the low-water-mark memory:

Router# clear memory low-water-mark

Related Commands Command Description

memory free low-watermark Configures a router to issue system logging
message notifications when available memory falls
below a specified threshold.

Cisco IOS Configuration Fundamentals Command Reference

104
 C commands
clear mls statistics

clear mls statistics

To reset the Multilayer Switching (MLS) statistics counters, use the clear mls statistics command in
privileged EXEC mode.

clear mls statistics [module num]

Syntax Description module num (Optional) Specifies the module number.

Command Default This command has no default settings.

Command Modes Privileged EXEC

Command History Release Modification

12.(17d)SXB1 This command was introduced on the Supervisor
Engine 720 and the Supervisor Engine 2.

12.2(17d)SXB5 The module num keyword and argumen t pair were

added.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command replaces the clear mls stats command, which was introduced on the Supervisor Engine 720
in Cisco IOS Release 12.2(17a)SX, and on the Supervisor Engine 2 in Cisco IOS Release 12.2(17d)SXB.

Examples This example shows how to reset the MLS statistics counters for all modules:

Router#
clear mls statistics
Router#
This example shows how to reset the MLS statistics counters for a specific module:

Router#
clear mls statistics module 5
Router#

Cisco IOS Configuration Fundamentals Command Reference

105
 C commands
clear mls statistics

Related Commands Command Description

show mls statistics Displays the MLS statistics for the IP, IPX,
multicast, Layer 2 protocol, and QoS.

Cisco IOS Configuration Fundamentals Command Reference

106
 C commands
clear parser cache

clear parser cache

To clear the parse cache entries and hit/miss statistics stored for the Parser Cache feature, use the clear
parser cachecommand in privileged EXEC mode.

clear parser cache

Syntax Description This command has no arguments or keywords.

Command Default No default behavior or values.

Command Modes Privileged EXEC

Command History Release Modification

12.1(5)T This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The Parser Cache feature optimizes the parsing (translation and execution) of Cisco IOS software
configuration command lines by remembering how to parse recently encountered command lines,
decreasing the time required to process large configuration files.
The clear parser cache command will free the system memory used by the Parser Cache feature and will
erase the hit/miss statistics stored for the output of the show parser statistics EXEC command. This
command is only effective when the Parser Cache feature is enabled.

Examples The following example shows the clearing of the parser cache:

Router# show parser statistics

Last configuration file parsed:Number of Commands:1484, Time:820 ms
Parser cache:enabled, 1460 hits, 26 misses
Router# clear parser cache
Router# show parser statistics
Last configuration file parsed:Number of Commands:1484, Time:820 ms
Parser cache:enabled, 0 hits, 1 misses

Cisco IOS Configuration Fundamentals Command Reference

107
 C commands
clear parser cache

Related Commands Command Description

parser cache Enables or disables the Parser Cache feature.

show parser statistics Displays statistics about the last configuration file
parsed and the status of the Parser Cache feature.

Cisco IOS Configuration Fundamentals Command Reference

108
 C commands
clear parser statistics

clear parser statistics

To clear the parser performance statistics, use the clear parser statisticscommand in privileged EXEC
mode.

clear parser statistics

Syntax Description This command has no arguments or keywords.

Command Default No default behavior or values.

Command Modes Privileged EXEC

Command History Release Modification

15.0S This command was introduced.

Usage Guidelines The clear parser statistics command will free the system memory used for recording parser performance
statistics stored for the output of the show parser statistics EXEC command..

Examples The following example shows the clearing parser statistics:

Router# show parser statistics

Last configuration file parsed: Number of Commands: 1, Time: 31 ms

Parser cache: enabled, 129 hits, 46 misses

Active startup time: 0

Standby startup time: 186
Copy to running-config time:0
Bulksync time:0

Top 10 slowest command:

Function Time (ms) Command
0xE71F90 7 shutdown
0x1235280 11 no ip address
0x1235280 11 no ip address
0x1235280 11 no ip address
0x1235280 11 no ip address
0x1235280 12 no ip address
0x1235280 12 no ip address
0x1235280 12 no ip address
0x1235280 12 no ip address
0xD6C940 6170 show run

Parser last bootup cache hits:

Cisco IOS Configuration Fundamentals Command Reference

109
 C commands
clear parser statistics

Bootup hits:125
Bootup misses:43
Bootup clear parser cache:0

Router# clear parser statistics

func=E01730, duration=0 cmd= clear parser statistics
Router# show parser statistics
Last configuration file parsed: Number of Commands: 0, Time: 0 ms

Parser cache: enabled, 130 hits, 47 misses

Active startup time: 0

Standby startup time: 0
Copy to running-config time:0
Bulksync time:0

Top 10 slowest command:

Function Time (ms) Command

Parser last bootup cache hits:

Bootup hits:0
Bootup misses:0
Bootup clear parser cache:0

Related Commands Command Description

parser cache Enables or disables the Parser Cache feature.

show parser statistics Displays statistics about the last configuration file
parsed and the status of the Parser Cache feature.

Cisco IOS Configuration Fundamentals Command Reference

110
 C commands
clear platform netint

clear platform netint

To clear the interrupt-throttling counters for the platform, use the clear platform netint command in
privileged EXEC mode.

clear platform netint

Syntax Description This command has no arguments or keywords.

Command Default This command has no default settings.

Command Modes Privileged EXEC

Command History Release Modification

12.2(17b)SXA Support for this command was introduced on the
Supervisor Engine 720.

12.2(17d)SXB Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Examples This example shows how to clear the interrupt-throttling counters for the platform:

Router#
clear platform netint
Router#

Related Commands Command Description

show platform netint Displays the platform network-interrupt
information.

Cisco IOS Configuration Fundamentals Command Reference

111
 C commands
clear processes interrupt mask

clear processes interrupt mask

To clear interrupt mask details for all processes in the interrupt mask buffer, use the clear processes
interrupt mask detailcommand in privileged EXEC mode.

clear processes interrupt mask detail

Syntax Description This command has no arguments or keywords.

Command Modes Privileged EXEC

Command History Release Modification

12.4(2)T This command was introduced as part of the
Process Interrupt Mask Profiler Enhancement
feature.

Usage Guidelines See the documentation of the scheduler interrupt mask commands (listed in the Related Commands
table) for further details on process interrupt mask profiling.

Examples The following example demonstrates how to the clear interrupt mask statistics from system memory for all
processes:

Router# clear processes interrupt mask detail

Related Commands Command Description

scheduler interrupt mask profile Starts interrupt mask profiling for all processes
running on the system

scheduler interrupt mask size Configures the maximum number of entries that
can exist in the interrupt mask buffer.

scheduler interrupt mask time Configures the maximum time that a process can
run with interrupts masked.

show process interrupt mask buffer Displays the information stored in the interrupt
mask buffer.

Cisco IOS Configuration Fundamentals Command Reference

112
C commands
clear processes interrupt mask

Command Description
show processes interrupt mask detail Displays interrupt masked details for the specified
processes or all processes in the system.

Cisco IOS Configuration Fundamentals Command Reference

113
 C commands
clear scp accounting

clear scp accounting

To clear the Switch-Module Configuration Protocol (SCP) accounting information, use the clear scp
accountingcommand in privilegedEXEC mode.

clear scp accounting

Syntax Description This command has no arguments or keywords.

Command Modes Privileged EXEC (#)

Command History Release Modification

15.0(1)M This command was introduced into a release earlier
than Cisco IOS Release 15.0(1)M.

12.2(33)SXI This command was integrated into a release earlier

than Cisco IOS Release 12.2(33)SXI.

Examples The following example shows how to clear the SCP accounting information:

Router# clear scp accounting

Related Commands Command Description

show scp Displays SCP information.

Cisco IOS Configuration Fundamentals Command Reference

114
 C commands
clear tcp

clear tcp
To clear a TCP connection, use the clear tcpcommand in privileged EXEC mode.

clear tcp {line line-number | local hostname port remote hostname port | tcb address}

Syntax Description line line-number Line number of the TCP connection to clear.

local hostname port remote hostname port Host name of the local router and port and host
name of the remote router and port of the TCP
connection to clear.

tcb address Transmission Control Block (TCB) address of the

TCP connection to clear. The TCB address is an
internal identifier for the endpoint.

Command Modes Privileged EXEC

Command History Release Modification

11.1 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The clear tcp command is particularly useful for clearing hung TCP connections.
The clear tcp line line-numbercommand terminates the TCP connection on the specified tty line.
Additionally, all TCP sessions initiated from that tty line are terminated.
The clear tcp local hostname port remote hostname portcommand terminates the specific TCP connection
identified by the host name and port pair of the local and remote router.
The clear tcp tcb address command terminates the specific TCP connection identified by the TCB address.

Examples The following example clears a TCP connection using its tty line number. The show tcp command displays
the line number (tty2) that is used in the clear tcp command.

Router# show tcp

tty2, virtual tty from host router20.cisco.com

Connection state is ESTAB, I/O status: 1, unread input bytes: 0
Local host: 171.69.233.7, Local port: 23
Foreign host: 171.69.61.75, Foreign port: 1058

Cisco IOS Configuration Fundamentals Command Reference

115
 C commands
clear tcp

Enqueued packets for retransmit: 0, input: 0, saved: 0

Event Timers (current time is 0x36144):

Timer Starts Wakeups Next
Retrans 4 0 0x0
TimeWait 0 0 0x0
AckHold 7 4 0x0
SendWnd 0 0 0x0
KeepAlive 0 0 0x0
GiveUp 0 0 0x0
PmtuAger 0 0 0x0

iss: 4151109680 snduna: 4151109752 sndnxt: 4151109752 sndwnd: 24576

irs: 1249472001 rcvnxt: 1249472032 rcvwnd: 4258 delrcvwnd: 30

SRTT: 710 ms, RTTO: 4442 ms, RTV: 1511 ms, KRTT: 0 ms
minRTT: 0 ms, maxRTT: 300 ms, ACK hold: 300 ms

Router# clear tcp line 2

[confirm]
[OK]

The following example clears a TCP connection by specifying its local router host name and port and its
remote router host name and port. The show tcp brief command displays the local (Local Address) and
remote (Foreign Address) host names and ports to use in the clear tcp command.

Router# show tcp brief

TCB Local Address Foreign Address (state)
60A34E9C router1.cisco.com.23 router20.cisco.1055 ESTAB

Router# clear tcp local router1 23 remote router20 1055

[confirm]
[OK]

The following example clears a TCP connection using its TCB address. The show tcp brief command
displays the TCB address to use in the clear tcp command.

Router# show tcp brief

TCB Local Address Foreign Address (state)
60B75E48 router1.cisco.com.23 router20.cisco.1054 ESTAB

Router# clear tcp tcb 60B75E48

[confirm]
[OK]

Related Commands Command Description

show tcp Displays the status of TCP connections.

show tcp brief Displays a concise description of TCP connection

endpoints.

Cisco IOS Configuration Fundamentals Command Reference

116
 C commands
clear vlan counters

clear vlan counters

To clear the software-cached counter values to start from zero again for a specified VLAN or all existing
VLANs, use the clear vlan counters command in privileged EXEC mode.

clear vlan [vlan-id] counters

Syntax Description vlan-id (Optional) The ID of a specific VLAN. Range: 1 to

4094.

Command Default This command has no default settings.

Command Modes Privileged EXEC (#)

Command History Release Modification

12.2(14)SX Support for this command was introduced on the
Supervisor Engine 720.

12.2(17d)SXB Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines If you do not specify a vlan-id; the software-cached counter values for all existing VLANs are cleared.

Examples This example shows how to clear the software-cached counter values for a specific VLAN:

Router# clear vlan 10 counters

Clear "show vlan" counters on this vlan [confirm]y
Router#

Related Commands Command Description

show vlan counters Displays the software-cached counter values.

Cisco IOS Configuration Fundamentals Command Reference

117
 C commands
clock

clock
To configure the port clocking mode for the 1000BASE-T transceivers, use the clock command in interface
configuration mode. To return to the default settings,use the no form of this command.

clock {auto | active [prefer] | passive [prefer]}

no clock

Syntax Description auto Enables the automatic-clock configuration.

active Enables the active operation.

prefer (Optional) Negotiates the specified mode with the

far end of the link.

passive Enables the passive operation.

Command Default auto

Command Modes Interface configuration

Command History Release Modification

12.2(17a)SX Support for this command was introduced on the
Supervisor Engine 720.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command is supported on the 1000BASE-T transceivers only.

If the clock mode of the near end of a link does not match the clock mode of the far end, the line protocol
does not come up.
The active and passive clock status is determined during the auto negotiation process before the
transmission link is established.
The clock command supports the following configurations:
• auto --Auto negotiates with the far end of the link but preference is given to the active-clock switch.
• active --Uses a local clock to determine transmitter-operation timing.

Cisco IOS Configuration Fundamentals Command Reference

118
 C commands
clock

• passive --Recovers the clock from the received signal and uses the recovered clock to determine
transmitter-operation timing.
• active prefer --Auto negotiates with the far end of the link but preference is given to the active-clock
switch.
• passive prefer --Auto negotiates with the far end of the link but preference is given to the passive-
clock switch.
Enter the show running-config interface command to display the current clock mode.
Enter the show interfaces command to display the clock mode that is negotiated by the firmware.

Examples This example shows how to enable the active-clock operation:

Router(config-if)# clock active

Router(config-if)#

Related Commands Command Description

show interfaces Displays traffic that is seen by a specific interface.

show running-config interface Displays the status and configuration of the module
or Layer 2 VLAN.

Cisco IOS Configuration Fundamentals Command Reference

119
 C commands
clock initialize nvram

clock initialize nvram

To restart the system clock from the last known system clock value, use the clock initialize
nvramcommand in global configuration mode. To disable the restart of the system clock from the last
known system clock value, use the no form of this command.

clock initialize nvram

no clock initialize nvram

Syntax Description This command has no arguments or keywords.

Command Default By default, the system clock is set to restart from the last known system clock value for platforms that have
no hardware calendar.

Command Modes Global configuration (config)

Command History Release Modification

12.3(4)T This command was introduced.

Usage Guidelines For platforms that have hardware calendars, the clock initialize nvram command is not available. When
the no form of the command is configured, the system clock gets initialized to default standard values. The
default values can be either 1MAR1993 or 1MAR2002.

Examples The following example shows how to set the system clock to restart from the last known system clock
value:

Router(config)# clock initialize nvram

Cisco IOS Configuration Fundamentals Command Reference

120
 C commands
config-register

config-register
To change the configuration register settings, use the config-register command in global configuration
mode.

config-register value

Syntax Description value Hexadecimal or decimal value that represents the

16-bit configuration register value that you want to
use the next time the router is restarted. The value
range is from 0x0 to 0xFFFF (0 to 65535 in
decimal).

Command Default Refer to the documentation for your platform for the default configuration register value. For many newer
platforms, the default is 0x2102, which causes the router to boot from Flash memory and the Break key to
be ignored.

Command Modes Global configuration

Command History Release Modification

10.0 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2(31)SB2 This command was integrated into Cisco IOS

Release 12.2(31)SB2.

12.2(33)SXH This command was integrated into Cisco IOS

Release 12.2(31)SXH.

Usage Guidelines This command applies only to platforms that use a software configuration register.
The lowest four bits of the configuration register (bits 3, 2, 1, and 0) form the boot field. The boot field
determines if the router boots manually, from ROM, or from Flash or the network.
To change the boot field value and leave all other bits set to their default values, follow these guidelines:
• If you set the configuration register boot field value to 0x0, you must boot the operating system
manually with the boot command.

Cisco IOS Configuration Fundamentals Command Reference

121
 C commands
config-register

• If you set the configuration register boot field value to 0x1, the router boots using the default ROM
software.
• If you set the configuration register boot field to any value from 0x2 to 0xF, the router uses the boot
field value to form a default boot filename for booting from a network server.
For more information about the configuration register bit settings and default filenames, refer to the
appropriate router hardware installation guide.

Note In a virtual switch application, If you have configured your config-register with a value that would skip file
parsing during the bootup process, your change to either a standalone or virtual switch will not take place
until you reconfigure your config-register. The config-register must be allowed to parse files in order to
ensure the conversion from either a standalone or virtual switch.

Examples In the following example, the configuration register is set to boot the system image from Flash memory:

config-register 0x2102

Related Commands Command Description

boot system Specifies the system image that the router loads at
startup.

confreg Changes the configuration register settings while in

ROM monitor mode.

o Lists the value of the boot field (bits 0 to 3) in the

configuration register.

show version Displays the configuration of the system hardware,

the software version, the names and sources of
configuration files, and the boot images.

Cisco IOS Configuration Fundamentals Command Reference

122
 C commands
configure check syntax

configure check syntax

To check the syntax configuration, use the configure check syntax commandinprivilegedEXEC mode.

configure check syntax [source-location]

Syntax Description source-location (Optional) Location or the address of the source to

be checked.

Command Default The syntax configuration is not checked.

Command Modes Privileged EXEC (#)

Command History Release Modification

15.0(1)M This command was introduced in a release earlier
than Cisco IOS Release 15.0(1)M.

12.2(33)SRB This command was integrated into a release earlier

than Cisco IOS Release 12.2(33)SRB.

Examples The following example shows how to check the syntax configuration using the configure check syntax
command:

Router# configure check syntax revrcsf:

Related Commands Command Description

configure revert Cancels the timed rollback and triggers the rollback
immediately, or resets the parameters for the timed
rollback.

Cisco IOS Configuration Fundamentals Command Reference

123
 C commands
configuration mode exclusive (Deprecated as of the 15.0S and T releases. It's still available on the M train.)

configuration mode exclusive (Deprecated as of the 15.0S and

T releases. It's still available on the M train.)
Note Effective with Cisco IOS XE Release 3.1S, the configuration mode exclusive command is replaced by the
parser command serializer command. See the parser command serializer command for more
information.

To enable single-user (exclusive) access functionality for the Cisco IOS command-line interface (CLI), use
the configuration mode exclusive command in global configuration mode. To disable the single-user
access (configuration locking) feature, use the no form of this command.

configuration mode exclusive {auto | manual} [expire seconds] [lock-show] [interleave]

[terminate] [config-wait seconds] [retry-wait seconds]
no configuration mode exclusive

Syntax Description auto Automatically limits configuration to single-user

mode.

manual Allows you to manually limit the configuration file

to single-user mode.

expire seconds (Optional) Specifies the number of seconds in

which the configuration lock is released after the
user stops making configuration changes.

lock-show (Optional) Gives priority to configuration

commands being executed from the exclusive
configuration session, and prevents the execution of
show commands.

interleave (Optional) Allows show commands from sessions

that are not holding the configuration lock to be
executed when the user in the session holding the
configuration lock is not making configuration
changes.
Note If you entered the lock-showkeyword, you
should enter this keyword.

terminate (Optional) Causes the configuration command

executed from the exclusive configuration session
to terminate show and clear commands being
executed in other sessions.

Cisco IOS Configuration Fundamentals Command Reference

124
 C commands
configuration mode exclusive (Deprecated as of the 15.0S and T releases. It's still available on the M train.)

config-wait seconds (Optional) Specifies the amount of time, in seconds,

that a configuration command entered by a user in
single user mode waits for show commands entered
by other users to finish being executed. If the show
command is still being executed when the timer
expires and if the terminate option is set, the
configuration command terminates the show
command. If the configuration command completes
execution before the specified number of seconds,
the show command begins execution.

retry-wait seconds (Optional) Specifies the amount of time, in seconds,

that show and clear EXEC commands will wait for
a configuration command entered by a user in
exclusive configuration mode to complete
execution.
If the configuration command is still being
executed when the specified amount of time has
passed, the EXEC commands generate an error
message and are terminated.
If execution of the configuration command is
completed before the specified number of seconds,
the EXEC commands are executed.

Command Default Single-user mode is disabled.

Command Modes Global configuration (config)

Command History Release Modification

12.3(14)T This command was introduced.

12.0(31)S This command was integrated into Cisco IOS

Release 12.0(31)S. The following keywords were
added: config-wait, expire, interleave, lock-
show,retry-wait,and terminate. New functionality
was added, including Access Session Locking.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2(33)SB This command was integrated into Cisco IOS

Release 12.2(33)SB.

Cisco IOS Configuration Fundamentals Command Reference

125
 C commands
configuration mode exclusive (Deprecated as of the 15.0S and T releases. It's still available on the M train.)

Release Modification
12.2(33)SXI This command was integrated into a release earlier
than Cisco IOS Release 12.2(33)SXI.

15.0(1)S This command was deprecated for Cisco IOS

Release 15.0(1)S.

Cisco IOS XE Release 3.1S This command was replaced by the parser
command serializer command.

Usage Guidelines

Note As of the 15.0 release, the configuration mode exclusive command is no longer available on the S and T
trains.

The configuration mode exclusive command enables the exclusive configuration lock feature. The
exclusive configuration lock allows single-user access to configuration modes using single-user
configuration mode. While the device configuration is locked, no other users can enter configuration
commands.
Users accessing the device using the state-full, session-based transports (telnet, Secure Shell (SSH) are able
to enter single-user configuration mode. The user enters single-user configuration mode by acquiring the
exclusive configuration lock using the configure terminal lock privileged EXEC mode command. The
configuration lock is released when the user exits configuration mode by using the end or exit command,
or by pressing Ctrl-Z. While a user is in single-user configuration mode, no other users can configure the
device. Users accessing Command Line Interface (CLI) options through stateless protocols (that is, the
HTTP web-based user interface) cannot access single-user configuration mode. (However, an Application
Programming Interface (API) allows the stateless transports to lock the configuration mode, complete its
operations, and release the lock.)

Examples The following example shows how to configure the configuration file for single-user autoconfiguration
mode by using the configuration mode exclusive auto command. Use the configuration terminal
command to enter global configuration mode and lock the configuration mode exclusively. After the Cisco
IOS configuration mode is locked exclusively, you can verify this configuration by entering the show
configuration lockcommand.

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# configuration mode exclusive auto
Router(config)# end
Router# show running-configuration
| include config

Building configuration...
Current configuration : 2296 bytes
configuration mode exclusive auto <========== auto policy
Router# configure terminal ?
<======== lock option not displayed when in auto policy
Router# configure terminal
<======= acquires the lock

Cisco IOS Configuration Fundamentals Command Reference

126
C commands
configuration mode exclusive (Deprecated as of the 15.0S and T releases. It's still available on the M train.)

The configuration mode is locked exclusively. The lock is cleared after you exit from configuration mode
by entering the end or exitcommand.

Enter configuration commands, one per line. End with CNTL/Z.

Router(config)#
Router(config)# show configuration lock

Parser Configure Lock

---------------------
Owner PID : 3
User : unknown
TTY : 0
Type : EXCLUSIVE
State : LOCKED
Class : EXPOSED
Count : 1
Pending Requests : 0
User debug info : configure terminal
Session idle state : TRUE
No of exec cmds getting executed : 0
No of exec cmds blocked : 0
Config wait for show completion : FALSE
Remote ip address : Unknown
Lock active time (in Sec) : 6
Lock Expiration timer (in Sec) : 593
Router(config)#
Router(config)# end
<========= releases the lock
Router#
Router# show configuration lock

Parser Configure Lock

---------------------
Owner PID : -1
User : unknown
TTY : -1
Type : NO LOCK
State : FREE
Class : unknown
Count : 0
Pending Requests : 0
User debug info :
Session idle state : TRUE
No of exec cmds getting executed : 0
No of exec cmds blocked : 0
Config wait for show completion : FALSE
Remote ip address : Unknown
Lock active time (in Sec) : 0
Lock Expiration timer (in Sec) : 0
The following example shows how to enable the exclusive locking feature in manual mode by using the
configuration mode exclusive manual command. Once you have configured manual exclusive mode, you
can lock the configuration mode by using the configure terminal lock command. In this mode, the
configure terminal command does not automatically lock the parser configuration mode. The lock is
cleared after you exit from configuration mode by entering the end or exit command.

Router# configure terminal

Configuration mode locked exclusively. The lock will be cleared once you exit out of
configuration mode using end/exit
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# configuration mode exclusive manual

Router(config)# end

Router#
Router# show running-configuration
| include configuration

Cisco IOS Configuration Fundamentals Command Reference

127
 C commands
configuration mode exclusive (Deprecated as of the 15.0S and T releases. It's still available on the M train.)

Building configuration...
Current configuration : 2298 bytes
configuration mode exclusive manual <==== 'manual' policy
Router# show configuration lock

Parser Configure Lock

---------------------
Owner PID : -1
User : unknown
TTY : -1
Type : NO LOCK
State : FREE
Class : unknown
Count : 0
Pending Requests : 0
User debug info :
Session idle state : TRUE
No of exec cmds getting executed : 0
No of exec cmds blocked : 0
Config wait for show completion : FALSE
Remote ip address : Unknown
Lock active time (in Sec) : 0
Lock Expiration timer (in Sec) : 0
Router#
Router# configure terminal ?

lock Lock configuration mode <========= 'lock' option displayed in 'manual' policy
Router# configure terminal <============ ‘configure terminal’ won't acquire lock
automatically
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# show configuration lock

Parser Configure Lock

---------------------
Owner PID : -1
User : unknown
TTY : -1
Type : NO LOCK
State : FREE
Class : unknown
Count : 0
Pending Requests : 0
User debug info :
Session idle state : TRUE
No of exec cmds getting executed : 0
No of exec cmds blocked : 0
Config wait for show completion : FALSE
Remote ip address : Unknown
Lock active time (in Sec) : 0
Lock Expiration timer (in Sec) : 0
Router(config)# end

Router# show configuration lock

Parser Configure Lock

---------------------
Owner PID : -1
User : unknown
TTY : -1
Type : NO LOCK
State : FREE
Class : unknown
Count : 0
Pending Requests : 0
User debug info :
Session idle state : TRUE
No of exec cmds getting executed : 0
No of exec cmds blocked : 0
Config wait for show completion : FALSE
Remote ip address : Unknown
Lock active time (in Sec) : 0

Cisco IOS Configuration Fundamentals Command Reference

128
 C commands
configuration mode exclusive (Deprecated as of the 15.0S and T releases. It's still available on the M train.)

Lock Expiration timer (in Sec) : 0

Router#
Router# configure

Router# configure terminal

Router# configure terminal ?

lock Lock configuration mode <======= 'lock' option displayed when in 'manual' policy
Router# configure terminal lock

Router# configure terminal lock

<============ acquires exclusive configuration lock

Configuration mode is locked exclusively. The lock is cleared after you exit from configuration mode by
entering the end or exit command. Enter configuration commands, one per line. End with CNTL/Z.

Router(config)# show configuration lock

Parser Configure Lock

---------------------
Owner PID : 3
User : unknown
TTY : 0
Type : EXCLUSIVE
State : LOCKED
Class : EXPOSED
Count : 1
Pending Requests : 0
User debug info : configure terminal lock
Session idle state : TRUE
No of exec cmds getting executed : 0
No of exec cmds blocked : 0
Config wait for show completion : FALSE
Remote ip address : Unknown
Lock active time (in Sec) : 5
Lock Expiration timer (in Sec) : 594
Router(config)# end
<================ 'end' releases exclusive configuration lock
Router# show configuration lock

Parser Configure Lock

---------------------
Owner PID : -1
User : unknown
TTY : -1
Type : NO LOCK
State : FREE
Class : unknown
Count : 0
Pending Requests : 0
User debug info :
Session idle state : TRUE
No of exec cmds getting executed : 0
No of exec cmds blocked : 0
Config wait for show completion : FALSE
Remote ip address : Unknown
Lock active time (in Sec) : 0
Lock Expiration timer (in Sec) : 0
Router#

Related Commands Command Description

configure terminal Enters global configuration mode.

Cisco IOS Configuration Fundamentals Command Reference

129
 C commands
configuration mode exclusive (Deprecated as of the 15.0S and T releases. It's still available on the M train.)

Command Description
debug configuration lock Enables debugging of the Cisco IOS configuration
lock.

show configuration lock Displays information about the lock status of the
running configuration file during a configuration
replace operation.

Cisco IOS Configuration Fundamentals Command Reference

130
 C commands
configure confirm

configure confirm
To confirm replacement of the current running configuration with a saved Cisco IOS configuration file, use
the configure confirm command in privileged EXEC mode.

configure confirm

Syntax Description This command has no arguments or keywords.

Command Modes Privileged EXEC (#)

Command History Release Modification

12.3(7)T This command was introduced.

12.2(25)S This command was integrated into Cisco IOS

Release 12.2S.

12.2(28)SB This command was integrated into Cisco IOS

Release 12.2SB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2SR.

12.2(33)SXH This command was integrated into Cisco IOS

Release 12.2SX.

12.2(33)SB This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco
10000 series.

12.2(33)SXI This command was integrated into Cisco IOS

Release 12.2(33)SXI.

Usage Guidelines The configure confirm command is used only if the time seconds keyword and argument of the configure
replace command are specified. If the configure confirm command is not entered within the specified
time limit, the configuration replace operation is automatically reversed (in other words, the current
running configuration file is restored to the configuration state that existed prior to entering the configure
replace command).

Cisco IOS Configuration Fundamentals Command Reference

131
 C commands
configure confirm

Examples The following example shows the use of the configure replace command with the time seconds keyword
and argument. You must enter the configure confirm command within the specified time limit to confirm
replacement of the current running configuration file:

Router# configure replace nvram:startup-config time 120

This will apply all necessary additions and deletions
to replace the current running configuration with the
contents of the specified configuration file, which is
assumed to be a complete configuration, not a partial
configuration. Enter Y if you are sure you want to proceed. ? [no]: Y
Total number of passes: 1
Rollback Done
Router# configure confirm

Related Commands Command Description

archive config Saves a copy of the current running configuration to
the Cisco IOS configuration archive.

configure replace Replaces the current running configuration with a

saved Cisco IOS configuration file.

maximum Sets the maximum number of archive files of the

running configuration to be saved in the Cisco IOS
configuration archive.

path (config-archive) Specifies the location and filename prefix for the
files in the Cisco IOS configuration archive.

show archive Displays information about the files saved in the

Cisco IOS configuration archive.

time-period Sets the time increment for automatically saving an

archive file of the current running configuration in
the Cisco IOS configuration archive.

Cisco IOS Configuration Fundamentals Command Reference

132
 C commands
configure memory

configure memory
To configure the system from the system memory, use the configure memory command in privileged
EXEC mode.

configure memory

Syntax Description This command has no arguments or keywords.

Command Modes Privileged EXEC

Command History Release Modification

10.0 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines On all platforms except Class A Flash file system platforms, this command executes the commands located
in the configuration file in NVRAM (the “startup configuration file”).
On Class A Flash file system platforms, if you specify the configure memory command, the router
executes the commands pointed to by the CONFIG_FILE environment variable. The CONFIG_FILE
environment variable specifies the location of the configuration file that the router uses to configure itself
during initialization. The file can be located in NVRAM or any of the Flash file systems supported by the
platform.
When the CONFIG_FILE environment variable specifies NVRAM, the router executes the NVRAM
configuration only if it is an entire configuration, not a distilled version. A distilled configuration is one that
does not contain access lists.
To view the contents of the CONFIG_FILE environment variable, use the show bootvar EXEC command.
To modify the CONFIG_FILE environment variable, use the boot config command and then save your
changes by issuing the copy system:running-config nvram:startup-config command.

Examples In the following example, a router is configured from the configuration file in the memory location pointed
to by the CONFIG_FILE environment variable:

Router# configure memory

Cisco IOS Configuration Fundamentals Command Reference

133
 C commands
configure memory

Related Commands Command Description

boot config Specifies the device and filename of the
configuration file from which the router configures
itself during initialization (startup).

copy system:running-config nvram:startup- Saves the running configuration as the startup

config configuration file.

show bootvar Displays the contents of the BOOT environment

variable, the name of the configuration file pointed
to by the CONFIG_FILE environment variable, the
contents of the BOOTLDR environment variable,
and the configuration register setting.

Cisco IOS Configuration Fundamentals Command Reference

134
 C commands
configure network

configure network
The configure network command was replaced by the copy{rcp| tftp} running-config command in Cisco
IOS Release 11.0. To maintain backward compatibility, the configure network command continues to
function in Cisco IOS Release 12.2(11)T for most systems, but support for this command may be removed
in a future release.
The copy{rcp| tftp} running-config command was replaced by the copy {ftp: | rcp: | tftp:}[filename]
system: running-config command in Cisco IOS Release 12.1.
The copy {ftp: | rcp: | tftp:}[filename] system: running-config command specifies that a configuration
file should be copied from a FTP, rcp, or TFTP source to the running configuration. See the description of
the copy command in this chapter for more information.

Cisco IOS Configuration Fundamentals Command Reference

135
 C commands
configure overwrite-network

configure overwrite-network
The configure overwrite-network has been replaced by the copy {ftp-url | rcp-url | tftp-url
nvram:startup-config command. See the description of the copycommand in the Cisco IOS File System
Commands chapter for more information.

Cisco IOS Configuration Fundamentals Command Reference

136
 C commands
configure replace

configure replace
To replace the current running configuration with a saved Cisco IOS configuration file, use the configure
replace command in privileged EXEC mode.

configure replace target-url [nolock] list force ignorecase [revert trigger [error] [timer minutes] |
time minutes]

Syntax Description target-url URL (accessible by the Cisco IOS file system) of
the saved Cisco IOS configuration file that is to
replace the current running configuration.

nolock (Optional) Disables the locking of the running

configuration file that prevents other users from
changing the running configuration during a
configuration replace operation.

list (Optional) Displays a list of the command lines

applied by the Cisco IOS software parser during
each pass of the configuration replace operation.
The total number of passes performed is also
displayed.

force (Optional) Replaces the current running

configuration file with the specified saved Cisco
IOS configuration file without prompting you for
confirmation.

ignorecase (Optional) Instructs the configuration to ignore the

case of the configuration confirmation.

revert trigger (Optional) Sets the triggers for reverting to the

original configuration.
• error --Reverts to the original configuration
upon error.
• timer minutes --Reverts to the original
configuration if the specified time elapses.

Cisco IOS Configuration Fundamentals Command Reference

137
 C commands
configure replace

time minutes (Optional) Time (in minutes) within which you

must enter the configure confirm command to
confirm replacement of the current running
configuration file. If the configure confirm
command is not entered within the specified time
limit, the configuration replace operation is
automatically reversed (in other words, the current
running configuration file is restored to the
configuration state that existed prior to entering the
configure replace command).

Command Modes Privileged EXEC (#)

Command History Release Modification

12.3(7)T This command was introduced.

12.2(25)S The nolock keyword was added.

12.2(28)SB This command was integrated into Cisco IOS

Release 12.2(28)SB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2(31)SB2 This command was implemented on the Cisco

10000 series.

12.2(33)SXH This command was integrated into Cisco IOS

Release 12.2(33)SXH.

12.2(33)SXI This command was integrated into Cisco IOS

Release 12.2(33)SXI.

12.4(20)T The revert and trigger keywords were added.

12.2(33)SRC The ignorecase keyword was added.

12.2(33)SB This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco
10000 series.

Usage Guidelines When configuring more than one keyword option, the following rules apply:
• The list keyword must be entered before the force and time keywords.
• The force keyword must be entered before the time keyword.

Cisco IOS Configuration Fundamentals Command Reference

138
 C commands
configure replace

If the current running configuration is replaced with a saved Cisco IOS configuration file that contains
commands unaccepted by the Cisco IOS software parser, an error message is displayed listing the
commands that were unaccepted. The total number of passes performed in the configuration replace
operation is also displayed.
In Cisco IOS Release 12.2(25)S, a locking feature for the configuration replace operation was introduced.
When the configure replace command is enabled, the Cisco IOS running configuration file is locked by
default for the duration of the configuration replace operation. This locking mechanism prevents other users
from changing the running configuration while the replace operation is taking place, which might otherwise
cause the replace operation to terminate unsuccessfully. You can disable the locking of the running
configuration using the configure replace nolock command.
The running configuration lock is automatically cleared at the end of the configuration replace operation. It
is not expected that you should need to clear the lock manually during the replace operation, but as a
protection against any unforeseen circumstances, you can manually clear the lock using the clear
configuration lock command. You can also display any locks that may be currently applied to the running
configuration using the show configuration lock command.

Examples This section contains the following examples:

• configure replace, page 137
• configure replace, page 137
• configure replace, page 137
• configure replace, page 137

Replacing the Current Running Configuration with a Saved Cisco IOS Configuration File
The following example shows how to replace the current running configuration with a saved Cisco IOS
configuration file named disk0:myconfig. Note that the configure replace command interactively prompts
you to confirm the operation.

Router# configure replace disk0:myconfig

This will apply all necessary additions and deletions
to replace the current running configuration with the
contents of the specified configuration file, which is
assumed to be a complete configuration, not a partial
configuration. Enter Y if you are sure you want to proceed. ? [no]: Y
Total number of passes: 1
Rollback Done

In the following example, the list keyword is specified to display the command lines that were applied
during the configuration replace operation:

Router# configure replace disk0:myconfig list

This will apply all necessary additions and deletions
to replace the current running configuration with the
contents of the specified configuration file, which is
assumed to be a complete configuration, not a partial
configuration. Enter Y if you are sure you want to proceed. ? [no]: Y
!Pass 1
!List of Commands:
no snmp-server community public ro
snmp-server community mystring
ro
end
Total number of passes: 1
Rollback Done

Cisco IOS Configuration Fundamentals Command Reference

139
 C commands
configure replace

Reverting to the Startup Configuration File

The following example shows how to revert to the Cisco IOS startup configuration file. This example also
shows the use of the optional force keyword to override the interactive user prompt.

Router# configure replace nvram:startup-config force

Total number of passes: 1
Rollback Done

Performing a Configuration Replace Operation with the configure confirm Command

The following example shows the use of the configure replace command with the time seconds keyword
and argument. You must enter the configure confirm command within the specified time limit to confirm
replacement of the current running configuration file. If the configure confirm command is not entered
within the specified time limit, the configuration replace operation is automatically reversed (in other
words, the current running configuration file is restored to the configuration state that existed prior to
entering the configure replace command).

Router# configure replace nvram:startup-config time 120

This will apply all necessary additions and deletions
to replace the current running configuration with the
contents of the specified configuration file, which is
assumed to be a complete configuration, not a partial
configuration. Enter Y if you are sure you want to proceed. ? [no]: Y
Total number of passes: 1
Rollback Done
Router# configure confirm

Performing a Configuration Rollback Operation

The following example shows how to make changes to the current running configuration and then roll back
the changes. As part of the configuration rollback operation, you must save the current running
configuration before making changes to the file. In this example, the archive config command is used to
save the current running configuration. Note that the generated output of the configure replace command
indicates that only one pass was performed to complete the rollback operation.

Note The path command must be configured before using the archive config command.

You first save the current running configuration in the configuration archive as follows:

Router# archive config

You then enter configuration changes as shown in the following example:

Router# configure terminal

Router(config)# user netops2 password rain
Router(config)# user netops3 password snow
Router(config)# exit

After making changes to the running configuration file, you might want to roll back these changes and
revert to the configuration that existed before the changes were made. The show archive command is used
to verify the version of the configuration to be used as a target file. The configure replace command is
then used to revert to the target configuration file as shown in the following example:

Router# show archive

There are currently 1 archive configurations saved.
The next archive file will be named disk0:myconfig-2
Archive # Name
0

Cisco IOS Configuration Fundamentals Command Reference

140
 C commands
configure replace

1 disk0:myconfig-1 <- Most Recent

2
3
4
5
6
7
8
9
10
Router# configure replace disk0:myconfig-1
Total number of passes: 1
Rollback Done

Related Commands Command Description

archive config Saves a copy of the current running configuration to
the Cisco IOS configuration archive.

configure confirm Confirms replacement of the current running

configuration with a saved Cisco IOS configuration
file.

maximum Sets the maximum number of archive files of the

running configuration to be saved in the Cisco IOS
configuration archive.

path Specifies the location and filename prefix for the

files in the Cisco IOS configuration archive.

show archive Displays information about the files saved in the

Cisco IOS configuration archive.

time-period Sets the time increment for automatically saving an

archive file of the current running configuration in
the Cisco IOS configuration archive.

Cisco IOS Configuration Fundamentals Command Reference

141
 C commands
configure revert

configure revert
To cancel the timed rollback and trigger the rollback immediately, or to reset parameters for the timed
rollback, use the configure revertcommand in privileged EXEC mode.
configure revert {now | timer {minutes | idle minutes}}

Syntax Description now Cancels the timed rollback and reverts immediately.

timer Resets the confirmation timer.

minutes Time in minutes (1-120).

idle minutes Idle time in minutes (1-120) for which to wait

before rollback.

Command Modes Privileged EXEC (#)

Command History Release Modification

12.2(33)SRC This command was introduced.

12.2(33)SB This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco
10000 series.

12.4(20)T This command was integrated into Cisco IOS

Release 12.4(20)T.

12.2(33)SXI This command was integrated into Cisco IOS

Release 12.2(33)SXI.

Usage Guidelines In order to use the configure revert command to configure a timed rollback, the Configuration Archive
functionality must be enable first. The Configuration Archive APIs are used to store the current
configuration before applying any changes or rolling back to the previous configuration.
In case of multi-user environments, only the user who enabled the timed rollback functionality will have
the permission to perform the following operations:
• Confirm the configuration change
• Reset the timer
• Cancel the timer and trigger rollback immediately

Cisco IOS Configuration Fundamentals Command Reference

142
 C commands
configure revert

Examples The following example shows how to cancel the timed rollback and revert to the saved configuration
immediately:

Rourter(config)# archive
Router(config-archive)# path disk0:abc
Router# configure revert now

Related Commands Command Description

archive config Saves a copy of the current running configuration to
the Cisco IOS configuration archive.

configure replace Replaces the current running configuration with a

saved Cisco IOS configuration file.

maximum Sets the maximum number of archive files of the

running configuration to be saved in the Cisco IOS
configuration archive.

path (config-archive) Specifies the location and filename prefix for the
files in the Cisco IOS configuration archive.

show archive Displays information about the files saved in the

Cisco IOS configuration archive.

time-period Sets the time increment for automatically saving an

archive file of the current running configuration in
the Cisco IOS configuration archive.

Cisco IOS Configuration Fundamentals Command Reference

143
 C commands
configure terminal

2. configure terminal
To enter global configuration mode, use the configure terminal command in privileged EXEC mode.

configure terminal

Cisco IOS Releases 12.3(14)T and Subsequent Releases:

configure terminal [lock]

Cisco IOS Releases 12.2(33)SRC and Subsequent Releases:

configure terminal [revert {timer minutes | idle minutes}]

Syntax Description lock (Optional) Locks the running configuration into

exclusive configuration mode for the duration of
your configuration session. This keyword only
functions if the configuration mode
exclusivecommand was previously enabled.

revert (Optional) Sets the parameters for reverting the

configuration if confirmation of the new
configuration is not received.

timer minutes Time in minutes (1-120) for which to wait for

confirmation.

idle minutes Idle time in minutes (1-120) for which to wait for
confirmation.

Command Modes Privileged EXEC (#)

Command History Release Modification

10.0 This command was introduced.

12.3(14)T The lock keyword option was added.

12.0(31)S This command was integrated into Cisco IOS

Release 12.0(31)S.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Cisco IOS Configuration Fundamentals Command Reference

144
 C commands
configure terminal

Release Modification
12.4(20)T The revertkeyword option was added, along with
the timer parameters of idle and minutes.

12.2(33)SB This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco
10000 series.

12.2(33)SXI This command was integrated into Cisco IOS

Release 12.2(33)SXI.

Usage Guidelines Use this command to enter global configuration mode. Note that commands in this mode are written to the
running configuration file as soon as you enter them (using the Enter key/Carriage Return).
After you enter the configure terminalcommand, the system prompt changes from <router-name># to
<router-name>(config)# , indicating that the router is in global configuration mode. To leave global
configuration mode and return to privileged EXEC mode, type exit or press Ctrl-Z.
To view the changes to the configuration you have made, use the more system:running-config command
or show running-config command in user EXEC or privileged EXEC mode.
Configuration Locking
The first user to enter the configure terminal lockcommand acquires the configuration lock (exclusive
configuration mode).

Examples The following example shows how to enter global configuration mode and lock the Cisco IOS software in
exclusive mode:

Router(config)# configure terminal lock

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)#

Related Commands Command Description

boot config Specifies the device and filename of the
configuration file from which the router configures
itself during initialization (startup).

configuration mode exclusive Enables locking of the configuration file for single
user access.

copy running-config startup-config Saves the running configuration as the startup

configuration file.
or
copy system:running-config nvram:startup-
config

Cisco IOS Configuration Fundamentals Command Reference

145
 C commands
configure terminal

Command Description
show running-config Displays the currently running configuration.
or
more system:running-config

Cisco IOS Configuration Fundamentals Command Reference

146
 C commands
confreg

confreg
To change the configuration register settings while in ROM monitor mode, use the confreg command in
ROM monitor mode.

confreg [value]

Syntax Description value (Optional) Hexadecimal value that represents the

16-bit configuration register value that you want to
use the next time the router is restarted. The value
range is from 0x0 to 0xFFFF.

Command Default Refer to your platform documentation for the default configuration register value.

Command Modes ROM monitor

Command History Release Modification

10.0 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Not all versions in the ROM monitor support this command. Refer to your platform documentation for
more information on ROM monitor mode.
If you use this command without specifying the configuration register value, the router prompts for each bit
of the configuration register.
The lowest four bits of the configuration register (bits 3, 2, 1, and 0) form the boot field. The boot field
determines if the router boots manually, from ROM, or from Flash or the network.
To change the boot field value and leave all other bits set to their default values, follow these guidelines:
• If you set the configuration register boot field value to 0x0, you must boot the operating system
manually with the boot command.
• If you set the configuration register boot field value to 0x1, the router boots using the default ROM
software.
• If you set the configuration register boot field to any value from 0x2 to 0xF, the router uses the boot
field value to form a default boot filename for booting from a network server.
For more information about the configuration register bit settings and default filenames, refer to the
appropriate router hardware installation guide.

Cisco IOS Configuration Fundamentals Command Reference

147
 C commands
confreg

Examples In the following example, the configuration register is set to boot the system image from Flash memory:

confreg 0x210F

In the following example, no configuration value is entered, so the system prompts for each bit in the
register:

rommon 7 > confreg

Configuration Summary
enabled are:
console baud: 9600
boot: the ROM Monitor

do you wish to change the configuration? y/n [n]: y

enable "diagnostic mode"? y/n [n]: y
enable "use net in IP bcast address"? y/n [n]:
enable "load rom after netboot fails"? y/n [n]:
enable "use all zero broadcast"? y/n [n]:
enable "break/abort has effect"? y/n [n]:
enable "ignore system config info"? y/n [n]:
change console baud rate? y/n [n]: y
enter rate: 0 = 9600, 1 = 4800, 2 = 1200, 3 = 2400 [0]: 0
change the boot characteristics? y/n [n]: y
enter to boot:
0 = ROM Monitor
1 = the boot helper image
2-15 = boot system
[0]: 0

Configuration Summary
enabled are:
diagnostic mode
console baud: 9600
boot: the ROM Monitor

do you wish to change the configuration? y/n [n]:

You must reset or power cycle for new config to take effect.
rommon 8>

Cisco IOS Configuration Fundamentals Command Reference

148
 C commands
continue (ROM monitor)

continue (ROM monitor)

To return to EXEC mode from ROM monitor mode, use the continue command in ROM monitor mode.

continue

Syntax Description This command has no arguments or keywords.

Command Default No default behavior or values.

Command Modes ROM monitor

Command History Release Modification

11.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 return to EXEC mode from ROM monitor mode, to use the system image instead of
reloading. On older platforms, the angle bracket (< >) indicates that the router is in ROM monitor mode.
On newer platforms, rommon number> is the default ROM monitor prompt. Typically, the router is in
ROM monitor mode when you manually load a system image or perform diagnostic tests. Otherwise, the
router will most likely never be in this mode.

Caution While in ROM monitor mode, the Cisco IOS system software is suspended until you issue either a reset or
the continue command.

Examples In the following example, the continue command switches the router from ROM monitor to EXEC mode:

> continue
Router#

Cisco IOS Configuration Fundamentals Command Reference

149
 C commands
continue (ROM monitor)

Related Commands Command Description

boot Boots the router manually.

Cisco IOS Configuration Fundamentals Command Reference

150
 C commands
copy

copy
To copy any file from a source to a destination, use the copy command in privileged EXEC or diagnostic
mode.

copy [/erase] [/verify | /noverify] source-url destination-url

Syntax Description /erase (Optional) Erases the destination file system before
copying.
Note This option is typically provided on
platforms with limited memory to allow for
an easy way to clear local flash memory
space.

/verify (Optional) Verifies the digital signature of the

destination file. If verification fails, the file is
deleted from the destination file system. This option
applies to Cisco IOS software image files only.

/noverify (Optional) If the file being copied is an image file,

this keyword disables the automatic image
verification that occurs after an image is copied.
Note This keyword is often issued if the file
verify auto command is enabled, which
automatically verifies the digital signature of
all images that are copied.

source-url The location URL (or alias) of the source file or

directory to be copied. The source can be either
local or remote, depending upon whether the file is
being downloaded or uploaded.

destination-url The destination URL (or alias) of the copied file or

directory. The destination can be either local or
remote, depending upon whether the file is being
downloaded or uploaded.

The exact format of the source and destination URLs varies according to the file or directory location. You
may enter either an alias keyword for a particular file or a filename that follows the standard Cisco IOS file
system syntax (filesystem :[/filepath ][/filename ]).
The table below shows two keyword shortcuts to URLs.

Cisco IOS Configuration Fundamentals Command Reference

151
 C commands
copy

Table 11 Common Keyword Aliases to URLs

Keyword Source or Destination

running-config (Optional) Keyword alias for the system:running-
config URL. The system:running-config keyword
represents the current running configuration file.
This keyword does not work in more and show file
EXEC command syntaxes.

startup-config (Optional) Keyword alias for the nvram:startup-

configURL. The nvram:startup-config keyword
represents the configuration file used during
initialization (startup). This file is contained in
NVRAM for all platforms except the Cisco 7000
family, which uses the CONFIG_FILE environment
variable to specify the startup configuration. The
Cisco 4500 series cannot use the copy running-
config startup-configcommand. This keyword
does not work in more and show file EXEC
command syntaxes.

The following tables list URL prefix keywords by file system type. The available file systems will vary by
platform. If you do not specify a URL prefix keyword, the router looks for a file in the current directory.
The table below lists URL prefix keywords for Special (opaque) file systems.

Table 12 URL Prefix Keywords for Special File Systems

Keyword Source or Destination

cns: Source URL for Cisco Networking Services files.

flh: Source URL for flash load helper log files.

logging Source URL which copies messages from the

logging buffer to a file.

modem: Destination URL for loading modem firmware on

to supported networking devices.

null: Null destination for copies or files. You can copy a

remote file to null to determine its size.

nvram: Router NVRAM. You can copy the startup

configuration to NVRAM or from NVRAM.

obfl: Source or destination URL for Onboard Failure

Logging files.

stby-nvram: Router NVRAM on the standby hardware. You can

copy the startup configuration to NVRAM or from
NVRAM.

Cisco IOS Configuration Fundamentals Command Reference

152
C commands
copy

Keyword Source or Destination

stby-obfl: Source or destination URL for Onboard Failure
Logging files on the standby hardware.

system: Source or destination URL for system memory,

which includes the running configuration.

tar: Source URL for the archive file system.

tmpsys: Source or destination URL for the temporary

system files.

xmodem: Source or destination for a file from a network

machine that uses the Xmodem protocol.

ymodem: Source or destination for a file from a network

machine that uses the Ymodem protocol.

The table belows lists URL prefix keywords for remote file systems.

Table 13 URL Prefix Keywords for Remote File Systems

Keyword Source or Destination

ftp: Source or destination URL for FTP network server.
The syntax for this alias is as follows:ftp:[[[//
username [:password]@]location]/directory]/
filename.

http:// Source or destination URL for an HTTP server

(also called a web server). The syntax for this alias
is as follows: http:// [[username:password]@]
{hostname | host-ip}[/ filepath]/ filename

https:// Source or destination URL for a Secure HTTP

(HTTPS) server. HTTPS uses Secure Socket Layer
(SSL) encryption. The syntax for this alias is as
follows:https://[[username:password]@]{hostname
| host-ip}[/ filepath]/ filename

rcp: Source or destination URL for a remote copy

protocol (rcp) network server. The syntax for this
alias is as follows:rcp:[[[//username@ ] location]/
directory]/filename

scp: Source or destination URL for a network server that

supports Secure Shell (SSH) and accepts copies of
files using the secure copy protocol (scp). The
syntax for this alias is as follows:scp://
username@location[/directory][/filename]

Cisco IOS Configuration Fundamentals Command Reference

153
 C commands
copy

Keyword Source or Destination

tftp: Source or destination URL for a TFTP network
server. The syntax for this alias is as follows:tftp:
[[//location]/directory]/filename.

The table below lists URL prefix keywords for local writable storage file systems.

Table 14 URL Prefix Keywords for Local Writable Storage File Systems

Alias Source or Destination

bootflash: Source or destination URL for boot flash memory.

disk0: and disk1: Source or destination URL of disk-based media.

flash: Source or destination URL for flash memory. This

alias is available on all platforms. For platforms
that lack a flash: device, note that flash: is aliased to
slot0:, allowing you to refer to the main flash
memory storage area on all platforms.

harddisk: Source or destination URL of the active harddisk

file system.

slavebootflash: Source or destination URL for internal flash

memory on the slave RSP card of a router
configured for HSA.

slaveram: NVRAM on a slave RSP card of a router

configured for HSA.

slaveslot0: Source or destination URL of the first Personal

Computer Memory Card International Association
(PCMCIA) card on a slave RSP card of a router
configured for HSA.

slaveslot1: Source or destination URL of the second PCMCIA

slot on a slave RSP card of a router configured for
HSA.

slot0: Source or destination URL of the first PCMCIA

flash memory card.

slot1: Source or destination URL of the second PCMCIA

flash memory card.

stby-bootflash: Source or destination URL for boot flash memory

in standby RP.

stby-harddisk: Source or destination URL for the standby

harddisk.

Cisco IOS Configuration Fundamentals Command Reference

154
 C commands
copy

Alias Source or Destination

stby-usb [ 0-1 ] : Source or destination URL for the Universal Serial
Bus (USB) flash drive that has been plugged into
the router and is located on the standby RP.

usb [ 0-1 ] : Source or destination URL for the Universal Serial

Bus (USB) flash drive that has been plugged into
the router and is located on the active RP.

usbflash 0 9 : Source or destination URL for the Universal Serial

Bus (USB) flash drive that has been plugged into
the router.

usbtoken [0 9] : Source or destination URL for the USB eToken that

has been plugged into the router.

Command Modes Privileged EXEC (#)

Diagnostic (diag)

Command History Release Modification

11.3T This command was introduced.

12.3(2)T • The http:// and https:// keywords were added

as supported remote source locations (file
system URL prefixes) for files.
• This command was enhanced to support
copying files to servers that support SSH and
the scp.

12.2(14)S This command was integrated into Cisco IOS

Release 12.2(14)S.

12.2(18)S The /verifyand /noverify keywords were added.

12.0(26)S The /verifyand /noverify keywords were integrated

into Cisco IOS Release 12.0(26)S.

12.3(4)T The /verifyand /noverify keywords were integrated

into Cisco IOS Release 12.3(4)T.

12.3(7)T The http:// and https:// keywords were enhanced to

support file uploads.

12.3(14)T The usbflash 0 9 :and usbtoken 0 9 :keywords

were added to support USB storage.

Cisco IOS Configuration Fundamentals Command Reference

155
 C commands
copy

Release Modification
12.2(28)SB This command was integrated into Cisco IOS
Release 12.2(28)SB.

12.2(25)SG This command was integrated into Cisco IOS

Release 12.2(25)SG.

12.4(11)T This command was integrated into the Cisco

7200VXR NPE-G2 platform.

12.2(33)SXH This command was integrated into Cisco IOS

Release 12.2(33)SXH.

Cisco IOS XE Release 2.1 The Cisco ASR1000 series routers became
available, and introduced the copy command in
diagnostic mode.

Usage Guidelines The fundamental function of the copy command is to allow you to copy a file (such as a system image or
configuration file) from one location to another location. The source and destination for the file is specified
using a Cisco IOS File System URL, which allows you to specify any supported local or remote file
location. The file system being used (such as a local memory source, or a remote server) dictates the syntax
used in the command.
You can enter on the command line all necessary source- and destination-URL information and the
username and password to use, or you can enter the copy command and have the router prompt you for any
missing information.
For local file systems, two commonly used aliases exist for the system:running-config and
nvram:startup-config files; these aliases are running-config and startup-config, respectively.

Timesaver Aliases are used to reduce the amount of typing you need to perform. For example, it is easier to type copy
run start (the abbreviated form of the copy running-config startup-config command) than it is to type
copy system:r nvram:s (the abbreviated form of the copy system:running-config nvram:startup-
configcommand). These aliases also allow you to continue using some of the common commands used in
previous versions of Cisco IOS software.

The entire copying process may take several minutes and differs from protocol to protocol and from
network to network.
The colon is required after the file system URL prefix keywords (such as flash). In some cases, file system
prefixes that did not require colons in earlier software releases are allowed for backwards compatibility, but
use of the colon is recommended.
In the URL syntax for ftp:, http:, https:, rcp:, scp: and tftp:, the location is either an IP address or a host
name. The filename is specified relative to the directory used for file transfers.
The following sections contain usage guidelines for the following topics:
Understanding Invalid Combinations of Source and Destination
Some invalid combinations of source and destination exist. Specifically, you cannot copy:
• From a running configuration to a running configuration

Cisco IOS Configuration Fundamentals Command Reference

156
C commands
copy

• From a startup configuration to a startup configuration

• From a device to the same device (for example, the copy flash: flash: command is invalid)
Understanding Character Descriptions
The table below describes the characters that you may see during processing of the copycommand.

Table 15 copy Character Descriptions

Character Description
! For network transfers, an exclamation point
indicates that the copy process is taking place. Each
exclamation point indicates the successful transfer
of ten packets (512 bytes each).

. For network transfers, a period indicates that the

copy process timed out. Many periods in a row
typically mean that the copy process may fail.

O For network transfers, an uppercase O indicates that

a packet was received out of order and the copy
process may fail.

e For flash erasures, a lowercase e indicates that a

device is being erased.

E An uppercase E indicates an error. The copy

process may fail.

V A series of uppercase Vs indicates the progress

during the verification of the image checksum.

Understanding Partitions
You cannot copy an image or configuration file to a flash partition from which you are currently running.
For example, if partition 1 is running the current system image, copy the configuration file or image to
partition 2. Otherwise, the copy operation will fail.
You can identify the available flash partitions by entering the show file system EXECcommand.
Using rcp
The rcp requires a client to send a remote username upon each rcp request to a server. When you copy a
configuration file or image between the router and a server using rcp, the Cisco IOS software sends the first
valid username it encounters in the following sequence:
1 The remote username specified in the copy command, if a username is specified.
2 The username set by the ip rcmd remote-username global configuration command, if the command is
configured.
3 The remote username associated with the current tty (terminal) process. For example, if the user is
connected to the router through Telnet and was authenticated through the username command, the
router software sends the Telnet username as the remote username.
4 The router host name.
For the rcp copy request to process, an account must be defined on the network server for the remote
username. If the network administrator of the destination server did not establish an account for the remote

Cisco IOS Configuration Fundamentals Command Reference

157
 C commands
copy

username, this command will not run. If the server has a directory structure, the configuration file or image
is written to or copied from the directory associated with the remote username on the server. For example,
if the system image resides in the home directory of a user on the server, specify that username as the
remote username.
If you are writing to the server, the rcp server must be properly configured to accept the rcp write request
from the user on the router. For UNIX systems, add an entry to the .rhosts file for the remote user on the
rcp server. Suppose the router contains the following configuration lines:

hostname Rtr1
ip rcmd remote-username User0
If the router IP address translates to Router1.company.com, then the .rhosts file for User0 on the rcp server
should contain the following line:

Router1.company.com Rtr1
Refer to the documentation for your rcp server for more details.
If you are using a personal computer as a file server, the computer must support the remote shell protocol
(rsh).
Using FTP
The FTP protocol requires a client to send a username and password with each FTP request to a remote
FTP server. Use the ip ftp username and ip ftp password global configuration commands to specify a
default username and password for all copy operations to or from an FTP server. Include the username in
the copy command syntax if you want to specify a username for that copy operation only.
When you copy a file from the router to a server using FTP, the Cisco IOS software sends the first valid
username that it encounters in the following sequence:
1 The username specified in the copy command, if a username is specified.
2 The username set by the ip ftp username command, if the command is configured.
3 Anonymous.
The router sends the first valid password in the following list:
1 The password specified in the copy command, if a password is specified.
2 The password set by the ip ftp password command, if the command is configured.
3 The router forms a password [email protected]. The variable username is the username
associated with the current session, routername is the configured host name, and domain is the domain
of the router.
The username and password must be associated with an account on the FTP server. If you are writing to the
server, the FTP server must be properly configured to accept the FTP write request from the user on the
router.

Note The Syslog message will display 'xxxx' in place of the password entered in the syntax of the copy {ftp:}
command.

If the server has a directory structure, the configuration file or image is written to or copied from the
directory associated with the username on the server. For example, if the system image resides in the home
directory of a user on the server, specify that username as the remote username.
Refer to the documentation for your FTP server for details on setting up the server.
Using HTTP or HTTPS

Cisco IOS Configuration Fundamentals Command Reference

158
C commands
copy

Copying a file to or from a remote HTTP or HTTPS server, to or from a local file system, is performed
using the embedded Secure HTTP client that is integrated in Cisco IOS software. The HTTP client is
enabled by default.
Downloading files from a remote HTTP or HTTPS server is performed using the HTTP client integrated in
Cisco IOS software.
If a username and password are not specified in the copy command syntax, the system uses the default
HTTP client username and password, if configured.
When you copy a file from a remote HTTP or HTTPS server, the Cisco IOS software sends the first valid
username that it encounters in the following sequence:
1 The username specified in the copy command, if a username is specified.
2 The username set by the ip http client username command, if the command is configured.
3 Anonymous.
The router sends the first valid password in the following list:
1 The password specified in the copy command, if a password is specified.
2 The password set by the ip http client password command, if the command is configured.
3 The router forms the password [email protected]. The variable username is the username
associated with the current session, routername is the configured host name, and domain is the domain
of the router.
Storing Images on Servers
Use the copy flash: destination-urlcommand (for example, copy flash: tftp:) to copy a system image or
boot image from flash memory to a network server. You can use the copy of the image as a backup copy.
Also, you can also use the image backup file to verify that the image in flash memory is the same as that in
the original file.
Copying from a Server to Flash Memory
Use the copy destination-url flash: command (for example, copy tftp: flash:) to copy an image from a
server to flash memory.
On Class B file system platforms, the system provides an option to erase existing flash memory before
writing onto it.

Note Verify the image in flash memory before booting the image.

Verifying Images
When copying a new image to your router, you should confirm that the image was not corrupted during the
copy process. You can verify the integrity of the image in any of the following ways:
• Depending on the destination file system type, a checksum for the image file may be displayed when
the copy command completes. You can verify this checksum by comparing it to the checksum value
provided for your image file on Cisco.com.

Cisco IOS Configuration Fundamentals Command Reference

159
 C commands
copy

Caution If the checksum values do not match, do not reboot the router. Instead, reissue the copycommand and
compare the checksums again. If the checksum is repeatedly wrong, copy the original image back into flash
memory beforeyou reboot the router from flash memory. If you have a corrupted image in flash memory
and try to boot from flash memory, the router will start the system image contained in ROM (assuming
booting from a network server is not configured). If ROM does not contain a fully functional system image,
the router might not function and will need to be reconfigured through a direct console port connection.

• Use the /verifykeyword.

• Enable automatic image verification by default by issuing the file verify auto command. This
command will automatically check the integrity of each file that is copied via the copy command
(without specifying the /verifyoption) to the router unless the /noverify keyword is specified.
• Use the UNIX 'diff' command. This method can also be applied to file types other than Cisco IOS
images. If you suspect that a file is corrupted, copy the suspect file and the original file to a UNIX
server. (The file names may need to be modified if you try to save the files in the same directory.)
Then run the UNIX 'diff' command on the two files. If there is no difference, then the file has not been
corrupted.
Copying a Configuration File from a Server to the Running Configuration
Use the copy {ftp: | rcp: | scp: | tftp: running-configcommand to load a configuration file from a network
server to the running configuration of the router. (Note that running-config is the alias for the
system:running-config keyword.) The configuration will be added to the running configuration as if the
commands were typed in the command-line interface (CLI). Thus, the resulting configuration file will be a
combination of the previous running configuration and the loaded configuration file, with the loaded
configuration file having precedence.
You can copy either a host configuration file or a network configuration file. Accept the default value of
host to copy and load a host configuration file containing commands that apply to one network server in
particular. Enter network to copy and load a network configuration file containing commands that apply to
all network servers on a network.
Copying a Configuration File from a Server to the Startup Configuration
Use the copy {ftp: | rcp: | scp: | tftp:} nvram:startup-configcommand to copy a configuration file from a
network server to the router startup configuration. These commands replace the startup configuration file
with the copied configuration file.
Storing the Running or Startup Configuration on a Server
Use the copy system:running-config {ftp: | rcp: | scp: | tftp:} command to copy the current configuration
file to a network server using FTP, rcp, scp, or TFTP. Use the copy nvram:startup-config {ftp: | rcp: |
scp: | tftp:} command to copy the startup configuration file to a network server.
The configuration file copy can serve as a backup copy.
Saving the Running Configuration to the Startup Configuration
Use the copy system:running-config nvram:startup-config command to copy the running configuration
to the startup configuration.

Cisco IOS Configuration Fundamentals Command Reference

160
C commands
copy

Note Some specific commands might not get saved to NVRAM. You will need to enter these commands again if
you reboot the machine. These commands are noted in the documentation. We recommend that you keep a
listing of these settings so you can quickly reconfigure your router after rebooting.

If you issue the copy system:running-config nvram:startup-configcommand from a bootstrap system

image, a warning will instruct you to indicate whether you want your previous NVRAM configuration to be
overwritten and configuration commands to be lost. This warning does not appear if NVRAM contains an
invalid configuration or if the previous configuration in NVRAM was generated by a bootstrap system
image.
On all platforms except Class A file system platforms, the copy system:running-config nvram:startup-
config command copies the currently running configuration to NVRAM.
On the Class A flash file system platforms, the copy system:running-config nvram:startup-config
command copies the currently running configuration to the location specified by the CONFIG_FILE
environment variable. This variable specifies the device and configuration file used for initialization. When
the CONFIG_FILE environment variable points to NVRAM or when this variable does not exist (such as at
first-time startup), the software writes the current configuration to NVRAM. If the current configuration is
too large for NVRAM, the software displays a message and stops executing the command.
When the CONFIG_FILE environment variable specifies a valid device other than nvram: (that is, flash:,
bootflash:, slot0:, or slot1:), the software writes the current configuration to the specified device and
filename, and stores a distilled version of the configuration in NVRAM. A distilled version is one that does
not contain access list information. If NVRAM already contains a copy of a complete configuration, the
router prompts you to confirm the copy.
Using CONFIG_FILE, BOOT, and BOOTLDR Environment Variables
For the Class A flash file system platforms, specifications are as follows:
• The CONFIG_FILE environment variable specifies the configuration file used during router
initialization.
• The BOOT environment variable specifies a list of bootable images on various devices.
• The BOOTLDR environment variable specifies the flash device and filename containing the rxboot
image that ROM uses for booting.
• Cisco 3600 routers do not use a dedicated boot helper image (rxboot), which many other routers use to
help with the boot process. Instead, the BOOTLDR ROM monitor environment variable identifies the
flash memory device and filename that are used as the boot helper; the default is the first system image
in flash memory.
To view the contents of environment variables, use the show bootvar EXEC command. To modify the
CONFIG_FILE environment variable, use the boot config global configuration command. To modify the
BOOTLDR environment variable, use the boot bootldr global configuration command. To modify the
BOOT environment variable, use the boot system global configuration command. To save your
modifications, use the copy system:running-config nvram:startup-configcommand.
When the destination of a copy command is specified by the CONFIG_FILE or BOOTLDR environment
variable, the router prompts you for confirmation before proceeding with the copy. When the destination is
the only valid image in the BOOT environment variable, the router also prompts you for confirmation
before proceeding with the copy.
Using the Copy Command with the Dual RSP Feature
The Dual RSP feature allows you to install two Route Switch Processor (RSP) cards in a single router on
the Cisco 7507 and Cisco 7513 platforms.

Cisco IOS Configuration Fundamentals Command Reference

161
 C commands
copy

On a Cisco 7507 or Cisco 7513 router configured for Dual RSPs, if you copy a file to nvram:startup-
configuration with automatic synchronization disabled, the system prompts whether you also want to copy
the file to the slave startup configuration. The default answer is yes. If automatic synchronization is
enabled, the system automatically copies the file to the slave startup configuration each time you use a
copy command with nvram:startup-configuration as the destination.
Using the copy command with the ASR1000 Series Routers
The copy command is available in both privileged EXEC and diagnostic mode on the Cisco ASR1000
series routers. Because the copycommand is available in diagnostic mode, it can be used to copy all types
of files between directories and remote locations even in the event of an IOS failure.

Examples The following examples illustrate uses of the copy command:

Verifying the Integrity of the Image Before It Is Copied Example

The following example shows how to specify image verification before copying an image:

Router# copy /verify tftp://10.1.1.1/cisco/c7200-js-mz disk0:

Destination filename [c7200-js-mz]?
Accessing tftp://10.1.1.1/cisco/c7200-js-mz...
Loading cisco/c7200-js-mz from 10.1.1.1 (via FastEthernet0/0):!!!!!!!!!!!!!!!!!!!!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!!!!!!!!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
[OK - 19879944 bytes]
19879944 bytes copied in 108.632 secs (183003 bytes/sec)
Verifying file integrity of disk0:/c7200-js-
mz ...................................................
..........................................................................................
.........
..........................................................................................
.........
.......................................Done!
Embedded Hash MD5 :CFA258948C4ECE52085DCF428A426DCD
Computed Hash MD5 :CFA258948C4ECE52085DCF428A426DCD
CCO Hash MD5 :44A7B9BDDD9638128C35528466318183
Signature Verified

Copying an Image from a Server to Flash Memory Examples

The following examples use a copy rcp:, copy tftp:, or copy ftp: command to copy an image file from a
server to flash memory:

Copying an Image from a Server to Flash Memory Example

The following example copies a system image named file1 from the remote rcp server with an IP address of
172.16.101.101 to flash memory. On Class B file system platforms, the Cisco IOS software allows you to
first erase the contents of flash memory to ensure that enough flash memory is available to accommodate
the system image.

Router#
copy rcp://[email protected]/file1 flash:file1
Destination file name [file1]?
Accessing file 'file1' on 172.16.101.101...
Loading file1 from 172.16.101.101 (via Ethernet0): ! [OK]
Erase flash device before writing? [confirm]
Flash contains files. Are you sure you want to erase? [confirm]
Copy 'file1' from server
as 'file1' into Flash WITH erase? [yes/no] yes

Cisco IOS Configuration Fundamentals Command Reference

162
C commands
copy

Erasing device... eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee...erased

Loading file1 from 172.16.101.101 (via Ethernet0): !
[OK - 984/8388608 bytes]
Verifying checksum... OK (0x14B3)
Flash copy took 0:00:01 [hh:mm:ss]

Copying an Image from a Server to a Flash Memory Using Flash Load Helper Example
The following example copies a system image into a partition of flash memory. The system will prompt for
a partition number only if there are two or more read/write partitions or one read-only and one read/write
partition and dual flash bank support in boot ROMs. If the partition entered is not valid, 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. In this case, the partition is read-only and has dual flash bank support in boot
ROM, so the system uses flash Load Helper.

Router# copy tftp: flash:

System flash partition information:

Partition Size Used Free Bank-Size State Copy-Mode
1 4096K 2048K 2048K 2048K Read Only RXBOOT-FLH
2 4096K 2048K 2048K 2048K Read/Write Direct
[Type ?<no> for partition directory; ? for full directory; q to abort]
Which partition? [default = 2]
**** NOTICE ****
Flash load helper v1.0
This process will accept the copy options and then terminate
the current system image to use the ROM based image for the copy.
Routing functionality will not be available during that time.
If you are logged in via telnet, this connection will terminate.
Users with console access can see the results of the copy operation.
---- ******** ----
Proceed? [confirm]
System flash directory, partition 1:
File Length Name/status
1 3459720 master/igs-bfpx.100-4.3
[3459784 bytes used, 734520 available, 4194304 total]
Address or name of remote host [255.255.255.255]? 172.16.1.1

Source file name? master/igs-bfpx-100.4.3

Destination file name [default = source name]?

Loading master/igs-bfpx.100-4.3 from 172.16.1.111: !
Erase flash device before writing? [confirm]
Flash contains files. Are you sure? [confirm]
Copy 'master/igs-bfpx.100-4.3' from TFTP server
as 'master/igs-bfpx.100-4.3' into Flash WITH erase? [yes/no] yes

Copying an Image from a Server to a Flash Memory Card Partition Example

The following example copies the file c3600-i-mz from the rcp server at IP address 172.23.1.129 to the
flash memory card in slot 0 of a Cisco 3600 series router, which has only one partition. As the operation
progresses, the Cisco IOS software prompts you to erase the files on the flash memory PC card to
accommodate the incoming file. This entire operation takes 18 seconds to perform, as indicated at the end
of the example.

Router# copy rcp: slot0:

PCMCIA Slot0 flash
Partition Size Used Free Bank-Size State Copy Mode
1 4096K 3068K 1027K 4096K Read/Write Direct
2 4096K 1671K 2424K 4096K Read/Write Direct
3 4096K 0K 4095K 4096K Read/Write Direct
4 4096K 3825K 270K 4096K Read/Write Direct
[Type ?<no> for partition directory; ? for full directory; q to abort]
Which partition? [default = 1]

Cisco IOS Configuration Fundamentals Command Reference

163
 C commands
copy

PCMCIA Slot0 flash directory, partition 1:

File Length Name/status
1 3142288 c3600-j-mz.test
[3142352 bytes used, 1051952 available, 4194304 total]
Address or name of remote host [172.23.1.129]?
Source file name? /tftpboot/images/c3600-i-mz

Destination file name [/tftpboot/images/c3600-i-mz]?

Accessing file '/tftpboot/images/c3600-i-mz' on 172.23.1.129...
Connected to 172.23.1.129
Loading 1711088 byte file c3600-i-mz: ! [OK]
Erase flash device before writing? [confirm]
Flash contains files. Are you sure you want to erase? [confirm]
Copy '/tftpboot/images/c3600-i-mz' from server
as '/tftpboot/images/c3600-i-mz' into Flash WITH erase? [yes/no]
yes

Erasing device... eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee ...erased

Connected to 172.23.1.129
Loading 1711088 byte file c3600-i-
mz: !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!!!!!!!!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

Verifying checksum... OK (0xF89A)

Flash device copy took 00:00:18 [hh:mm:ss]

Saving a Copy of an Image on a Server Examples

The following examples use copy commands to copy image files to a server for storage:

Copy an Image from Flash Memory to an rcp Server Example

The following example copies a system image from flash Memory to an rcp server using the default remote
username. Because the rcp server address and filename are not included in the command, the router
prompts for it.

Router#
copy flash: rcp:
IP address of remote host [255.255.255.255]? 172.16.13.110
Name of file to copy? gsxx
writing gsxx - copy complete

Copy an Image from Flash Memory to an SSH Server Using scp Example
The following example shows how to use scp to copy a system image from flash memory to a server that
supports SSH:

Router# copy flash:c4500-ik2s-mz.scp scp://user1@host1/

Address or name of remote host [host1]?

Destination username [user1]?
Destination filename [c4500-ik2s-mz.scp]?
Writing c4500-ik2s-mz.scp
Password:
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
Before you can use the server-side functionality, SSH, authentication, and authorization must be properly
configured so the router can determine whether a user is at the right privilege level. The scp server-side
functionality is configured with the ip scp server enable command.

Copy an Image from a Partition of Flash Memory to a Server Example

The following example copies an image from a particular partition of flash memory to an rcp server using a
remote username of netadmin1.

Cisco IOS Configuration Fundamentals Command Reference

164
C commands
copy

The system will prompt if there are two or more partitions. If the partition entered is not valid, the process
terminates. You have the option to enter a partition number, a question mark (?) for a directory display of
all partitions, or a question mark and a number (? number) for a directory display of a particular partition.
The default is the first partition.

Router# configure terminal

Router# ip rcmd remote-username netadmin1
Router# end
Router# copy flash: rcp:
System flash partition information:
Partition Size Used Free Bank-Size State Copy-Mode
1 4096K 2048K 2048K 2048K Read Only RXBOOT-FLH
2 4096K 2048K 2048K 2048K Read/Write Direct
[Type ?<number> for partition directory; ? for full directory; q to abort]
Which partition? [1] 2
System flash directory, partition 2:
File Length Name/status
1 3459720 master/igs-bfpx.100-4.3
[3459784 bytes used, 734520 available, 4194304 total]
Address or name of remote host [ABC.CISCO.COM]?
Source file name? master/igs-bfpx.100-4.3
Destination file name [master/igs-bfpx.100-4.3]?
Verifying checksum for 'master/igs-bfpx.100-4.3' (file # 1)... OK
Copy 'master/igs-bfpx.100-4.3' from Flash to server
as 'master/igs-bfpx.100-4.3'? [yes/no] yes
!!!!...
Upload to server done
Flash copy took 0:00:00 [hh:mm:ss]

Copying an Image from a Flash Memory File System to an FTP Server Example
The following example copies the file c3600-i-mz from partition 1 of the flash memory card in slot 0 to an
FTP server at IP address 172.23.1.129:

Router# show slot0: partition 1

PCMCIA Slot0 flash directory, partition 1:
File Length Name/status
1 1711088 c3600-i-mz
[1711152 bytes used, 2483152 available, 4194304 total]
Router# copy slot0:1:c3600-i-mz ftp://myuser:[email protected]/c3600-i-mz
Verifying checksum for '/tftpboot/cisco_rules/c3600-i-mz' (file # 1)... OK
Copy '/tftpboot/cisco_rules/c3600-i-mz' from Flash to server
as 'c3700-i-mz'? [yes/no] yes
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!!!!!!!!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!!!!!!!!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
Upload to server done
Flash device copy took 00:00:23 [hh:mm:ss]

Copying an Image from Boot Flash Memory to a TFTP Server Example

The following example copies an image from boot flash memory to a TFTP server:

Router#
copy bootflash:file1 tftp://192.168.117.23/file1
Verifying checksum for 'file1' (file # 1)... OK
Copy 'file1' from Flash to server
as 'file1'? [yes/no]y
!!!!...
Upload to server done
Flash copy took 0:00:00 [hh:mm:ss]

Cisco IOS Configuration Fundamentals Command Reference

165
 C commands
copy

Copying a Configuration File from a Server to the Running Configuration Example

The following example copies and runs a configuration filename host1-confg from the netadmin1 directory
on the remote server with an IP address of 172.16.101.101:

Router#
copy rcp://[email protected]/host1-confg system:running-config
Configure using host1-confg from 172.16.101.101? [confirm]
Connected to 172.16.101.101
Loading 1112 byte file host1-confg:![OK]
Router#
%SYS-5-CONFIG: Configured from host1-config by rcp from 172.16.101.101

Copying a Configuration File from a Server to the Startup Configuration Example

The following example copies a configuration file host2-confg from a remote FTP server to the startup
configuration. The IP address is 172.16.101.101, the remote username is netadmin1, and the remote
password is ftppass.

Router#
copy ftp://netadmin1:[email protected]/host2-confg nvram:startup-config
Configure using rtr2-confg from 172.16.101.101?[confirm]
Connected to 172.16.101.101
Loading 1112 byte file rtr2-confg:![OK]
[OK]
Router#
%SYS-5-CONFIG_NV:Non-volatile store configured from rtr2-config by
FTP from 172.16.101.101

Copying the Running Configuration to a Server Example

The following example specifies a remote username of netadmin1. Then it copies the running configuration
file named rtr2-confg to the netadmin1 directory on the remote host with an IP address of 172.16.101.101.

Router# configure terminal

Router(config)# ip rcmd remote-username netadmin1

Router(config)#
end

Router#
copy system:running-config rcp:

Remote host[]? 172.16.101.101

Name of configuration file to write [Rtr2-confg]?

Write file rtr2-confg on host 172.16.101.101?[confirm]
Building configuration...[OK]
Connected to 172.16.101.101

Copying the Startup Configuration to a Server Example

The following example copies the startup configuration to a TFTP server:

Router#
copy nvram:startup-config tftp:
Remote host[]? 172.16.101.101

Name of configuration file to write [rtr2-confg]? <cr>

Write file rtr2-confg on host 172.16.101.101?[confirm] <cr>
![OK]

Cisco IOS Configuration Fundamentals Command Reference

166
C commands
copy

Saving the Current Running Configuration Example

The following example copies the running configuration to the startup configuration. On a Class A flash
file system platform, this command copies the running configuration to the startup configuration specified
by the CONFIG_FILE variable.

copy system:running-config nvram:startup-config

The following example shows the warning that the system provides if you try to save configuration
information from bootstrap into the system:

Router(boot)# copy system:running-config nvram:startup-config

Warning: Attempting to overwrite an NVRAM configuration written
by a full system image. This bootstrap software does not support
the full configuration command set. If you perform this command now,
some configuration commands may be lost.
Overwrite the previous NVRAM configuration?[confirm]

Enter no to escape writing the configuration information to memory.

Moving Configuration Files to Other Locations Examples

On some routers, you can store copies of configuration files on a flash memory device. Five examples
follow:

Copying the Startup Configuration to a Flash Memory Device Example

The following example copies the startup configuration file (specified by the CONFIG_FILE environment
variable) to a flash memory card inserted in slot 0:

Router# copy nvram:startup-config slot0:router-confg

Copying the Running Configuration to a Flash Memory Device Example

The following example copies the running configuration from the router to the flash memory PC card in
slot 0:

Router# copy system:running-config slot0:berlin-cfg

Building configuration...

5267 bytes copied in 0.720 secs

Copying to the Running Configuration from a Flash Memory Device Example

The following example copies the file named ios-upgrade-1 from the flash memory card in slot 0 to the
running configuration:

Router# copy slot0:4:ios-upgrade-1 system:running-config

Copy
'ios-upgrade-1
' from flash device
as 'running-config' ? [yes/no] yes

Copying to the Startup Configuration from a Flash Memory Device Example

The following example copies the router-image file from the flash memory to the startup configuration:

Router# copy flash:router-image nvram:startup-config

Cisco IOS Configuration Fundamentals Command Reference

167
 C commands
copy

Copying a Configuration File from one Flash Device to Another Example

The following example copies the file running-config from the first partition in internal flash memory to
the flash memory PC card in slot 1. The checksum of the file is verified, and its copying time of 30 seconds
is displayed.

Router# copy flash: slot1:

System flash
Partition Size Used Free Bank-Size State Copy Mode
1 4096K 3070K 1025K 4096K Read/Write Direct
2 16384K 1671K 14712K 8192K Read/Write Direct
[Type ?<no> for partition directory; ? for full directory; q to abort]
Which partition? [default = 1]
System flash directory, partition 1:
File Length Name/status
1 3142748 dirt/images/mars-test/c3600-j-mz.latest
2 850 running-config
[3143728 bytes used, 1050576 available, 4194304 total]
PCMCIA Slot1 flash directory:
File Length Name/status
1 1711088 dirt/images/c3600-i-mz
2 850 running-config
[1712068 bytes used, 2482236 available, 4194304 total]
Source file name? running-config
Destination file name [running-config]?
Verifying checksum for 'running-config' (file # 2)... OK
Erase flash device before writing? [confirm]
Flash contains files. Are you sure you want to erase? [confirm]
Copy 'running-config' from flash: device
as 'running-config' into slot1: device WITH erase? [yes/no] yes

Erasing device... eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee ...erased

!
[OK - 850/4194304 bytes]
Flash device copy took 00:00:30 [hh:mm:ss]
Verifying checksum... OK (0x16)

Copying a File from a Remote Web Server Examples

In the following example, the file config1 is copied from a remote server to flash memory using HTTP:

Router# copy
http://
www.example.com:8080/configs/config1 flash:config1

In the following example, a default username and password for HTTP Client communications is
configured, and then the file sample.scr is copied from a secure HTTP server using HTTPS:

Router# configure terminal

Router(config)# ip http client username joeuser

Router(config)# ip http client password letmein

Router(config)# end

Router# copy https://www.example_secure.com/scripts/sample.scr flash:

In the following example, an HTTP proxy server is specified before using the copy http:// command:

Router# configure terminal

Router(config)# ip http client proxy-server edge2 proxy-port 29

Router(config)# end

Router# copy
http://
www.example.com/configs/config3 flash:/configs/config3

Cisco IOS Configuration Fundamentals Command Reference

168
 C commands
copy

Copying an Image from the Master RSP Card to the Slave RSP Card Example
The following example copies the router-image file from the flash memory card inserted in slot 1 of the
master RSP card to slot 0 of the slave RSP card in the same router:

Router# copy slot1:router-image slaveslot0:

Related Commands Command Description

boot config Specifies the device and filename of the
configuration file from which the router configures
itself during initialization (startup).

boot system Specifies the system image that the router loads at
startup.

cd Changes the default directory or file system.

copy xmodem: flash: Copies any file from a source to a destination.

copy ymodem: flash: Copies any file from a source to a destination.

delete Deletes a file on a flash memory device.

dir Displays a list of files on a file system.

erase Erases a file system.

ip rcmd remote-username Configures the remote username to be used when

requesting a remote copy using rcp.

ip scp server enable Enables scp server-side functionality.

reload Reloads the operating system.

show bootvar Displays the contents of the BOOT environment

variable, the name of the configuration file pointed
to by the CONFIG_FILE environment variable, the
contents of the BOOTLDR environment variable,
and the configuration register setting.

show (flash file system) Displays the layout and contents of a flash memory
file system.

slave auto-sync config Turns on automatic synchronization of

configuration files for a Cisco 7507 or Cisco 7513
router that is configured for Dual RSP Backup.

verify bootflash: File system or directory containing the files to list,

followed by a colon.

Cisco IOS Configuration Fundamentals Command Reference

169
 C commands
copy erase flash

copy erase flash

The copy erase flash command has been replaced by the erase flash:command. See the description of the
erase command for more information.
O n some platforms, use can use the copy /erase source-url flash: syntax to erase the local Flash file
system before copying a new file into Flash. See the desciption of the copy command for details on this
option.

Cisco IOS Configuration Fundamentals Command Reference

170
 C commands
copy http

copy http
The copy http:// command is documented as part of the copy command.

Cisco IOS Configuration Fundamentals Command Reference

171
 C commands
copy https

copy https
The copy https:// command is documented as part of the copy command.

Cisco IOS Configuration Fundamentals Command Reference

172
 C commands
copy logging system

copy logging system

To copy archived system events to a destination file system, use the copy logging systemcommand in
privileged EXEC mode. To stop copying the archived system events, use the no form of the command.

copy logging system target : filename

no copy logging system

Syntax Description target : Specifies the destination file system; Valid values
are as follows:
• bootflash:
• disk0:
• disk1:
• ftp:
• http:
• https:
• rcp:
• slavebootflash:
• slavedisk0:
• slavedisk1:
• slavesup-bootdisk:
• slavesup-bootflash:
• sup-bootdisk:
• sup-bootflash:
• tftp:

filename Name of the file.

Command Default This command has no default settings.

Command Modes Privileged EXEC (#)

Command History Release Modification

12.2(33)SXH This command was introduced.

Cisco IOS Configuration Fundamentals Command Reference

173
 C commands
copy logging system

Release Modification
12.2(33)SCC The command was introduced for the Cisco
uBR10012 router in the Cisco IOS Software
Release 12.2(33)SCC.

Usage Guidelines System Event Archive (SEA) is supported on switches that have a Supervisor Engine 32 or Supervisor
Engine 720 with a compact flash adapter and a Compact Flash card (WS-CF-UPG= for Supervisor Engine
720).
Cisco Universal Broadband Router 10012
The System Event Archive (SEA) feature is used to address the debug trace and system console constraints.
Use the copy logging systemcommand to copy the major and critical events stored in the sea_log.dat file,
to the destination file system.

Note To store the system event logs, the SEA requires either the PCMCIA ATA disk or Compact Flash Disk in
compact flash adapter for PRE2.

The following example shows how to copy the SEA to the file system of disk0:

Router# copy logging system disk0:

Destination filename [sea_log.dat]?

The following example shows how to copy the SEA using the remote file copy function (rcp):

Router# copy logging system rcp:

Address or name of remote host []? 192.0.2.1

Destination username [Router]? username1
Destination filename [sea_log.dat]? /auto/tftpboot-users/username1/sea_log.dat

Related Commands clear logging system Clears the event records stored in the SEA.

logging system Enables or disables SEA logging system.

show logging system Displays the SEA logging system disk.

Cisco IOS Configuration Fundamentals Command Reference

174
 C commands
copy xmodem

copy xmodem
To copy a Cisco IOS image from a local or remote computer (such as a PC, Macintosh, or UNIX
workstation) to Flash memory on a Cisco 3600 series router using the Xmodem protocol, use the copy
xmodem: command in EXEC mode.

copy xmodem: flashfilesystem:

Syntax Description flash-filesystem : Destination of the copied file, followed by a colon.

Command Modes EXEC

Command History Release Modification

11.2 P This command was introduced.

12.2(15)T This command is no longer supported in Cisco IOS

Mainline or Technology-based (T) releases. It may
continue to appear in Cisco IOS 12.2S-family
releases.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command is a form of the copy command. The copy xmodem: and copy xmodem commands are
identical. See the description of the copy command for more information.
Copying a file using FTP, rcp, or TFTP is much faster than copying a file using Xmodem. Use the copy
xmodem: command only if you do not have access to an FTP, TFTP, or rcp server.
This copy operation is performed through the console or AUX port. The AUX port, which supports
hardware flow control, is recommended.
No output is displayed on the port over which the transfer is occurring. You can use the logging buffered
command to log all router messages sent to the console port during the file transfer.

Examples The following example initiates a file transfer from a local or remote computer to the router’s internal Flash
memory using the Xmodem protocol:

copy xmodem: flash:

Cisco IOS Configuration Fundamentals Command Reference

175
 C commands
copy xmodem

Related Commands Command Description

copy Copies any file from a source to a destination.

copy ymodem: Copies a Cisco IOS image from a local or remote

computer (such as a PC, Macintosh, or UNIX
workstation) to Flash memory on a Cisco 3600
series router using the Ymodem protocol.

Cisco IOS Configuration Fundamentals Command Reference

176
 C commands
copy ymodem

copy ymodem
To copy a Cisco IOS image from a local or remote computer (such as a PC, Macintosh, or UNIX
workstation) to Flash memory on a Cisco 3600 series router using the Ymodem protocol, use the copy
ymodem: command in EXEC mode.

copy ymodem: flashfilesystem:

Syntax Description flash-filesystem : Destination of the copied file, followed by a colon.

Command Modes EXEC

Command History Release Modification

11.2 P This command was introduced.

12.2(15)T This command is no longer supported in Cisco IOS

Mainline or Technology-based (T) releases. It may
continue to appear in Cisco IOS 12.2S-family
releases.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The copy ymodem: and copy ymodem commands are identical. See the description of the copycommand
for more information.
Copying a file using FTP, rcp, or TFTP is much faster than copying a file using Ymodem. Use the copy
ymodem: command only if you do not have access to an FTP, rcp, or TFTP server.
This copy operation is performed through the console or AUX port. The AUX port, which supports
hardware flow control, is recommended.
No output is displayed on the port over which the transfer is occurring. You can use the logging buffered
command to log all router messages sent to the console port during the file transfer.

Examples The following example initiates a file transfer from a local or remote computer to the router’s internal Flash
memory using the Ymodem protocol:

copy ymodem: flash:

Cisco IOS Configuration Fundamentals Command Reference

177
 C commands
copy ymodem

Related Commands Command Description

copy xmodem: Copies a Cisco IOS image from a local or remote
computer (such as a PC, Macintosh, or UNIX
workstation) to Flash memory on a Cisco 3600
series router using the Xmodem protocol.

Cisco IOS Configuration Fundamentals Command Reference

178
 C commands
copy noverify

copy noverify
To disable the automatic image verification for the current copy operation, use the copy /
noverifycommand.

copy /noverify source-url destination-url

Syntax Description source-url Location URL or alias of the source file or

directory to be copied; see the “Usage Guidelines”
section for additional information.

destination-url Destination URL or alias of the copied file or

directory; see the “Usage Guidelines” section for
additional information.

Command Default Verification is done automatically after completion of a copy operation.

Command Modes Privileged EXEC

Command History Release Modification

12.2(14)SX Support for this command was introduced on the
Supervisor Engine 720.

12.2(17d)SXB Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The exact format of the source and destination URLs varies according to the file or directory location. You
may enter either an alias keyword for a particular file or an alias keyword for a file system type (not a file
within a type).

Cisco IOS Configuration Fundamentals Command Reference

179
 C commands
copy noverify

Timesaver Aliases are used to cut down on the amount of typing that you need to perform. For example, it is easier to
type copy run start (the abbreviated form of the copy running-config startup-config command) than it is
to type copy system:r nvram:s (the abbreviated form of the copy system:running-config nvram:startup-
configcommand). These aliases allow you to continue using some of the common commands that are used
in previous versions of Cisco IOS software.

The table below shows two keyword shortcuts to URLs.

Table 16 Common Keyword Aliases to URLs

Keyword Source or Destination

running-config (Optional) Specifies the alias for the
system:running-config URL. This keyword does
not work in the more and show file command
syntaxes.

startup-config (Optional) Specifies the alias for the

nvram:startup-config URL.The nvram:startup-
config keyword represents the configuration file
that is used during initialization (startup). This file
is contained in NVRAM. This keyword does not
work in more and show file EXEC command
syntaxes.

The following tables list aliases by file system type. If you do not specify an alias, the system looks for a
file in the current directory.
The table below lists the URL prefix aliases for special (opaque) file systems.

Table 17 URL Prefix Aliases for Special File Systems

Alias Source or Destination

flh: Source URL for Flash load helper log files.

nvram: Router NVRAM. You can copy the startup

configuration into or from NVRAM. You can also
display the size of a private configuration file.

null: Null destination for copies or files. You can copy a

remote file to null to determine its size.

system: Source or destination URL for system memory,

which includes the running configuration.

xmodem: Source destination for the file from a network

device that uses the Xmodem protocol.

ymodem: Source destination for the file from a network

device that uses the Ymodem protocol.

Cisco IOS Configuration Fundamentals Command Reference

180
C commands
copy noverify

The table below lists the URL prefix aliases for network file systems.

Table 18 URL Prefix Aliases for Network File Systems

Alias Source or Destination

ftp: Source or destination URL for an FTP network
server. The syntax for this alias is as follows:ftp:
[[[//username [:password]@]location]/directory]/
filename.

rcp: Source or destination URL for an rcp network

server. The syntax for this alias is as follows: rcp:
[[[//username@ ] location]/directory]/filename.

tftp: Source or destination URL for a TFTP network

server. The syntax for this alias is tftp:[[//location]/
directory]/filename.

The table below lists the URL prefix aliases for local writable storage file systems.

Table 19 URL Prefix Aliases for Local Writable Storage File Systems

Alias Source or Destination

bootflash: Source or destination URL for boot flash memory.

disk0: and disk1: Source or destination URL of rotating media.

flash: Source or destination URL for Flash memory. This

alias is available on all platforms.
For platforms that lack a Flash: device, note that
flash: is aliased to slot0:, allowing you to refer to
the main Flash memory storage area on all
platforms.

slavebootflash: Source or destination URL for internal Flash

memory on the slave RSP card of a device that is
configured for HSA.

slaveram: NVRAM on a slave RSP card of a device that is

configured for HSA.

slavedisk0: Source or destination URL of the first PCMCIA

card on a slave RSP card of a device that is
configured for HSA.

slavedisk1: Source or destination URL of the second PCMCIA

slot on a slave RSP card of a device that is
configured for HSA.

Cisco IOS Configuration Fundamentals Command Reference

181
 C commands
copy noverify

Alias Source or Destination

slaveslot0: Source or destination URL of the first PCMCIA
card on a slave RSP card of a router configured for
HSA--Available on systems that are configured
with a Supervisor Engine 2.

slaveslot1: Source or destination URL of the second PCMCIA

slot on a slave RSP card of a router configured for
HSA--Available on systems that are configured
with a Supervisor Engine 2.

slot0: Source or destination URL of the first PCMCIA

Flash memory card--Available on systems that are
configured with a Supervisor Engine 2.

slot1: Source or destination URL of the second PCMCIA

Flash memory card--Available on systems that are
configured with a Supervisor Engine 2.

You can enter on the command line all necessary source- and destination-URL information and the
username and password to use, or you can enter the copy command and have the switch prompt you for
any missing information.
If you enter information, choose one of the following three options: running-config, startup-config, or a
file system alias (see the tables above). The location of a file system dictates the format of the source or
destination URL.
The colon is required after the alias. However, earlier commands that do not require a colon remain
supported but are unavailable in context-sensitive help.
The entire copying process may take several minutes and differs from protocol to protocol and from
network to network.
In the alias syntax for ftp:, rcp:, and tftp:, the location is either an IP address or a hostname. The filename
is specified for the directory that is used for file transfers.
Enter the file verify autocommand to set up verification globally.

Examples This example shows how to disable the automatic image verification for the current copy operation:

Router# copy /noverify tftp: sup-bootflash:

.................................................
[OK - 24301348 bytes]
24301348 bytes copied in 157.328 secs (154463 bytes/sec)
Router#

Related Commands Command Description

file verify auto Verifies the compressed Cisco IOS image
checksum.

Cisco IOS Configuration Fundamentals Command Reference

182
C commands
copy noverify

Command Description
verify Verifies the checksum of a file on a Flash memory
file system or compute an MD5 signature for a file.

Cisco IOS Configuration Fundamentals Command Reference

183
 C commands
copy noverify

Cisco IOS Configuration Fundamentals Command Reference

184
D through E
• databits, page 187
• data-character-bits, page 189
• default-value data-character-bits, page 191
• default-value exec-character-bits, page 193
• default-value modem-interval, page 195
• default-value special-character-bits, page 196
• define interface-range, page 198
• delete, page 200
• diag, page 203
• diagnostic bootup level, page 207
• diagnostic cns, page 209
• diagnostic event-log size, page 211
• diagnostic level, page 213
• diagnostic monitor, page 215
• diagnostic ondemand, page 220
• diagnostic schedule module, page 222
• diagnostic start, page 225
• diagnostic stop, page 230
• dir, page 233
• disable, page 237
• disconnect-character, page 239
• dispatch-character, page 240
• dispatch-machine, page 242
• dispatch-timeout, page 244
• do, page 246
• downward-compatible-config, page 248
• editing, page 250
• enable, page 254
• enable last-resort, page 258
• end, page 259
• environment-monitor shutdown temperature, page 261
• environment temperature-controlled, page 262
• erase, page 264
• erase bootflash, page 268
• errdisable detect cause, page 269

Cisco IOS Configuration Fundamentals Command Reference

185
 D through E

• errdisable recovery, page 271

• escape-character, page 274
• exec, page 277
• exec-banner, page 278
• exec-character-bits, page 280
• exec-timeout, page 282
• execute-on, page 284
• exit (EXEC), page 289
• exit (global), page 291

Cisco IOS Configuration Fundamentals Command Reference

186
 D through E
databits

databits
To set the number of data bits per character that are interpreted and generated by the router hardware, use
the databitscommand 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.

Command Default Eight data bits per character

Command Modes Line configuration

Command History Release Modification

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 4
Router(config-line)# databits 7

Cisco IOS Configuration Fundamentals Command Reference

187
 D through E
databits

Related Commands Command Description

data-character-bits Sets the number of data bits per character that are
interpreted and generated by the Cisco IOS
software.

terminal databits Changes the number of data bits per character for
the current terminal line for this session.

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.

Cisco IOS Configuration Fundamentals Command Reference

188
 D through E
data-character-bits

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-bitscommand 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 7 Seven data bits per character.

8 Eight data bits per character. This is the default.

Command Default Eight data bits per character

Command Modes Line configuration

Command History Release Modification

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 1

Router(config-line)# data-character-bits 7

Cisco IOS Configuration Fundamentals Command Reference

189
 D through E
data-character-bits

Related Commands Command Description

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.

Cisco IOS Configuration Fundamentals Command Reference

190
 D through E
default-value data-character-bits

default-value data-character-bits
To configure the number of data bits per character that are generated and interpreted by Cisco software to
either 7 bits or 8 bits, use the default-value data-character-bitscommand in global configuration mode.
To disable the configured size, use the no form of this command.

default-value data-character-bits {7 | 8}
no default-value data-character-bits

Syntax Description 7 Selects 7 bits as the default size.

8 Selects 8 bits as the default size.

Command Default 8 data bits per character are generated.

Command Modes Global configuration (config)

Command History Release Modification

15.0(1)M This command was introduced in a release earlier
than Cisco IOS Release 15.0(1)M.

12.2(33)SRB This command was integrated into a release earlier

than Cisco IOS Release 12.2(33)SRB.

12.2(33)SXI This command was integrated into a release earlier

than Cisco IOS Release 12.2(33)SXI.

Cisco IOS XE Release 2.1 This command was integrated into Cisco IOS XE
Release 2.1.

Examples The following example shows how to set the default number of data character bits to 8:

Router# configure terminal

Router(config)# default-value data-character-bits 8

Cisco IOS Configuration Fundamentals Command Reference

191
 D through E
default-value data-character-bits

Related Commands Command Description

default-value exec-character-bits Defines the EXEC character width to either 7 bits
or 8 bits.

default-value modem-signal Configures the default frequency time to scan

modem signals.

default-value special-character-bits Configures the flow control default value from a 7-

bit width to an 8-bit width.

Cisco IOS Configuration Fundamentals Command Reference

192
 D through E
default-value exec-character-bits

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 .

Command Default 7-bit ASCII character set

Command Modes Global configuration

Command History Release Modification

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 helpcommand.

Examples The following example selects the full 8-bit ASCII character set for EXEC banners and prompts:

Router(config)# default-value exec-character-bits 8

Cisco IOS Configuration Fundamentals Command Reference

193
 D through E
default-value exec-character-bits

Related Commands Command Description

default-value special-character-bits Configures the flow control default value from a 7-
bit width to an 8-bit width.

exec-character-bits Configures the character widths of EXEC and

configuration command characters.

length Sets the terminal screen length.

terminal exec-character-bits Locally changes the ASCII character set used in

EXEC and configuration command characters for
the current session.

terminal special-character-bits Changes the ASCII character widths to accept

special characters for the current terminal line and
session.

Cisco IOS Configuration Fundamentals Command Reference

194
 D through E
default-value modem-interval

default-value modem-interval
To configure the default frequency time to scan modem signals, use the default-value modem-
intervalcommand in global configuration mode. To disable the configured frequency, use the no form of
this command.

default-value modem-interval milliseconds

no default-value modem-interval

Syntax Description milliseconds Time frequency, in milliseconds (ms). The range is

from 0 to 1000.

Command Default The frequency time to scan modem signals is 50 ms.

Command Modes Global configuration (config)

Command History Release Modification

15.0(1)M This command was introduced in a release earlier
than Cisco IOS Release 15.0(1)M.

Examples The following example shows how to set the default time to scan the modem signal to 345 ms:

Router# configure terminal

Router(config)# default-value modem-signal 345

Related Commands Command Description

default-value data-character-bits Configures the default size of bits handled to either
7 bits or 8 bits.

default-value exec-character-bits Defines the EXEC character width to either 7 bits

or 8 bits.

default-value special-character-bits Configures the flow control default value from a 7-

bit width to an 8-bit width.

Cisco IOS Configuration Fundamentals Command Reference

195
 D through E
default-value special-character-bits

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 commanddefault-value special-character-bits {7 | 8}

no default-value special-character-bits

Syntax Description 7 Selects the 7-bit character set. This is the default.

8 Selects the full 8-bit character set.

Command Default 7-bit character set

Command Modes Global configuration

Command History Release Modification

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 8

Related Commands Command Description

default-value exec-character-bits Defines the EXEC character width for either 7 bits
or 8 bits.

Cisco IOS Configuration Fundamentals Command Reference

196
D through E
default-value special-character-bits

Command Description
exec-character-bits Configures the character widths of EXEC and
configuration command characters.

length Sets the terminal screen length.

terminal exec-character-bits Locally changes the ASCII character set used in

EXEC and configuration command characters for
the current session.

terminal special-character-bits Changes the ASCII character widths to accept

special characters for the current terminal line and
session.

Cisco IOS Configuration Fundamentals Command Reference

197
 D through E
define interface-range

define interface-range
To create an interface-range macro, use the define interface-range command in global configuration
mode. To remove an interface-range macro, use the no form of this command.

define interface-range macro-name interface-range

Syntax Description macro-name Name of the interface-range macro.

interface-range Type of interface range.

• For a list of valid values, see the “Usage
Guidelines” section.

Command Default Interface-range macro is not configured.

Command Modes Global configuration (config)

Command History Release Modification

12.2(14)SX This command was introduced.

12.2(17d)SXB This command was integrated into Cisco IOS XE

Release 12.2(17d)SXB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines
• The define interface-range command applies a particular configuration on multiple interfaces and
creates multiple logical, and sub interfaces.
• An interface range macro name can comprise up to 32 characters.
• An interface range for a macro can accept a maximum of five ranges. However, the subinterface range
for a macro accepts only one range.
• An interface range cannot span slots.
• Use the interface-type slot/first-interface last-interface format to enter the interface range.
• Valid values for the interface-type argument are as follows:
◦ atm —Supported on Cisco 7600 series routers that are configured with a Supervisor Engine 2
◦ ethernet
◦ fastethernet

Cisco IOS Configuration Fundamentals Command Reference

198
 D through E
define interface-range

◦ ge-wan —Supported on Cisco 7600 series routers that are configured with a Supervisor Engine 2
◦ gigabitethernet
◦ loopback
◦ port-channel interface-number —Valid values are from 1 to 256
◦ pos —Supported on Cisco 7600 series routers that are configured with a Supervisor Engine 2
◦ tengigabitethernet
◦ tunnel
◦ vlan vlan-id —Valid values are from 1 to 4094

Examples The following example shows how to create a multiple-interface macro:

Device(config)# define interface-range macro1 ethernet 1/2 - 5, fastethernet 5/5 - 10

The following example shows how to create multiple loopback interfaces:

Device(config)# define interface-range loopback1-10

Related Commands Command Description

interface range Executes a command on multiple ports at the same
time.

Cisco IOS Configuration Fundamentals Command Reference

199
 D through E
delete

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 the table below for a list of supported
URLs.

/force (Optional) Deletes the specified file or directory

without prompting you for verification.
Note Use this keyword with caution: the system
will not ask you to confirm the file deletion.

/recursive (Optional) Deletes all files in the specified

directory, as well as the directory itself.

Command Modes EXEC (>)

Privileged EXEC (#)
Diagnostic (diag)

Command History Release Modification

11.0 This command was introduced.

12.3(14)T The usbflash 0 9 : and usbtoken 0 9 : options were

added to the list of Cisco IOS File System URLs.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Cisco IOS Configuration Fundamentals Command Reference

200
 D through E
delete

Release Modification
Cisco IOS XE Release 2.1 This command was introduced on the Cisco ASR
1000 Series Routers and the following
enhancements were introduced:
• This command was introduced in diagnostic
mode for the first time. The command can be
entered in both privileged EXEC and
diagnostic mode on the Cisco ASR1000 Series
Routers.
• The harddisk:, obfl:, stby-bootflash: stby-
harddisk:, stby-nvram: , stby-obfl:, stby-
usb[0-1]:, and usb[0 1]: url options were
introduced.

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. To accept the change, you may enter y, Y, or simply hit the Enter key. Entering ? will emit a
help prompt.
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 undeleteEXECcommand. 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.
The table below contains a list of Cisco IOS File System URLs.

Table 20 URL File System Prefix Keywords

Prefix Filesystem
bootflash: Delete the file from boot Flash memory.

flash: Delete the file from Flash memory.

harddisk: Delete the file from the harddisk file system.

nvram: Delete the from the router NVRAM.

obfl: Delete the file from the onboard failure logging file
system.

slot0: Delete the file from the first PCMCIA Flash

memory card.

stby-bootflash: Delete the file from the standby bootflash file

system.

Cisco IOS Configuration Fundamentals Command Reference

201
 D through E
delete

Prefix Filesystem
stby-harddisk: Delete the file from the standby harddisk file
system.

stby-nvram: Delete the from the router NVRAM on the standby

hardware.

stby-obfl: Delete the file from the onboard failure logging file
system on the standby hardware.

stby-usb [ 0 - 1 ]: Delete the file from the standby USB Flash drive.

usb [ 0 - 1 ]; Delete the file from the USB Flash drive.

usbflash 0 9 : Delete the file from the USB Flash drive.

usbtoken 0 9 : Delete the file from the USB eToken.

Examples The following example deletes the file named test from the Flash card inserted in slot 0:

Router# delete slot0:test

Delete slot0:test? [confirm]

Related Commands Command Description

cd Changes the default directory or file system.

dir Displays a list of files on a file system.

show bootvar Displays the contents of the BOOT environment

variable, the name of the configuration file pointed
to by the CONFIG_FILE environment variable, the
contents of the BOOTLDR environment variable,
and the configuration register setting.

squeeze Permanently deletes Flash files by squeezing a

Class A Flash file system.

undelete Recovers a file marked “deleted” on a Class A or

Class B Flash file system.

Cisco IOS Configuration Fundamentals Command Reference

202
 D through E
diag

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 command diag slot-number [halt | previous | post | verbose [wait] | wait]
no diag slot-number

Syntax Description slot-number Slot number of the line card you want to test. Slot
numbers range from 0 to 11 for the Cisco 12012
and 0 to 7 for the Cisco 12008 router. Slot numbers
for the CSC are 16 and 17, and for the FSC are 18,
19, and 20.

halt (Optional) Stops the field diagnostic testing on the

line card.

previous (Optional) Displays previous test results (if any) for

the line card.

post (Optional) Initiates an EPROM-based extended

power-on self-test (EPOST) only. The EPOST test
suite is not as comprehensive as the field
diagnostics, and a pass/fail message is the only
message displayed on the console.

verbose [wait (Optional) Enables the maximum status messages

to be displayed on the console. By default, only the
minimum status messages are displayed on the
console. If you specify the optional wait keyword,
the Cisco IOS software is not automatically
reloaded on the line card after the test completes.

wait (Optional) Stops the automatic reloading of the

Cisco IOS software on the line card after the
completion of the field diagnostic testing. If you
use this keyword, you must use the microcode
reload slot global configuration command, or
manually remove and insert the line card (to power
it up) in the slot so that the GRP will recognize the
line card and download the Cisco IOS software
image to the line card.

Command Default No field diagnostics tests are performed on the line card.

Cisco IOS Configuration Fundamentals Command Reference

203
 D through E
diag

Command Modes Privileged EXEC

Command History Release Modification

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 Performing field diagnostics on a line card stops all activity on the line card. Before the diag EXEC
command begins running diagnostics, you are prompted to confirm the request to perform field diagnostics
on the line card.

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 When you stop the field diagnostic test, the line card remains down (that is, in an unbooted state). In most
cases, you stopped the testing because you need to remove the line card or replace the line card. If that is
not the case, and you want to bring the line card back up (that is, online), you must use the microcode
reload global configuration command or power cycle the line card.

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.

Cisco IOS Configuration Fundamentals Command Reference

204
 D through E
diag

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 3

Running Diags will halt ALL activity on the requested slot. [confirm]
Router#
Launching a Field Diagnostic for slot 3
Running DIAG config check
RUNNING 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 3

Field Diag eeprom values: run 159 fial mode 0 (PASS) slot 3
last test failed was 0, error code 0
sending SHUTDOWN FDIAG_QUIT to fdiag in slot 3
Board 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 verbose

Running Diags will halt ALL activity on the requested slot. [confirm]
Router#
Launching a Field Diagnostic for slot 3
Running DIAG config check
RUNNING 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 Cache
FDIAG_STAT_PASS test_num 1
FDIAG_STAT_IN_PROGRESS: test #2 Sunblock Ordering
FDIAG_STAT_PASS test_num 2
FDIAG_STAT_IN_PROGRESS: test #3 Dram Datapins
FDIAG_STAT_PASS test_num 3
.
.
.
Field Diags: FDIAG_STAT_DONE
Field Diagnostic ****PASSED**** for slot 3
Field Diag eeprom values: run 159 fial mode 0 (PASS) slot 3
last test failed was 0, error code 0
sending SHUTDOWN FDIAG_QUIT to fdiag in slot 3
Board will reload
.
.
.
Router#

Cisco IOS Configuration Fundamentals Command Reference

205
 D through E
diag

Related Commands Command Description

microcode reload Reloads the Cisco IOS image on a line card on the
Cisco 7000 series with RSP7000, Cisco 7500
series, or Cisco 12000 series routers after all
microcode configuration commands have been
entered.

Cisco IOS Configuration Fundamentals Command Reference

206
 D through E
diagnostic bootup level

diagnostic bootup level

To set the diagnostic bootup level, use the diagnostic bootup levelcommand 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 minimal Specifies minimal diagnostics. See the Usage

Guidelines section for additional information.

complete Specifies complete diagnostics. See the Usage

Guidelines section for additional information.

Command Default minimal

Command Modes Global configuration (config)

Command History Release Modification

12.2(14)SX Support for this command was introduced on the
Supervisor Engine 720.

12.2(17d)SXB Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2(33)SCC The command was integrated in this release to

support Generic Online Diagnostics (GOLD)
functionalityfor Cisco UBR10012 Universal
Broadband Router.

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:
• Complete--Runs all tests.
• Minimal--Runs only EARL tests for the supervisor engine and loopback tests for all ports in the
system.

Cisco IOS Configuration Fundamentals Command Reference

207
 D through E
diagnostic bootup level

Note Although the default is minimal, you can set the diagnostic level to complete for troubleshooting hardware
problems.

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, use the no diagnostic bootup level command.
For information on the diagnostic test types, use the show diagnosticcommand.
The new level takes effect at the next reload or the next time that an online insertion and removal is
performed.

Examples The following example shows how to set the diagnostic bootup level:

Router(config)#
diagnostic bootup level complete

Related Commands Command Description

show diagnostic bootup level Displays the coverage level for the configured
bootup diagnostics.

Cisco IOS Configuration Fundamentals Command Reference

208
 D through E
diagnostic cns

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 publish Sends diagnostic results to a remote network

application to make decisions and take corrective
actions that are based on the diagnostic results.

subscribe Receives messages from remote network

applications to perform diagnostic tests or retrieve
diagnostic results.

subject (Optional) Event subject name.

Command Default The following are the default settings for diagnostic cns:
diagnostic cns publish cisco.cns.device.diag_results
diagnostic cns subscribe cisco.cns.device.diag_commands

Command Modes Global configuration

Command History Release Modification

12.2(14)SX Support for this command was introduced on the
Supervisor Engine 720.

12.2(17d)SXB Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

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.

Cisco IOS Configuration Fundamentals Command Reference

209
 D through E
diagnostic cns

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 publish my.cns.publish
Router(config)#

This example shows how to receive messages from remote network applications to perform diagnostic tests
or retrieve diagnostic results:

Router(config)#
diagnostic cns subscribe my.cns.subscribe
Router(config)#

This example shows how to set the default to publish:

Router(config)#
default
diagnostic cns publish
Router(config)#

Related Commands Command Description

show diagnostic cns publish Displays the publish information about the CNS
subject.

show diagnostic cns subscribe Displays the subscribe information about the CNS
subject.

Cisco IOS Configuration Fundamentals Command Reference

210
 D through E
diagnostic event-log size

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 size Diagnostic event-log sizes. The valid values range
from 1 to 10000 entries.

Command Default The event log sizeis 500 entries.

Command Modes Global configuration (config)

Command History Release Modification

12.2(14)SX Support for this command was introduced on the
Supervisor Engine 720.

12.2(17d)SXB Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

12.2(33)SRA. This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2(33)SCC The command was integrated in this release to

support Generic Online Diagnostics (GOLD)
functionalityfor Cisco UBR10012 Universal
Broadband Router.

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.

Cisco IOS Configuration Fundamentals Command Reference

211
 D through E
diagnostic event-log size

Examples The following example shows how to set the diagnostic event-log size:

Router(config)#
diagnostic event-log size 600

Related Commands Command Description

show diagnostic events Displays the event log for the diagnostic events.

Cisco IOS Configuration Fundamentals Command Reference

212
 D through E
diagnostic level

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.

Command Default No diagnostic tests are performed.

Command Modes Privileged EXEC

Command History Release Modification

12.1(10)EX2 This command was introduced.

12.2(18)S This command was introduced on Cisco 7304

routers running Cisco IOS Release 12.2 S.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2SX This command is supported in the Cisco IOS

Release 12.2SX train. Support in a specific 12.2SX
release of this train depends on your feature set,
platform, and platform hardware.

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.

Cisco IOS Configuration Fundamentals Command Reference

213
 D through E
diagnostic level

Examples The following example shows how to enable diagnostic power-on tests:

diagnostic level power-on

The following sample output shows the output that is displayed upon system bootup after a power cycle or
router crash:

.
.
.
System Power On Diagnostics
DRAM Size ....................128 MB
Testing DRAM..................Passed
Level2 Cache .................Present
Testing Level2 Cache (256 KB)Passed
Level3 Cache .................Present
Testing Level3 Cache (1024 KB)Passed
System Power On Diagnostics Complete

Note This output is displayed when the system is booting, not when the command is issued.

Related Commands Command Description

debug redundancy Enables NSE redundancy debugging.

show c7300 Displays the types of cards (NSE and line cards)
installed in a Cisco 7300 series router.

show redundancy (7300) Displays redundancy information for the active and
standby NSEs.

Cisco IOS Configuration Fundamentals Command Reference

214
 D through E
diagnostic monitor

diagnostic monitor
To configure 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 intervalmodule number test {test-id | test-id-range | all} hh:mm:ss milliseconds
days
diagnostic monitor syslog
diagnostic monitor module num test {test-id | test-id-range | all}
no diagnostic monitor {interval | syslog}

Cisco UBR10012 Router

diagnostic monitor {bay slot/bay | slot slot number | subslot slot/subslot} test {test-id | test-id-
range | all}
diagnostic monitor interval{bay slot/bay | slot slot-no | subslot slot/subslot} test {test-id | test-id-
range | all} hh:mm:ss milliseconds days
diagnostic monitor syslog
diagnostic monitor threshold {bay slot/bay | slot slot-no | subslot slot/subslot} test {test-id | test-
id-range | all} failure count failures [{runs | days | hours | minutes | seconds | milliseconds}
window_size]

Syntax Description interval Sets the interval between testing.

module number Specifies the module number.

test Specifies a test to run.

test-id Identification number for the test to run. See the

“Usage Guidelines” section for additional
information.

test-id-range Range of identification numbers for tests to be run.

See the “Usage Guidelines” section for additional
information.

all Runs all the diagnostic tests.

hour hh (Optional) Specifies the number of hours between

tests. See the “Usage Guidelines” section for
formatting guidelines.

min mm (Optional) Specifies the number of minutes

between tests. See the “Usage Guidelines” section
for formatting guidelines.

Cisco IOS Configuration Fundamentals Command Reference

215
 D through E
diagnostic monitor

second ss (Optional) Specifies the number of seconds

between tests. See the “Usage Guidelines” section
for formatting guidelines.

millisec ms (Optional) Specifies the number of milliseconds

between tests; see the “Usage Guidelines” section
for formatting guidelines.

syslog Enables system logging messages when a health-

monitoring test fails.

bay slot/bay Indicates the card slot and bay number where the
diagnostic test is run periodically and monitored.
The bay keyword is used to refer a SPA on the
router. The valid range for the slot number is from
1 to 8 and 0 to 3 for the bay number.

slot slotnumber Indicates the slot number of the full-height line card
where the diagnostic test is run periodically and
monitored. The slot keyword is used to refer a full-
height line card on the router. The valid range for
the slot is from 1 to 8.

subslot slot/subslot Indicates the slot and subslot number of half-height

line card on which the diagnostic test is run
periodically and monitored. The subslot keyword is
used to refer a half-height line card on the router.
The valid range for the slot number is from 1 to 8
and 0 to 1 for the subslot number.

threshold Configures the failure threshold value for the

specified bay, slot, or subslot.

failure count failures Configures the count for maximum failures allowed
after which the failed test results are displayed in
the output of the show diagnostic resultscommand.
The range for number of allowed failures is 0 to 99.

hh:mm:ss Hours, minutes, and seconds interval configured to

run the test again.

milliseconds Number of milliseconds between tests.

days Number of days between tests. The valid range is

from 0 to 20.

runs window_size Number of test-run count for the failure window-

size.

days window_size Number of days for the failure window-size.

hours window_size Number of hours for the failure window-size.

minutes window_size Number of minutes for the failure window-size.

Cisco IOS Configuration Fundamentals Command Reference

216
 D through E
diagnostic monitor

seconds window_size Number of seconds for the failure window-size.

milliseconds window_size Number of milliseconds for the failure window-

size.

Command Default The defaults are as follows:

• Depending on the test run, monitoring may be enabled or disabled.
• Depending on the test run, the default monitoring interval varies.
• syslog is enabled.

Command Modes Global configuration (config)

Command History Release Modification

12.2(14)SX Support for this command was introduced on the
Supervisor Engine 720.

12.2(17d)SXB Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2(33)SCC The command was integrated into Cisco IOS

Release 12.2(33)SCC to support Generic Online
Diagnostics (GOLD) functionalityfor Cisco
UBR10012 Universal Broadband Router. The
keywords bay, slot, and subslot were added for the
Cisco UBR10012 Universal Broadband Router.

Usage Guidelines Use these guidelines when scheduling testing:

• test-id -- Enter the show diagnostic content command to display the test ID list .
• test-id-range -- Enter the show diagnostic content command to display the test ID list . Enter the range
as integers separated by a comma and a hyphen (for example, 1,3-6 specifies test IDs 1, 3, 4, 5, and 6).
• hh-- Enter the hours from 1 to 24.
• mm-- Enter the minutes from 1 to 60.
• days-- Enter the number of days between tests.
• ss-- Enter the seconds from 1 to 60.
• ms-- Enter the milliseconds from 1 to 1000.
Enter the [no] diagnostic monitor test {test-id | test-id-range | all} command to enable or disable the
specified health monitoring test.

Cisco IOS Configuration Fundamentals Command Reference

217
 D through E
diagnostic monitor

When entering the diagnostic monitor module number test {test-id | test-id-range | all} command,
observe the following:
• Required
◦ Isolate network traffic by disabling all connected ports and do not pump test packets during the
test.
◦ Remove all modules for testing FIB TCAM and SSRAM memory on the PFC of the supervisor
engine.
◦ Reset the system or the test module before putting the system back into the normal operating
mode.
• Recommended
◦ If the DFC module is present, remove all modules, and then reboot the system before starting the
memory test on the central PFC3B of the supervisor engine.
◦ Turn off all background health-monitoring tests on the supervisor engine and the modules using
the no diagnostic monitor module number test {test-id | test-id-range | all} command.
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.
Cisco UBR10012 Router
The command syntax to refer a line card or SPAs is different on Cisco UBR10012 Router. The keyword is
slot x for a full-height line card, slot x/y for a half-height card, and bay x/y for a SPA.
To monitor a diagnostic test periodically, you first need to configure the hours, minutes, and seconds
interval to run the diagnostic test using the diagnostic monitor intervalcommand. An error message is
displayed, if the interval is not configured before enabling the monitoring.
To store log details for failed tests, execute the diagnostic monitor syslogcommand. A threshold value to
specify the maximum count for allowed failures is configured using the diagnostic monitor
thresholdcommand. The failed test results can be viewed using the show diagnostic resultscommand,
after the number of failed test reaches the maximum number of allowed failures configured using the
diagnostic monitor thresholdcommand.

Examples The following example shows how to run the specified test every 3 days:

Router(config)# diagnostic monitor interval module 5 test 7 09:07:05 45 3

The following example shows how to enable the generation of a syslog message when any health-
monitoring test fails:

Router(config)#
diagnostic monitor syslog

Cisco IOS Configuration Fundamentals Command Reference

218
 D through E
diagnostic monitor

Cisco UBR10012 Router

The following example shows a sample output of an error message displayed when monitoring is enabled
before configuring the test interval:

Router(config)# diagnostic monitor bay 1/0 test 2

Aug 12 18:04:56.280: %DIAG-3-MONITOR_INTERVAL_ZERO: Bay 1/0: Monitoring interval

is 0. Cannot enable monitoring for Test #2

The following example shows how to configure the periodic interval for running diagnostic tests on the the
router before enabling monitoring:

Router(config)# diagnostic monitor interval bay 1/0 test 2 06:00:00 100 10

The following example shows how to enable the diagnostic monitoring on bay 1/0:
Router(config)# diangostic monitor bay 1/0 test 2

The following example shows how to enable logging of failed messages to syslog:

Router(config)# diangostic monitor syslog

The following example shows how to configure the failure threshold value after which the failed test results
are displayed in the command output for show diagnostic results:

Router(config)# diagnostic monitor threshold bay 1/0 test 2 failure count 10

Related Commands Command Description

show diagnostic content Displays test information including test ID, test
attributes, and supported coverage test levels for
each test and for all modules.

Cisco IOS Configuration Fundamentals Command Reference

219
 D through E
diagnostic ondemand

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 iteration iteration-count Sets the number of times the same test to rerun
when the command is issued . The valid range for
iteration-count is between 1 to 999.

action-on-failure Sets the execution action when a failure is detected.

continue Continues testing when a test failure is detected.

stop Stops testing when a test failure is detected.

error-count (Optional) Number of errors that are allowed before

stopping. This argument is used with the continue
optio n. The valid range for error-count is from 0 to
65534.

Command Default The default settings are as follows:

• iteration-count is 1
• action-on-error is continue
• error-count is 0

Command Modes Privileged EXEC (#)

Command History Release Modification

12.2(14)SX Support for this command was introduced on the
Supervisor Engine 720.

12.2(17d)SXB Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Cisco IOS Configuration Fundamentals Command Reference

220
 D through E
diagnostic ondemand

Release Modification
12.2(33)SCC The command was integrated in this release to
support Generic Online Diagnostics (GOLD)
functionalityfor Cisco UBR10012 Universal
Broadband Router.

Usage Guidelines Entering 0 for the error-count sets the number of errors that are allowed to unlimited.

Examples The following example shows how to set the ondemand testing iteration count:

Router#
diagnostic ondemand iteration 4
Router#

The following example shows how to set the execution action when an error is detected:

Router#
diagnostic ondemand action-on-failure continue 2
Router#

Related Commands Command Description

show diagnostic ondemand settings Displays the settings for on-demand diagnostics.

Cisco IOS Configuration Fundamentals Command Reference

221
 D through E
diagnostic schedule module

diagnostic schedule module

To set the scheduling of test-based diagnostic testing for a specific module or schedule a supervisor engine
switchover, use the diagnostic schedule module command in global configuration mode. To remove the
scheduling, use the no form of this command.

diagnostic schedule module {module-number | slot/subslot} test {test-id | all | complete | minimal |
non-disruptive | [per-port [port{interface-port-number | port-number-list | all}]]} {on month dd
yyyy hh:mm | daily hh:mm | weekly day-of-week hh:mm}
no diagnostic schedule module {module-number | slot/subslot} test {test-id | all | complete |
minimal | non-disruptive | [per-port [port{interface-port-number | port-number-list | all}]]} {on
month dd yyyy hh:mm | daily hh:mm | weekly day-of-week hh:mm}

Syntax Description module-number Specifies the module number.

slot / subslot Specifies the slot number of the active supervisor

engine.

test Specifies the diagnostic test suite attribute.

test-id Identification number for the test to be run; see the

“Usage Guidelines” section for additional
information.

all Runs all diagnostic tests.

complete Selects the complete bootup test suite.

minimal Selects the minimal bootup test suite.

non-disruptive Selects the nondisruptive test suite.

per-port Selects the per-port test suite.

port (Optional) Specifies the port to schedule testing.

interface-port- number (Optional) Port number.

port-number-list (Optional) Range of port numbers, separated by a

hyphen.

all (Optional) Specifies all ports.

on month dd yyyy hh : mm Specifies the scheduling of a test-based diagnostic

task; see the “Usage Guidelines” section for
formatting guidelines.

daily hh : mm Specifies the daily scheduling of a test-based

diagnostic task; see the “Usage Guidelines” section
for formatting guidelines.

Cisco IOS Configuration Fundamentals Command Reference

222
 D through E
diagnostic schedule module

weekly day-of-week hh : mm Specifies the weekly scheduling of a test-based

diagnostic task; see the “Usage Guidelines” section
for formatting guidelines.

Command Default Test-based diagnostic testing for a specific module is not scheduled.

Command Modes Global configuration (config)

Command History Release Modification

12.2(14)SX This command was introduced on the Supervisor
Engine 720.

12.2(17b)SXA This command was modified to support scheduled

switchover for supervisor engines.

12.2(17d)SXB This command was modified to support the

Supervisor Engine 2.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2(33)SRE This command was modified. The complete,

minimal, non-disruptive, and per-port keywords
were added.

Usage Guidelines Use these guidelines when scheduling testing:

• test-id -- Enter the show diagnostic content command to display the test ID list .
• month-- Spell out the month such as january, february ... december (either uppercase or lowercase
characters).
• dd-- Enter the day as a two-digit number.
• yyyy-- Enter the year as a four-digit number.
• hh : mm-- Enter the time as a two-digit number (for a 24-hour clock) for hours:minutes; the colon (:) is
required.
• day-of-week-- Spell out the day of the week, such as monday, tuesday... sunday (either uppercase or
lowercase characters).
• per-port is not supported when specifying a scheduled switchover.
You can use the diagnostic schedule module slot / subslot test test-id command to schedule a switchover
from the active supervisor engine to the standby supervisor engine.
Enter the show diagnostic content module slot / subslot command to display the test ID list and look for
the test ID in the ScheduleSwitchover field.

Cisco IOS Configuration Fundamentals Command Reference

223
 D through E
diagnostic schedule module

You can specify a periodic switchover (daily or weekly) or a single switchover occurrence at a specific
time using these commands:
• diagnostic schedule module slot / subslot test test-id on mm dd yyyy hh:mm
• diagnostic schedule module slot / subslot test test-id daily hh:mm
• diagnostic schedule module slot / subslot test test-id weekly day-of-week hh:mm

Note To avoid system downtime in the event that the standby supervisor engine cannot switch over the system,
Cisco recommends that you schedule a switchover from the standby supervisor engine to the active
supervisor engine 10 minutes after the switchover occurs.

Examples The following example shows how to schedule the diagnostic testing on a specific month, date and time for
a specific module:

Router(config)# diagnostic schedule module 1 test 5 on may 27 2010 10:30

The following example shows how to schedule the diagnostic testing to occur daily at a certain time for a
specific module:

Router(config)# diagnostic schedule module 1 test 5 daily 12:25

The following example shows how to schedule the diagnostic testing to occur weekly on a certain day for a
specific module:

Router(config)# diagnostic schedule module 1 test 5 weekly friday 09:23

Related Commands Command Description

show diagnostic content Displays test information including test ID, test
attributes, and supported coverage test levels for
each test and for all modules.

show diagnostic schedule Displays the current scheduled diagnostic tasks.

Cisco IOS Configuration Fundamentals Command Reference

224
 D through E
diagnostic start

diagnostic start
To run the specified diagnostic test, use the diagnostic startcommand 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

Cisco UBR10012 Universal Broadband Router

diagnostic start {bay slot/bay | slot slot-no} test {test-id | test-id-range | all | complete | minimal |
non-disruptive}
diagnostic start subslot slot/subslot test {test-id | test-id-range | all | complete | minimal | non-
disruptive | [per-port [port{num | port#-range | all}]]}

Syntax Description module num Specifies the module number.

test Specifies a test to run.

test-id Identification number for the test to run. See the

Usage Guidelines section for additional
information.

test-id-range Range of identification numbers for tests to run.

See the Usage Guidelines section for additional
information.

minimal Runs minimal bootup diagnostic tests.

complete Runs complete bootup diagnostic tests.

basic Runs basic on-demand diagnostic tests.

per-port Runs per-port level tests.

non-disruptive Runs the non disruptive health-monitoring tests.

all Runs all diagnostic tests.

port num (Optional) Specifies the interface port number.

port port# range (Optional) Specifies the interface port number

range. See the Usage Guidelines section for
additional information.

port all (Optional) Specifies all ports.

Cisco IOS Configuration Fundamentals Command Reference

225
 D through E
diagnostic start

system test all Runs all disruptive and nondisruptive diagnostic

tests at once. All test dependencies are handled
automatically.

bay slot/bay Indicates the card slot and bay number where the
diagnostic test is executed. The bay keyword is
used to refer a SPA on the router. The valid range
for the slot number is from 1 to 8 and 0 to 3 for the
bay number.

slot slot-no Indicates the slot number of the full-height line card
where the diagnostic test is executed. The slot
keyword is used to refer a full-height line card on
the router. The valid range for slot is from 1 to 8.

subslot slot/sub-slot Indicates the slot and subslot number of half-height

line card where the diagnostic test is executed. The
subslot keyword is used to refer a half-height line
card on the router. The valid range for the slot
number is from 1 to 8 and 0 to 1 for the subslot
number.

Command Default None

Command Modes Privileged EXEC (#)

Command History Release Modification

12.2(14)SX Support for this command was introduced on the
Supervisor Engine 720.

12.2(17a)SX This command was changed to include the

complete and basic keywords.

12.2(17d)SXB Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2.(33)SXH This command was changed to include the system

test all keywords.

Cisco IOS Configuration Fundamentals Command Reference

226
 D through E
diagnostic start

Release Modification
12.2(33)SCC The command was integrated in this release to
support Generic Online Diagnostics (GOLD)
functionalityfor Cisco UBR10012 Universal
Broadband Router. The keywords bay, slot, and
subslot were added for the Cisco UBR10012
Universal Broadband Router.

Usage Guidelines

Note Running all online diagnostic tests disrupts normal system operation. Reset the system after the diagnostic
start system test all command has completed. 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 Do not enter the diagnostic start module x test all command on systems that are configured with a
DFC3A because this command causes the TCAM test to fail.

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.
Cisco UBR10012 Router
The command syntax to refer a line card or SPAs is different on Cisco UBR10012 Router. The keyword is
slot x for a full-height line card, slot x/y for a half-height card, and bay x/y for a SPA.

Note To start a diagnostic test on the Cisco UBR10012 Router execute the command diagnostic stopwith the
bay, slot or subslot keyword respectively.

The GOLD test cases used to poll for system errors in Cisco IOS Software Release 12.2(33)SCC are Low
Latency Queueing (LLQ) drop, Cable Line Card (CLC) memory leak, and Guardian index leak tests.

Examples The following example shows how to run the specified diagnostic test at the specified slot:

Router# diagnostic start module 1 test 5

Module 1:Running test(s) 5 may disrupt normal system operation
Do you want to run disruptive tests? [no] yes
00: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 successfully
00: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 successfully
Router#

Cisco IOS Configuration Fundamentals Command Reference

227
 D through E
diagnostic start

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]:

Cisco UBR10012 Router

The following example shows how to run a diagnostic test with test id 2 on a SPA:

ubr-122s-1# diagnostic start bay 1/0 test 2

ubr-122s-1#
Aug 5 09:24:42.019: %DIAG-6-TEST_RUNNING: Bay 1/0: Running TestModenaLLQDrops{I
D=2} ...
Aug 5 09:24:42.019: %DIAG-6-TEST_OK: Bay 1/0: TestModenaLLQDrops{ID=2} has comp
leted successfully

Related Commands Command Description

diagnostic schedule Sets the diagnostic test schedule for a particular
bay, slot, or subslot.

show diagnostic description Provides the description for the diagnostic tests.

diagnostic stop Runs the specified diagnostic test.

show diagnostic content module Displays the available diagnostic tests.

diagnostic bootup level Configures the diagnostic bootup level.

diagnostic event-log size Modifies the diagnostic event-log size dynamically.

diagnostic monitor Configures the health-monitoring diagnostic

testing.

diagnostic ondemand Configures the on-demand diagnostics.

show diagnostic bootup Displays the configured diagnostics level at bootup.

show diagnostic events Displays the diagnostic event log.

Cisco IOS Configuration Fundamentals Command Reference

228
D through E
diagnostic start

Command Description
show diagnostic ondemand settings Displays the settings for the on-demand
diagnostics.

show diagnostic result Displays the diagnostic test results for a module.

show diagnostic schedule Displays the current scheduled diagnostic tasks.

show diagnostic status Displays the running diagnostics tests.

Cisco IOS Configuration Fundamentals Command Reference

229
 D through E
diagnostic stop

diagnostic stop
To stop the testing process, use the diagnostic stop command in privileged EXEC mode.

diagnostic stop module num

Cisco UBR10012 Universal Broadband Router

diagnostic stop {bay slot/bay | slot slot-no | subslot slot/subslot}

Syntax Description module num Module number.

bay slot/bay Indicates the card slot and bay number of the SPA
for which the diagnostic test has stopped. The bay
keyword is used to refer a SPA on the router. The
valid range for the slot number is from 1 to 8 and 0
to 3 for the bay number.

slot slot-no Indicates the slot number of full height line card for
which the diagnostic test has to be stopped. The slot
keyword is used to refer a full-height line card on
the router. Valid range for the slot is from 1 to 8.

subslot slot/subslot Indicates the slot and subslot number of half-height

line card for which the diagnostic test has to be
stopped. The subslot keyword is used to refer a
half-height line card on the router. The valid range
for the slot number is from 1 to 8 and 0 to 1 for the
subslot number.

Command Default None

Command Modes Privileged EXEC (#)

Command History Release Modification

12.2(14)SX Support for this command was introduced on the
Supervisor Engine 720.

12.2(17d)SXB Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

Cisco IOS Configuration Fundamentals Command Reference

230
 D through E
diagnostic stop

Release Modification
12.2(33)SRA This command was integrated into Cisco IOS
Release 12.2(33)SRA.

12.2(33)SCC The command was integrated in this release to

support Generic Online Diagnostics (GOLD)
functionalityfor Cisco UBR10012 Universal
Broadband Router. The keywords bay, slot, and
subslot were added for the Cisco UBR10012
Universal Broadband Router.

Usage Guidelines Use the diagnostic start command to start the testing process.
Cisco UBR10012 Router
The command syntax to refer a line card or SPAs is different on Cisco UBR10012 Router. The keyword is
slot x for a full-height line card, slot x/y for a half-height card, and bay x/y for a SPA.

Note To stop a diagnostic test on the Cisco UBR10012 Router execute the command diagnostic stopwith the
bay, slot or subslot keyword respectively.

The GOLD test cases used to poll for system errors in Cisco IOS Software Release 12.2(33)SCC are Low
Latency Queueing (LLQ) drop, Cable Line Card (CLC) memory leak, and line card index leak tests.

Examples This example shows how to stop the diagnostic test process:

Router# diagnostic stop module 3

Router#

This example shows how to stop the diagnostic test process for subslot 5/0 on the Cisco UBR10012
Universal Broadband Router:

Router# diagnostic stop subslot 5/0

Router#

Related Commands Command Description

diagnostic schedule Sets the diagnostic test schedule for a particular
bay, slot, or subslot.

show diagnostic description Provides the description for the diagnostic tests.

diagnostic start Stops the specified diagnostic test.

show diagnostic content module Displays the available diagnostic tests.

Cisco IOS Configuration Fundamentals Command Reference

231
 D through E
diagnostic stop

Command Description
diagnostic bootup level Configures the diagnostic bootup level.

diagnostic event-log size Modifies the diagnostic event-log size dynamically.

diagnostic monitor Configures the health-monitoring diagnostic

testing.

diagnostic ondemand Configures the on-demand diagnostics.

show diagnostic bootup Displays the configured diagnostics level at bootup.

show diagnostic events Displays the diagnostic event log.

show diagnostic ondemand settings Displays the settings for the on-demand
diagnostics.

show diagnostic result Displays the diagnostic test results for a module.

show diagnostic schedule Displays the current scheduled diagnostic tasks.

show diagnostic status Displays the running diagnostics tests.

Cisco IOS Configuration Fundamentals Command Reference

232
 D through E
dir

dir
To display a list of files on a file system, use the dircommand in EXEC, privileged EXEC, or diagnostic
mode.

dir [/all] [/recursive] [all-filesystems] [filesystem:] [file-url]

Syntax Description /all (Optional) Lists deleted files, undeleted files, and
files with errors.

/recursive (Optional) Lists files recursively.

all-filesystems (Optional) Lists all files in all file systems on the

router.

filesystem: (Optional) File system or directory containing the

files to list, followed by a colon.

file-url (Optional) The name of the files to display on a

specified device. The files can be of any type. You
can use wildcards in the filename. A wildcard
character (*) matches all patterns. Strings after a
wildcard are ignored.

Command Default When you omit the /all keyword, the Cisco IOS software displays only undeleted files.

Command Modes User EXEC (>) Privileged EXEC (#) Diagnostic (diag)

Command History Release Modification

11.0 This command was introduced.

12.3 This command was modified. A timestamp that

shows the offset from Coordinated Universal Time
(UTC) was added to the dir command display.

12.3(14)T This command was modified. The usbflash 0

9 :and usbtoken 0 9 : options were added as
available file systems.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Cisco IOS Configuration Fundamentals Command Reference

233
 D through E
dir

Release Modification
12.4(11)T This command was modified. Support for this
command was implemented on the Cisco 7200VXR
NPE-G2 platform.

Cisco IOS XE Release 2.1 This command was introduced on the Cisco ASR
1000 Series Routers, and the following
enhancements were introduced:
• The command was made available in
diagnostic mode.
• The /recursive option was introduced.
• The file systems available with the Cisco ASR
1000 Series Routers became available as
filesystem: options.

15.0(1)M This command was modified. The output modifier

was added.

15.0(01)XO Note added to explain different byte and usage

calculations for show file systems and dir
commands on cat4000 series routers.

Usage Guidelines Use the show file systemscommand to display more details about the files in a particular file system.

Note As of release 15.0(01)XO, on cat4000 series routers, the show(flash file system) and dirwill display
slightly different byte count and usage information for the same file system. This is due to slight difference
in how IOS computes these figures for this platform.

You can use the Cisco IOS software output modifiers to filter the output of the dir command, to display
only those lines you are interested in.
The output modifier feature is invoked by using the pipe symbol (|). To use this feature, enter the dir
command as normal but add a space and the pipe symbol at the end of the command line. Then add one of
the keywords shown in the table below.

Table 21 Using Output Modifiers

Command Purpose
append regular expression Appends redirected output to URL (only to the
URLs supporting the append operation).

begin regular expression Displays the first line that matches the regular
expression, and then all other lines that follow that
line.

include regular expression Displays all lines that match the regular expression.

Cisco IOS Configuration Fundamentals Command Reference

234
 D through E
dir

Command Purpose
exclude regular expression Displays all lines except those that match the
regular expression.

format regular expression Formats the output using the specification file.

redirect regular expression Redirects the output to the URL.

section regular expression Filters a section of the output.

tee regular expression Copies output to the URL.

Note The append, redirect and tee keywords do not support rcp in the display.

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-mz
2 -rw- 4767328 Jan 02 2004 18:42:53 -08:00 c7200-js-mz
5 -rw- 639 Jan 03 2004 12:09:32 -08:00 rally
7 -rw- 639 Jan 03 2004 12:37:13 -08:00 the_time
20578304 bytes total (3104544 bytes free)

The following is sample output from the dir /allcommand:

Router# dir /all slot0:

Directory of slot0:/
1 -rw- 4720148 Dec 15 2003 17:49:36 -08:00 hampton/nitro/c7200-j-mz
2 -rw- 4767328 Jan 02 2004 18:42:53 -08:00 c7200-js-mz
3 -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 rally
6 -rw- 639 Jan 03 1994 12:37:01 -08:00 [the_time]
7 -rw- 639 Jan 03 1994 12:37:13 -08:00

The table below describes the significant fields shown in the displays.

Table 22 dir Field Descriptions

Field Description
1 Index number of the file.

-rw- Permissions. The file can be any or all of the

following:
• d--directory
• r--readable
• w--writable
• x--executable

Cisco IOS Configuration Fundamentals Command Reference

235
 D through E
dir

Field Description
4720148 Size of the file, in bytes.

Dec 15 2003 17:49:36 Last modification date.

-08:00 Conversion to local time in hours from Coordinated

Universal Time (UTC). In the example, -08:00
indicates that the given time is 8 hours behind UTC
or Pacific Standard Time (PST).

hampton/nitro/c7200-j-mz Filename. Deleted files are indicated by square

brackets around the filename.

The following example shows how to use the output modifier feature with the exclude keyword and regular
expression. The table above describes the significant fields shown in the output.

Routwe# dir | exclude asr

Directory of bootflash:/
12 drwx 4096 Jan 5 2005 01:34:50 +00:00 lost+found
59265 drwx 4096 Apr 20 2004 01:51:10 +00:00 .installer
14817 drwx 4096 Apr 20 2004 01:54:37 +00:00 .ssh
88897 drwx 4096 Jan 7 2005 22:13:26 +00:00 .prst_sync

Related Commands Command Description

cd Changes the default directory or file system.

delete Deletes a file on a Flash memory device.

undelete Recovers a file marked “deleted” on a Class A or

Class B flash file system.

Cisco IOS Configuration Fundamentals Command Reference

236
 D through E
disable

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 privilege-level (Optional) Specific privilege level (other than user
EXEC mode).

Command Modes EXEC (>) Privileged EXEC (#) Diagnostic (diag)

Command History Release Modification

10.0 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Cisco IOS XE Release 2.1 This command was introduced on the Cisco ASR
1000 Series Routers, and became available in
diagnostic mode.

Usage Guidelines Up to 16 security levels can be configured using Cisco IOS software. If such levels are configured on a
system, using this command with the privilege-level option allows you to exit to a lower security level. If a
level is not specified, the user will exit to the user EXEC mode, which is the default.

Note Five EXEC commands are associated with privilege level 0: disable, enable, exit, help, and logout. If you
configure a privilege level greater than 0, these five commands will not be included in the command set for
that privilege level.

Examples In the following example, the user enters privileged EXEC mode using the enable command, then exits
back to user EXEC mode using the disable command. Note that the prompt for user EXEC mode is >, and
the prompt for privileged EXEC mode is #.

Router> enable
Password: <letmein>
Router# disable
Router>

Cisco IOS Configuration Fundamentals Command Reference

237
 D through E
disable

Related Commands Command Description

enable Enables higher privilege level access, such as
privileged EXEC mode.

Cisco IOS Configuration Fundamentals Command Reference

238
 D through E
disconnect-character

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 ascii-number Decimal representation of the session disconnect

character.

Command Default No disconnect character is defined.

Command Modes Line configuration

Command History Release Modification

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 4

Router(config-line)# disconnect-character 27

Cisco IOS Configuration Fundamentals Command Reference

239
 D through E
dispatch-character

dispatch-character
To define a character that causes a packet to be sent, use the dispatch-charactercommand in line
configuration mode. To remove the definition of the specified dispatch character, usethe noform of this
command.

dispatch-character ascii-number1 [ascii-number2...]

no dispatch-character ascii-number1 [ascii-number2...]

Syntax Description ascii-number1 Decimal representation of the desired dispatch

character.

ascii-number2 . . . (Optional) Additional decimal representations of

characters. This syntax indicates that you can define
any number of characters as dispatch characters.

Command Default No dispatch character is defined.

Command Modes Line configuration

Command History Release Modification

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.

Cisco IOS Configuration Fundamentals Command Reference

240
 D through E
dispatch-character

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 4

Router(config-line)# dispatch-character 13

Related Commands Command Description

dispatch-machine Specifies an identifier for a TCP packet dispatch
state machine on a particular line.

dispatch-timeout Sets the character dispatch timer.

state-machine Specifies the transition criteria for the state of a

particular state machine.

terminal dispatch-character Defines a character that causes a packet to be sent

for the current session.

Cisco IOS Configuration Fundamentals Command Reference

241
 D through E
dispatch-machine

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 name Name of the state machine that determines when to
send packets on the asynchronous line.

Command Default No dispatch state machine identifier is defined.

Command Modes Line configuration

Command History Release Modification

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 linefeedfor the state machine:

Router(config)# state-machine linefeed 0 0 9 0

Router(config)# state-machine linefeed 0 11 255 0
Router(config)# state-machine linefeed 0 10 10 transmit

Cisco IOS Configuration Fundamentals Command Reference

242
 D through E
dispatch-machine

Router(config)# line 1
Router(config-line)# dispatch-machine linefeed

Related Commands Command Description

dispatch-character Defines a character that causes a packet to be sent.

dispatch-timeout Sets the character dispatch timer.

state-machine Specifies the transition criteria for the state of a

particular state machine.

Cisco IOS Configuration Fundamentals Command Reference

243
 D through E
dispatch-timeout

dispatch-timeout
To set the character dispatch timer, use the dispatch-timeoutcommand in line configuration mode. To
remove the timeout definition, use the noform of this command.

dispatch-timeout milliseconds
no dispatch-timeout

Syntax Description milliseconds Integer that specifies the number of milliseconds

(ms) that the Cisco IOS software waits after putting
the first character into a packet buffer before
sending the packet. During this interval, more
characters can be added to the packet, which
increases the processing efficiency of the remote
host.

Command Default No dispatch timeout is defined.

Command Modes Line configuration

Command History Release Modification

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-timeoutand 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.

Cisco IOS Configuration Fundamentals Command Reference

244
 D through E
dispatch-timeout

Note The system response time might appear intermittent if the timeout interval is greater than 100 milliseconds
and remote echoing is used. For lines with a reverse-Telnet connection, use a dispatch-timeout value less
than 10 milliseconds.

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 4

Router(config-line)# dispatch-timeout 80

Related Commands Command Description

buffer-length Specifies the maximum length of data streams
forwarded on a line.

dispatch-character Defines a character that causes a packet to be sent.

dispatch-machine Specifies an identifier for a TCP packet dispatch

state machine on a particular line.

state-machine Specifies the transition criteria for the state of a

particular state machine.

terminal dispatch-timeout Sets the character dispatch timer for the current
session.

Cisco IOS Configuration Fundamentals Command Reference

245
 D through E
do

do
To execute user EXEC or privileged EXEC commands from global configuration mode or other
configuration modes or submodes, use the docommand in any configuration mode.

do command

Syntax Description command The user EXEC or privileged EXEC command to

be executed.

Command Default A user EXEC or privileged EXEC command is not executed from a configuration mode.

Command Modes All configuration modes

Command History Release Modification

12.2(8)T This command was introduced.

12.2(14)S This command was integrated into Cisco IOS

Release 12.2(14)S.

12.2(14)SX Support for this command was added for the

Supervisor Engine 720.

12.2(17a)SX This command was changed to support the copy

command restriction.

12.2(17d)SXB Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

15.1(3)T This command was integrated into Cisco IOS

Release 15.1(3)T.

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.

Cisco IOS Configuration Fundamentals Command Reference

246
 D through E
do

Tip This command can be useful for saving your configuration to the startup-config file without having to
return to the user EXEC mode or privileged EXEC mode (do copy running-config startup-config) or for
checking the status of a feature (using a do show command) while configuring the feature.

Caution Do not enter the do command in user EXEC mode or privileged EXEC mode. Interruption of service might
occur.

You cannot use the do command to execute the configure terminal c ommand 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 c ommands 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/0

Serial3/0 is up, line protocol is up
Hardware is M8T-RS232
MTU 1500 bytes, BW 1544 Kbit, DLY 20000 usec, rely 255/255, load 1/255
Encapsulation HDLC, loopback not set, keepalive set (10 sec)
Last input never, output 1d17h, output hang never
Last 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 tunnel

Related Commands Command Description

clear vpdn tunne l Shuts down a specified VPDN tunnel and all
sessions within the tunnel.

configure terminal Enters global configuration mode.

copy Copies any file from a source to a destination.

show interfaces Displays statistics for all interfaces configured on

the router or access server.

write core Tests the configuration of a core dump setup.

Cisco IOS Configuration Fundamentals Command Reference

247
 D through E
downward-compatible-config

downward-compatible-config
To generate a configuration that is compatible with an earlier Cisco IOS release, use the downward-
compatible-configcommand 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 version Cisco IOS release number, not earlier than Release
10.2.
Note You must have a period (.) in the version
number. For example, 12.4.

Command Default The configuration is not compatible with earlier Cisco IOS releases.

Command Modes Global configuration (config)

Command History Release Modification

11.1 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2(33)SXI This command was integrated into a release earlier

than Cisco IOS Release 12.2(33)SXI.

Cisco IOS XE Release 2.1 This command was implemented on the Cisco ASR
1000 Series Aggregation Services Routers.

Usage Guidelines In Cisco IOS Release 10.3, IP access lists changed format. Use the downward-compatible-
configcommand to regenerate a configuration in a format prior to Release 10.3 if you will 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.

Cisco IOS Configuration Fundamentals Command Reference

248
 D through E
downward-compatible-config

Examples The following example shows how to generate a configuration file compatible with Cisco IOS Release 10.2
access lists:

Router(config)# downward-compatible-config 10.2

Related Commands Command Description

access-list (extended) Provides extended access lists that allow more
detailed access lists.

access-list (standard) Defines a standard XNS access list.

Cisco IOS Configuration Fundamentals Command Reference

249
 D through E
editing

editing
To reen able 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.

Command Default Enabled

Command Modes Line configuration

Command History Release Modification

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.
The table below 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, characters are bolded in the
“Function Summary” column to indicate the relation between the letter used and the function.

Cisco IOS Configuration Fundamentals Command Reference

250
D through E
editing

Table 23 Command Editing Keys and Functions

Keys Function Summary Function Details

Tab Complete command Completes a partial command
name entry. When you enter a
unique set of characters and press
the Tab key, the system
completes the command name. If
you enter a set of characters that
could indicate more than one
command, the system beeps to
indicate an error. To view the
commands which match the set of
characters you have entered, enter
a question mark (?) immediately
following the partial command
(no space). The CLI will then list
the commands that begin with
that string.

Return (at the command line) Execute Executes the command.

Return (at the --More-- prompt) Continue Displays the next line of output.

Space Bar (at the --More-- Continue Displays the next screen of
prompt) 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 B ack 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 F orward character Moves the cursor one character to
the right.

Esc, B B ack word Moves the cursor back one word.

Esc, F F orward word Moves the cursor forward one

word.

1 The arrow keys function only with ANSI-compatible terminals.

Cisco IOS Configuration Fundamentals Command Reference

251
 D through E
editing

Keys Function Summary Function Details

Ctrl-A Beginning of line Moves the cursor to the beginning
of the line.

Ctrl-E E nd of line Moves the cursor to the end of the

command line.

Ctrl-D D elete character Deletes the character at the

cursor.

Esc, D D elete 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 T ranspose characters Transposes the character to the

left of the cursor with the
character located at the cursor.

Ctrl-R or Ctrl-L R edisplay 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 P revious 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) N ext 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.

Cisco IOS Configuration Fundamentals Command Reference

252
 D through E
editing

Keys Function Summary Function Details

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 C apitalize word Capitalizes the word from the

cursor to the end of the word.

Esc, U Make word uppercase Changes all letters from the

cursor to the next space on the
line appear in uppercase letters.

Esc, L Make word lowercase Changes the word to lowercase

from the cursor to the end of the
word.

Examples In the following example, enhanced editing mode is disabled on line 3:

Router(config)# line 3
Router(config-line)# no editing

Related Commands Command Description

terminal editing Controls CLI enhanced editing feature for the
current terminal session.

Cisco IOS Configuration Fundamentals Command Reference

253
 D through E
enable

1. 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 privilege-level (Optional) Privilege level at which to log in.

view (Optional) Enters into root view, which enables

users to configure CLI views.
Note This keyword is required if you want to
configure a CLI view.

view-name (Optional) Enters or exits a specified command-line

interface (CLI) view. This keyword can be used to
switch from one CLI view to another CLI view.

Command Default Privilege-level 15 (privileged EXEC)

Command Modes User EXEC (>)

Privileged EXEC (#)
Diagnostic Mode (diag)

Command History Release Modification

10.0 This command was introduced.

12.3(7)T The view keyword and view-name argument were

added.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2(33)SRB The view keyword and view-name argument were

integrated into Cisco IOS Release 12.2(33)SRB.

12.2SX This command is supported in the Cisco IOS

Release 12.2SX train. Support in a specific 12.2SX
release of this train depends on your feature set,
platform, and platform hardware.

Cisco IOS Configuration Fundamentals Command Reference

254
 D through E
enable

Release Modification
12.2(33)SB This command was integrated into Cisco IOS
Release 12.2(22)SB.

Cisco IOS XE Release 2.1 This command became available on the ASR 1000
Series Routers, and became available in diagnostic
mode for the first time.

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 IOSSecurity 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> enable
Password: <letmein>
Router# disable
Router>

Cisco IOS Configuration Fundamentals Command Reference

255
 D through E
enable

The following example shows which commands are available inside the CLI view “first” after the user has
logged into this view:

Router# enable view first

Password:
00:28:23:%PARSER-6-VIEW_SWITCH:successfully set to view 'first'.
Router# ?
Exec commands:
configure Enter configuration mode
enable Turn on privileged commands
exit Exit from the EXEC
show Show running system information
Router# show ?
ip IP information
parser Display parser information
version System hardware and software status
Router# show ip ?

access-lists List IP access lists

accounting The active IP accounting database
aliases IP alias table
arp IP ARP table
as-path-access-list List AS path access lists
bgp BGP information
cache IP fast-switching route cache
casa display casa information
cef Cisco Express Forwarding
community-list List community-list
dfp DFP information
dhcp Show items in the DHCP database
drp Director response protocol
dvmrp DVMRP information
eigrp IP-EIGRP show commands
extcommunity-list List extended-community list
flow NetFlow switching
helper-address helper-address table
http HTTP information
igmp IGMP information
irdp 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 view

Router#
01:08:16:%PARSER-6-VIEW_SWITCH:successfully set to view 'root'.
Router#
! Enable the show parser view command from the root view
Router# show parser view
Current view is 'root'
! Enable the show parser view command from the root view to display all views
Router# show parser view all
Views Present in System:
View Name: first
View Name: second
! Switch to the CLI view “first.”
Router# enable view first

Router#
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 view
Current view is 'first'

Cisco IOS Configuration Fundamentals Command Reference

256
 D through E
enable

Related Commands Command Description

disable Exits from privileged EXEC mode to user EXEC
mode, or, if privilege levels are set, to the specified
privilege level.

enable password Sets a local password to control access to various

privilege levels.

privilege level (global) Sets a privilege level for a command.

privilege level (line) Sets a privilege level for a command for a specific
line.

Cisco IOS Configuration Fundamentals Command Reference

257
 D through E
enable last-resort

enable last-resort
To enable password parameters as the last resort without specifying the local enable password if no
TACACS servers respond, use the enable last-resort command in global configuration mode. To disable
the password parameters, use the no form of this command.

no enable last-resort {password | succeed}

no enable last-resort

Syntax Description password Enables password parameters by specifying the

local enable password.

succeed Enables password parameters without specifying

the local enable password.

Command Default The password parameters for the router are not enabled.

Command Modes Global configuration (config)

Command History Release Modification

15.0(1)M This command was introduced in a release earlier
than Cisco IOS 15.0(1)M.

Examples The following example shows how to enable password parameters as the last resort without specifying the
local enable password if no TACACS servers respond:

Router> enable
Router# configure terminal
Router(config)# enable last-resort succeed

Related Commands Command Description

show tacacs Displays statistics for a TACACS+ server.

Cisco IOS Configuration Fundamentals Command Reference

258
 D through E
end

end
To en d 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.

Command Default No default behavior or values.

Command Modes Global configuration

Command History Release Modification

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 This global configuration command can be used in any configuration mode.

Use this command when you are done configuring the system and you want to return to EXEC mode to
perform verification steps.

Examples In the following example, the end command is used to exit from ALPS ASCU configuration mode and
return to privileged EXEC mode. A show command is used in privileged EXEC mode to verify the
configuration.

Router# configure terminal

Router(config)# interface serial 1:1

Router(config-if)# alps ascu 4B

Router(config-alps-ascu)# end
Router# show interface serial 1:1

Cisco IOS Configuration Fundamentals Command Reference

259
 D through E
end

Related Commands Command Description

exit (global) Exits from the current configuration mode.

Cisco IOS Configuration Fundamentals Command Reference

260
 D through E
environment-monitor shutdown temperature

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.

Command Default By default, rommon is enabled.

Command Modes Global configuration

Command History Release Modification

12.2(14)SX Support for this command was introduced on the
Supervisor Engine 720.

12.2(18)SXF17 Support for powerdown keyword added.

12.2(33)SXH6 Support for powerdown keyword added.

Examples This example shows how to place the supervisor engine in ROMMON when a major active alarm occurs:

Router(config)#
environment-monitor shutdown temperature rommon
Router(config)#

This example shows how to power down the supervisor engine when a major active alarm occurs:

Router(config)#
environment-monitor shutdown temperature powerdown
Router(config)#

Cisco IOS Configuration Fundamentals Command Reference

261
 D through E
environment temperature-controlled

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.

Command Default This command is disabled by default.

Command Modes Global configuration

Command History Release Modification

12.2(14)SX Support for this command was introduced on the
Supervisor Engine 720.

12.2(17d)SXB Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

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-controlled
Router(config)#
This example shows how to disable the ambient temperature control:

Router(config)#

Cisco IOS Configuration Fundamentals Command Reference

262
D through E
environment temperature-controlled

no environment temperature-controlled
Router(config)#

Cisco IOS Configuration Fundamentals Command Reference

263
 D through E
erase

erase
To erase a file system or all files available on a file system, use the erasecommand in privileged EXEC or
diagnostic mode.

erase {/all nvram: | /no-squeeze-reserve-space filesystem: | filesystem: | startup-config}

Cisco 7600 Series Routers and Cisco ASR 1000 Series Routers
erase {/all nvram: | filesystem: | startup-config}

Syntax Description /all Erases all files in the specified file system.

nvram: Erases all files in the NVRAM.

file-system: File system name, followed by a colon. For

example, flash: or nvram:.
Note This argument may not be used if the device
memory contains logging persistent files.

/no-squeeze-reserve-space Disables the squeeze operation to conserve memory

and makes the erase command compatible with
older file systems.

startup-config Erases the contents of the configuration memory.

Command Modes Privileged EXEC (#) Diagnostic (#)

Command History Release Modification

11.0 This command was introduced.

12.2(11)T This command was modified. The /no-squeeze-

reserve-spacekeyword was added.

12.2(14)SX This command was modified. Support for this

command was added for the Supervisor Engine
720.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Cisco IOS Configuration Fundamentals Command Reference

264
 D through E
erase

Release Modification
Cisco IOS XE Release 2.1 This command was modified. The command was
introduced in diagnostic mode on the Cisco ASR
1000 Series Routers, and the /all keyword was
added.

15.0(1)M This command was modified in a release earlier

than Cisco IOS Release 15.0(1)M. The file-system :
argument was added.

Usage Guidelines The erase nvram: command replaces the write erase command and the erase startup-config command.

Caution When you use the erase command to erase a file system, you cannot recover the files in the file system.

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 erasecommand 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 formatcommand 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-spacekeyword
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 Use the context-sensitive help to determine which file systems can be used for the erase command. The
output will vary based on the platform.

Cisco IOS Configuration Fundamentals Command Reference

265
 D through E
erase

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:2

System flash directory, partition 2:

File Length Name/status
1 1711088 dirt/images/c3600-i-mz
[1711152 bytes used, 15066064 available, 16777216 total]
Erase flash device, partition 2? [confirm]
Are you sure? [yes/no]:
yes
Erasing device... eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee ...erased

The 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-Mode
1 4096K 2048K 2048K 2048K Read Only RXBOOT-FLH
2 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/status
1 3459720 master/igs-bfpx.100-4.3
[3459784 bytes used, 734520 available, 4194304 total]
Erase flash device, partition 2? [confirm] <Return>

Related Commands Command Description

boot config Specifies the device and filename of the
configuration file from which the router configures
itself during initialization (startup).

delete Deletes a file on a flash memory device.

more nvram:startup-config Displays the startup configuration file contained in

NVRAM or specified by the CONFIG_FILE
environment variable.

show bootvar Displays the contents of the BOOT environment

variable, the name of the configuration file pointed
to by the CONFIG_FILE environment variable, the
contents of the BOOTLDR environment variable,
and the configuration register setting.

Cisco IOS Configuration Fundamentals Command Reference

266
D through E
erase

Command Description
squeeze Removes all deleted files from the flash file system
and recovers the memory space used by deleted
files.

undelete Recovers a file marked “deleted” on a Class A or

Class B flash file system.

write erase The write erase command is replaced by the erase

nvram:command. See the description of the erase
command for more information

Cisco IOS Configuration Fundamentals Command Reference

267
 D through E
erase bootflash

erase bootflash
The erase bootflash: and erase bootflash commands have identical functions. See the description of the
erasecommand in this chapter for more information.

Cisco IOS Configuration Fundamentals Command Reference

268
 D through E
errdisable detect cause

errdisable detect cause

To enable error-disable detection, use the errdisable detect cause command in global configuration mode.
To disable error-disable detection, use the no form of this command.

errdisable detect cause {all | bpduguard | dtp-flap | l2ptguard | link-flap | packet-buffer-error |

pagp-flap | rootguard | udld}
no errdisable detect cause {all | bpduguard | dtp-flap | l2ptguard | link-flap | pagp-flap |
rootguard | udld}

Syntax Description all Specifies error-disable detection for all error-

disable causes.

bpduguard Specifies detection for the Bridge Protocol Data

Unit (BPDU)-guard error-disable cause.

dtp-flap Specifies detection for the Dynamic Trunking

Protocol (DTP)-flap error-disable cause.

l2ptguard Specifies detection for the Layer 2 Protocol

Tunneling guard error-disable cause.

link-flap Specifies detection for the link flap error-disable

cause.

packet-buffer-error Causes the packet buffer error to error-disable the

affected port.

pagp-flap Specifies detection for the Port Aggregation

Protocol (PAgP)-flap error-disable cause.

rootguard Specifies detection for the root-guard error-disable

cause.

udld Specifies detection for the Unidirectional Link

Detection (UDLD) error-disable cause.

Command Default Error-disable detection is enabled for all causes.

Command Modes Global configuration (config)

Cisco IOS Configuration Fundamentals Command Reference

269
 D through E
errdisable detect cause

Command History Release Modification

15.0(1)M This command was introduced in a release earlier
than Cisco IOS Release 15.0(1)M.

12.2(14)SX This command was modified. Support was added

for the Supervisor Engine 720.

12.2(17b)SXA This command was modified. The packet-buffer-

error keyword was added.

12.2(17d)SXB This command was modified. Support for this

command on the Supervisor Engine 2 was extended
to Release 12.2(17d)SXB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines

Note Entering the no errdisable detect cause packet-buffer-error command allows you to detect the fault that
triggers a power cycle of the affected module.

A cause (bpduguard, dtp-flap, link-flap, pagp-flap, root-guard, udld) is defined as the reason why the error-
disable state occurred. When a cause is detected on an interface, the interface is placed in an error-disable
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 The following example shows how to enable error-disable detection for the Layer 2 protocol-tunnel guard
error-disable cause:

Router(config)#
errdisable detect cause l2ptguard

Related Commands Command Description

show errdisable detect Displays the error-disable detection status.

show interfaces status Displays the interface status or a list of interfaces in

an error-disable state on LAN ports only.

shutdown Disables an interface.

Cisco IOS Configuration Fundamentals Command Reference

270
 D through E
errdisable recovery

errdisable recovery
To configure 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 | rootguard | udld | unicast-flood} | interval seconds}
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 | rootguard | udld | unicast-flood} | interval seconds}

Syntax Description cause Enables error-disable recovery from a specific

cause.

all Enables the recovery timers for all error-disable

causes.

arp-inspection Enables error-disable recovery from an Address

Resolution Protocol (ARP) inspection cause.

bpduguard Enables the recovery timer for the Bridge Protocol

Data Unit (BPDU)-guard error-disable cause.

channel-misconfig Enables the recovery timer for the channel-

misconfig error-disable cause.

dhcp-rate-limit Enables the recovery timer for the Dynamic Host

Configuration Protocol (DHCP)-rate-limit error-
disable cause.

dtp-flap Enables the recovery timer for the Dynamic

Trunking Protocol (DTP)-flap error-disable cause.

gbic-invalid Enables the recovery timer for the Gigabit Interface

Converter (GBIC)-invalid error-disable cause.

l2ptguard Enables the recovery timer for the Layer 2 Protocol

Tunneling (L2PT) error-disable cause.

link-flap Enables the recovery timer for the link-flap error-

disable cause.

pagp-flap Enables the recovery timer for the Port Aggregation

Protocol (PAgP)-flap error-disable cause.

psecure-violation Enables the recovery timer for the psecure-violation

error-disable cause.

Cisco IOS Configuration Fundamentals Command Reference

271
 D through E
errdisable recovery

security-violation Enables the automatic recovery of ports that were

disabled because of 802.1X security violations.

rootguard Enables the recovery timer for the root-guard error-

disable cause.

udld Enables the recovery timer for the Unidirectional

Link Detection (UDLD) error-disable cause.

unicast-flood Enables the recovery timer for the unicast-flood

error-disable cause.

interval seconds Specifies the time, in seconds, to recover from a

specified error-disable cause. The range is from 30
to 86400. The default interval is 300.

Command Default The recovery mechanisms are disabled.

Command Modes Global configuration (config)

Command History Release Modification

15.0(1)M This command was introduced in a release earlier
than Cisco IOS Release 15.0(1)M.

12.2(14)SX This command was modified. This command was

implemented on the Supervisor Engine 720.

12.2(17d)SXB This command was modified. This command was

implemented on the Supervisor Engine 2.

12.2(18)SXD This command was modified. The arp-inspection

keyword was added.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines A cause (bpduguard, channel-misconfig, dhcp-rate-limit, dtp-flap, l2ptguard, link-flap, pagp-flap, psecure-
violation, security-violation, rootguard, udld, or unicast-flood) is defined as the reason why the error-
disable state occurred. When a cause is detected on an interface, the interface is placed in an error-disable
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-disable state until a shutdown and no shutdown occur. If you
enable recovery for a cause, the interface is brought out of the error-disable state and allowed to retry
operation once all the causes have timed out.

Cisco IOS Configuration Fundamentals Command Reference

272
 D through E
errdisable recovery

You must enter the shutdown command and then the no shutdown command to manually recover an
interface from the error-disable state.

Note A separate line is required each time you want to enter the errdisable recovery cause command to add a
new reason for recovery; each new reason does not get appended to the original single line. This means you
must enter each new reason separately.

Examples This example shows how to enable the recovery timer for the BPDU-guard error-disable cause:

Router(config)#
errdisable recovery cause bpduguard

This example shows how to set the recovery timer to 300 seconds:

Router(config)#
errdisable recovery interval 300

Related Commands Command Description

show errdisable recovery Displays the information about the error-disable
recovery timer.

show interfaces status Displays the interface status or a list of interfaces in

an error-disabled state on LAN ports only.

shutdown Disables an interface.

Cisco IOS Configuration Fundamentals Command Reference

273
 D through E
escape-character

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 noor defaultform of this command.
escape-character {break | char | default | none | soft}
no escape-character [soft]
default escape-character [soft]

Syntax Description break Sets the escape character to Break. Note that the
Break key should not be used as an escape
character on a console terminal.

char Character (for example, !) or its ASCII decimal

representation ( integer in the range of 0 to 255) to
be used as the escape character.

default Sets the escape key sequence to the default of Ctrl-

^, X.

none Disables escape entirely.

soft Sets an escape character that will wait until pending

input is processed before it executes.

Command Default 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 Release Modification

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.

Cisco IOS Configuration Fundamentals Command Reference

274
 D through E
escape-character

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:
• The length of the logout sequence must be 14 characters or fewer.
• The soft escape character cannot be the same as the generic Cisco escape character, Break, or the
characters b, d, n, or s.
• The soft escape character should be an ASCII value from 1 to 127. Do not use the number 30.

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 console

Router(config-line)# escape-character 16
The 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 1
Router(config-line)# escape-character !
Router(config-line)# end
Router# show running-config
Building configuration...
.
.
.
line 1
autoselect during-login
autoselect ppp
modem InOut
transport preferred none
transport output telnet
escape-character 33

Cisco IOS Configuration Fundamentals Command Reference

275
 D through E
escape-character

Related Commands Command Description

show line Displays information about the specified line
connection, or all the lines.

terminal escape-character Sets the escape character for the current terminal
line for the current session.

Cisco IOS Configuration Fundamentals Command Reference

276
 D through E
exec

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.

Command Default The EXEC processes is enabled on all lines.

Command Modes Line configuration

Command History Release Modification

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 7

Router(config-line)# no exec

Cisco IOS Configuration Fundamentals Command Reference

277
 D through E
exec-banner

exec-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.

Command Default Enabled on all lines

Command Modes Line configuration

Command History Release Modification

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 motdglobal configurationcommands. 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-bannercommand is enabled or disabled. The table
below summarizes the effects of the exec-banner command and the motd-banner command.

Cisco IOS Configuration Fundamentals Command Reference

278
 D through E
exec-banner

Table 24 Banners Displayed Based On exec-banner and motd-banner Combinations

exec-banner (default) no exec-banner

motd-banner (default) MOTD banner None
EXEC banner

no motd-banner 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. The table below summarizes the effects of the
exec-banner command and the motd-banner command for reverse Telnet connections.

Table 25 Banners Displayed Based On exec-banner and motd-banner Combinations for Reverse Telnet
Sessions to Async Lines

exec-banner (default) no exec-banner

motd-banner (default) MOTD banner Incoming banner
Incoming banner

no motd-banner Incoming banner Incoming banner

Examples The following example suppresses the EXEC and MOTD banners on virtual terminal lines 0 to 4:

Router(config)# line vty 0 4

Router(config-line)# no exec-banner

Related Commands Command Description

banner exec Defines and enables a customized banner to be
displayed whenever the EXEC process is initiated.

banner incoming Defines and enables a customized message to be

displayed when there is an incoming connection to
a terminal line from a host on the network.

banner motd Defines and enables a customized message-of-the-

day banner.

motd-banner Controls (enables or disables) the display of

message-of-the-day banners on a specified line or
lines.

Cisco IOS Configuration Fundamentals Command Reference

279
 D through E
exec-character-bits

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.

Command Default 7-bit ASCII character set

Command Modes Line configuration

Command History Release Modification

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 If you are using the autoselect function, set the activation character to the default (Return) and the value for
exec-character-bits to 7. If you change these defaults, the application will not recognize the activation
request.

Cisco IOS Configuration Fundamentals Command Reference

280
 D through E
exec-character-bits

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 8

Router(config)# line 0
Router(config-line)# exec-character-bits 7

Related Commands Command Description

default-value exec-character-bits Defines the EXEC character width for either 7 bits
or 8 bits.

default-value special-character-bits Configures the flow control default value from a 7-

bit width to an 8-bit width.

length Sets the terminal screen length.

terminal exec-character-bits Locally changes the ASCII character set used in

EXEC and configuration command characters for
the current session.

terminal special-character-bits Changes the ASCII character widths to accept

special characters for the current terminal line and
session.

Cisco IOS Configuration Fundamentals Command Reference

281
 D through E
exec-timeout

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.

Command Default 10 minutes

Command Modes Line configuration

Command History Release Modification

10.0 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

15.0(1)SY2 The no form of the command updated to configure

an exec-timeout of 0 0on the device.

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 no form of this command.

Examples The following example sets a time interval of 2 minutes, 30 seconds:

Router(config)# line console 0

Router(config-line)# exec-timeout 2 30

Cisco IOS Configuration Fundamentals Command Reference

282
D through E
exec-timeout

The following example sets a time interval of 10 seconds:

Router(config)# line console 0

Router(config-line)# exec-timeout 0 10

Cisco IOS Configuration Fundamentals Command Reference

283
 D through E
execute-on

execute-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 slot slot-number Executes the command on the line card in the
specified slot. Slot numbers can be chosen from the
following ranges:
• Cisco 12012 router: 0 to 11
• Cisco 12008 access server: 0 to 7
• Cisco AS5800 access server: 0 to 13

all Executes the command on all line cards.

master (AS5800 only) Executes the designated command

on a Dial Shelf Controller (DSC). Do not use this
option; it is used for technical support
troubleshooting only.

command Cisco IOS command to remotely execute on the

line card.

Command Modes Privileged EXEC

Command History Release Modification

11.2 GS This command was introduced to support Cisco
12000 series Gigabit Switch Routers.

11.3(2)AA This command was implemented in images for the

Cisco AS5800 series.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2(33)SRE This command was integrated into Cisco IOS

Release 12.2(33)SRE. Pipe '|" options can now be
used with show option in the execute-on command
on SUP and SAMI consoles.

Cisco IOS Configuration Fundamentals Command Reference

284
 D through E
execute-on

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 This command is useful when used with show EXEC commands (such as show version), because you can
verify and troubleshoot the features found only on a specific line card. Please note, however, that because
not all statistics are maintained on the line cards, the output from some of the show commands might not be
consistent.

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 Though you can use the attachprivileged EXEC command to execute commands on a specific line card,
using the execute-on slotcommand saves you some steps. For example, first you must use the attach
command to connect to the Cisco IOS software running on the line card. Next you must issue the
command. Finally you must disconnect from the line card to return to the Cisco IOS software running on
the GRP card. With the execute-on slot command, you can perform three steps with one command. In
addition, the execute-on allcommand allows you to perform the same command on all line cards
simultaneously.

Cisco c7600 Sup Guidelines and Restrictions

Beginning with the 12.2(33)SRE Cisco IOS release, all pipe '|" options can now be used with show option
in the execute-on command on SUP and SAMI consoles.
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-oncommand 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 Do not use this command to change configurations on dial shelf cards, because such changes will not be
reflected in the router shelf.

Using this command makes it possible to accumulate inputs for inclusion in the show tech-
supportcommand.
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.

Cisco IOS Configuration Fundamentals Command Reference

285
 D through E
execute-on

The show tech-supportcommand 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
ping
The 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
reload
You can use the execute-on command to enable remote execution of the commands included in the
following partial list:
• debug dsc clock
• show context
• show diag
• show environment
• show dsc clock
• show dsi
• show dsip
• show tech-support

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 POS0
Hardware is BFLC POS
lcpos_instance struct 6033A6E0
RX POS ASIC addr space 12000000
TX POS ASIC addr space 12000100
SUNI framer addr space 12000400
SUNI rsop intr status 00
CRC16 enabled, HDLC enc, int clock
no loop
Interface POS1
Hardware is BFLC POS
lcpos_instance struct 6033CEC0
RX POS ASIC addr space 12000000
TX POS ASIC addr space 12000100
SUNI framer addr space 12000600
SUNI rsop intr status 00
CRC32 enabled, HDLC enc, int clock
no loop
Interface POS2
Hardware is BFLC POS
lcpos_instance struct 6033F6A0
RX POS ASIC addr space 12000000
TX POS ASIC addr space 12000100
SUNI framer addr space 12000800
SUNI rsop intr status 00
CRC32 enabled, HDLC enc, int clock
no loop

Cisco IOS Configuration Fundamentals Command Reference

286
D through E
execute-on

Interface POS3
Hardware is BFLC POS
lcpos_instance struct 60341E80
RX POS ASIC addr space 12000000
TX POS ASIC addr space 12000100
SUNI framer addr space 12000A00
SUNI rsop intr status 00
CRC32 enabled, HDLC enc, ext clock
no loop
Router#
In the following example, the user executes the show version command on the line card in slot 2 and 3 of a
Cisco c7600 Sup series device:

Example for c7600 SUP -

Router#execute-on 2 3 show

WORD Command to be executed

| Output modifiers
<cr>
Router#execute-on 2 3 show version
| ?
append Append redirected output to URL (URLs supporting append operation
only)
begin Begin with the line that matches
exclude Exclude lines that match
format Format the output using the specified spec file
include Include lines that match
redirect Redirect output to URL
section Filter a section of output
tee Copy output to URL
Router#execute-on 2 3 execute-on 4 show version
?
WORD Command to be executed
| Output modifiers
<cr>
Router#execute-on 2 3 execute-on 4 show version
| redirect
?
bootflash: Uniform Resource Locator
const_nvram: Uniform Resource Locator
disk0: Uniform Resource Locator
disk1: Uniform Resource Locator
nvram: Uniform Resource Locator
sami#2-fs: Uniform Resource Locator
sami#3-fs: Uniform Resource Locator
slavebootflash: Uniform Resource Locator
slaveconst_nvram: Uniform Resource Locator
slavedisk0: Uniform Resource Locator
slavedisk1: Uniform Resource Locator
slavenvram: Uniform Resource Locator
slavercsf: Uniform Resource Locator
slavesup-bootdisk: Uniform Resource Locator
slavesup-bootflash: Uniform Resource Locator
sup-bootdisk: Uniform Resource Locator
sup-bootflash: Uniform Resource Locator
In the following example, the user executes the show command on the line card in slot 4 of a Cisco c7600
SAMI series device:

Router#execute-on 4 show
?
WORD Command to be executed
| Output modifiers
<cr>
Router#execute-on 4 show
| ?
append Append redirected output to URL (URLs supporting append operation
only)
begin Begin with the line that matches
exclude Exclude lines that match
include Include lines that match

Cisco IOS Configuration Fundamentals Command Reference

287
 D through E
execute-on

redirect Redirect output to URL

section Filter a section of output
tee Copy output to URL

Related Commands Command Description

attach Connects you to a specific line card for the purpose
of executing commands using the Cisco IOS
software image on that line card.

Cisco IOS Configuration Fundamentals Command Reference

288
 D through E
exit (EXEC)

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.

Command Default No default behavior or values

Command Modes EXEC

Command History Release Modification

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)# exit
Router# disable
Router> exit

Related Commands Command Description

disconnect Disconnects a line.

end Ends your configuration session by exiting to

EXEC mode.

Cisco IOS Configuration Fundamentals Command Reference

289
 D through E
exit (EXEC)

Command Description
exit (global) Exits from the current configuration mode to the
next highest configuration mode.

logout Closes your connection to the device (equivilant to

the exit command).

Cisco IOS Configuration Fundamentals Command Reference

290
 D through E
exit (global)

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.

Command Default No default behavior or values

Command Modes All configuration modes

Command History Release Modification

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)# exit
Router(config-if)#
The following example displays an exit from the interface configuration mode to return to
the global configuration mode:
Router(config-if)# exit
Router(config)#

Cisco IOS Configuration Fundamentals Command Reference

291
 D through E
exit (global)

Related Commands Command Description

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.

Cisco IOS Configuration Fundamentals Command Reference

292
F through K
• file prompt, page 294
• file verify auto, page 295
• format, page 297
• fsck, page 301
• full-help, page 307
• help, page 309
• hidekeys, page 311
• history, page 313
• history size, page 315
• hold-character, page 317
• hostname, page 319
• hw-module reset, page 321
• hw-module shutdown, page 322
• insecure, page 323
• international, page 324
• ip bootp server, page 326
• ip finger, page 328
• ip ftp passive, page 330
• ip ftp password, page 331
• ip ftp source-interface, page 333
• ip ftp username, page 335
• ip rarp-server, page 337
• ip rcmd domain-lookup, page 339
• ip rcmd rcp-enable, page 341
• ip rcmd remote-host, page 343
• ip rcmd remote-username, page 346
• ip rcmd rsh-enable, page 348
• ip rcmd source-interface, page 350
• ip telnet source-interface, page 352
• ip tftp blocksize, page 354
• ip tftp boot-interface, page 355
• ip tftp min-timeout, page 356
• ip tftp source-interface, page 357
• ip wccp web-cache accelerated, page 359

Cisco IOS Configuration Fundamentals Command Reference

293
 F through K
file prompt

file prompt
To specify the level of prompting, use the file promptcommand in global configuration mode.

file prompt prompt [alert | noisy | quiet]

Syntax Description alert (Optional) Prompts only for destructive file

operations. This is the default.

noisy (Optional) Confirms all file operation parameters.

quiet (Optional) Seldom prompts for file operations.

Command Default alert

Command Modes Global configuration

Command History Release Modification

11.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 change the amount of confirmation needed for different file operations.
This command affects only prompts for confirmation of operations. The router will always prompt for
missing information.

Examples The following example configures confirmation prompting for all file operations:

Router(config)# file prompt noisy

Cisco IOS Configuration Fundamentals Command Reference

294
 F through K
file verify auto

file verify auto

To enable automatic image verification, use the file verify auto command in global configuration mode. To
disable automatic image verification, use the no form of this command.

file verify auto

no file verify auto

Syntax Description This command has no arguments or keywords.

Command Default Image verification is not automatically applied to all images that are copied or reloaded onto a router.

Command Modes Global configuration

Command History Release Modification

12.2(18)S This command was introduced.

12.0(26)S This command was integrated into Cisco IOS

Release 12.0(26)S.

12.2(14)SX This command was integrated into Cisco IOS

Release 12.2(14)SX and implemented on the
Supervisor Engine 720.

12.2(17d)SXB Support was added for the Supervisor Engine 2.

12.3(4)T This command was integrated into Cisco IOS

Release 12.3(4)T.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Image verification is accomplished by verifying the compressed Cisco IOS image checksum.
Image verification allows users to automatically verify the integrity of all Cisco IOS images. Thus, users
can be sure that the image is protected from accidental corruption, which can occur at any time during
transit, starting from the moment the files are generated by Cisco until they reach the user.
The file verify auto command enables image verification globally; that is, all images that are to be copied
(via the copy command) or reloaded (via the reload command) are automatically verified. Although both
the copy and reload commands have a /verify keyword that enables image verification, you must issue the

Cisco IOS Configuration Fundamentals Command Reference

295
 F through K
file verify auto

keyword each time you want to copy or reload an image. The file verify auto command enables image
verification by default so you no longer have to specify image verification multiple times.
If you have enabled image verification by default but prefer to disable verification for a specific image
copy or reload, the /noverify keyword along with either the copy or the reload command will override the
file verify auto command.

Examples The following example shows how to enable automatic image verification:

Router(config)# file verify auto

Related Commands Command Description

copy Copies any file from a source to a destination.

copy/noverify Disables the automatic image verification for the

current copy operation.

reload Reloads the operating system.

verify Verifies the checksum of a file on a Flash memory

file system or computes an MD5 signature for a
file.

Cisco IOS Configuration Fundamentals Command Reference

296
 F through K
format

format
To format a Class A, Class B, or Class C flash memory file system, use the format command in privileged
EXEC or diagnostic mode.

Class B and Class C Flash File Systems

format filesystem1:

Class A Flash File System

format [spare spare-number] filesystem1 : [[filesystem2:][monlib-filename]]

Syntax Description spare (Optional) Reserves spare sectors as specified by

the spare-number argument when you format flash
memory.

spare-number (Optional) Number of the spare sectors to reserve in

formatted flash memory. Valid values are from 0 to
16. The default value is 0.

filesystem1 : Flash memory to format, followed by a colon.

Valid values for use with the Cisco 7600 series
router are disk0: disk1:, bootflash:, slot0:, sup-
slot0:, and sup-bootflash:; see the “Usage
Guidelines” section for additional information.
Valid values for use with the ASR 1000 Series
Routers are bootflash:, harddisk:, stby-harddisk:,
obfl:, and usb[0 1];.

filesystem2 : (Optional) File system containing the monlib file to

use for formatting the argument
filesystem1followed by a colon.

monlib-filename (Optional) Name of the ROM monitor library file

(monlib file) to use for formatting the
filesystem1argument. The default monlib file is the
one bundled with the system software.
Dual Route Switch Processors (RSP) High System
Availability (HSA) Functionality
When this command is used with Dual RSPs and
you do not specify the monlib-filenameargument,
the system takes the ROM monitor library file from
the slave image bundle. If you specify the monlib-
filename argument, the system assumes that the
files reside on the slave devices.

Cisco IOS Configuration Fundamentals Command Reference

297
 F through K
format

Command Default spare-number : 0monlib-filename:The monlib file bundled with the system software

Command Modes Privileged EXEC (#)

Diagnostic (diag)

Command History Release Modification

11.0 This command was introduced.

12.2(14)SX Support for this command was added for the

Supervisor Engine 720.

12.2(17d)SXB Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

12.3(14)T Support for Class B flash (USB flash and USB

eToken) file systems was added as part of the USB
Storage feature.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Cisco IOS XE Release 2.1 This command was introduced on the Cisco ASR
1000 Series Routers and the following
enhancements were introduced:
• This command was introduced in diagnostic
mode for the first time. The command can be
entered in both privileged EXEC and
diagnostic mode on the Cisco ASR 1000 Series
Routers.
• The harddisk:, obfl:, stby-harddisk:, stby-
usb[0-1]: and usb[0-1]: filesystem1 : options
were introduced.

12.2YST This command was integrated into Cisco IOS

Release 12.2YST.

Usage Guidelines Reserve a certain number of memory sectors as spares, so that if some sectors fail, most of the flash
memory card can still be used. Otherwise, you must reformat the flash card after some of the sectors fail.
Use this command to format Class A, B, or C flash memory file systems. The Cisco 7600 series router
supports only Class A and Class C flash file systems.
In some cases, you might need to insert a new Personal Computer Memory Card Industry Association
(PCMCIA) flash memory or flash PC card and load images or backup configuration files onto it. Before
you can use a new flash memory or flash PC card, you must format it.
Sectors in flash memory or flash PC cards can fail. Reserve certain flash memory or flash PC sectors as
“spares” by using the optional spare-number argument on the format command to specify 0 to 16 sectors

Cisco IOS Configuration Fundamentals Command Reference

298
 F through K
format

as spares. If you reserve a small number of spare sectors for emergencies, you can still use most of the flash
memory or flash PC card. If you specify 0 spare sectors and some sectors fail, you must reformat the flash
memory or flash PC card, thereby erasing all existing data.
The monlib file is the ROM monitor library. The ROM monitor uses this file to access files in the flash file
system. The Cisco IOS system software contains a monlib file. Use the show disk0: allcommand to display
monlib file details.
When this command is used with HSA and you do not specify the monlib-filename argument, the system
takes the ROM monitor library file from the slave image bundle. If you specify the monlib-filename
argument, the system assumes that the files reside on the slave devices.
In the command syntax, the filesystem1 :argumentspecifies the device to format and the
filesystem2 :argumentspecifies the optional device containing the monlib file used to format the
filesystem1 :argument. The device determines which monlib file to use, as follows:
• If you omit the optional filesystem2 : and monlib-filename arguments, the system formats the
filesystem1 : argument using the monlib file already bundled with the system software.
• If you omit only theoptional filesystem2 : argument, the system formats the filesystem1 :
argumentusing the monlib file from the device you specified with the cd command.
• If you omit only the optional monlib-filename argument, the system formats filesystem1 : using the
filesystem2 : monlib file.
• When you specify both arguments--filesystem2 : and monlib-filename-- the system formats the
filesystem1 : argumentusing the monlib file from the specified device.
• You can specify the filesystem1 :arguments’s own monlib file in this argument. If the system cannot
find a monlib file, it terminates its formatting.

Note Most platforms do not support booting from images stored on flash memory cards . You should reboot your
device only from integrated memory locations, such as NVRAM.

Cisco 7600 Series Router Notes

The bootflash:, slot0:, sup-slot0:, and sup-bootflash: keywords are supported on Cisco 7600 series
routers that are configured with a Supervisor Engine 2.
Use the format command to format Class A or C flash memory file systems.
• The disk0: and disk1: keywords are for Class C file systems.
• The bootflash:, slot0:, sup-slot0:, and sup-bootflash: keywords are for Class A file systems.
The disk0: keyword is supported on Cisco 7600 series routers that are configured with a Supervisor Engine
2 only.
Cisco ASR 1000 Series Routers Notes
This command is available in both privileged EXEC and diagnostic mode on the Cisco ASR 1000 Series
Routers.

Examples The following example shows how to format a flash memory card that is inserted in slot 0:

Router# format slot0:

Running config file on this device, proceed? [confirm] y
All sectors will be erased, proceed? [confirm] y
Enter volume id (up to 31 characters): <Return>

Cisco IOS Configuration Fundamentals Command Reference

299
 F through K
format

Formatting sector 1 (erasing)

Format device slot0 completed

When the console returns to the privileged EXEC prompt, the new flash memory card is formatted and
ready for use.
This following example shows how to format a CompactFlash PC card that is inserted in slot 0:

Router# format disk0:

Running config file on this device, proceed? [confirm] y
All sectors will be erased, proceed? [confirm] y
Enter volume id (up to 31 characters): <Return>
Formatting sector 1 (erasing)
Format device disk0 completed
When the console returns to the EXEC prompt, the new CompactFlash PC card is formatted
and ready for use.

This follwing example shows how a format operation cleans up the disk and writes the monitor library on
the disk filesystem:

Router# format formatdisk:

Format operation may take a while. Continue? [confirm]
Format operation will destroy all data in "bootdisk:". Continue? [confirm]
Hash Computation: 100%Done!
Computed Hash SHA2: DFBA87256310DC8A7B7BF8158451F7F4
0AC333C9B396D9D0E42DDBD542C30E08
F3946DDE692AF04F0B20F29BE51C49C4
1B631790A542D81F9A7C90ABC2426960

Embedded Hash SHA2: DFBA87256310DC8A7B7BF8158451F7F4

0AC333C9B396D9D0E42DDBD542C30E08
F3946DDE692AF04F0B20F29BE51C49C4
1B631790A542D81F9A7C90ABC2426960

Digital signature successfully verified in file Monlib

Writing Monlib sectors....
Monlib write complete
Format: All system sectors written. OK...
Format: Total sectors in formatted partition: 1000881
Format: Total bytes in formatted partition: 512451072
Format: Operation completed successfully.
Format of bootdisk: complete

Related Commands Command Description

cd Changes the default directory or file system.

copy Copies any file from a source to a destination.

delete Deletes a file on a flash memory device.

show disk0: all Displays ATA MONLIB file information for disk0.

show file systems Lists available file systems.

squeeze Permanently deletes flash files by squeezing a Class

A flash file system.

undelete Recovers a file marked “deleted” on a Class A or

Class B flash file system.

Cisco IOS Configuration Fundamentals Command Reference

300
 F through K
fsck

fsck
To check a File Allocation Table (FAT)-based disk, a flash file system, or a Class C file system for damage
and to repair any problems, use the fsckcommand in privileged EXEC or diagnostic mode.

Supported Platforms Other than the Cisco 7600 Series and Cisco ASR1000 Series Routers
fsck [/nocrc] [/automatic] [/all] [/force] [filesystem:]

Cisco 7600 Series Routers

fsck [/automatic] [/all] [/force] [filesystem:]

Cisco ASR 1000 Series Routers

fsck [/all] [/force] [filesystem:]

Syntax Description /nocrc (Optional) This keyword is available for Class C

flash file systems only. Omits cyclic redundancy
checks (CRCs).

/automatic (Optional) This keyword is available for Advanced

Technology Attachment (ATA) FAT-based disks
only. Specifies that the check and repair actions
should proceed automatically. This option can be
used to skip the prompts for each check and repair
action.
Note This command also specifies the automatic
mode for the Cisco 7600 series router; see
the “Usage Guidelines” section for
additional information.

/ all (Optional) Specifies that all partitions on the disk

be checked for problems.

/force (Optional) Ensures forced termination of

simultaneous file operations on the same device.

filesystem : The file system prefix indicating the disk to be

checked. The colon (:) is required. Typically, the
file system prefix will be disk0: or disk1:. In case
of dual processors, the file system on the redundant
supervisor engine can also be specified.

Command Default A FAT-based disk, flash file system, or Class C file system is not checked for damage and repaired. If you
do not enter the /automatic keyword, command-line interface (CLI) prompts for actions are issued. For the
Cisco 7600 series router, if you do not specify the disk0: keyword, the current file system is checked.

Cisco IOS Configuration Fundamentals Command Reference

301
 F through K
fsck

This command is available in both privileged EXEC and diagnostic mode on the Cisco ASR1000 series
routers.

Command Modes Privileged EXEC (#) Diagnostic (diag)

Command History Release Modification

11.3 AA This command was introduced.

12.0(22)S This command was implemented on the Cisco 7000

family of routers and on the Cisco 10000 series
router and the Gigabit Switch Router (GSR) to
support ATA disks.

12.2(13)T This command was integrated into Cisco IOS

Release 12.2(13)T.

12.2(14)SX This command was modified. Support for this

command was added for the Supervisor Engine
720.

12.2(17d)SXB This command was modified. Support for this

command on the Supervisor Engine 2 was extended
to Release 12.2(17d)SXB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Cisco IOS XE Release 2.1 This command was introduced on the Cisco ASR
1000 Series Routers and the following
enhancements were introduced:
• This command was introduced in diagnostic
mode for the first time. The command can be
entered in both privileged EXEC and
diagnostic mode on the Cisco ASR 1000 series
routers.
• The /all option was introduced.
• The harddisk:, obfl:, stby-harddisk:, stby-
usb[0-1]:,and usb[0-1]: filesystem : options
were introduced.

15.0(1)M This command was modified. The /force keyword

was added.

Usage Guidelines Supported Platforms Other than Cisco 7600 Series Router

Cisco IOS Configuration Fundamentals Command Reference

302
 F through K
fsck

This command performs all steps necessary to remove corrupted files and reclaim unused disk space.
Changes include checking for incorrect file sizes, cluster loops, and so on. The default form of this
command issues multiple prompts to confirm each of the changes. However, you can skip these prompts by
using the /automatic keyword when issuing the command.
When you use the /automatickeyword you are prompted to confirm that you want the automatic option.
Prompts for actions will be skipped, but all actions performed are displayed to the terminal (see the
example below).
This command works with ATA Personal Computer Memory Card Industry Association (PCMCIA) cards
formatted in Disk Operating System (DOS), or for Class C flash file systems.

Note Only one partition (the active partition) is checked in the ATA disk.

Cisco 7600 Series Router

The disk0: or slavedisk0: file systems are the only file systems in the Cisco 7600 series routers on which
you can run the File-System-Check ( fsck) utility. The slavedisk0: file system appears in redundant
supervisor engine systems only.
This command is valid only on Class C flash file systems and only on PCMCIA ATA flash disks and
CompactFlash disks.
The output for the fsck slavedisk0: command is similar to the fsck disk0: command output.
If you do not enter any arguments, the current file system is used. Use the pwd command to display the
current file system.
If you enter the disk0: or slavedisk0: keyword, the fsck utility checks the selected file system for
problems. If a problem is detected, a prompt is displayed asking if you want the problem fixed.
If you enter the /automatic keyword, you are prompted to confirm that you want the automatic mode. In
automatic mode, problems are fixed automatically and you are not prompted to confirm.
If you do not specify the /forcekeyword, any simultaneous file operations on the same device are not
terminated. Instead, an error message stating files are open for read or write access appears. If you specify
the /force keyword, the fsck utility terminates files that are open for read or write access and continues to
check for problems.
The table below lists the checks and actions that are performed by the fsck utility.

Table 26 fsck Utility Checks and Actions

Checks Actions
Checks the boot sector and the partition table and reports the No action.
errors.

Validates the media with the signature in the last 2 bytes of the No action.
first sector (0x55 and 0xaa, respectively).

Checks the os_id to find whether this is a FAT-12 or FAT-16 No action.

file system (valid values include 0, 1, 4, and 6).

Checks the number of FAT’s field (correct values are 1 and 2). No action.

Cisco IOS Configuration Fundamentals Command Reference

303
 F through K
fsck

Checks Actions
Checks these values: No action.
• n_fat_sectors cannot be less than 1.
• n_root_entries cannot be less than 16.
• n_root_sectors cannot be less than 2.
• base_fat_sector, n_sectors_per_cluster, n_heads,
n_sectors_per_track is not 0.

Checks the files and FAT for these errors:

Checks the FAT for invalid cluster numbers. If the cluster is a part of a file chain, the cluster is changed to
end of file (EOF). If the cluster is not part of a file chain, it is
added to the free list and unused cluster chain. The table below
lists valid cluster numbers; numbers other than those listed in
the table below are invalid numbers.

Checks the file’s cluster chain for loops. If the loop is broken, the file is truncated at the cluster where
the looping occurred.

Checks the directories for nonzero size fields. If directories are found with nonzero size fields, the size is reset
to zero.

Checks for invalid start cluster file numbers. If the start cluster number of a file is invalid, the file is deleted.

Checks files for bad or free clusters. If the file contains bad or free clusters, the file is truncated at
the last good cluster; an example is the cluster that points to
this bad/free cluster.

Checks to see if the file’s cluster chain is longer than indicated If the file’s cluster chain is longer than indicated by the size
by the size fields. fields, the file size is recalculated and the directory entry is
updated.

Checks to see if two or more files share the same cluster If two or more files are crosslinked, you are prompted to accept
(crosslinked). the repair, and one of the files is truncated.

Checks to see if the file’s cluster chain is shorter than is If the file’s cluster chain is shorter than is indicated by the size
indicated by the size fields. fields, the file size is recalculated and the directory entry is
updated.

Checks to see if there are any unused cluster chains. If unused cluster chains are found, new files are created and
linked to that file with the name fsck-start cluster

The table below lists the valid cluster numbers. Numbers other than those listed in the table below are
invalid numbers.

Table 27 Valid Cluster Numbers

Cluster FAT-12 FAT-16

Next entry in the chain 2-FEF 2-FFEF

Cisco IOS Configuration Fundamentals Command Reference

304
 F through K
fsck

Cluster FAT-12 FAT-16

Last entry in chain FF8-FFF FFF8-FFFF

Available cluster 0 0

Bad Cluster FF7 FFF7

Examples
Supported Platforms Other than the Cisco 7600 Series Router
The following example shows sample output from the fsck command in automatic mode:

Router# fsck /automatic disk1:

Proceed with the automatic mode? [yes] y
Checking the boot sector and partition table...
Checking FAT, Files and Directories...
Start cluster of file disk1:/file1 is invalid, removing file
File disk1:/file2 has a free/bad cluster, truncating...
File disk1:/file2 truncated.
File disk1:/file3 has a free/bad cluster, truncating...
File disk1:/file3 truncated.
File disk1:/file4 has a invalid cluster, truncating...
File disk1:/file4 truncated.
File disk1:/file5 has a invalid cluster, truncating...
File disk1:/file5 truncated.
File disk1:/file6 has a invalid cluster, truncating...
File disk1:/file6 truncated.
File size of disk1:/file7 is not correct, correcting it
File disk1:/file8 cluster chain has a loop, truncating it
File disk1:/file8 truncated.
File disk1:/file9 cluster chain has a loop, truncating it
File disk1:/file9 truncated.
File disk1:/file16 has a free/bad cluster, truncating...
File disk1:/file16 truncated.
File disk1:/file20 has a free/bad cluster, truncating...
File disk1:/file20 truncated.
Reclaiming unused space...
Created file disk1:/fsck-4 for an unused cluster chain
Created file disk1:/fsck-41 for an unused cluster chain
Created file disk1:/fsck-73 for an unused cluster chain
Created file disk1:/fsck-106 for an unused cluster chain
Created file disk1:/fsck-121 for an unused cluster chain
Created file disk1:/fsck-132 for an unused cluster chain
Created file disk1:/fsck-140 for an unused cluster chain
Created file disk1:/fsck-156 for an unused cluster chain
Created file disk1:/fsck-171 for an unused cluster chain
Created file disk1:/fsck-186 for an unused cluster chain
Created file disk1:/fsck-196 for an unused cluster chain
Created file disk1:/fsck-235 for an unused cluster chain
Created file disk1:/fsck-239 for an unused cluster chain
Updating FAT...
fsck of disk1: complete

Cisco 7600 Series Router

This example shows how to run a check of the current file system:

Router# fsck
Checking the boot sector and partition table...
Checking FAT, Files and Directories...
Files
1) disk0:/FILE3 and
2) disk0:/FILE2

Cisco IOS Configuration Fundamentals Command Reference

305
 F through K
fsck

have a common cluster.

Press 1/2 to truncate or any other character to ignore[confirm] q
Ignoring this error and continuing with the rest of the check...
Files
1) disk0:/FILE5 and
2) disk0:/FILE4
have a common cluster.
Press 1/2 to truncate or any other character to ignore[confirm] 1
File disk0:/FILE5 truncated.
Files
1) disk0:/FILE7 and
2) disk0:/FILE6
have a common cluster.
.
.
.
1) disk0:/FILE15 and
2) disk0:/FILE13
have a common cluster.
Press 1/2 to truncate or any other character to ignore[confirm] i
Ignoring this error and continuing with the rest of the check...
Reclaiming unused space...
Created file disk0:/fsck-11 for an unused cluster chain
Created file disk0:/fsck-20 for an unused cluster chain
Created file disk0:/fsck-30 for an unused cluster chain
Created file disk0:/fsck-35 for an unused cluster chain
Created file disk0:/fsck-40 for an unused cluster chain
Created file disk0:/fsck-46 for an unused cluster chain
Created file disk0:/fsck-55 for an unused cluster chain
Created file disk0:/fsck-62 for an unused cluster chain
Created file disk0:/fsck-90 for an unused cluster chain
Updating FAT...
fsck of disk0: complete

Related Commands Command Description

cd Changes the default directory or file system.

pwd Shows the current setting of the cd command.

Cisco IOS Configuration Fundamentals Command Reference

306
 F through K
full-help

full-help
To get help f or the full set of user-level commands, use the full-help command in line configuration mode.

full-help

Syntax Description This command has no arguments or keywords.

Command Default Disabled

Command Modes Line configuration

Command History Release Modification

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 full-help command enables (or disables) an unprivileged user to see all of the help messages available.
It is used with the show ? command.

Examples In the following example, the show ? command is used first with full-help disabled. Then full-help is
enabled for the line, and the show ? command is used again to demonstrate the additional help output that
is displayed.

Router> show ?
bootflash Boot Flash information
calendar Display the hardware calendar
clock Display the system clock
context Show context information
dialer Dialer parameters and statistics
history Display the session command history
hosts IP domain-name, lookup style, nameservers, and host table
isdn ISDN information
kerberos Show Kerberos Values
modemcap Show Modem Capabilities database
ppp PPP parameters and statistics
rmon rmon statistics
sessions Information about Telnet connections
snmp snmp statistics
terminal Display terminal configuration parameters
users Display information about terminal lines
version System hardware and software status

Cisco IOS Configuration Fundamentals Command Reference

307
 F through K
full-help

Router> enable
Password:<letmein>

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# line console 0
Router(config-line)# full-help
Router(config-line)# exit

Router#
%SYS-5-CONFIG_I: Configured from console by console
Router# disable
Router> show ?
access-expression List access expression
access-lists List access lists
aliases Display alias commands
apollo Apollo network information
appletalk AppleTalk information
arp ARP table
async Information on terminal lines used as router interfaces
bootflash Boot Flash information
bridge Bridge Forwarding/Filtering Database [verbose]
bsc BSC interface information
bstun BSTUN interface information
buffers Buffer pool statistics
calendar Display the hardware calendar
.
.
.
translate Protocol translation information
ttycap Terminal capability tables
users Display information about terminal lines
version System hardware and software status
vines VINES information
vlans Virtual LANs Information
whoami Info on current tty line
x25 X.25 information
xns XNS information
xremote XRemote statistics

Related Commands Command Description

help Displays a brief description of the help system.

Cisco IOS Configuration Fundamentals Command Reference

308
 F through K
help

help
To display a brief description of the help system, use the help command in any command mode.

help

Syntax Description This command has no arguments or keywords.

Command Default No default behavior or values.

Command Modes User EXEC

Privileged EXEC
All configuration modes

Command History Release Modification

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 help command provides a brief description of the context-sensitive help system, which functions as
follows:
• To list all commands available for a particular command mode, enter a question mark (?) at the system
prompt.
• To obtain a list of commands that begin with a particular character string, enter the abbreviated
command entry immediately followed by a question mark (?). This form of help is called word help ,
because it lists only the keywords or arguments that begin with the abbreviation you entered.
• To list the keywords and arguments associated with a command, enter a question mark (?) in place of a
keyword or argument on the command line. This form of help is called command syntax help , because
it lists the keywords or arguments that apply based on the command, keywords, and arguments you
have already entered.

Examples In the following example, the help command is used to display a brief description of the help system:

Router#
help
Help may be requested at any point in a command by entering

Cisco IOS Configuration Fundamentals Command Reference

309
 F through K
help

a question mark '?'. If nothing matches, the help list will

be empty and you must backup until entering a '?' shows the
available options.
Two styles of help are provided:
1. Full help is available when you are ready to enter a
command argument (e.g. 'show ?') and describes each possible
argument.
2. Partial help is provided when an abbreviated argument is entered
and you want to know what arguments match the input
(e.g. 'show pr?'.)

The following example shows how to use word help to display all the privileged EXEC commands that
begin with the letters “co.” The letters entered before the question mark are reprinted on the next command
line to allow the user to continue entering the command.

Router# co?
configure connect copy
Router# co

The following example shows how to use command syntax help to display the next argument of a partially
complete access-list command. One option is to add a wildcard mask. The <cr> symbol indicates that the
other option is to press Enter to execute the command without adding any more keywords or arguments.
The characters entered before the question mark are reprinted on the next command line to allow the user to
continue entering the command or to execute that command as it is.

Router(config)# access-list 99 deny 131.108.134.234 ?

A.B.C.D Mask of bits to ignore
<cr>
Router(config)# access-list 99 deny 131.108.134.234

Related Commands Command Description

full-help Enables help for the full set of user-level commands
for a line.

Cisco IOS Configuration Fundamentals Command Reference

310
 F through K
hidekeys

hidekeys
To suppress the display of password information in configuration log files, use the hidekeys command in
configuration change logger configuration mode. To allow the display of password information in
configuration log files, use the no form of this command.

hidekeys
no hidekeys

Syntax Description This command has no arguments or keywords.

Command Default Password information is displayed.

Command Modes Configuration change logger configuration

Command History Release Modification

12.3(4)T This command was introduced.

12.2(25)S This command was integrated into Cisco IOS

Release 12.2(25)S.

12.2(27)SBC This command was integrated into Cisco IOS

Release 12.2(27)SBC.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2(33)SB This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco
10000 series.

Usage Guidelines Enabling the hidekeys command increases security by preventing password information from being
displayed in configuration log files.

Examples The following example shows how to prevent password information from being displayed in configuration
log files:

Router# configure terminal

!

Cisco IOS Configuration Fundamentals Command Reference

311
 F through K
hidekeys

Router(config)# archive
Router(config-archive)# log config
Router(config-archive-log-config)# hidekey
s
Router(config-archive-log-config)# end

Related Commands Command Description

archive Enters archive configuration mode.

log config Enters configuration change logger configuration

mode.

logging enable Enables the logging of configuration changes.

logging size Specifies the maximum number of entries retained

in the configuration log.

notify syslog Enables the sending of notifications of

configuration changes to a remote syslog.

show archive log config Displays entries from the configuration log.

Cisco IOS Configuration Fundamentals Command Reference

312
 F through K
history

history
To enable the command history function, use the history command in line configuration mode. To disable
the command history function, use the no form of this command.

history
no history

Syntax Description This command has no arguments or keywords.

Command Default Enabled with ten command lines in the buffer.

Command Modes Line configuration

Command History Release Modification

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 command history function provides a record of EXEC commands that you have entered. This function
is particularly useful for recalling long or complex commands or entries, including access lists.
To change the number of command lines that the system will record in its history buffer, use the history
size line configuration command.
The history command enables the history function with the last buffer size specified or, if there was not a
prior setting, with the default of ten lines. The no history command disables the history function.
The show history EXEC command will list the commands you have entered, but you can also use your
keyboard to display individual commands. The table below lists the keys you can use to recall commands
from the command history buffer.

Cisco IOS Configuration Fundamentals Command Reference

313
 F through K
history

Table 28 History Keys

Key(s) Functions
Ctrl-P or Up Arrow2 Recalls commands in the history buffer in a
backward sequence, beginning with the most recent
command. Repeat the key sequence to recall
successively older commands.

Ctrl-N or Down Arrow1 Returns to more recent commands in the history

buffer after recalling commands with Ctrl-P or the
Up Arrow. Repeat the key sequence to recall
successively more recent commands.

Examples In the following example, the command history function is disabled on line 4:

Router(config)# line 4

Router(config-line)# no history

Related Commands Command Description

history size Sets the command history buffer size for a
particular line.

show history Lists the commands you have entered in the current
EXEC session.

terminal history Enables the command history function for the

current terminal session or changes the size of the
command history buffer for the current terminal
session.

2 The arrow keys function only with ANSI-compatible terminals.

Cisco IOS Configuration Fundamentals Command Reference

314
 F through K
history size

history size
To change the command history buffer size for a particular line, use the history size command in line
configuration mode. To reset the command history buffer size to ten lines, use the no form of this
command.

history size number-of-lines

no history size

Syntax Description number-of-lines Specifies the number of command lines that the
system will record in its history buffer. The range is
from 0 to 256. The default is 10.

Command Default 10 command lines

Command Modes Line configuration

Command History Release Modification

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 history size command should be used in conjunction with the history and show history commands.
The history command enables or disables the command history function. The show history command lists
the commands you have entered in the current EXEC session. The number of commands that the history
buffer will show is set by the history size command.

Note The history size command only sets the size of the buffer; it does not reenable the history function. If the
no history command is used, the history command must be used to reenable this function.

Examples The following example displays line 4 configured with a history buffer size of 35 lines:

Router(config)# line 4
Router(config-line)# history size 35

Cisco IOS Configuration Fundamentals Command Reference

315
 F through K
history size

Related Commands Command Description

history Enables or disables the command history function.

show history Lists the commands you have entered in the current
EXEC session.

terminal history size Enables the command history function for the
current terminal session or changes the size of the
command history buffer for the current terminal
session.

Cisco IOS Configuration Fundamentals Command Reference

316
 F through K
hold-character

hold-character
To define the local hold character used to pause output to the terminal screen, use the hold-character
command in line configuration mode. To restore the default, use the no form of this command.

hold-character ascii-number
no hold-character

Syntax Description ascii-number ASCII decimal representation of a character or

control sequence (for example, Ctrl-P).

Command Default No hold character is defined.

Command Modes Line configuration

Command History Release Modification

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 Break character is represented by zero; NULL cannot be represented. To continue the output, enter any
character after the hold character. To use the hold character in normal communications, precede it with the
escape character. See the “ASCII Character Set” appendix for a list of ASCII characters.

Examples The following example sets the hold character to Ctrl-S, which is ASCII decimal character 19:

Router(config)# line 8
Router(config-line)# hold-character 19

Related Commands Command Description

terminal hold-character Sets or changes the hold character for the current
session.

Cisco IOS Configuration Fundamentals Command Reference

317
 F through K
hold-character

Cisco IOS Configuration Fundamentals Command Reference

318
 F through K
hostname

hostname
To specify or modify the hostname for the network server, use the hostname command in global
configuration mode.

hostname name

Syntax Description name New hostname for the network server.

Command Default The default hostname is Router.

Command Modes Global configuration

Command History Release Modification

10.0 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2(33)SB This command was integrated into Cisco IOS

Release 12.2(33)SB.

12.2(33)SXI This command was integrated into Cisco IOS

Release 12.2(33)SXI.

Cisco IOS XE Release 2.5 This command was integrated into Cisco IOS XE
Release 2.5.

15.0(1)M4 This command was integrated into Cisco IOS

Release 15.0(1)M4 and support for numeric
hostnames added.

Usage Guidelines The hostname is used in prompts and default configuration filenames.
Do not expect case to be preserved. Uppercase and lowercase characters look the same to many internet
software applications. It may seem appropriate to capitalize a name the same way you might do in English,
but conventions dictate that computer names appear all lowercase. For more information, refer to RFC
1178, Choosing a Name for Your Computer .
The name must also follow the rules for ARPANET hostnames. They must start with a letter, end with a
letter or digit, and have as interior characters only letters, digits, and hyphens. Names must be 63 characters

Cisco IOS Configuration Fundamentals Command Reference

319
 F through K
hostname

or fewer. Creating an all numeric hostname is not recommended but the name will be accepted after an
error is returned.

Router(config)#hostname 123
% Hostname contains one or more illegal characters.
123(config)#

A hostname of less than 10 characters is recommended. For more information, refer to RFC 1035, Domain
Names--Implementation and Specification .
On most systems, a field of 30 characters is used for the hostname and the prompt in the CLI. Note that the
length of your hostname may cause longer configuration mode prompts to be truncated. For example, the
full prompt for service profile configuration mode is:

(config-service-profile)#

However, if you are using the hostname of “Router,” you will only see the following prompt (on most
systems):

Router(config-service-profil)#

If the hostname is longer, you will see even less of the prompt:

Basement-rtr2(config-service)#

Keep this behavior in mind when assigning a name to your system (using the hostname global
configuration command). If you expect that users will be relying on mode prompts as a CLI navigation aid,
you should assign hostnames of no more than nine characters.
The use of a special character such as '\'(backslash) and a three or more digit number for the character
setting like hostname, results in incorrect translation:

Router(config)#
Router(config)#hostname \99
% Hostname contains one or more illegal characters.

Examples The following example changes the hostname to “host1”:

Router(config)# hostname host1

host1(config)#

Related Commands Command Description

setup Enables you to make major changes to your
configurations, for example, adding a protocol suit,
making major addressing scheme changes, or
configuring newly installed interfaces.

Cisco IOS Configuration Fundamentals Command Reference

320
 F through K
hw-module reset

hw-module reset
To reset a module by turning the power off and then on, use the hw-module reset command in privileged
EXEC mode.

hw-module module num reset

Syntax Description module num Applies the command to a specific module; see the
“Usage Guidelines” section for valid values.

Command Default This command has no default settings.

Command Modes Privileged EXEC

Command History Release Modification

12.2(14)SX This command was introduced on the Supervisor
Engine 720.

12.2(17d)SXB This command on the Supervisor Engine 2 was

extended to Release 12.2(17d)SXB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2(31)SB2 This command was integrated into Cisco IOS

12.2(31)SB2.

Usage Guidelines The num argument designates the module number. Valid values depend on the chassis that is used. For
example, if you have a 13-slot chassis, valid values for the module number are from 1 to 13.

Examples This example shows how to reload a specific module:

Router#
hw-module module 3 reset

Cisco IOS Configuration Fundamentals Command Reference

321
 F through K
hw-module shutdown

hw-module shutdown
To shut down the module, use the hw-module shutdown command in privileged EXEC mode.

hw-module module num shutdown

Syntax Description module num Applies the command to a specific module; see the
“Usage Guidelines” section for valid values.

Command Default This command has no default settings.

Command Modes Privileged EXEC

Command History Release Modification

12.2(14)SX Support for this command was introduced on the
Supervisor Engine 720.

12.2(17d)SXB Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command is supported on the SSL Services Module and the NAM.
If you enter the hw-module shutdowncommand to shut down the module, you will have to enter the no
power enable module command and the power enable module command to restart (power down and then
power up) the module.

Examples This example shows how to shut down and restart the module:

Router# hw-module module 3 shutdown

Router# no power enable module 3
Router# power enable module 3

Cisco IOS Configuration Fundamentals Command Reference

322
 F through K
insecure

insecure
To configure a line as insecure, use the insecure command in line configuration mode. To disable this
function, use the no form of this command.

insecure
no insecure

Syntax Description This command has no arguments or keywords.

Command Default Disabled

Command Modes Line configuration

Command History Release Modification

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 identify a modem line as insecure for DEC local area transport (LAT) classification.

Examples In the following example, line 10 is configured as an insecure dialup line:

Router(config)# line 10
Router(config-line)# insecure

Cisco IOS Configuration Fundamentals Command Reference

323
 F through K
international

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 (^[), use the international command in line configuration mode. To
display characters in 7-bit format, use the no form of this command.

international
no international

Syntax Description This command has no arguments or keywords.

Command Default Disabled

Command Modes Line configuration

Command History Release Modification

11.3 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines If you are configuring a Cisco IOS platform using the Cisco web browser user interface (UI), this function
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:

line vty 4
international

Cisco IOS Configuration Fundamentals Command Reference

324
 F through K
international

Related Commands Command Description

terminal international Prints the Escape character as a single character
instead of as the caret and bracket symbols (^[) for
a current Telnet session in instances when you are
using Telnet to access a Cisco IOS platform and
you want to display 8-bit and multibyte
international characters (for example, Kanji).

Cisco IOS Configuration Fundamentals Command Reference

325
 F through K
ip bootp server

ip bootp server
To enable the Bootstrap Protocol (BOOTP) service on your routing device, use the ip bootp server
command in global configuration mode. To disable BOOTP services, use the no form of the command.

ip bootp server
no ip bootp server

Syntax Description This command has no arguments or keywords.

Command Default Enabled

Command Modes Global configuration

Command History Release Modification

11.2 This command was introduced.

12.0(1)T The DHCP relay agent and DHCP server features

were introduced. BOOTP forwarding is now
handled by the DHCP relay agent implementation.

12.2(8)T The ip dhcp bootp ignore command was

introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines By default, the BOOTP service is enabled. When disabled, the no ip bootp server command will appear in
the configuration file.
The integrated Dynamic Host Configuration Protocol (DHCP) server was introduced in Cisco IOS Release
12.0(1)T. Because DHCP is based on BOOTP, both of these services share the “well-known” UDP server
port of 67 (per RFC 951, RFC 1534, and RFC 2131; the client port is 68). To disable DHCP services
(DHCP relay and DHCP server), use the no service dhcp command. To disable BOOTP services (in
releases 12.2(8)T and later), but leave DHCP services enabled, use the ip dhcp bootp ignore command.
If both the BOOTP server and DHCP server are disabled, “ICMP port unreachable” messages will be sent
in response to incoming requests on port 67, and the original incoming packet will be discarded. If DHCP
is enabled, using the no ip bootp server command by itself will not stop the router from listening on UDP
port 67.

Cisco IOS Configuration Fundamentals Command Reference

326
 F through K
ip bootp server

Note As with all minor services, the async line BOOTP service should be disabled on your system if you do not
have a need for it in your network. Any network device that has User Data Protocol (UDP), TCP, BOOTP,
DHCP, or Finger services should be protected by a firewall or have the services disabled to protect against
Denial of Service attacks.

Examples In the following example, BOOTP and DHCP services are disabled on the router:

Router(config)# no ip bootp server

Router(config)# no service dhcp

Related Commands Command Description

ip dhcp bootp ignore Configures the Cisco IOS DHCP server to
selectively ignore and not reply to received
Bootstrap Protocol (BOOTP) request packets,
allowing you continue using DHCP while disabling
BOOTP.

service dhcp Enables the Cisco IOS Dynamic Host

Configuration Protocol (DHCP) server and relay
agent features.

Cisco IOS Configuration Fundamentals Command Reference

327
 F through K
ip finger

ip finger
To configure a system to accept Finger protocol requests (defined in RFC 742), use the ip finger command
in global configuration mode. To disable this service, use the noform of this command.

ip finger [rfc-compliant]
no ip finger

Syntax Description rfc-compliant (Optional) Configures the system to wait for

“Return” or “/W” input when processing Finger
requests. This keyword should not be used for those
systems.

Command Default Disabled

Command Modes Global configuration

Command History Release Modification

11.3 This command was introduced.

12.1(5), 12.1(5)T This command was changed from being enabled by

default to being disabled by default.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The Finger service allows remote users to view the output equivalent to the show users [wide] command.
When ip finger is configured, the router will respond to a telnet a.b.c.d finger command from a remote
host by immediately displaying the output of the show userscommand and then closing the connection.
When the ip finger rfc-compliantcommandis configured, the router will wait for input before displaying
anything (as required by RFC 1288). The remote user can then enter the Return key to display the output of
the show users EXEC command, or enter /W to display the output of the show users wide EXEC
command. After this information is displayed, the connection is closed.

Cisco IOS Configuration Fundamentals Command Reference

328
 F through K
ip finger

Note As with all minor services, the Finger service should be disabled on your system if you do not have a need
for it in your network. Any network device that has UDP, TCP, BOOTP, or Finger services should be
protected by a firewall or have the services disabled to protect against Denial of Service attacks.

Because of the potential for hung lines, the rfc-compliantform of this command should not be configured
for devices with more than 20 simultaneous users.

Examples The following example disables the Finger protocol:

Router(config)# no ip finger

Cisco IOS Configuration Fundamentals Command Reference

329
 F through K
ip ftp passive

ip ftp passive
To configure the router to use only passive FTP connections, use the ip ftp passivecommand in global
configuration mode . To allow all types of FTP connections, use the noform of this command.

ip ftp passive
no ip ftp passive

Syntax Description This command has no arguments or keywords.

Command Default All types of FTP connections are allowed.

Command Modes Global configuration

Command History Release Modification

10.3 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Examples In the following example, the router is configured to use only passive FTP connections:

Router(config)# ip ftp passive

Related Commands Command Description

ip ftp password Specifies the password to be used for FTP
connections.

ip ftp source-interface Specifies the source IP address for FTP

connections.

ip ftp username Configures the username for FTP connections.

Cisco IOS Configuration Fundamentals Command Reference

330
 F through K
ip ftp password

ip ftp password
To specify the password to be used for File Transfer Protocol (FTP) connections, use the ip ftp
passwordcommand in global configuration mode. To return the password to its default, use the no form of
this command.

ip ftp password [type] password

no ip ftp password

Syntax Description type (Optional) Type of encryption to use on the

password. A value of 0 disables encryption. A value
of 7 indicates proprietary encryption.

password Password to use for FTP connections.

Command Default The router forms a password [email protected]. The variable username is the username
associated with the current session, routername is the configured host name, and domain is the domain of
the router.

Command Modes Global configuration

Command History Release Modification

10.3 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Examples The following example configures the router to use the username “red” and the password “blue” for FTP
connections:

Router(config)# ip ftp username red

Router(config)# ip ftp password blue

Cisco IOS Configuration Fundamentals Command Reference

331
 F through K
ip ftp password

Related Commands Command Description

ip ftp password Specifies the password to be used for FTP
connections.

ip ftp source-interface Specifies the source IP address for FTP

connections.

ip ftp username Configures the username for FTP connections.

Cisco IOS Configuration Fundamentals Command Reference

332
 F through K
ip ftp source-interface

ip ftp source-interface
To specify the source IP address for File Transfer Protocol (FTP) connections, use the ip ftp source-
interfacecommand in global configuration mode. To use the address of the interface where the connection
is made, use the no form of this command.

ip ftp source-interface interface-type interface-number

no ip ftp source-interface

Syntax Description interface-type interface-number The interface type and number to use to obtain the
source address for FTP connections.

Command Default The FTP source address is the IP address of the interface that the FTP packets use to leave the router.

Command Modes Global configuration (config)

Command History Release Modification

10.3 This command was introduced.

12.3(6) Destination address lookup in a Virtual Private

Network (VPN) routing and forwarding (VRF)
table was added for the transfer of FTP packets.

12.3(8)T This command was integrated into Cisco IOS

Release 12.3(8)T.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Use this command to set the same source address for all FTP connections.
In Cisco IOS 12.3(6) and later releases, FTP is VRF-aware, which means that FTP transfer is supported
across an interface within a VRF instance. To specify a VRF as a source for FTP connections, the VRF
must be associated with the same interface that you configure with the ip ftp source-interface command.
In this configuration, FTP looks for the destination IP address for file transfer in the specified VRF table. If
the specified source interface is not up, Cisco IOS software selects the address of the interface closest to the
destination as the source address.

Cisco IOS Configuration Fundamentals Command Reference

333
 F through K
ip ftp source-interface

Examples The following example shows how to configure the router to use the IP address associated with Ethernet
interface 0 as the source address on all FTP packets, regardless of which interface is actually used to send
the packet:

Router> enable
Router# configure terminal
Router(config)# ip ftp source-interface ethernet 0

The following example shows how to configure the router to use the VRF table named vpn1 to look for the
destination IP address for the transfer of FTP packets:

Router# configure terminal

Router(config)# ip ftp source-interface ethernet 0
Router(config)# ip vrf vpn1
Router(config-vrf)# rd 200:1
Router(config-vrf)# route-target both 200:1
Router(config-vrf)# interface ethernet 0
Router(config-if)# ip vrf forwarding vpn1
Router(config-if)# end

Related Commands Command Description

ip ftp passive Configures the router to use only passive FTP
connections.

ip ftp password Specifies the password to be used for FTP

connections.

ip ftp username Configures the username for FTP connections.

Cisco IOS Configuration Fundamentals Command Reference

334
 F through K
ip ftp username

ip ftp username
To configure the username for File Transfer Protocol (FTP) connections, use the ip ftp usernamecommand
in global configuration mode . To configure the router to attempt anonymous FTP, use the noform of this
command.

ip ftp username username

no ip ftp username

Syntax Description username Username for FTP connections.

Command Default The Cisco IOS software attempts an anonymous FTP.

Command Modes Global configuration

Command History Release Modification

10.3 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The remote username must be associated with an account on the destination server.

Examples In the following example, the router is configured to use the username “red” and the password “blue”for
FTP connections:

Router(config)# ip ftp username red

Router(config)# ip ftp password blue

Related Commands Command Description

ip ftp passive Configures the router to use only passive FTP
connections.

Cisco IOS Configuration Fundamentals Command Reference

335
 F through K
ip ftp username

Command Description
ip ftp password Specifies the password to be used for FTP
connections.

ip ftp source-interface Specifies the source IP address for FTP

connections.

Cisco IOS Configuration Fundamentals Command Reference

336
 F through K
ip rarp-server

ip rarp-server
To enable the router to act as a Reverse Address Resolution Protocol (RARP) server, use the ip rarp-
server command in interface configuration mode. To restore the interface to the default of no RARP server
support, use the noform of this command.

ip rarp-server ip-address
no ip rarp-server ip-address

Syntax Description ip-address IP address that is to be provided in the source

protocol address field of the RARP response
packet. Normally, this is set to whatever address
you configure as the primary address for the
interface.

Command Default Disabled

Command Modes Interface configuration

Command History Release Modification

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 feature makes diskless booting of clients possible between network subnets where the client and server
are on separate subnets.
RARP server support is configurable on a per-interface basis, so that the router does not interfere with
RARP traffic on subnets that need no RARP assistance.
The Cisco IOS software answers incoming RARP requests only if both of the following two conditions are
met:
• The ip rarp-server command has been configured for the interface on which the request was received.
• A static entry is found in the IP ARP table that maps the MAC address contained in the RARP request
to an IP address.
Use the show ip arp EXEC command to display the contents of the IP ARP cache.
Sun Microsystems, Inc. makes use of RARP and UDP-based network services to facilitate network-based
booting of SunOS on it’s workstations. By bridging RARP packets and using both the ip helper-address

Cisco IOS Configuration Fundamentals Command Reference

337
 F through K
ip rarp-server

interface configuration command and the ip forward-protocol global configuration command, the Cisco
IOS software shouldbe able to perform the necessary packet switching to enable booting of Sun
workstations across subnets. Unfortunately, some Sun workstations assume that the sender of the RARP
response, in this case the router, is the host that the client can contact to TFTP load the bootstrap image.
This causes the workstations to fail to boot.
By using the ip rarp-server command, the Cisco IOS software can be configured to answer these RARP
requests, and the client machine should be able to reach its server by having its TFTP requests forwarded
through the router that acts as the RARP server.
In the case of RARP responses to Sun workstations attempting to diskless boot, the IP address specified in
the ip rarp-server interface configuration command should be the IP address of the TFTP server. In
addition to configuring RARP service, the Cisco IOS software must be configured to forward UDP-based
Sun portmapper requests to completely support diskless booting of Sun workstations. This can be
accomplished using configuration commands of the following form:

ip forward-protocol udp 111

interface
interface name
ip helper-address
target-address

RFC 903 documents the RARP.

Examples The following partial example configures a router to act as a RARP server. The router is configured to use
the primary address of the specified interface in its RARP responses.

arp 172.30.2.5 0800.2002.ff5b arpa

interface ethernet 0
ip address 172.30.3.100 255.255.255.0
ip rarp-server 172.30.3.100

In the following example, a router is configured to act as a RARP server, with TFTP and portmapper
requests forwarded to the Sun server:

! Allow the router to forward broadcast portmapper requests

ip forward-protocol udp 111
! Provide the router with the IP address of the diskless sun
arp 172.30.2.5 0800.2002.ff5b arpa
interface ethernet 0
! Configure the router to act as a RARP server, using the Sun Server's IP
! address in the RARP response packet.
ip rarp-server 172.30.3.100
! Portmapper broadcasts from this interface are sent to the Sun Server.
ip helper-address 172.30.3.100

Related Commands Command Description

ip forward-protocol Speeds up flooding of UDP datagrams using the
spanning-tree algorithm.

ip helper-address Forwards UDP broadcasts, including BOOTP,

received on an interface.

Cisco IOS Configuration Fundamentals Command Reference

338
 F through K
ip rcmd domain-lookup

ip rcmd domain-lookup
To reena ble the basic Domain Name Service (DNS) security check for rcp and rsh, use the ip rcmd
domain-lookupcommand in global configuration mode. T o disable the basic DNS security check for
remote copy protocol (rcp) and remote shell protoco (rsh), use the no form of this command.

ip rcmd domain-lookup
no ip rcmd domain-lookup

Syntax Description This command has no arguments or keywords.

Command Default Enabled

Command Modes Global configuration

Command History Release Modification

10.3 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The abbreviation RCMD (remote command) is used to indicate both rsh and rcp.
DNS lookup for RCMD is enabled by default (provided general DNS services are enabled on the system
using the ip domain-lookupcommand).
The no ip rcmd domain-lookup command is used to disable the DNS lookup for RCMD. The ip rcmd
domain-lookup command is used to reenable the DNS lookup for RCMD.
DNS lookup for RCMD is performed as a basic security check. This check is performed using a host
authentication process. When enabled, the system records the address of the requesting client. That address
is mapped to a host name using DNS. Then a DNS request is made for the IP address for that host name.
The IP address received is then checked against the original requesting address. If the address does not
match with any of the addresses received from DNS, the RCMD request will not be serviced.
This reverse lookup is intended to help protect against spoofing. However, please note that the process only
confirms that the IP address is a valid “routable” address; it is still possible for a hacker to spoof the valid
IP address of a known host.
The DNS lookup is done after the TCP handshake but before the router (which is acting as a rsh/rcp server)
sends any data to the remote client.
The no ip rcmd domain-lookup will turn off DNS lookups for rsh and rcp only. The no ip domain-
lookup command takes precedence over the ip rcmd domain-lookupcommand. This means that if the no

Cisco IOS Configuration Fundamentals Command Reference

339
 F through K
ip rcmd domain-lookup

ip domain-lookup command is in the current configuration, DNS will be bypassed for rcp and rsh even if
the ip rcmd domain-lookup command is enabled.

Examples In the following example, the DNS security check is disabled for RCMD (rsh/rcp):

Router(config)# no ip rcmd domain-lookup

Related Commands Command Description

ip domain-lookup Enables the IP DNS-based host name-to-address
translation.

Cisco IOS Configuration Fundamentals Command Reference

340
 F through K
ip rcmd rcp-enable

ip rcmd rcp-enable
To configure the Cisco IOS software to allow remote users to copy files to and from the router using
remote copy protocol (rcp), use the ip rcmd rcp-enable command in global configuration mode. To
disable rcp on the device, use the no form of this command.
ip rcmd rcp-enable
no ip rcmd rcp-enable

Syntax Description This command has no arguments or keywords.

Command Default To ensure security, the router is not enabled for rcp by default.

Command Modes Global configuration

Command History Release Modification

10.3 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines To allow a remote user to execute rcp commands on the router, you must also create an entry for the remote
user in the local authentication database using the ip rcmd remote-host command.
The no ip rcmd rcp-enable command does not prohibit a local user from using rcp to copy system images
and configuration files to and from the router.
To protect against unauthorized users copying the system image or configuration files, the router is not
enabled for rcp by default.

Examples In the following example, the rcp service is enabled on the system, the IP address assigned to the
Loopback0 interface is used as the source address for outbound rcp and rsh packets, and access is granted
to the user “netadmin3”on the remote host 172.16.101.101:
Router(config)# ip rcmd rcp-enable

Router(config)# ip rcmd source-interface Loopback0

Router(config)# ip rcmd remote-host router1 172.16.101.101 netadmin3

Cisco IOS Configuration Fundamentals Command Reference

341
 F through K
ip rcmd rcp-enable

Related Commands Command Description

ip rcmd remote-host Creates an entry for the remote user in a local
authentication database so that remote users can
execute commands on the router using rsh or rcp.

Cisco IOS Configuration Fundamentals Command Reference

342
 F through K
ip rcmd remote-host

ip rcmd remote-host
To create an entry for the remote user in a local authentication database so that remote users can execute
commands on the router using remote shell protocol (rsh) or remote copy protocol (rcp), use the ip rcmd
remote-host command in global configuration mode. To remove an entry for a remote user from the local
authentication database, use the no form of this command.

ip rcmd remote-host local-username {ip-address | host-name} remote-username [enable [level]]

no ip rcmd remote-host local-username {ip-address | host-name} remote-username [enable [level]]

Syntax Description local-username Name of the user on the local router. You can
specify the router name as the username. This name
needs to be communicated to the network
administrator or to the user on the remote system.
To be allowed to remotely execute commands on
the router, the remote user must specify this value
correctly.

ip-address IP address of the remote host from which the local

router will accept remotely executed commands.
Either the IP address or the host name is required.

host-name Name of the remote host from which the local

router will accept remotely executed commands.
Either the host name or the IP address is required.

remote-username Name of the user on the remote host from which the
router will accept remotely executed commands.

enable [level] (Optional) Enables the remote user to execute

privileged EXEC commands using rsh or to copy
files to the router using rcp. The range is from 1 to
15. The default is 15. For information on the enable
level, refer to the privilege level global
configuration command in the Release 12.2 Cisco
IOS Security Command Reference.

Command Default No entries are in the local authentication database.

Command Modes Global configuration

Cisco IOS Configuration Fundamentals Command Reference

343
 F through K
ip rcmd remote-host

Command History Release Modification

10.3 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines A TCP connection to a router is established using an IP address. Using the host name is valid only when
you are initiating an rcp or rsh command from a local router. The host name is converted to an IP address
using DNS or host-name aliasing.
To allow a remote user to execute rcp or rsh commands on a local router, you must create an entry for the
remote user in the local authentication database. You must also enable the router to act as an rsh or rcp
server.
To enable the router to act as an rsh server, issue the ip rcmd rsh-enable command. To enable the router to
act as an rcp server, issue the ip rcmd rcp-enable command.The router cannot act as a server for either of
these protocols unless you explicitly enable the capacity.
A local authentication database, which is similar to a UNIX .rhosts file, is used to enforce security on the
router through access control. Each entry that you configure in the authentication database identifies the
local user, the remote host, and the remote user. To permit a remote user of rsh to execute commands in
privileged EXEC mode or to permit a remote user of rcp to copy files to the router, specify the enable
keyword and level. For information on the enable level, refer to the privilege level global configuration
command in the Release 12.2 Cisco IOS Security Command Reference.
An entry that you configure in the authentication database differs from an entry in a UNIX .rhostsfile in the
following aspect. Because the .rhosts file on a UNIX system resides in the home directory of a local user
account, an entry in a UNIX .rhosts file need not include the local username; the local username is
determined from the user account. To provide equivalent support on a router, specify the local username
along with the remote host and remote username in each authentication database entry that you configure.
For a remote user to be able to execute commands on the router in its capacity as a server, the local
username, host address or name, and remote username sent with the remote client request must match
values configured in an entry in the local authentication file.
A remote client host should be registered with DNS. The Cisco IOS software uses DNS to authenticate the
remote host’s name and address. Because DNS can return several valid IP addresses for a host name, the
Cisco IOS software checks the address of the requesting client against all of the IP addresses for the named
host returned by DNS. If the address sent by the requester is considered invalid, that is, it does not match
any address listed with DNS for the host name, then the software will reject the remote-command execution
request.
Note that if no DNS servers are configured for the router, then that device cannot authenticate the host in
this manner. In this case, the Cisco IOS software sends a broadcast request to attempt to gain access to
DNS services on another server. If DNS services are not available, you must use the no ip domain-lookup
command to disable the attempt to gain access to a DNS server by sending a broadcast request.
If DNS services are not available and, therefore, you bypass the DNS security check, the software will
accept the request to remotely execute a command only if all three values sent with the request match
exactly the values configured for an entry in the local authentication file.

Cisco IOS Configuration Fundamentals Command Reference

344
 F through K
ip rcmd remote-host

Examples The following example allows the remote user named netadmin3 on a remote host with the IP address
172.16.101.101 to execute commands on router1 using the rsh or rcp protocol. User netadmin3 is allowed
to execute commands in privileged EXEC mode.

Router(config)# ip rcmd remote-host router1 172.16.101.101 netadmin3 enable

Related Commands Command Description

ip rcmd rcp-enable Configures the Cisco IOS software to allow remote
users to copy files to and from the router.

ip domain-lookup Enables the IP DNS-based host name-to-address

translation.

ip rcmd rsh-enable Configures the router to allow remote users to

execute commands on it using the rsh protocol.

Cisco IOS Configuration Fundamentals Command Reference

345
 F through K
ip rcmd remote-username

ip rcmd remote-username
To configure the remote username to be used when requesting a remote copy using remote copy protocol
(rcp), use the ip rcmd remote-usernamecommand in global configuration mode . To remove from the
configuration the remote username, use the noform of this command.

ip rcmd remote-username username

no ip rcmd remote-username username

Syntax Description username Name of the remote user on the server. This name
is used for rcp copy requests. All files and images
to be copied are searched for or written relative to
the directory of the remote user’s account, if the
server has a directory structure, for example, as do
UNIX systems.

Command Default If you do not issue this command, the Cisco IOS software sends the remote username associated with the
current tty process, if that name is valid, for rcp copy commands. For example, if the user is connected to
the router through Telnet and the user was authenticated through the usernamecommand, then the software
sends that username as the remote username.

Note The remote username must be associated with an account on the destination server.

If the username for the current tty process is not valid, the Cisco IOS software sends the host name as the
remote username. For rcp boot commands, the Cisco IOS software sends the access server host name by
default.

Note For Cisco, tty lines are commonly used for access services. The concept of tty originated with UNIX. For
UNIX systems, each physical device is represented in the file system. Terminals are called tty devices (tty
stands for teletype, the original UNIX terminal).

Command Modes Global configuration

Command History Release Modification

10.3 This command was introduced.

Cisco IOS Configuration Fundamentals Command Reference

346
 F through K
ip rcmd remote-username

Release Modification
12.2(33)SRA This command was integrated into Cisco IOS
Release 12.2(33)SRA.

Usage Guidelines The rcp protocol requires that a client send the remote username on an rcp request to the server. Use this
command to specify the remote username to be sent to the server for an rcp copy request. If the server has a
directory structure, as do UNIX systems, all files and images to be copied are searched for or written
relative to the directory of the remote user’s account.

Note Cisco IOS Release 10.3 added the ip keyword to rcmd commands. If you are upgrading from Release 10.2
to Release 10.3 or a later release, this keyword is automatically added to any rcmd commands you have in
your Release 10.2 configuration files.

Examples The following example configures the remote username to netadmin1:

Router(config)# ip rcmd remote-username netadmin1

Related Commands Command Description

boot network rcp Changes the default name of the network
configuration file from which to load configuration
commands.

boot system rcp Specifies the system image that the router loads at
startup.

bridge acquire Forwards any frames for stations that the system
has learned about dynamically.

copy Copies any file from a source to a destination.

Cisco IOS Configuration Fundamentals Command Reference

347
 F through K
ip rcmd rsh-enable

ip rcmd rsh-enable
To configure the router to allow remote users to execute commands on it using remote shell protocol (rsh),
use the ip rcmd rsh-enable command in global configuration mode. To disable a router that is enabled for
rsh, use the no form of this command.

ip rcmd rsh-enable
no ip rcmd rsh-enable

Syntax Description This command has no arguments or keywords.

Command Default To ensure security, the router is not enabled for rsh by default.

Command Modes Global configuration

Command History Release Modification

10.3 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines rsh, used as a client process, gives users the ability to remotely get router information (such as status)
without the need to connect into the router and then disconnect. This is valuable when looking at many
statistics on many different routers.
Use this command to enable the router to receive rsh requests from remote users. In addition to issuing this
command, you must create an entry for the remote user in the local authentication database to allow a
remote user to execute rsh commands on the router.
The no ip rcmd rsh-enable command does not prohibit a local user of the router from executing a
command on other routers and UNIX hosts on the network using rsh. The no form of this command only
disables remote access to rsh on the router.

Examples The following example enables a router as an rsh server:

Router(config)# ip rcmd rsh-enable

Cisco IOS Configuration Fundamentals Command Reference

348
 F through K
ip rcmd rsh-enable

Related Commands Command Description

ip rcmd remote-host Creates an entry for the remote user in a local
authentication database so that remote users can
execute commands on the router using rsh or rcp.

Cisco IOS Configuration Fundamentals Command Reference

349
 F through K
ip rcmd source-interface

ip rcmd source-interface
To force remote copy protocol (rcp) or remote shell protocol (rsh) to use the IP address of a specified
interface for all outgoing rcp/rsh communication packets, use the ip rcmd source-interface command in
global configuration mode. To disable a previously configured ip rcmd source-interface command, use
the no form of this command.
ip rcmd source-interface interface-id
no ip rcmd source-interface interface-id

Syntax Description interface-id The name and number used to identify the
interface. For example, Loopback2.

Command Default The address of the interface closest to the destination is used as the source interface for rcp/rsh
communications.

Command Modes Global configuration

Command History Release Modification

11.3 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines If this command is not used, or if the interface specified in this command is not available (not up), the
Cisco IOS software uses the address of the interface closest to the destination as the source address.
Use this command to force the system to tag all outgoing rcp/rsh packets with the IP address associated
with the specified interface. This address is used as the source address as long as the interface is in the up
state.
This command is especially useful in cases where the router has many interfaces, and you want to ensure
that all rcp and/or rsh packets from this router have the same source IP address. A consistent address is
preferred so that the other end of the connection (the rcp/rsh server or client) can maintain a single session.
The other benefit of a consistent address is that an access list can be configured on the remote device.
The specified interface must have an IP address associated with it. If the specified interface does not have
an IP address or is in a down state, then rcp/rsh reverts to the default. To avoid this, add an IP address to the
subinterface or bring the interface to the up state.

Cisco IOS Configuration Fundamentals Command Reference

350
 F through K
ip rcmd source-interface

Examples In the following example, Loopback interface 0 is assigned an IP address of 220.144.159.200, and the ip
rcmd source-interface command is used to specify that the source IP address for all rcp/rsh packets will be
the IP address assigned to the Loopback0 interface:
interface Loopback0
description Loopback interface
ip address 220.144.159.200 255.255.255.255
no ip directed-broadcast
!
.
.
.
clock timezone GMT 0
ip subnet-zero
no ip source-route
no ip finger
ip rcmd source-interface Loopback0
ip telnet source-interface Loopback0
ip tftp source-interface Loopback0
ip ftp source-interface Loopback0
ip ftp username cisco
ip ftp password shhhhsecret
no ip bootp server
ip domain-name net.galaxy
ip name-server 220.144.159.1
ip name-server 220.144.159.2
ip name-server 219.10.2.1
!

.
.
.

Related Commands Command Description

ip rcmd remote-host Creates an entry for the remote user in a local
authentication database so that remote users can
execute commands on the router using rsh or rcp.

Cisco IOS Configuration Fundamentals Command Reference

351
 F through K
ip telnet source-interface

ip telnet source-interface
To specify the IP address of an interface as the source address for Telnet connections, use the ip telnet
source-interface command in global configuration mode. To reset the source address to the default for
each connection, use the no form of this command.

ip telnet source-interface interface

no ip telnet source-interface

Syntax Description interface The interface whose address is to be used as the

source for Telnet connections.

Command Default The address of the closest interface to the destination is the source address.

Command Modes Global configuration

Command History Release Modification

11.1 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 set the IP address of an interface as the source for all Telnet connections.
If the specified interface is not up, the Cisco IOS software selects the address of the interface closest to the
destination as the source address.

Examples The following example forces the IP address for Ethernet interface 1 as the source address for Telnet
connections :

Router(config)# ip telnet source-interface Ethernet1

Cisco IOS Configuration Fundamentals Command Reference

352
 F through K
ip telnet source-interface

Related Commands Command Description

ip radius source-interface Forces RADIUS to use the IP address of a specified
interface for all outgoing RADIUS packets.

Cisco IOS Configuration Fundamentals Command Reference

353
 F through K
ip tftp blocksize

ip tftp blocksize
To negotiate a transfer TFTP blocksize, use the ip tftp blocksizecommand in global configuration mode.
To disable this configuration, use the no form of this command.

ip tftp blocksize bytes

no ip tftp blocksize

Syntax Description bytes The size in bytes of the TFTP block from 512 to
8192.

Command Default The default TFTP blocksize is 512 bytes.

Command Modes Global configuration (config)

Command History Release Modification

12.2S This command was introduced for the 12.2S
releases.

15.1(1)SG This command was integrated into the 15.1(1)SG

releases.

Examples The following example shows how to set a 1024 byte TFTP blocksize:

Router> enable
Router# configure terminal
Router(config)# ip tftp bblocksize 1024

Related Commands Command Description

ip tftp min-timeout Specifies the minimum timeout period for
retransmission of data.

Cisco IOS Configuration Fundamentals Command Reference

354
 F through K
ip tftp boot-interface

ip tftp boot-interface
To use an interface for TFTP booting, use the ip tftp boot-interfacecommand in global configuration
mode. To disable this configuration, use the no form of this command.

ip tftp boot-interface type number

no ip tftp boot-interface

Syntax Description type The type of the interface to be used. You can
choose from a list of interfaces.

number The related interface number. Each interface has a

related range of numbers. For example, the Virtual
Multipoint Interface has a range of interface
numbers from 1 to 2147483647.

Command Default No interface is used for TFTP booting.

Command Modes Global configuration (config)

Command History Release Modification

15.0(1)M This command was introduced in a release earlier
than Cisco IOS 15.0(1)M.

Examples The following example shows how to ensure that an interface is used for TFTP booting:

Router> enable
Router# configure terminal
Router(config)# ip tftp boot-interface

Related Commands Command Description

ip tftp min-timeout Specifies the minimum timeout period for
retransmission of data.

Cisco IOS Configuration Fundamentals Command Reference

355
 F through K
ip tftp min-timeout

ip tftp min-timeout
To specify the minimum timeout period for retransmission of data using TFTP, use the ip tftp min-
timeoutcommand in global configuration mode. To disable, use the no form of this command.

ip tftp min-timeout seconds

no ip tftp min-timeout

Syntax Description seconds Specifies the timeout value, in seconds. The range
is from 4 to 20.

Command Default The default minimum timeout period for retransmission of data is 4 seconds.

Command Modes Global configuration (config)

Command History Release Modification

15.0(1)M This command was introduced in a release earlier
than Cisco IOS 15.0(1)M.

Examples The following example shows how to specify the minimum timeout period for retransmission of data as 5
seconds:

Router> enable
Router# configure terminal
Router(config)# ip tftp min-timeout 5

Related Commands Command Description

ip tftp boot-interface Ensures that an interface is used for TFTP booting.

Cisco IOS Configuration Fundamentals Command Reference

356
 F through K
ip tftp source-interface

ip tftp source-interface
To specify the IP address of an interface as the source address for TFTP connections, use the ip tftp
source-interface command in global configuration mode. To return to the default, use the no form of this
command.
ip tftp source-interface interface-type interface-number
no ip tftp source-interface

Syntax Description interface-type interface-number The interface type and number whose address is to
be used as the source for TFTP connections.

Command Default The address of the closest interface to the destination is selected as the source address.

Command Modes Global configuration (config)

Command History Release Modification

11.1 This command was introduced.

12.3(6) Destination address lookup in a Virtual Private

Network (VPN) routing and forwarding (VRF)
table was added for the transfer of TFTP packets.

12.3(8)T This command was integrated into Cisco IOS

Release 12.3(8)T.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Use this command to set the IP address of an interface as the source for all TFTP connections.
If the specified interface is not up, the Cisco IOS software selects the address of the interface closest to the
destination as the source address.
In Cisco IOS 12.3(6) and later releases, TFTP is VRF-aware, which means that TFTP transfer is supported
across an interface within a Virtual Private Network (VPN) routing and forwarding (VRF) instance. To
specify a VRF as a source for TFTP connections, the VRF must be associated with the same interface that
you configure with the ip tftp source-interface command. In this configuration, TFTP looks for the
destination IP address for file transfer in the specified VRF table.

Cisco IOS Configuration Fundamentals Command Reference

357
 F through K
ip tftp source-interface

Examples The following example shows how to configure the router to use the IP address associated with loopback
interface 0 as the source address for TFTP connections :

Router# configure terminal

Router(config)# ip tftp source-interface loopback0

The following example shows how to configure the router to use the VRF table named vpn1 to look for the
destination IP address for TFTP connections. In this example, file transfer using TFTP is accomplished
across an interface within a VRF (VRF vpn1) link.

Router# configure terminal

Router(config)# ip tftp source-interface ethernet 1/0
Router(config)# ip vrf vpn1
Router(config-vrf)# rd 100:1
Router(config-vrf)# route-target both 100:1
Router(config-vrf)# interface ethernet 1/0
Router(config-if)# ip vrf forwarding vpn1
Router(config-if)# end

Related Commands Command Description

ip ftp source-interface Forces outgoing FTP packets to use the IP address
of a specified interface as the source address.

ip radius source-interface Forces outgoing RADIUS packets to use the IP

address of a specified interface as the source
address.

Cisco IOS Configuration Fundamentals Command Reference

358
 F through K
ip wccp web-cache accelerated

ip wccp web-cache accelerated

To enable the hardware acceleration for WCCP version 1, use the ip wccp web-cache
acceleratedcommand in global configuration mode. To disable hardware acceleration, use the no form of
this command.

ip wccp web-cache accelerated [[group-address groupaddress] | [redirect-list access-list] |

[group-list access-list] | [password password]]
no ip wccp web-cache accelerated

Syntax Description group-address group-address (Optional) Directs the router to use a specified
multicast IP address for communication with the
WCCP service group. See the “Usage Guidelines”
section for additional information.

redirect-list access-list (Optional) Directs the router to use an access list to

control traffic that is redirected to this service
group. See the “Usage Guidelines” section for
additional information.

group-list access-list (Optional) Directs the router to use an access list to

determine which cache engines are allowed to
participate in the service group. See the “Usage
Guidelines” section for additional information.

password password (Optional) Specifies a string that directs the router

to apply MD5 authentication to messages received
from the service group specified by the service
name given. See the “Usage Guidelines” section for
additional information.

Command Default When this command is not configured, hardware acceleration for WCCPv1 is not enabled.

Command Modes Global configuration (config)

Command History Release Modification

12.2(17d)SXB Support for this command on the Supervisor Engine
2 was extended to Cisco IOS Release
12.2(17d)SXB.

Cisco IOS Configuration Fundamentals Command Reference

359
 F through K
ip wccp web-cache accelerated

Release Modification
12.2(18)SXD1 This command was changed to support the
Supervisor Engine 720.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The group-address group-address option requires a multicast address that is used by the router to
determine which cache engine should receive redirected messages. This option instructs the router to use
the specified multicast IP address to coalesce the “I See You” responses for the “Here I Am” messages that
it has received on this group address. In addition, the response is sent to the group address. The default is
for no group-address to be configured, so that all “Here I Am” messages are responded to with a unicast
reply.
The redirect-list access-list option instructs the router to use an access list to control the traffic that is
redirected to the cache engines of the service group that is specified by the service-name given. The access-
list argument specifies either a number from 1 to 99 to represent a standard or extended access list number,
or a name to represent a named standard or extended access list. The access list itself specifies the traffic
that is permitted to be redirected. The default is for no redirect-list to be configured (all traffic is
redirected).
The group-list access-list option instructs the router to use an access list to control the cache engines that
are allowed to participate in the specified service group. The access-list argument specifies either a number
from 1 to 99 to represent a standard access list number, or a name to represent a named standard access list.
The access list specifies which cache engines are permitted to participate in the service group. The default
is for no group-list to be configured, so that all cache engines may participate in the service group.
The password can be up to seven characters. When you designate a password, the messages that are not
accepted by the authentication are discarded. The password name is combined with the HMAC MD5 value
to create security for the connection between the router and the cache engine.

Examples The following example shows how to enable the hardware acceleration for WCCP version 1:

Router(config)# ip wccp web-cache accelerated

Related Commands Command Description

ip wccp version Specifies which version of WCCP to configure on
your router.

Cisco IOS Configuration Fundamentals Command Reference

360
L through mode
• length, page 363
• load-interval, page 365
• location, page 367
• lock, page 368
• lockable, page 370
• log config, page 372
• logging buginf, page 374
• logging enable, page 376
• logging esm config, page 378
• logging event bundle-status, page 380
• logging event link-status (global configuration), page 382
• logging event link-status (interface configuration), page 384
• logging event subif-link-status, page 386
• logging event trunk-status, page 388
• logging reload, page 389
• logging ip access-list cache (global configuration), page 391
• logging ip access-list cache (interface configuration), page 394
• logging persistent (config-archive-log-cfg), page 396
• logging persistent reload (config-archive-log-cfg), page 398
• logging size, page 400
• logging synchronous, page 402
• logging system, page 405
• logout, page 407
• logout-warning, page 408
• macro (global configuration), page 410
• macro (interface configuration), page 412
• maximum, page 414
• memory cache error-recovery, page 416
• memory cache error-recovery options, page 418
• memory free low-watermark, page 420
• memory lite, page 422
• memory reserve, page 423
• memory reserve critical, page 425
• memory sanity, page 427
• memory scan, page 429

Cisco IOS Configuration Fundamentals Command Reference

361
 L through mode

• memory-size iomem, page 431

• menu (EXEC), page 433
• menu menu-name single-space, page 435
• menu clear-screen, page 437
• menu command, page 439
• menu default, page 442
• menu line-mode, page 444
• menu options, page 446
• menu prompt, page 448
• menu status-line, page 450
• menu text, page 452
• menu title, page 454
• microcode (12000), page 456
• microcode (7000/7500), page 458
• microcode (7200), page 460
• microcode reload (12000), page 462
• microcode reload (7000 7500), page 464
• microcode reload (7200), page 466
• mkdir, page 468
• mkdir disk0:, page 470
• mode, page 472

Cisco IOS Configuration Fundamentals Command Reference

362
 L through mode
length

length
To set the terminal screen length, use the length command in line configuration mode. To restore the
default value, use the no form of this command.

length screen-length
no length

Syntax Description screen-length The number of lines on the screen. A value of zero
disables pausing between screens of output.

Command Default Screen length of 24 lines

Command Modes Line configuration

Command History Release Modification

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 Cisco IOS software uses the value of this command to determine when to pause during multiple-screen
output. Not all commands recognize the configured screen length. For example, the show terminal
command assumes a screen length of 24 lines or more.

Examples In the following example, the terminal type is specified and the screen pause function is disabled for the
terminal connection on line 6:

Router(config)# line 6
Router(config-line)# terminal-type VT220
Router(config-line)# length 0

Cisco IOS Configuration Fundamentals Command Reference

363
 L through mode
length

Related Commands Command Description

terminal length Sets the number of lines on the current terminal
screen for the current session.

Cisco IOS Configuration Fundamentals Command Reference

364
 L through mode
load-interval

load-interval
To change the length of time for which data is used to compute load statistics, use the load-interval
command in interface configuration mode or Frame Relay DLCI configuration mode. To revert to the
default setting, use the noform of this command.

load-interval seconds
no load-interval seconds

Syntax Description seconds Length of time for which data is used to compute
load statistics. Value is a multiple of 30, from 30 to
600 (30, 60, 90, 120, and so on). The default is 300
seconds.

Command Default Enabled

Command Modes Interface configuration Frame Relay DLCI configuration

Command History Release Modification

10.3 This command was introduced.

12.2(4)T This command was made available in Frame Relay

DLCI configuration mode.

12.2(18)SXF Support for this command was introduced on the

Supervisor Engine 720.

12.2(28)SB This command was integrated into Cisco IOS

Release 12.2(28)SB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines To make computations more reactive to short bursts of traffic, you can shorten the length of time over
which load averages are computed.
If the load interval is set to 30 seconds, new data is used for load calculations over a 30-second period. This
data is used to compute load statistics, including the input rate in bits and packets per second, the output
rate in bits and packets per second, the load, and reliability.

Cisco IOS Configuration Fundamentals Command Reference

365
 L through mode
load-interval

Load data is gathered every five seconds. This data is used for a weighted-average calculation in which
recent load data has more weight in the computation than older load data. If the load interval is set to 30
seconds, the average is computed for the last 30 seconds of load data.
If you change the calculation interval from the default of five minutes to a shorter period of time, the input
and output statistics that are displayed by the show interface command or the show frame-relay pvc
command will be more current and will be based on more nearly instantaneous data, rather than reflecting
the average load over a longer period of time.
This command is often used for dial backup purposes to increase or decrease the likelihood of
implementation of a backup interface, but it can be used on any interface.

Examples
Interface Example
In the following example, the default average of five minutes is changed to a 30-second average. A burst in
traffic that would not trigger a dial backup for an interface configured with the default five-minute interval
might trigger a dial backup for this interface, which is set for the shorter 30-second interval.

Router(config)# interface serial 0

Router(config-if)# load-interval 30

Frame Relay PVC Example

In the following example, the load interval is set to 60 seconds for a Frame Relay PVC with the DLCI 100:

Router(config)# interface serial 1/1

Router(config-if)# frame-relay interface-dlci 100
Router(config-fr-dlci)# load-interval 60

Related Commands Command Description

show interfaces Displays statistics for all interfaces configured on
the router or access server.

Cisco IOS Configuration Fundamentals Command Reference

366
 L through mode
location

location
To provide a description of the location of a serial device, use the location command in line configuration
mode. To remove the description, use the no form of this command.

location text
no location

Syntax Description text Location description.

Command Default A location description is not provided.

Command Modes Line configuration (config-line)

Command History Release Modification

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 location command enters information about the device location and status. Use the show users all
EXEC command to display the location information.

Examples In the following example, the location description for the console line is given as “Building 3, Basement”:

Router(config)# line console

Router(config-line)# location Building 3, Basement

Related Commands Command Description

show users Displays information about the active lines on a
router.

Cisco IOS Configuration Fundamentals Command Reference

367
 L through mode
lock

lock
To configure a temporary password on a line, use the lockcommand in EXEC mode.

lock

Syntax Description This command has no arguments or keywords.

Command Default Not locked

Command Modes EXEC

Command History Release Modification

10.0 This command was introduced in a release prior to
Cisco IOS Release 10.0.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines You can prevent access to your session while keeping your connection open by setting up a temporary
password. To lock access to the terminal, perform the following steps:
1 Enter the lock command. The system prompts you for a password.
2 Enter a password, which can be any arbitrary string. The system will prompt you to confirm the
password. The screen then clears and displays the message “Locked.”
3 To regain access to your sessions, reenter the password.
The Cisco IOS software honors session timeouts on a locked lines. You must clear the line to remove this
feature. The system administrator must set the line up to allow use of the temporary locking feature by
using the lockable line configuration command.

Examples The following example shows configuring the router as lockable, saving the configuration, and then
locking the current session for the user:

Router(config-line)# lockable
Router(config-line)# ^Z
Router# copy system:running-config nvram:startup-config
Building configuration...
OK
Router# lock

Cisco IOS Configuration Fundamentals Command Reference

368
 L through mode
lock

Password: <password>
Again: <password>
Locked
Password: <password>
Router#

Related Commands Command Description

lockable Enables the lock EXEC command.

login (EXEC) Enables or changes a login username.

Cisco IOS Configuration Fundamentals Command Reference

369
 L through mode
lockable

lockable
To enable use of the lock EXEC command, use the lockablecommand in line configuration mode. To
reinstate the default (the terminal session cannot be locked), use the noform of this command.

lockable
no lockable

Syntax Description This command has no arguments or keywords.

Command Default Sessions on the line are not lockable (the lock EXEC command has no effect).

Command Modes Line configuration

Command History Release Modification

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 enables use of temporary terminal locking, which is executed using the lock EXEC
command. Terminal locking allows a user keep the current session open while preventing access by other
users.

Examples In the following example, the terminal connection is configured as lockable, then the current connection is
locked:

Router# configure terminal

Router(config)# line console 0
Router(config-line)# lockable
Router(config)# ^Z
Router# lock
Password: <password>
Again: <password>
Locked

Password: <password>
Router#

Cisco IOS Configuration Fundamentals Command Reference

370
 L through mode
lockable

Related Commands Command Description

lock Prevents access to your session by other users by
setting a temporary password on your terminal line.

Cisco IOS Configuration Fundamentals Command Reference

371
 L through mode
log config

log config
To enter configuration change logger configuration mode, use the log configcommand in archive
configuration mode.

log config

Syntax Description This command has no arguments or keywords.

Command Default None

Command Modes Archive configuration

Command History Release Modification

12.3(4)T This command was introduced.

12.2(25)S This command was integrated into Cisco IOS

Release 12.2(25)S.

12.2(27)SBC This command was integrated into Cisco IOS

Release 12.2(27)SBC.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2(33)SB This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco
10000 series.

Examples The following example shows how to place the router in configuration change logger configuration mode:

Router# configure terminal

!
Router(config)# archive
Router(config-archive)# log config
Router(config-archive-log-config)#

Cisco IOS Configuration Fundamentals Command Reference

372
 L through mode
log config

Related Commands Command Description

archive Enters archive configuration mode.

hidekeys Suppresses the display of password information in

configuration log files.

logging enable Enables the logging of configuration changes.

logging size Specifies the maximum number of entries retained

in the configuration log.

notify syslog Enables the sending of notifications of

configuration changes to a remote syslog.

show archive log config Displays entries from the configuration log.

Cisco IOS Configuration Fundamentals Command Reference

373
 L through mode
logging buginf

logging buginf
To allow debug messages to be generated for the standard system logging buffer, use the logging
buginfcommand in global configuration mode. To disable the logging for debugging functionality, use the
no form of this command.

logging buginf
no logging buginf

Syntax Description This command has no arguments or keywords.

Command Default Debug messages are not suppressed.

Command Modes Global configuration (config)

Command History Release Modification

15.0(1)M This command was introduced in a release earlier
than Cisco IOS Release 15.0(1)M.

12.2(33)SRC This command was integrated into a release earlier

than Cisco IOS Release 12.2(33)SRC.

12.2(33)SXI This command was integrated into a release earlier

than Cisco IOS Release 12.2(33)SXI.

Cisco IOS XE Release 2.1 This command was integrated into Cisco IOS XE
Release 2.1.

Usage Guidelines The no logging buginfcommand is used to avoid a situation where a large amount of debug messages
might overload the processor (CPU hog condition). This condition differs from the use of the undebug
allcommand wherein all debugging calls are disabled in the Cisco IOS software. No debug reporting is
available, even if debugging is enabled. Note that even though debugging has been completely disabled in
the system, other message reporting, including error reporting, is still available.

Examples The following example shows how to enable buginf logging for debugging:

Router# configure terminal

Router(config)# logging buginf

Cisco IOS Configuration Fundamentals Command Reference

374
 L through mode
logging buginf

Related Commands Command Description

show logging Displays the state of system logging (syslog) and
the contents of the standard system logging buffer.

Cisco IOS Configuration Fundamentals Command Reference

375
 L through mode
logging enable

logging enable
To enable the logging of configuration changes, use the logging enablecommand in configuration change
logger configuration mode. To disable the logging of configuration changes, use the no form of this
command.

logging enable
no logging enable

Syntax Description This command has no arguments or keywords.

Command Default Configuration change logging is disabled.

Command Modes Configuration change logger configuration

Command History Release Modification

12.3(4)T This command was introduced.

12.2(25)S This command was integrated into Cisco IOS

Release 12.2(25)S.

12.2(27)SBC This command was integrated into Cisco IOS

Release 12.2(27)SBC.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2(33)SB This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco
10000 series.

Usage Guidelines Use this command if you want to log configuration changes. If you disable configuration logging, all
configuration log records that were collected are purged.

Examples The following example shows how to enable configuration logging:

Router# configure terminal

!
Router(config)# archive

Cisco IOS Configuration Fundamentals Command Reference

376
 L through mode
logging enable

Router(config-archive)# log config

Router(config-archive-log-config)# logging enable
Router(config-archive-log-config)# end

The following example shows how to clear the configuration log by disabling and then reenabling the
configuration log:

Router# configure terminal

!
Router(config)# archive
Router(config-archive)# log config
Router(config-archive-log-config)# no logging enable
Router(config-archive-log-config)# logging enable
Router(config-archive-log-config)# end

Related Commands Command Description

archive Enters archive configuration mode.

hidekeys Suppresses the display of password information in

configuration log files.

log config Enters configuration change logger configuration

mode.

logging size Specifies the maximum number of entries retained

in the configuration log.

notify syslog Enables the sending of notifications of

configuration changes to a remote syslog.

show archive log config Displays entries from the configuration log.

Cisco IOS Configuration Fundamentals Command Reference

377
 L through mode
logging esm config

logging esm config

To permit configuration changes from Embedded Syslog Manager (ESM) filters, use the logging esm
config command in global configuration mode. To disable the configuration, use the no form of this
command.

logging esm config

no logging esm config

Syntax Description This command has no arguments or keywords.

Command Default ESM filters are enabled.

Command Modes Global configuration (config)

Command History Release Modification

15.0(1)M This command was introduced in a release earlier
than Cisco IOS Release 15.0(1)M.

12.2(33)SRC This command was integrated into a release earlier

than Cisco IOS Release 12.2(33)SRC.

12.2(33)SXI This command was integrated into a release earlier

than Cisco IOS Release 12.2(33)SXI.

Cisco IOS XE Release 2.1 This command was integrated into Cisco IOS XE
Release 2.1.

Usage Guidelines You can use the no logging esm config command to disallow configuration changes from ESM filters.

Examples The following example shows how to configure the ESM filters:

Router# configure terminal

Router(config)# logging esm config

Cisco IOS Configuration Fundamentals Command Reference

378
 L through mode
logging esm config

Related Commands Command Description

logging filter Specifies a syslog filter module to be used by the
ESM.

Cisco IOS Configuration Fundamentals Command Reference

379
 L through mode
logging event bundle-status

logging event bundle-status

To enable message bundling, use the logging event bundle-status command in interface configuration
mode. To disable message bundling, use the no form of this command.

logging event bundle-status

no logging event bundle-status

Syntax Description default Enables system logging of interface state-change

events on all interfaces in the system.

boot Enables system logging of interface state-change

events on all interfaces in the system during system
initialization.

Command Default Message bundling does not occur.

Command Modes Global configuration

Command History Release Modification

12.2(14)SX Support for this command was introduced on the
Supervisor Engine 720.

12.2(17d)SXB Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The logging event bundle-status command is not applicable on Port Channel or Ether-Channel interfaces.

Examples This example shows how to enable the system logging of the interface state-change events on all interfaces
in the system:

Router(config)# logging event bundle-status

Router(config)# end
Router # show logging event bundle-status
*Aug 4 17:36:48.240 UTC: %EC-SP-5-UNBUNDLE: Interface FastEthernet9/23 left the port-

Cisco IOS Configuration Fundamentals Command Reference

380
 L through mode
logging event bundle-status

channel Port-channel2
*Aug 4 17:36:48.256 UTC: %LINK-SP-5-CHANGED: Interface FastEthernet9/23, changed state to
administratively down
*Aug 4 17:36:47.865 UTC: %EC-SPSTBY-5-UNBUNDLE: Interface FastEthernet9/23 left the port-
channel Port-channel2
Router # show logging event bundle-status
*Aug 4 17:37:35.845 UTC: %EC-SP-5-BUNDLE: Interface FastEthernet9/23 joined port-channel
Port-channel2
*Aug 4 17:37:35.533 UTC: %EC-SPSTBY-5-BUNDLE: Interface FastEthernet9/23 joined port-
channel Port-channel2

Related Commands Command Description

show running-config Displays the status and configuration of the module
or Layer 2 VLAN.

Cisco IOS Configuration Fundamentals Command Reference

381
 L through mode
logging event link-status (global configuration)

logging event link-status (global configuration)

To change the default or set the link-status event messaging during system initialization, use the logging
event link-status command in global configuration mode. To disable the link-status event messaging, use
the no form of this command.

logging event link-status {default | boot}

no logging event link-status {default | boot}

Syntax Description default Enables system logging of interface state-change

events on all interfaces in the system.

boot Enables system logging of interface state-change

events on all interfaces in the system during system
initialization.

Command Default Interface state-change messages are not sent.

Command Modes Global configuration

Command History Release Modification

12.2(14)SX Support for this command was introduced on the
Supervisor Engine 720.

12.2(17d)SXB Support for this command on the Supervisor Engine

2 was extended to Release 12.2(17d)SXB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines You do not have to enter the logging event link-status boot command to enable link-status messaging
during system initialization. The logging event link-status default command logs system messages even
during system initialization.
If you enter both the logging event link-status default and the no logging event link-status
bootcommands, the interface state-change events are logged after all modules in the Cisco 7600 series
router come online after system initialization. The logging event link-status default and the no logging
event link-status boot commands are saved and retained in the running configuration of the system.

Cisco IOS Configuration Fundamentals Command Reference

382
 L through mode
logging event link-status (global configuration)

When both the logging event link-status default and the no logging event link-status bootcommands are
present in the running configuration and you want to display the interface state-change messages during
system initialization, enter the logging event link-status boot command.

Examples This example shows how to enable the system logging of the interface state-change events on all interfaces
in the system:

Router(config)# logging event link-status default

Router(config)#

This example shows how to enable the system logging of interface state-change events on all interfaces
during system initialization:

Router(config)# logging event link-status boot

Router(config)#

This example shows how to disable the system logging of interface state-change events on all interfaces:

Router(config)# no logging event link-status default

Router(config)#

This example shows how to disable the system logging of interface state-change events during system
initialization:

Router(config)# no logging event link-status boot

Router(config)#

Related Commands Command Description

show running-config Displays the status and configuration of the module
or Layer 2 VLAN.

Cisco IOS Configuration Fundamentals Command Reference

383
 L through mode
logging event link-status (interface configuration)

logging event link-status (interface configuration)

To enable link-status event messaging on an interface, use the logging event link-status command in
interface configuration mode. To disable link-status event messaging, use the no form of this command.

logging event link-status [bchan | dchan | nfas]

no logging event link-status [bchan | dchan | nfas]

Syntax Description bchan (Optional) Logs B-channel status messages. This

keyword is available only for integrated services
digital network (ISDN) serial interfaces.

dchan (Optional) Logs D-channel status messages. This

keyword is available only for ISDN serial
interfaces.

nfas (Optional) Logs non-facility associated signaling

(NFAS) D-channel status messages. This keyword
is available only for ISDN serial interfaces.

Command Default Interface state-change messages are not sent.

Command Modes Interface configuration (config-if)

Command History Release Modification

12.2(14)SX This command was introduced on the Supervisor
Engine 720.

12.2(17d)SXB This command was modified to support the

Supervisor Engine 2.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines To enable system logging of interface state-change events on a specific interface, enter the logging event
link-status command.

Cisco IOS Configuration Fundamentals Command Reference

384
 L through mode
logging event link-status (interface configuration)

Examples The following example shows how to enable link-status event messaging on an interface:

Router(config-if)# logging event link-status

This example shows how to disable link-status event messaging on an interface:

Router(config-if)# no logging event link-status

Cisco IOS Configuration Fundamentals Command Reference

385
 L through mode
logging event subif-link-status

logging event subif-link-status

To enable the link-status event messaging on a subinterface, use the logging event subif-link-status
command in interface configuration mode. To disable the link-status event messaging on a subinterface,
use the no form of this command.

logging event subif-link-status

no logging event subif-link-status

Syntax Description This command has no arguments or keywords.

Command Default Subinterface state-change messages are not sent.

Command Modes Interface configuration

Command History Release Modification

12.2(17d)SXB Support for this command on the Supervisor Engine
2 was extended to Release 12.2(17d)SXB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command is not supported on Cisco 7600 series routers that are configured with a Supervisor Engine
720.
To enable system logging of interface state-change events on a specific subinterface, enter the logging
event subif-link-status command.
To enable system logging of interface state-change events on a specific interface, enter the logging event
link-status command.
To enable system logging of interface state-change events on all interfaces in the system, enter the logging
event link-status command.

Examples This example shows how to enable the system logging of the interface state-change events on a
subinterface:

Router(config-if)# logging event subif-link-status

Router(config-if)#

Cisco IOS Configuration Fundamentals Command Reference

386
 L through mode
logging event subif-link-status

This example shows how to disable the system logging of the interface state-change events on a
subinterface:

Router(config-if)# no logging event subif-link-status

Router(config-if)#

Related Commands Command Description

show running-config Displays the status and configuration of the module
or Layer 2 VLAN.

Cisco IOS Configuration Fundamentals Command Reference

387
 L through mode
logging event trunk-status

logging event trunk-status

To enable trunk status messaging, use the logging event trunk-status command in interface configuration
mode. To disable trunk status messaging, use the no form of this command.

logging event trunk-status

no logging event trunk-status

Syntax Description This command has no keywords or variables.

Command Default This command has no default settings.

Command Modes Interface configuration mode

Command History Release Modification

12.2(14)SX Support for this command was introduced.

Usage Guidelines The logging event bundle-status command is not applicable on Port Channel or Ether-Channel interfaces.

Examples This example shows how to enable the trunk status messaging on physical ports:

Router(config)# logging event trunk-status

Router(config)# end
Router# show logging event trunk-status
*Aug 4 17:27:01.404 UTC: %DTP-SPSTBY-5-NONTRUNKPORTON: Port Gi3/3 has become non-trunk
*Aug 4 17:27:00.773 UTC: %DTP-SP-5-NONTRUNKPORTON: Port Gi3/3 has become non-trunk
Router#

Cisco IOS Configuration Fundamentals Command Reference

388
 L through mode
logging reload

logging reload
To set the reload logging level, use the logging reloadcommand in global configuration mode. To disable
the reload logging, use the no form of this command.

logging reload [message-limit number] [severity-level | alerts | critical | debugging | emergencies |

errors | informational | notifications | warnings]
no logging reload

Syntax Description message-limit (Optional) Sets the limit on the number of messages
that can be logged during reload.

number Number of messages. The range is from 1 to

4294967295.

severity-level (Optional) Logging severity level. The range is

from 0 to 7.

alerts (Optional) Specifies that an immediate action is

needed.

critical (Optional) Specifies the critical conditions.

debugging (Optional) Displays the debugging messages

emergencies (Optional) Specifies that the system is unusable.

errors (Optional) Specifies error conditions

informational (Optional) Specifies error informational messages

notifications (Optional) Specifies normal but significant

conditions.

warnings (Optional) Specifies warning conditions.

Command Default The logging reload message limit is 1000 notifications.

Command Modes Global configuration (config)

Cisco IOS Configuration Fundamentals Command Reference

389
 L through mode
logging reload

Command History Release Modification

15.0(1)M This command was introduced in a release earlier
than Cisco IOS Release 15.0(1)M.

12.2(33)SRC This command was integrated into a release earlier

than Cisco IOS Release 12.2(33)SRC.

12.2(33)SXI This command was integrated into a release earlier

than Cisco IOS Release 12.2(33)SXI.

Cisco IOS XE Releas e2.1 This command was integrated into Cisco IOS XE
Release 2.1.

Usage Guidelines The default setting is recommended. Setting the message-limit too low may result in losing important
messages during reload. If the logging reload command is not enabled, logging is turned off during reload.

Examples The following example shows how to set the limit on number of messages that can be logged during reload
to 100:

Router# configure terminal

Router(config)# logging reload message-limit 100

Related Commands Command Description

show logging Displays the state of system logging (syslog) and
the contents of the standard system logging buffer.

Cisco IOS Configuration Fundamentals Command Reference

390
 L through mode
logging ip access-list cache (global configuration)

logging ip access-list cache (global configuration)

To configure the Optimized ACL Logging (OAL) parameters, use the logging ip access-list cache
command in global configuration mode. To return to the default settings, use the no form of this command.
logging ip access-list cache {entries entries | interval seconds | rate-limit pps | threshold packets}
no logging ip access-list cache [entries | interval | rate-limit | threshold]

Syntax Description entries entries Specifies the maximum number of log entries that
are cached in the software; valid values are from 0
to 1048576 entries.

interval seconds Specifies the maximum time interval before an

entry is sent to syslog; valid values are from 5 to
86400 seconds.

rate-limit pps Specifies the number of packets that are logged per
second in the software; valid values are from 10 to
1000000 pps.

threshold packets Specifies the number of packet matches before an

entry is sent to syslog; valid values are from 1 to
1000000 packets.

Command Default The defaults are as follows:

• entries --8000 entries.
• seconds --300 seconds (5 minutes).
• rate-limit pps --0 (rate limiting is off) and all packets are logged.
• threshold packets --0 (rate limiting is off) and the system log is not triggered by the number of packet
matches.

Command Modes Global configuration

Command History Release Modification

12.2(17d)SXB Support for this command was introduced on the
Supervisor Engine 720.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Cisco IOS Configuration Fundamentals Command Reference

391
 L through mode
logging ip access-list cache (global configuration)

Usage Guidelines This command is supported on Cisco 7600 series routers that are configured with a Supervisor Engine 720
only.
OAL is supported on IPv4 unicast traffic only.
You cannot configure OAL and VACL capture on the same chassis. OAL and VACL capture are
incompatible. With OAL configured, use SPAN to capture traffic.
If the entry is inactive for the duration that is specified in the update-interval seconds command, th e entry
is removed from the cache.
If you enter the no logging ip access-list cache command without keywords, all the parameters are
returned to the default values.
You must set ICMP unreachable rate limiting to 0 if the OAL is configured to log denied packets.
When enabling the IP "too short" check using the mls verify ip length minimum command, valid IP packets
with with an IP protocol field of ICMP(1), IGMP(2), IP(4), TCP(6), UDP(17), IPv6(41), GRE(47), or
SIPP-ESP(50) will be hardware switched. All other IP protocol fields are software switched.

Caution Using optimized access-list logging (OAL) and the mls verify ip length minimum command together can
cause routing protocol neighbor flapping as they are incompatible

Examples This example shows how to specify the maximum number of log entries that are cached in the software:

Router(config)#
logging ip access-list cache entries 200

This example shows how to specify the maximum time interval before an entry is sent to the system log:

Router(config)#
logging ip access-list cache interval 350

This example shows how to specify the number of packets that are logged per second in the software:

Router(config)#
logging ip access-list cache rate-limit 100

This example shows how to specify the number of packet matches before an entry is sent to the system log:

Router(config)#
logging ip access-list cache threshold 125

Related Commands Command Description

clear logging ip access-list cache Clears all the entries from the OAL cache and sends
them to the syslog.

logging ip access-list cache (interface Enables an OAL-logging cache on an interface that

configuration) is based on direction.

Cisco IOS Configuration Fundamentals Command Reference

392
L through mode
logging ip access-list cache (global configuration)

Command Description
show logging ip access-list Displays information about the logging IP access
list.

update-interval seconds Removes entries from the cache that are inactive for
the duration that is specified in the command.

Cisco IOS Configuration Fundamentals Command Reference

393
 L through mode
logging ip access-list cache (interface configuration)

logging ip access-list cache (interface configuration)

To enable an Optimized ACL Logging (OAL)-logging cache on an interface that is based on direction, use
the logging ip access-list cache command in interface configuration mode. To disable OAL, use the no
form of this command.

logging ip access-list cache [in | out]

no logging ip access-list cache

Syntax Description in (Optional) Enables OAL on ingress packets.

out (Optional) Enables OAL on egress packets.

Command Default Disabled

Command Modes Interface configuration

Command History Release Modification

12.2(17d)SXB Support for this command was introduced on the
Supervisor Engine 720.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command is supported on Cisco 7600 series routers that are configured with a Supervisor Engine 720
only.
This command is supported on traffic that matches the log keyword in the applied ACL. You must set
ICMP unreachable rate limiting to 0 if the OAL is configured to log denied packets.
On systems that are configured with a PFC3A, support for the egress direction on tunnel interfaces is not
supported.
OAL is supported on IPv4 unicast traffic only.
You cannot configure OAL and VACL capture on the same chassis. OAL and VACL capture are
incompatible. With OAL configured, use SPAN to capture traffic.
If the entry is inactive for the duration that is specified in the update-interval seconds command, th e entry
is removed from the cache.
If you enter the no logging ip access-list cache command without keywords, all the parameters are
returned to the default values.

Cisco IOS Configuration Fundamentals Command Reference

394
 L through mode
logging ip access-list cache (interface configuration)

When enabling the IP "too short" check using the mls verify ip length minimum command, valid IP packets
with with an IP protocol field of ICMP(1), IGMP(2), IP(4), TCP(6), UDP(17), IPv6(41), GRE(47), or
SIPP-ESP(50) will be hardware switched. All other IP protocol fields are software switched.

Caution Using optimized access-list logging (OAL) and the mls verify ip length minimum command together can
cause routing protocol neighbor flapping as they are incompatible

Examples This example shows how to enable OAL on ingress packets:

Router(config-if)#
logging ip access-list cache in

This example shows how to enable OAL on egress packets:

Router(config-if)#
logging ip access-list cache out

Related Commands Command Description

clear logging ip access-list cache Clears all the entries from the OAL cache and sends
them to the syslog.

logging ip access-list cache (global configuration) Configures the OAL parameters.

show logging ip access-list Displays information about the logging IP access

list.

update-interval seconds Removes entries from the cache that are inactive for
the duration that is specified in the command.

Cisco IOS Configuration Fundamentals Command Reference

395
 L through mode
logging persistent (config-archive-log-cfg)

logging persistent (config-archive-log-cfg)

To enable the configuration logging persistent feature and to select how the configuration commands are to
be saved to the Cisco IOS secure file system, use the logging persistent command in the log config
submode of archive configuration mode. To disable this capability, use the no form of this command.
logging persistent {auto | manual}
no logging persistent {auto | manual}

Syntax Description auto Specifies that each configuration command will be

saved automatically to the Cisco IOS secure file
system.

manual Specifies that each configuration command must be

saved manually to the Cisco IOS secure file system.

Command Default The configuration commands are not saved to the Cisco IOS secure file system.

Command Modes Archive configuration mode, log config (configuration-change logger) submode (config-archive-log-cfg)#

Command History Release Modification

12.0(26)S This command was introduced.

12.2(25)S This command was integrated into Cisco IOS

Release 12.2(25)S.

12.2(28)SB This command was integrated into Cisco IOS

Release 12.2(28)SB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.4(11)T This command was integrated into Cisco IOS

Release 12.4(11)T.

12.2(33)SXH This command was integrated into Cisco IOS

Release 12.2(33)SXH.

12.2(33)SB This command was integrated into Cisco IOS

Release 12.2(33)SB.

Cisco IOS Configuration Fundamentals Command Reference

396
 L through mode
logging persistent (config-archive-log-cfg)

Usage Guidelines When you use the manualkeyword, you must save each configuration command manually to the Cisco IOS
secure file system. To do this, you must use the archive log config persistent save command.

Examples The following example automatically saves the configuration commands to the Cisco IOS secure file
system:

Router(config)# archive
Router(config-archive)# log config
Router(config-archive-log-cfg)# logging enable
Router(config-archive-log-cfg)# logging persistent auto

Related Commands Command Description

logging persistent reload Sequentially applies configuration commands in the
configuration logger database to the running-config
file after a reload.

archive log config persistent save Saves the persisted commands in the configuration
log to the Cisco IOS secure file system.

Cisco IOS Configuration Fundamentals Command Reference

397
 L through mode
logging persistent reload (config-archive-log-cfg)

logging persistent reload (config-archive-log-cfg)

To sequentially apply the configuration commands saved in the configuration logger database (since the
last write memorycommand) to the running-config file after a reload, use the logging persistent reload
command in configuration change logger configuration mode in archive configuration mode. To disable
this capability, use the no form of this command.
logging persistent reload
no logging persistent reload

Syntax Description This command has no arguments or keywords.

Command Default The configuration commands saved in the configuration logger database are not applied to the running-
config file.

Command Modes Archive config mode; log config (configuration change logger) submode (config-archive-log-cfg)#

Command History Release Modification

12.2(33)SRA This command was introduced.

12.4(11)T This command was integrated into Cisco IOS

Release 12.4(11)T.

12.2(33)SXH This command was integrated into Cisco IOS

Release 12.2(33)SXH.

12.2(33)SB This command was integrated into Cisco IOS

Release 12.2(33)SB.

Usage Guidelines Use the logging persistent reload command when you want changed configuration commands to take
effect on the next reload of the router.

Examples The following example applies the configuration commands in the configuration logger database to the
running-config file after the next reload:

Router(config-archive-log-cfg)# logging persistent reload

Cisco IOS Configuration Fundamentals Command Reference

398
 L through mode
logging persistent reload (config-archive-log-cfg)

Related Commands Command Description

logging persistent Enables the configuration logging persistent
feature.

Cisco IOS Configuration Fundamentals Command Reference

399
 L through mode
logging size

logging size
To specify the maximum number of entries retained in the configuration log, use the logging sizecommand
in configuration change logger configuration mode. To reset the default value, use the no form of this
command.

logging size entries

no logging size

Syntax Description entries The maximum number of entries retained in the

configuration log. Valid values range from 1 to
1000. The default value is 100 entries.

Command Default 100 entries

Command Modes Configuration change logger configuration

Command History Release Modification

12.3(4)T This command was introduced.

12.2(25)S This command was integrated into Cisco IOS

Release 12.2(25)S.

12.2(27)SBC This command was integrated into Cisco IOS

Release 12.2(27)SBC.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2(33)SB This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco
10000 series.

Usage Guidelines When the configuration log is full, the oldest log entry will be removed every time a new entry is added.

Cisco IOS Configuration Fundamentals Command Reference

400
 L through mode
logging size

Note If a new log size is specified that is smaller than the current log size, the oldest entries will be immediately
purged until the new log size is satisfied, regardless of the age of the log entries.

Examples The following example shows how to specify that the configuration log may have a maximum of 200
entries:

Router(config-archive-log-config)# logging size 200

The following example shows how to clear the configuration log by reducing the log size to 1, then
resetting the log size to the desired value. Only the most recent configuration log file will be saved.

Router(config)# archive
Router(config-archive)# log config
Router(config-archive-log-config)# logging size 1
Router(config-archive-log-config)# logging size 200

Related Commands Command Description

archive Enters archive configuration mode.

hidekeys Suppresses the display of password information in

configuration log files.

log config Enters configuration change logger configuration

mode.

logging enable Enables the logging of configuration changes.

notify syslog Enables the sending of notifications of

configuration changes to a remote syslog.

show archive log config Displays entries from the configuration log.

Cisco IOS Configuration Fundamentals Command Reference

401
 L through mode
logging synchronous

logging synchronous
To synchronize unsolicited messages and debug output with solicited Cisco IOS software output and
prompts for a specific console port line, auxiliary port line, or vty, use the logging synchronous command
in line configuration mode. To disable synchronization of unsolicited messages and debug output, use the
no form of this command.
logging synchronous [level severity-level | all] [limit number-of-lines]
no logging synchronous [level severity-level | all] [limit number-of-lines]

Syntax Description level severity-level (Optional) Specifies the message severity level.
Messages with a severity level equal to or higher
than this value are printed asynchronously. Low
numbers indicate greater severity and high numbers
indicate lesser severity. The default value is 2.

all (Optional) Specifies that all messages are printed

asynchronously, regardless of the severity level.

limit number-of-lines (Optional) Specifies the number of buffer lines to

be queued for the terminal, after which new
messages are dropped. The default value is 20.

Command Default This command is disabled.

If you do not specify a severity level, the default value of 2 is assumed.
If you do not specify the maximum number of buffers to be queued, the default value of 20 is assumed.

Command Modes Line configuration

Command History Release Modification

10.0 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2SX This command is supported in the Cisco IOS

Release 12.2SX train. Support in a specific 12.2SX
release of this train depends on your feature set,
platform, and platform hardware.

Cisco IOS Configuration Fundamentals Command Reference

402
 L through mode
logging synchronous

Usage Guidelines When synchronous logging of unsolicited messages and debug output is turned on, unsolicited Cisco IOS
software output is displayed on the console or printed after solicited Cisco IOS software output is displayed
or printed. This keeps unsolicited messages and debug output from being interspersed with solicited
software output and prompts.

Tip This command is useful for keeping system messages from interrupting your typing. By default, messages
will appear immediately when they are processed by the system, and the CLI cursor will appear at the end
of the displayed message. For example, the line “Configured by console from console” may be printed to
the screen, interrupting whatever command you are currently typing. The logging synchronous command
allows you to avoid these potentially annoying interruptions without have to turn off logging to the console
entirely.

When this command is enabled, unsolicited messages and debug output are displayed on a separate line
than user input. After the unsolicited messages are displayed, the CLI returns to the user prompt.

Note This command is also useful for allowing you to continue typing when debugging is enabled.

When specifying a severity level number, consider that for the logging system, low numbers indicate
greater severity and high numbers indicate lesser severity.
When a message queue limit of a terminal line is reached, new messages are dropped from the line,
although these messages might be displayed on other lines. If messages are dropped, the notice “ %SYS-3-
MSGLOST number-of-messages due to overflow” follows any messages that are displayed. This notice is
displayed only on the terminal that lost the messages. It is not sent to any other lines, any logging servers,
or the logging buffer.

Caution By configuring abnormally large message queue limits and setting the terminal to “terminal monitor” on a
terminal that is accessible to intruders, you expose yourself to “denial of service” attacks. An intruder could
carry out the attack by putting the terminal in synchronous output mode, making a Telnet connection to a
remote host, and leaving the connection idle. This could cause large numbers of messages to be generated
and queued, and these messages could consume all available RAM. You should guard against this type of
attack through proper configuration.

Examples In the following example, a system message appears in the middle of typing the show running-config
command:

Router(config-line)# end
Router# show ru
2w1d: %SYS-5-CONFIG_I: Configured from console by consolenning-config
.
.
.

The user then enables synchronous logging for the current line (indicated by the * symbol in the show line
command), after which the system displays the system message on a separate line, and returns the user to
the prompt to allow the user to finish typing the command on a single line:

Router# show line

Cisco IOS Configuration Fundamentals Command Reference

403
 L through mode
logging synchronous

Tty Typ Tx/Rx A Modem Roty AccO AccI Uses Noise Overruns Int
* 0 CTY - - - - - 0 3 0/0 -
.
.
.
Router# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# line 0
Router(config-line)# logging syn
<tab>
Router(config-line)# logging synchronous

Router(config-line)# end

Router# show ru

2w1d: %SYS-5-CONFIG_I: Configured from console by console

Router# show running-config

In the following example, synchronous logging for line 4 is enabled with a severity level of 6. Then
synchronous logging for line 2 is enabled with a severity level of 7 and is specified with a maximum
number of buffer lines of 1,000.

Router(config)# line 4
Router(config-line)# logging synchronous level 6
Router(config-line)# exit
Router(config)# line 2
Router(config-line)# logging synchronous level 7 limit 1000
Router(config-line)# end
Router#

Related Commands Command Description

line Identifies a specific line for configuration and starts
the line configuration command collection mode.

logging on Controls logging of error messages and sends

debug or error messages to a logging process,
which logs messages to designated locations
asynchronously to the processes that generated the
messages.

Cisco IOS Configuration Fundamentals Command Reference

404
 L through mode
logging system

logging system
To enable System Event Archive (SEA) logging, use the logging systemcommand in global configuration
mode. To disable SEA logging, use the no form of this command.

logging system [disk name]

no logging system

Syntax Description disk name (Optional) Stores the system event archive (system
event log file) in the specified disk. The specified
disk must be already have been configured to allow
for the storage of the system event archive.

Command Default By default, SEA logging feature is enabled, and the events are logged to a file on a persistent storage device
(bootflash: or disk:).

Command Modes Global configuration (config)

Command History Release Modification

12.2(33)SXH This command was introduced.

12.2(33)SCC The command was introduced for the Cisco

uBR10012 router in the Cisco IOS Software
Release 12.2(33)SCC.

Usage Guidelines SEA is supported on switches that have a Supervisor Engine 32 or Supervisor Engine 720 with a compact
flash adapter and a Compact Flash card (WS-CF-UPG= for Supervisor Engine 720).
To stop SEA logging to a specified disk, use the default logging system command.
For documentation of the configuration tasks associated with this feature, see the chapter “Configuring the
System Event Archive” in the Catalyst 6500 Release 12.2SX Software Configuration Guide .
Cisco Universal Broadband Router 100112
The SEA feature is used to address the deficiencies of the debug trace and system console. Support for SEA
feature was introduced on Cisco uBR10012 Router in the Cisco IOS Release 12.2(33)SCC. Use the logging
system disk command to change the location of the disk used to store the sea_log.dat file.

Cisco IOS Configuration Fundamentals Command Reference

405
 L through mode
logging system

Note To store the system event logs, the SEA requires either PCMCIA ATA disk or Compact Flash disk in
compact flash adapter for PRE2.

Examples The following example shows how to specify that the SEA log file should be written to the disk “disk1:”:

Router(config)# logging system disk disk1:

Router(config)# end

Related Commands clear logging system Clears the event records stored in the SEA.

copy logging system Copies the archived system event log to another
location.

show logging system Displays the SEA logging system disk.

Cisco IOS Configuration Fundamentals Command Reference

406
 L through mode
logout

logout
To close an active terminal session by logging off the router, use the logout command in user EXEC mode.

logout

Syntax Description This command has no arguments or keywords.

Command Default No default behavior or values.

Command Modes User EXEC

Command History Release Modification

10.0 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Examples In the following example, the exit (global) command is used to move from global configuration mode to
privileged EXEC mode, the disable command is used to move from privileged EXEC mode to user EXEC
mode, and the logout command is used to log off (exit from the active session):

Router(config)# exit
Router# disable
Router> logout

Cisco IOS Configuration Fundamentals Command Reference

407
 L through mode
logout-warning

logout-warning
To warn users of an impending forced timeout, use the logout-warningcommand in line configuration
mode. To restore the default, use the no form of this command.

logout-warning [seconds]
logout-warning

Syntax Description seconds (Optional) Number of seconds that are counted

down before session termination. If no number is
specified, the default of 20 seconds is used.

Command Default No warning is sent to the user.

Command Modes Line configuration

Command History Release Modification

10.3 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command notifies the user of an impending forced timeout (set using the absolute-timeout
command).

Examples In the following example, a logout warning is configured on line 5 with a countdown value of 30 seconds:

Router(config)# line 5
Router(config-line)# logout-warning 30

Related Commands Command Description

absolute-timeout Sets the interval for closing user connections on a
specific line or port.

Cisco IOS Configuration Fundamentals Command Reference

408
L through mode
logout-warning

Command Description
session-timeout Sets the interval for closing the connection when
there is no input or output traffic.

Cisco IOS Configuration Fundamentals Command Reference

409
 L through mode
macro (global configuration)

macro (global configuration)

To create a global command macro, use the macrocommand in global configuration mode. To remove the
macro, use the no form of this command.
macro {global {apply macro-name | description text | trace macro-name [keyword-to-value] value-
first-keyword [keyword-to-value] value-second-keyword [keyword-to-value] value-third-keyword
[keyword-to-value]} | name macro-name}
no macro {global {apply macro-name | description text | trace macro-name [keyword-to-value]
value-first-keyword [keyword-to-value] value-second-keyword [keyword-to-value] value-third-
keyword [keyword-to-value]} | name macro-name}

Syntax Description global Applies the macro globally.

apply macro-name Applies a specified macro.

description text Provides a description of the macros applied to the

switch.

trace macro-name Applies a specified macro with trace enabled.

keyword-to-value (Optional) Keyword to replace with a value.

value-first-keyword Value of the first keyword to replace.

value-second-keyword Value of the second keyword to replace.

value-third-keyword Value of the third keyword to replace.

name macro-name Specifies the name of a macro.

Command Default This command has no default setting.

Command Modes Global configuration (config)

Command History Release Modification

12.2(33)SXH This command was introduced.

15.0(1)M This command was integrated into a release earlier

than Cisco IOS Release 15.0(1)M.

Cisco IOS Configuration Fundamentals Command Reference

410
 L through mode
macro (global configuration)

Usage Guidelines You can enter up to three keyword pairs using the macro global trace command.
You can enter the macro global descriptioncommand on the switch stack or on a standalone switch.
Use the description textkeyword and argument to associate the comment text, or the macro name with a
switch. When multiple macros are applied on a switch, the description text is used from the last applied
macro. You can verify the global description settings by using the show parser macro description
command.
To find the syntax or configuration errors, enter the macro global trace macro-name command to apply
and debug the macro.
To display a list of any keyword-value pairs defined in the macro, enter the macro global apply macro-
name ? command.
You can delete a global macro-applied configuration on a switch only by entering the no version of each
command that is in the macro.
Keyword matching is case sensitive.
When a macro is applied on the commands, all matching occurrences of keywords are replaced with the
corresponding values.
The no form of the macro name command deletes only the macro definition. It does not affect the
configuration of the interfaces on which the macro is already applied.

Examples The following example shows how to apply the macro called snmp to set the hostname address to “test-
server” and to set the IP precedence value to 7:

Router(config)# macro global apply snmp ADDRESS test-server VALUE 7

The following example shows how to debug the macro called snmp by using the macro global trace
command to find the syntax or configuration errors in the macro when it is applied to a switch:

Router(config)# macro global trace snmp VALUE 7 VALUE 8 VALUE 9

Applying command...`snmp-server enable traps port-security'
Applying command...`snmp-server enable traps linkup'
Applying command...`snmp-server enable traps linkdown'
Applying command...`snmp-server host'
%Error Unknown error.
Applying command...`snmp-server ip precedence 7'
Router(config)#

Related Commands Command Description

macro (interface configuration) Creates an interface-specific command macro.

show parser macro Displays the smart port macros.

Cisco IOS Configuration Fundamentals Command Reference

411
 L through mode
macro (interface configuration)

macro (interface configuration)

To create an interface-specific command macro, use the macro command in interface configuration mode.
To remove the macro, use the no form of this command.

macro {apply macro-name | description text | trace macro-name [keyword-to-value] value-first-

keyword [keyword-to-value] value-second-keyword [keyword-to-value] value-third-keyword
[keyword-to-value]}
no macro {apply macro-name | description text | trace macro-name [keyword-to-value] value-first-
keyword [keyword-to-value] value-second-keyword [keyword-to-value] value-third-keyword
[keyword-to-value]}

Syntax Description apply macro-name Applies a specified macro.

description text Specifies a description about the macros that are

applied to the interface.

trace macro-name Applies a specified macro with trace enabled.

keyword-to-value (Optional) Keyword to replace with a value.

value-first-keyword Value of the keyword to replace.

Command Default This command has no default setting.

Command Modes Interface configuration (config-if)

Command History Release Modification

12.2(33)SXH This command was introduced.

Usage Guidelines You can enter up to three keyword changes using the macro trace command.
You can enter the macro description command on the switch stack or on a standalone switch.
Use the description text keyword and argument to associate comment text, or the macro name, with a
switch. When multiple macros are applied on a switch, the description text will be from the last applied
macro. You can verify the description settings by entering the show parser macro description command.
To find any syntax or configuration errors, enter the macro trace macro-name command to apply and
debug the macro.

Cisco IOS Configuration Fundamentals Command Reference

412
 L through mode
macro (interface configuration)

To display a list of any keyword-value pairs defined in the macro, enter the macro apply macro-name ?
command.
To successfully apply the macro, you must enter any required keyword-value pairs.
Keyword matching is case sensitive.
In the commands that the macro applies, all matching occurrences of keywords are replaced with the
corresponding values.
You can delete all configuration on an interface by entering the default interface interfaceinterface
configuration command.

Examples The following example shows how to apply the user-created macro called desktop-config and to verify the
configuration:

Router(config)# interface fastethernet1/2

Router(config-if)# macro apply desktop-config

The following example shows how to apply the user-created macro called desktop-config and to replace all
occurrences of vlan with VLAN ID 25:

Router(config-if)# macro apply desktop-config vlan 25

Related Commands Command Description

macro (global configuration) Creates a command macro.

show parser macro Displays the smart port macros.

Cisco IOS Configuration Fundamentals Command Reference

413
 L through mode
maximum

maximum
To set the maximum number of archive files of the running configuration to be saved in the Cisco IOS
configuration archive, use the maximum command in archive configuration mode. To reset this command
to its default, use the no form of this command.
maximum number
no maximum number

Syntax Description number Maximum number of archive files of the running

configuration to be saved in the Cisco IOS
configuration archive. You can archive from 1 to 14
configuration files. The default is 10.

Command Default By default, a maximum of 10 archive files of the running configuration are saved in the Cisco IOS
configuration archive.

Command Modes Archive configuration (config-archive)

Command History Release Modification

12.3(7)T This command was introduced.

12.2(25)S This command was integrated into Cisco IOS

Release 12.2(25)S.

12.2(28)SB This command was integrated into Cisco IOS

Release 12.2(28)SB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2(31)SB2 This command was implemented on the Cisco

10000 series.

12.2(33)SXH This command was integrated into Cisco IOS

Release 12.2(33)SXH.

12.2(33)SB This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco
10000 series.

Cisco IOS Configuration Fundamentals Command Reference

414
 L through mode
maximum

Usage Guidelines

Note Before using this command, you must configure the path command to specify the location and filename
prefix for the files in the Cisco IOS configuration archive.

After the maximum number of files are saved in the Cisco IOS configuration archive, the oldest file is
automatically deleted when the next, most recent file is saved.

Note This command should only be used when a local writable file system is specified in the url argument of the
path command. Network file systems may not support deletion of previously saved files.

Examples In the following example, a value of 5 is set as the maximum number of archive files of the running
configuration to be saved in the Cisco IOS configuration archive:

configure terminal
!
archive
path disk0:myconfig
maximum 5
end

Related Commands Command Description

archive config Saves a copy of the current running configuration to
the Cisco IOS configuration archive.

configure confirm Confirms replacement of the current running

configuration with a saved Cisco IOS configuration
file.

configure replace Replaces the current running configuration with a

saved Cisco IOS configuration file.

path Specifies the location and filename prefix for the

files in the Cisco IOS configuration archive.

show archive Displays information about the files saved in the

Cisco IOS configuration archive.

time-period Sets the time increment for automatically saving an

archive file of the current running configuration in
the Cisco IOS configuration archive.

Cisco IOS Configuration Fundamentals Command Reference

415
 L through mode
memory cache error-recovery

memory cache error-recovery

To trace error recovery in memory using caches, use the memory cache error-recoverycommand in
global configuration mode. To disable the memory cache error recovery mechanisms, use the no form of
this command.

memory cache error-recovery {L1 | L2 | L3} {data | inst}

no memory cache error-recovery {L1 | L2 | L3} {data | inst}

Syntax Description L1 Specifies the L1 cache.

L2 Specifies the L2 cache.

L3 Specifies the L3 cache.

data Specifies if data recovery is required.

inst Specifies if instruction recovery is required.

Command Default Memory cache error recovery mechanisms are not enabled.

Command Modes Global configuration (config)

Command History Release Modification

15.0(1)M This command was introduced in a release earlier
than Cisco IOS Release 15.0(1)M.

12.2(33)SXI This command was integrated into a release earlier

than Cisco IOS Release 12.2(33)SXI.

Examples The following example shows how to enable the memory cache error-recovery command:

Router> enable
Router# configure terminal
Router(config)# memory cache error-recovery

Cisco IOS Configuration Fundamentals Command Reference

416
 L through mode
memory cache error-recovery

Related Commands Command Description

memory cache error-recovery options Traces error recovery in memory using caches
through set options.

Cisco IOS Configuration Fundamentals Command Reference

417
 L through mode
memory cache error-recovery options

memory cache error-recovery options

To trace error recovery in memory using caches through set options, use the memory cache error-
recovery optionscommand in global configuration mode. To disable the set memory cache error recovery
mechanisms, use the no form of this command.
memory cache error-recovery options {abort-if-same-content | blocking-mode | max-recoveries
value | nvram-report | parity-check | window seconds}
no memory cache error-recovery options {abort-if-same-content | blocking-mode | max-
recoveries value | nvram-report | parity-check | window seconds}

Syntax Description abort-if-same-content Abort recovery if the cache contains the same
content as the memory.

blocking-mode Sets the memory blocking mode to special or ON.

max-recoveries value The maximum number of recoveries allowed within

a time window. Specify a value in the range 0 to
255.

nvram-report Saves the report in the NVRAM.

parity-check Sets the parity checking mode to normal or ON.

window seconds The time window, in seconds. Specify a value in

the range 1 to 31536000.

Command Default Memory cache error recovery mechanisms are not enabled.

Command Modes Global configuration (config)

Command History Release Modification

15.0(1)M This command was introduced in a release earlier
than Cisco IOS Release 15.0(1)M.

12.2(33)SXI This command was integrated into a release earlier

than Cisco IOS Release 12.2(33)SXI.

Examples The following example shows how to enable the memory cache error-recovery optionscommand:
Router> enable

Cisco IOS Configuration Fundamentals Command Reference

418
 L through mode
memory cache error-recovery options

Router# configure terminal

Router(config)# memory cache error-recovery options abort-if-same-content

Related Commands Command Description

memory cache error-recovery Traces error recovery in memory using caches.

Cisco IOS Configuration Fundamentals Command Reference

419
 L through mode
memory free low-watermark

memory free low-watermark

To configure a router to issue system logging message notifications when available memory falls below a
specified threshold, use the memory free low-watermarkcommand in global configuration mode. To
disable memory threshold notifications, use the no form of this command.

memory free low-watermark {processor threshold | io threshold}

no memory free low-watermark

Syntax Description processor threshold Sets the processor memory threshold in kilobytes.
When available processor memory falls below this
threshold, a notification message is triggered. Valid
values are 1 to 4294967295.

io threshold Sets the input/output (I/O) memory threshold in

kilobytes. When available I/O memory falls below
this threshold, a notification message is triggered.
Valid values are 1 to 4294967295.

Command Default Memory threshold notifications are disabled.

Command Modes Global configuration

Command History Release Modification

12.2(18)S This command was introduced.

12.0(26)S This command was integrated into Cisco IOS

Release 12.0(26)S.

12.3(4)T This command was integrated into Cisco IOS

Release 12.3(4)T.

12.2(27)SBC This command was integrated into Cisco IOS

Release 12.2(27)SBC.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Cisco IOS Configuration Fundamentals Command Reference

420
 L through mode
memory free low-watermark

Usage Guidelines Using this command, you can configure a router to issue a system logging message each time available free
memory falls below a specified threshold (“low-watermark”). Once available free memory rises to 5
percent above the threshold, another notification message is generated.

Examples The following example specifies a free processor memory notification threshold of 20000 KB:

Router(config)# memory free low-watermark processor 200000

If available free processor memory falls below this threshold, the router sends a notification message like
this one:

000029: *Aug 12 22:31:19.559: %SYS-4-FREEMEMLOW: Free Memory has dropped below 20000k
Pool: Processor Free: 66814056 freemem_lwm: 204800000

Once available free processor memory rises to a point 5 percent above the threshold, another notification
message like this is sent:

000032: *Aug 12 22:33:29.411: %SYS-5-FREEMEMRECOVER: Free Memory has recovered 20000k

Pool: Processor Free: 66813960 freemem_lwm: 0

Related Commands Command Description

memory reserve critical Reserves memory for use by critical processes.

Cisco IOS Configuration Fundamentals Command Reference

421
 L through mode
memory lite

memory lite
To enable the memory allocation lite (malloc_lite) feature, use the memory lite command in global
configuration mode. To disable this feature, use the no form of this command.

memory lite
no memory lite

Syntax Description This command has no arguments or keywords.

Command Default This command is enabled by default.

Command Modes Global configuration

Command History Release Modification

12.3(11)T This command was introduced.

Usage Guidelines The malloc_lite feature was implemented to avoid excessive memory allocation overhead for situations
where less than 128 bytes were required. This feature is supported for processor memory pools only.
The malloc_lite feature is enabled by default. If the malloc_lite feature is disabled using the no memory
litecommand, you can re-enable the feature by entering the memory lite command.

Examples The following example shows how to disable the malloc_lite feature:

no memory lite

Related Commands Command Description

scheduler heapcheck process Performs a “sanity check” for corruption in
memory blocks when a process switch occurs.

Cisco IOS Configuration Fundamentals Command Reference

422
 L through mode
memory reserve

memory reserve
To reserve a specified amount of memory in kilobytes for console access and critical notifications, use the
memory reserve command in global configuration mode. To disable the configuration, use the no form of
this command.

Syntax for Releases 15.0(1)M and 12.2(33)SRC and Later Releases

memory reserve {console size | critical [total-size]}
no memory reserve {console | critical}

Syntax for Releases 12.2(33)SXI, Cisco IOS XE Release 2.1 and Later Releases
memory reserve critical [total-size]
no memory reserve critical

Syntax Description console Reserves the memory size for a console session.

size Amount of memory to be reserved, in kilobytes.

The range is from 1 to 4096.

critical Reserves the memory for critical notifications.

total-size (Optional) Total amount of memory to be reserved,

in kilobytes. The range is from 1 to 4294967295.

Command Modes Global configuration (config)

Command Default 256 KB is reserved for console memory access. 100 KB is reserved for cricial memory access.

Command History Release Modification

15.0(1)M This command was introduced in a release earlier
than Cisco IOS Release 15.0(1)M.

12.2(33)SRC This command was integrated into a release earlier

than Cisco IOS Release 12.2(33)SRC.

12.2(33)SXI This command was integrated into a release earlier

than Cisco IOS Release 12.2(33)SXI.

Cisco IOS Configuration Fundamentals Command Reference

423
 L through mode
memory reserve

Release Modification
Cisco IOS XE Release 2.1 This command was implemented on the Cisco ASR
1000 Series Aggregation Services Routers.

Usage Guidelines The memory reserve console command reserves enough memory to ensure console access to a Cisco IOS
device for administrative and troubleshooting purposes. This feature is especially beneficial when the
device runs low on memory.
The memory reserve critical command reserves the specified amount of memory in kilobytes so that the
router can issue critical notifications. The amount of memory reserved for critical notifications cannot
exceed 25 percent of the total available memory.

Examples The following example shows how to reserve a specified amount of memory in kilobytes for console
access:

Router# configure terminal

Router(config)# memory reserve console 2

Related Commands Command Description

memory free low-watermark Configures a router to issue system logging
message notifications when available memory falls
below a specified threshold.

Cisco IOS Configuration Fundamentals Command Reference

424
 L through mode
memory reserve critical

memory reserve critical

Note Effective with Cisco IOS Release 12.4(15)T1, the memory reserve critical command is replaced by the
memory reserve command. See the memory reserve command for more information.

To configure the size of the memory region to be used for critical notifications (system logging messages),
use the memory reserve criticalcommand in global configuration mode. To disable the reservation of
memory for critical notifications, use the no form of this command.
memory reserve critical kilobytes
no memory reserve critical

Syntax Description kilobytes Specifies the amount of memory to be reserved in

kilobytes. Valid values are 1 to 4294967295, but
the value you specify cannot exceed 25 percent of
total memory. The default is 100 kilobytes.

Command Default 100 kilobytes of memory is reserved for the logging process.

Command Modes Global configuration (config)

Command History Release Modification

12.2(18)S This command was introduced.

12.0(26)S This command was integrated into Cisco IOS

Release 12.0(26)S.

12.3(4)T This command was integrated into Cisco IOS

Release 12.3(4)T.

12.2(27)SBC This command was integrated into Cisco IOS

Release 12.2(27)SBC.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.4(15)T1 This command was replaced by the memory

reserve command.

Cisco IOS Configuration Fundamentals Command Reference

425
 L through mode
memory reserve critical

Usage Guidelines This command reserves a region of memory on the router so that, when system resources are overloaded,
the router retains enough memory to issue critical system logging messages.

Note Once the size of the reserved memory region is specified, any change to the specified value takes effect
only after the current configuration is saved and the system has been reloaded.

Examples The following example shows how to reserve 1,000 KB of system memory for logging messages at the
next system restart:

Router(config)# memory reserve critical 1000

Related Commands Command Description

memory free low-watermark Configures a router to issue syslog notifications
when available memory falls below a specified
threshold.

Cisco IOS Configuration Fundamentals Command Reference

426
 L through mode
memory sanity

memory sanity
To perform a “sanity check” for corruption in buffers and queues, use the memory sanity command in
global configuration mode. To disable this feature, use the no form of this command.
memory sanity [buffer | queue | all]
no memory sanity

Syntax Description buffer (Optional) Specifies checking all buffers.

queue (Optional) Specifies checking all queues.

all (Optional) Specifies checking all buffers and

queues.

Command Default This command is not enabled by default. If the buffer or queue keyword is not specified, a sanity check
will be performed on all buffers and queues.

Command Modes Global configuration

Command History Release Modification

12.2(15)T This command was introduced.

Usage Guidelines When the memory sanity buffer command is enabled, a sanity check is performed on buffers when a
packet buffer is allocated or when a packet buffer is returned to the buffer pool. This command also time-
stamps the buffer, which may be useful when tracking the age of a buffer.
The memory sanity command can be saved in the startup configuration file and, therefore, it is not
necessary to reconfigure this command each time the router is reloaded. Like the scheduler heapcheck
process memory command, the memory sanity command can check for corruption in the I/O memory
block.
Enabling the memory sanity command may result in slight router performance degradation.

Examples The following example shows how to perform a sanity check for corruption in all buffers and queues:
memory sanity all

Cisco IOS Configuration Fundamentals Command Reference

427
 L through mode
memory sanity

Related Commands Command Description

scheduler heapcheck process memory Performs a “sanity check” for corruption in
memory blocks when a process switch occurs.

Cisco IOS Configuration Fundamentals Command Reference

428
 L through mode
memory scan

memory scan
To enable the Memory Scan feature, use the memory scan command in global configuration mode. To
restore the router configuration to the default, use the no form of this command.

memory scan
no memory scan

Syntax Description This command has no arguments or keywords.

Command Default This command is disabled by default.

Command Modes Global configuration

Command History Release Modification

12.0(4)XE This command was introduced.

12.0(7)T This command was integrated in Cisco IOS Release

12.0 T for the Cisco 7500 series only.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The Memory Scan feature adds a low-priority background process that searches all installed dynamic
random-access memory (DRAM) for possible parity errors. If errors are found in memory areas that are not
in use, this feature attempts to scrub (remove) the errors. The time to complete one memory scan and scrub
cycle can range from 10 minutes to several hours, depending on the amount of installed memory. The
impact of the Memory Scan feature on the central processing unit (CPU) is minimal. To view the status of
the memory scan feature on your router, use the show memory scan command in EXEC mode.

Examples The following example enables the Memory Scan feature on a Cisco 7500 series router:

Router(config)# memory scan

Cisco IOS Configuration Fundamentals Command Reference

429
 L through mode
memory scan

Related Commands Command Description

show memory scan Displays the number and type of parity errors on
your system.

Cisco IOS Configuration Fundamentals Command Reference

430
 L through mode
memory-size iomem

memory-size iomem
To reallocate the percentage of DRAM to use for I/O memory and processor memory, use the memory-size
iomem command in global configuration mode. To revert to the default memory allocation, use the no
form of this command.

memory-size iomem i/o-memory-percentage

no memory-size iomem

Syntax Description i/o-memory-percentage The percentage of DRAM allocated to I/O memory,

in bytes. The values permitted are 5, 10, 15, 20, 25,
30, 40, and 50 . A minimum of 4 MB of memory is
required for I/O memory.

Command Default The default memory allocation is 25 percent of the DRAM to I/O memory and 75 percent of the DRAM to
processor memory.

Note If thesmartinitprocess has been enabled, the default memory allocation of 25 percent to the I/O memory
does not apply. Instead, smartinitexamines the network modules, and then calculates the memory
allocation for the I/O memory.

Command Modes Global configuration (config)

Command History Release Modification

11.2 P This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.4(15)T1 This command was integrated into Cisco IOS

Release 12.4(15)T1.

Usage Guidelines When you specify the percentage of I/O memory in the command line, the processor memory automatically
acquires the remaining percentage of the DRAM memory.

Cisco IOS Configuration Fundamentals Command Reference

431
 L through mode
memory-size iomem

Examples The following example allocates 40 percent of the DRAM memory to I/O memory and the remaining 60
percent to the processor memory:

Router#
configure terminal
Router(config)#
memory-size iomem 40
Smart-init will be disabled and new I/O memory size will take effect upon reload.

Cisco IOS Configuration Fundamentals Command Reference

432
 L through mode
menu (EXEC)

menu (EXEC)
To display a preconfigured user menu, use the menu command in user EXEC or privileged EXEC mode.

menu menu-name

Syntax Description menu-name The name of the menu.

Command Modes User EXEC

Privileged EXEC

Command History Release Modification

10.0 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines A user menu is a type of user interface where text descriptions of actions to be performed are displayed to
the user. The user can use the menu to select services and functions without having to know the details of
command-line interface (CLI) commands.
Menus can be created for users in global configuration mode, using the commands listed in the “Related
Commands” section.
A menu can be invoked at either the user or privileged EXEC level, but if an item in the menu contains a
privileged EXEC command, the user must be logged in at the privileged level for the command to succeed.

Examples The following example invokes a menu named OnRamp:

Router> menu OnRamp

Welcome to OnRamp Internet Services

Type a number to select an option;

Type 9 to exit the menu.
1 Read email
2 UNIX Internet access
3 Resume UNIX connection
6 Resume next connection
9 Exit menu system

Cisco IOS Configuration Fundamentals Command Reference

433
 L through mode
menu (EXEC)

Related Commands Command Description

menu clear-screen Clears the terminal screen before displaying a
menu.

menu command Specifies underlying commands for user interface

menus.

menu default Specifies the menu item to use as the default.

menu line-mode Requires the user to press Enter after specifying an

option number.

menu options Sets options for items in user interface menus.

menu prompt Specifies the prompt for a user interface menu.

menu single-space Displays menu items single-spaced rather than

double-spaced.

menu status-line Displays a line of status information about the

current user at the top of a menu.

menu text Specifies the text of a menu item in a user interface

menu.

menu title Creates a title, or banner, for a user menu.

no menu Deletes a specified menu from a menu

configuration.

Cisco IOS Configuration Fundamentals Command Reference

434
 L through mode
menu menu-name single-space

menu menu-name single-space

To display menu items single-spaced rather than double-spaced, use the menu <menu-name> single-space
command in global configuration mode.

menu menu-name single-space

Syntax Description menu-name Name of the menu this command should be applied
to.

Command Default Enabled for menus with more than nine items; disabled for menus with nine or fewer items.

Command Modes Global configuration

Command History Release Modification

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 more than nine menu items are defined, the menu is displayed single-spaced. To configure the menus
with nine or fewer items to display single-spaced, use this command.

Examples In the following example, single-spaced menu items are displayed for the menu named Access1:

menu Access1 single-space

Related Commands Command Description

menu (EXEC) Invokes a user menu.

menu clear-screen Clears the terminal screen before displaying a

menu.

menu command Specifies underlying commands for user menus.

Cisco IOS Configuration Fundamentals Command Reference

435
 L through mode
menu menu-name single-space

Command Description
menu default Specifies the menu item to use as the default.

menu line-mode Requires the user to press Enter after specifying an

item.

menu options Sets options for items in user menus.

menu prompt Specifies the prompt for a user menu.

menu status-line Displays a line of status information about the

current user at the top of a menu.

menu text Specifies the text of a menu item in a user menu.

menu title Creates a title, or banner, for a user menu.

Cisco IOS Configuration Fundamentals Command Reference

436
 L through mode
menu clear-screen

menu clear-screen
To clear the terminal screen before displaying a menu, use the menu clear-screen command in global
configuration mode.

menu clear-screen menu-name clear-screen

Syntax Description menu-name Name of the menu this command should be applied
to.

Command Default Disabled

Command Modes Global configuration

Command History Release Modification

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 uses a terminal-independent mechanism based on termcap entries defined in the router and
the configured terminal type for the user. This command allows the same menu to be used on multiple
types of terminals instead of having terminal-specific strings embedded within menu titles. If the termcap
entry does not contain a clear string, the menu system enters 24 new lines, causing all existing text to scroll
off the top of the terminal screen.

Examples In the following example, the terminal screen is cleared before displaying the menu named Access1:

Router(config)# menu Access1 clear-screen

Related Commands Command Description

menu (EXEC) Invokes a user menu.

menu command Specifies underlying commands for user menus.

Cisco IOS Configuration Fundamentals Command Reference

437
 L through mode
menu clear-screen

Command Description
menu default Specifies the menu item to use as the default.

menu line-mode Requires the user to press Enter after specifying an

item.

menu options Sets options for items in user menus.

menu prompt Specifies the prompt for a user menu.

menu single-space Displays menu items single-spaced rather than

double-spaced.

menu status-line Displays a line of status information about the

current user at the top of a menu

menu text Specifies the text of a menu item in a user menu.

menu title Creates a title, or banner, for a user menu.

no menu Deletes a specified menu from a menu

configuration.

Cisco IOS Configuration Fundamentals Command Reference

438
 L through mode
menu command

menu command
To specify underlying commands for user menus, use the menu command command in global
configuration mode.

menu command menu menu-name command menu-item {command | menu-exit}

Syntax Description menu-name Name of the menu. You can specify a maximum of
20 characters.

menu-item Number, character, or string used as the key for the

item. The key is displayed to the left of the menu
item text. You can specify a maximum of 18 menu
entries. When the tenth item is added to the menu,
the line-mode and single-space options are
activated automatically.

command Command to issue when the user selects an item.

menu-exit Provides a way for menu users to return to a higher-

level menu or exit the menu system.

Command Default Disabled

Command Modes Global configuration

Command History Release Modification

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 assign actions to items in a menu. Use the menu text global configuration command
to assign text to items. These commands must use the same menu name and menu selection key.
The menu command command has a special keyword for the command argument, menu-exit, that is
available only within menus. It is used to exit a submenu and return to the previous menu level, or to exit
the menu altogether and return to the EXEC command prompt.
You can create submenus that are opened by selecting entries in another menu. Use the menu EXEC
command as the command for the submenu item.

Cisco IOS Configuration Fundamentals Command Reference

439
 L through mode
menu command

Note If you nest too many levels of menus, the system prints an error message on the terminal and returns to the
previous menu level.

When a menu allows connections (their normal use), the command for an entry activating the connection
should contain a resume command, or the line should be configured to prevent users from escaping their
sessions with the escape-char none command. Otherwise, when they escape from a connection and return
to the menu, there will be no way to resume the session and it will sit idle until the user logs out.
Specifying the resume command as the action that is performed for a selected menu entry permits a user to
resume a named connection or connect using the specified name, if there is no active connection by that
name. As an option, you can also supply the connect string needed to connect initially. When you do not
supply this connect string, the command uses the specified connection name.
You can also use the resume/next command, which resumes the next connection in the user’s list of
connections. This function allows you to create a single menu entry that steps through all of the user’s
connections.

Note A menu should not contain any exit paths that leave users in an unfamiliar interface environment.

When a particular line should always display a menu, that line can be configured with an autocommand
line configuration command. Menus can be run on a per-user basis by defining a similar
autocommandcommand for that local username. For more information about the autocommand
command, refer to the Cisco IOS Dial Technologies Configuration Guide.

Examples In the following example, the commands to be issued when the menu user selects option 1, 2, or 3 are
specified for the menu named Access1:

menu Access1 command 1 tn3270 vms.cisco.com

menu Access1 command 2 rlogin unix.cisco.com
menu Access1 command 3 menu-exit

The following example allows a menu user to exit a menu by entering Exit at the menu prompt:

menu Access1 text Exit Exit

menu Access1 command Exit menu-exit

Related Commands Command Description

autocommand Configures the Cisco IOS software to automatically
execute a command when a user connects to a
particular line.

menu (EXEC) Invokes a user menu.

menu clear-screen Clears the terminal screen before displaying a

menu.

Cisco IOS Configuration Fundamentals Command Reference

440
L through mode
menu command

Command Description
menu default Specifies the menu item to use as the default.

menu line-mode Requires the user to press Enter after specifying an

item.

menu options Sets options for items in user menus.

menu prompt Specifies the prompt for a user menu.

menu single-space Displays menu items single-spaced rather than

double-spaced.

menu status-line Displays a line of status information about the

current user at the top of a menu

menu text Specifies the text of a menu item in a user menu.

menu title Creates a title, or banner, for a user menu.

Cisco IOS Configuration Fundamentals Command Reference

441
 L through mode
menu default

menu default
To specify the menu item to use as the default, use the menu default command in global configuration
mode.

menu menu-name default menu-item

Syntax Description menu-name Name of the menu. You can specify a maximum of
20 characters.

menu-item Number, character, or string key of the item to use

as the default.

Command Default Disabled

Command Modes Global configuration

Command History Release Modification

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 specify which menu entry is used when the user presses Enter without specifying an
item. The menu entries are defined by the menu command and menu text global configuration commands.

Examples In the following example, the menu user exits the menu when pressing Enter without selecting an item:

menu Access1 9 text Exit the menu

menu Access1 9 command menu-exit
menu Access1 default
9

Cisco IOS Configuration Fundamentals Command Reference

442
 L through mode
menu default

Related Commands Command Description

menu (EXEC) Invokes a preconfigured user menu.

menu command Specifies underlying commands for user menus.

menu prompt Specifies the prompt for a user menu.

menu text Specifies the text of a menu item in a user menu.

menu title Creates a title, or banner, for a user menu.

Cisco IOS Configuration Fundamentals Command Reference

443
 L through mode
menu line-mode

menu line-mode
To require the user to press Enter after specifying an item, use the menu line-mode command in global
configuration mode.

menu menu-name line-mode

Syntax Description menu-name Name of the menu this command should be applied
to.

Command Default Enabled for menus with more than nine items. Disabled for menus with nine or fewer items.

Command Modes Global configuration

Command History Release Modification

10.0 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines In a menu of nine or fewer items, you ordinarily select a menu item by entering the item number. In line
mode, you select a menu entry by entering the item number and pressing Enter. Line mode allows you to
backspace over the selected number and enter another number before pressing Enter to issue the command.
This option is activated automatically when more than nine menu items are defined but also can be
configured explicitly for menus of nine or fewer items.
In order to use strings as keys for items, the menu line-mode command must be configured.

Examples In the following example, the line-mode option is enabled for the menu named Access1:

menu Access1 line-mode

Cisco IOS Configuration Fundamentals Command Reference

444
 L through mode
menu line-mode

Related Commands Command Description

menu (EXEC) Invokes a preconfigured user menu.

menu clear-screen Clears the terminal screen before displaying a

menu.

menu command Specifies underlying commands for a user menu.

menu default Specifies the menu item to use as the default.

menu options Sets options for items in user menus.

menu prompt Specifies the prompt for a user menu.

menu single-space Displays menu items single-spaced rather than

double-spaced.

menu status-line Displays a line of status information about the

current user at the top of a menu.

menu text Specifies the text of a menu item in a user menu.

Cisco IOS Configuration Fundamentals Command Reference

445
 L through mode
menu options

menu options
To set options for items in user menus, use the menu options command in global configuration mode.

Cisco IOS Release 10.0, 12.2(33)SRA, 12.2(33)SXI , and Later Releases

menu menu-name options menu-item [login] [pause]

Cisco IOS XE Release 3.1S and Later Releases

menu menu-name options menu-item {login | pause}

Syntax Description menu-name The name of the menu. You can specify a
maximum of 20 characters.

menu-item Number, character, or string key of the item

affected by the option.

login (Optional) Configures the router to request a login

before issuing the command.

pause (Optional) Configures the router to pause after

issuing the command and before redrawing the
menu.

Command Default The menu options are disabled.

Command Modes Global configuration (config)

Command History Release Modification

10.0 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2(33)SXI This command was integrated into a release earlier

than Cisco IOS Release 12.2(33)SXI.

Cisco IOS XE Release 3.1S This command was integrated into a release earlier
than Cisco IOS Release 3.1S.

Cisco IOS Configuration Fundamentals Command Reference

446
 L through mode
menu options

Usage Guidelines Use the menu command and menu text commands to define a menu entry.

Examples The following example shows how to configure the router to request a login before issuing the command
specified by menu entry 3 of the menu named Access1:

Router(config)#
menu Access1 options 3 login

Related Commands Command Description

menu (EXEC) Invokes a user menu.

menu clear-screen Clears the terminal screen before displaying a

menu.

menu command Specifies underlying commands for user menus.

menu default Specifies the menu item to use as the default.

menu line-mode Requires the user to press Enter after specifying an

item.

menu prompt Specifies the prompt for a user menu.

menu single-space Displays menu items single-spaced rather than

double-spaced.

menu status-line Displays a line of status information about the

current user at the top of a menu.

menu text Specifies the text of a menu item in a user menu.

menu title Creates a title, or banner, for a user menu.

Cisco IOS Configuration Fundamentals Command Reference

447
 L through mode
menu prompt

menu prompt
To specify the prompt for a user menu, use the menu prompt command in global configuration mode.

menu menu-name prompt d prompt d

Syntax Description menu-name Name of the menu. You can specify a maximum of
20 characters.

d A delimiting character that marks the beginning and

end of a title. Text delimiters are characters that do
not ordinarily appear within the text of a title, such
as slash ( / ), double quote ("), and tilde (~). ^C is
reserved for special use and should not be used in
the text of the title.

prompt Prompt string for the menu.

Command Default Disabled

Command Modes Global configuration

Command History Release Modification

10.0 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Press Enter after entering the first delimiter. The router will prompt you for the text of the prompt. Enter the
text followed by the delimiter, and press Enter.
Use the menu command and menu text commands to define the menu selections.

Examples In the following example, the prompt for the menu named Access1 is configured as “Select an item.”:

Router(config)# menu Access1 prompt /

Enter TEXT message. End with the character '/'.
Select an item. /
Router(config)#

Cisco IOS Configuration Fundamentals Command Reference

448
 L through mode
menu prompt

Related Commands Command Description

menu (EXEC) Invokes a user menu.

menu command Specifies underlying commands for user menus.

menu default Specifies the menu item to use as the default.

menu text Specifies the text of a menu item in a user menu.

menu title Creates a title, or banner, for a user menu.

Cisco IOS Configuration Fundamentals Command Reference

449
 L through mode
menu status-line

menu status-line
To display a line of status information about the current user at the top of a menu, use the menu status-line
command in global configuration mode.

menu menu-name status-line

Syntax Description menu-name Name of the menu this command should be applied
to.

Command Default Disabled

Command Modes Global configuration

Command History Release Modification

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 displays the status information at the top of the screen before the menu title is displayed.
This status line includes the router’s host name, the user’s line number, and the current terminal type and
keymap type (if any).

Examples In the following example, status information is enabled for the menu named Access1:

menu Access1 status-line

Related Commands Command Description

menu (EXEC) Invokes a user menu.

menu clear-screen Clears the terminal screen before displaying a

menu.

Cisco IOS Configuration Fundamentals Command Reference

450
L through mode
menu status-line

Command Description
menu command Specifies underlying commands for user menus.

menu default Specifies the menu item to use as the default.

menu line-mode Requires the user to press Enter after specifying an

item in a menu.

menu options Sets options for items in user menus.

menu prompt Specifies the prompt for a user menu.

menu single-space Displays menu items single-spaced rather than

double-spaced.

menu text Specifies the text of a menu item in a user menu.

menu title Creates a title, or banner, for a user menu.

Cisco IOS Configuration Fundamentals Command Reference

451
 L through mode
menu text

menu text
To specify th e text of a menu item in a user menu, use the menu text command in global configuration
mode.

menu menu-name text menu-item menu-text

Syntax Description menu-name Name of the menu. You can specify a maximum of
20 characters.

menu-item Number, character, or string used as the key for the

item. The key is displayed to the left of the menu
item text. You can specify a maximum of 18 menu
items. When the tenth item is added to the menu,
the menu line-mode and menu single-space
commands are activated automatically.

menu-text Text of the menu item.

Command Default No text appears for the menu item.

Command Modes Global configuration

Command History Release Modification

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 assign text to items in a menu. Use the menu command command to assign actions
to items. These commands must use the same menu name and menu selection key.
You can specify a maximum of 18 items in a menu.

Examples In the following example, the descriptive text for the three entries is specified for options 1, 2, and 3 in the
menu named Access1:

menu Access1 text 1 IBM Information Systems

Cisco IOS Configuration Fundamentals Command Reference

452
 L through mode
menu text

menu Access1 text 2 UNIX Internet Access

menu Access1 text 3 Exit menu system

Related Commands Command Description

menu (EXEC) Invokes a user menu.

menu clear-screen Clears the terminal screen before displaying a

menu.

menu command Specifies underlying commands for user menus.

menu default Specifies the menu item to use as the default.

menu line-mode Requires the user to press Enter after specifying an

item.

menu options Sets options for items in user menus.

menu prompt Specifies the prompt for a user menu.

menu single-space Displays menu items single-spaced rather than

double-spaced.

menu status-line Displays a line of status information about the

current user at the top of a menu.

menu title Creates a title, or banner, for a user menu.

Cisco IOS Configuration Fundamentals Command Reference

453
 L through mode
menu title

menu title
To create a t itle (banner) for a user menu, use the menu title command in global configuration mode.

menu menu-name title d menu-title d

Syntax Description menu-name Name of the menu. You can specify a maximum of
20 characters.

d A delimiting character that marks the beginning and

end of a title. Text delimiters are characters that do
not ordinarily appear within the text of a title, such
as slash ( / ), double quote ("), and tilde (~). ^C is
reserved for special use and should not be used in
the text of the title.

menu-title Lines of text to appear at the top of the menu.

Command Default The menu does not have a title.

Command Modes Global configuration

Command History Release Modification

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 menu title command must use the same menu name used with the menu text and menu command
commands used to create a menu.
You can position the title of the menu horizontally by preceding the title text with blank characters. You
can also add lines of space above and below the title by pressing Enter.
Follow the title keyword with one or more blank characters and a delimiting character of your choice. Then
enter one or more lines of text, ending the title with the same delimiting character. You cannot use the
delimiting character within the text of the message.
When you are configuring from a terminal and are attempting to include special control characters, such as
a screen-clearing string, you must use Ctrl-V before the special control characters so that they are accepted
as part of the title string. The string ^[[H^[[J is an escape string used by many VT100-compatible terminals
to clear the screen. To use a special string, you must enter Ctrl-V before each escape character.

Cisco IOS Configuration Fundamentals Command Reference

454
 L through mode
menu title

You also can use the menu clear-screen global configuration command to clear the screen before
displaying menus and submenus, instead of embedding a terminal-specific string in the menu title. The
menu clear-screen command allows the same menu to be used on different types of terminals.

Examples In the following example, the title that will be displayed is specified when the menu named Access1 is
invoked. Press Enter after the second slash (/) to display the prompt.

Router(config)# menu Access1 title /^[[H^[[J

Enter TEXT message. End with the character '/'.
Welcome to Access1 Internet Services

Type a number to select an option;

Type 9 to exit the menu.
/
Router(config)#

Related Commands Command Description

menu (EXEC) Invokes a user menu.

menu clear-screen Clears the terminal screen before displaying a

menu.

menu command Specifies underlying commands for user menus.

menu default Specifies the menu item to use as the default.

menu line-mode Requires the user to press Enter after specifying an

item.

menu options Sets options for items in user menus.

menu prompt Specifies the prompt for a user menu.

menu single-space Displays menu items single-spaced rather than

double-spaced.

menu status-line Displays a line of status information about the

current user at the top of a menu.

menu text Specifies the text of a menu item in a user menu.

Cisco IOS Configuration Fundamentals Command Reference

455
 L through mode
microcode (12000)

microcode (12000)
To load a Cisco IOS software image on a line card from Flash memory or the GRP card on a Cisco 12000
series Gigabit Switch Router (GSR), use the microcode command in global configuration mode. To load
the microcode bundled with the GRP system image, use the no form of this command.

microcode {oc12-atm | oc12-pos | oc3-pos4} {flash file-id [slot] | system [slot]}

no microcode {oc12-atm | oc12-pos | oc3-pos4} [flash file-id [slot] | system [slot]]

Syntax Description oc12-atm | oc12-pos | oc3-pos4 Interface name.

flash Loads the image from the Flash file system.

file-id Specifies the device and filename of the image file

to download from Flash memory. A colon (:) must
separate the device and filename (for example,
slot0:gsr-p-mz). Valid devices include:
• bootflash: --Internal Flash memory.
• slot0: --First PCMCIA slot.
• slot1: --Second PCMCIA slot.

slot (Optional) Slot number of the line card that you

want to copy the software image to. Slot numbers
range from 0 to 11 for the Cisco 12012 router and 0
to 7 for the Cisco 12008 router. If you do not
specify a slot number, the Cisco IOS software
image is downloaded on all line cards.

system Loads the image from the software image on the

GRP card.

Command Default The default is to load the image from the GRP card (system).

Command Modes Global configuration

Command History Release Modification

11.2 GS This command was introduced for Cisco 12000
series GSRs.

Cisco IOS Configuration Fundamentals Command Reference

456
 L through mode
microcode (12000)

Release Modification
12.2(33)SRA This command was integrated into Cisco IOS
Release 12.2(33)SRA.

Usage Guidelines In addition to the Cisco IOS image that resides on the GRP card, each line card on a Cisco 12000 series has
a Cisco IOS image. When the router is reloaded, the specified image is loaded onto the GRP card and then
automatically downloaded to all the line cards.
Normally, you want the same Cisco IOS image on the GRP card and all line cards. However, if you want to
upgrade a line card with a new version of microcode for testing or to fix a defect, you might need to load a
Cisco IOS image that is different from the one on the line card. Additionally, you might need to load a new
image on the line card to work around a problem that is affecting only one of the line cards.
To load a Cisco IOS image on a line card, first use the copy tftp command to download the Cisco IOS
image to a slot on one of the PCMCIA Flash memory cards. Then use the microcode command to
download the image to the line card, followed by the microcode reload command to start the image.
Immediately after you enter the microcode reload command and press Return, the system reloads all
microcode. Global configuration mode remains enabled. After the reloading is complete, enter the exit
command to return to the EXEC system prompt.
To verify that the correct image is running on the line card, use the execute-on slot slot show version
command.
For additional information on GSR configuration, refer to the documentation specific to your Cisco IOS
software release.

Examples In the following example, the Cisco IOS software image in slot 0 is downloaded to the line card in slot 10.
This software image is used when the system is booted, a line card is inserted or removed, or the
microcode reloadglobal configuration command is issued.

Router(config)# microcode oc3-POS-4 flash slot0:fip.v141-7 10

Router(config)# microcode reload 10

In this example, the user would issue the execute-on slot 10 show version command to verify that the
correct version is loaded.

Related Commands Command Description

microcode reload (12000) Reloads microcode on Cisco 12000 series GSRs.

Cisco IOS Configuration Fundamentals Command Reference

457
 L through mode
microcode (7000/7500)

microcode (7000/7500)
To specify the location of the microcode that you want to download from Flash memory into the writable
control store (WCS) on Cisco 7000 series (including RSP based routers) or Cisco 7500 series routers, use
the microcode command in global configuration mode. To load the microcode bundled with the system
image, use the no form of this command.

microcode interface-type {flash-filesystem:filename [slot] | rom | system [slot]}

no microcode interface-type {flash-filesystem:filename [slot] | rom | system [slot]}

Syntax Description interface-type One of the following interface processor names:

aip, cip, eip, feip, fip, fsip, hip, mip, sip, sp, ssp,
trip, vip, or vip2

flash-filesystem : Flash file system, followed by a colon . Valid file

systems are bootflash, slot0, and slot1
Slave devices such as slaveslot0 are invalid. The
slave’s file system is not available during
microcode reloads.

filename Name of the microcode file.

slot (Optional) Number of the slot. Range is from 0 to

15.

rom If ROM is specified, the router loads from the

onboard ROM microcode.

system If the system keyword is specified, the router loads

the microcode from the microcode bundled into the
system image you are running for that interface
type.

Command Default The default is to load from the microcode bundled in the system image.

Command Modes Global configuration

Command History Release Modification

10.3 This command was introduced.

Cisco IOS Configuration Fundamentals Command Reference

458
 L through mode
microcode (7000/7500)

Release Modification
12.2(33)SRA This command was integrated into Cisco IOS
Release 12.2(33)SRA.

Usage Guidelines If you do not use the microcode reload command after using the microcode command, the microcode
reload command will be written to the configuration file automatically.
When using Dual RSPs for simple hardware backup, ensure that the master and slave RSP card contain the
same microcode image in the same location when the router is to load the interface processor microcode
from a Flash file system. Thus, if the slave RSP becomes the master, it will be able to find the microcode
image and download it to the interface processor.

Examples In the following example, all FIP cards will be loaded with the microcode found in Flash memoryfile
fip.v141-7 when the system is booted, when a card is inserted or removed, or when the microcode
reloadglobal configuration command is issued. The configuration is then written to the startup
configuration file.

Router(config)#
microcode fip slot0:fip.v141-7
Router(config)# end
Router# copy system:running-config nvram:startup-config

Related Commands Command Description

more flh:logfile Displays the system console output generated
during the Flash load helper operation.

Cisco IOS Configuration Fundamentals Command Reference

459
 L through mode
microcode (7200)

microcode (7200)
To configure a default override for the microcode that is downloaded to the hardware on a Cisco 7200
series router, use the microcode command in global configuration mode. To revert to the default microcode
for the current running version of the Cisco IOS software, use the no form of this command.

microcode {ecpa | pcpa} location

no microcode {ecpa | pcpa}

Syntax Description ecpa ESCON Channel Port Adapter (CPA) interface.

pcpa Parallel CPA interface.

location Location of microcode, including the device and

filename.

Command Default If the default or noform of the command is specified, the driver uses the default microcode for the current
running version of the Cisco IOS software.

Command Modes Global configuration

Command History Release Modification

11.3(3)T This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines If there are any default overrides when the configuration is written, then the microcode reload command
will be written to the configuration automatically. This action enables the configured microcode to be
downloaded at system startup.
The CPA microcode image is preloaded on Flash memory cards for Cisco 7200-series routers for Cisco
IOS Release 11.3(3)T and later releases. You may be required to copy a new image to Flash memory when
a new microcode image becomes available.
For more information on the CPA configuration and maintenance, refer to the “Configuring Cisco
Mainframe Channel Connection Adapters” chapter in the Release 12.2 Cisco IOS Bridging and IBM
Networking Configuration Guide.

Cisco IOS Configuration Fundamentals Command Reference

460
 L through mode
microcode (7200)

Examples The following example instructs the Cisco IOS software to load the microcode from an individual
microcode image that is stored as a file on the Flash card inserted in Flash card slot 0:

microcode ecpa slot0:xcpa26-1

Related Commands Command Description

microcode reload (7200) Resets and reloads the specified hardware in a
Cisco 7200 series router.

show microcode Displays microcode information.

Cisco IOS Configuration Fundamentals Command Reference

461
 L through mode
microcode reload (12000)

microcode reload (12000)

To reload the Cisco IOS image from a line card on Cisco 12000 series routers, use the microcode reload
command in global configuration mode.

microcode reload [slot-number]

Syntax Description slot-number (Optional) Slot number of the line card that you
want to reload the Cisco IOS software image on.
Slot numbers range from 0 to 11 for the Cisco
12012 and from 0 to 7 for the Cisco 12008 router. If
you do not specify a slot number, the Cisco IOS
software image is reloaded on all line cards.

Command Modes Global configuration

Command History Release Modification

11.2 GS This command was introduced for Cisco 12000
series GSRs.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines In addition to the Cisco IOS image that resides on the GRP card, each line card on Cisco 12000 series
routers has a Cisco IOS image. When the router is reloaded, the specified Cisco IOS image is loaded onto
the GRP card and automatically downloaded to all the line cards.
Normally, you want the same Cisco IOS image on the GRP card and all line cards. However, if you want to
upgrade a line card with a new version of microcode for testing or to fix a defect, you might need to load a
different Cisco IOS image. Additionally, you might need to load a new image on the line card to work
around a problem affecting only one of the line cards.
To load a Cisco IOS image on a line card, first use the copy tftp command to download the Cisco IOS
image to a slot on one of the PCMCIA Flash memory cards. Then use the microcode command to
download the image to the line card, followed by the microcode reload command to start the image. To
verify that the correct image is running on the line card, use the execute-on slot slot show version
command.
For additional information on GSR configuration, refer to the “Observing System Startup and Performing a
Basic Configuration” chapter in the Cisco 12000 series installation and configuration guides.
The microcode reload (12000) command allows you to issue another command immediately.

Cisco IOS Configuration Fundamentals Command Reference

462
 L through mode
microcode reload (12000)

Note Issuing a microcode reload command on any of the line cards in a Cisco 12000 GSR immediately returns
the console command prompt. This allows you to issue a subsequent command immediately to the
reloading line card. However, any commands entered at this time will not execute, and often no indication
will be given that such a command failed to run. Verify that the microcode has reloaded before issuing new
commands.

Examples In the following example, the mirocode firmware is reloaded on the line card in slot 10:

Router(config)# microcode reload 10

Related Commands Command Description

microcode (12000) Loads a Cisco IOS software image on a line card
from Flash memory or the GRP card on a Cisco
12000 series GSR.

Cisco IOS Configuration Fundamentals Command Reference

463
 L through mode
microcode reload (7000 7500)

microcode reload (7000 7500)

To reload the processor card on the Cisco 7000 series with RSP7000 or Cisco 7500 series routers, use the
microcode reload command in global configuration mode.

microcode reload [slot-number]

Syntax Description slot-number (Optional) Reloads the specified processor card slot
on a Cisco 7500 series router.

Command Default No default behaviors or values.

Command Modes Global configuration

Command History Release Modification

10.3 This command was introduced for Cisco 7500
series routers.

12.3(8)T The slot-number argument was added for Cisco

7500 series routers.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command reloads the microcode without rebooting the router. Immediately after you enter the
microcode reload command, the system reloads all microcode. Global configuration mode remains
enabled.

Note If you modify the system configuration to load a microcode image, the microcode reload command will be
written to the configuration file automatically following the use of a microcode command. This action
enables the configured microcode to be downloaded at system startup.

Cisco IOS Configuration Fundamentals Command Reference

464
 L through mode
microcode reload (7000 7500)

Examples In the following example, all controllers are reset, and the microcode specified in the current configuration
is loaded:

Router(config)# microcode reload

Related Commands Command Description

microcode (7000/7500) Specifies the location from where microcode should
be loaded when the microcode reload command is
processed on RSP-based routers.

Cisco IOS Configuration Fundamentals Command Reference

465
 L through mode
microcode reload (7200)

microcode reload (7200)

To reload the Cisco IOS microcode image on an ESCON CPA card in the Cisco 7200 series router, use the
microcode reload command in privileged EXEC mode.

microcode reload {all | ecpa [slot slot-number] | pcpa [slot slot-number]}

Syntax Description all Resets and reloads all hardware types that support
downloadable microcode.

ecpa Resets and reloads only those slots that contain

hardware type ecpa.

pcpa Resets and reloads only those slots that contain

hardware type pcpa.

slot slot-number (Optional) Resets and reloads only the slot

specified, and only if it contains the hardware
specified.

Command Modes Privileged EXEC

Command History Release Modification

11.3(3)T This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Hardware types that do not support downloadable microcode are unaffected by the microcode reload all
command.
You will be prompted for confirmation before the microcode reloadcommand is executed.

Examples The following example reloads the ESCON CPA microcode in slot 5 with the currently configured
microcode:

Router# microcode reload ecpa slot 5

Cisco IOS Configuration Fundamentals Command Reference

466
 L through mode
microcode reload (7200)

Related Commands Command Description

microcode (7200) Configures a default override for the microcode that
is downloaded to the hardware on a Cisco 7200
series router.

show microcode Displays the microcode bundled into a Cisco 7000

series with RSP7000, Cisco 7200 series, or Cisco
7500 series router.

Cisco IOS Configuration Fundamentals Command Reference

467
 L through mode
mkdir

mkdir
To create a new directory in a Class C flash file system, use the mkdir command in user EXEC, privileged
EXEC, or diagnostic mode.

mkdir directory

Syntax Description directory The name of the directory to create.

Command Modes User EXEC (>) Privileged EXEC (#) Diagnostic (diag)

Command History Release Modification

11.3AA This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Cisco IOS XE Release 2.1 This command was modified and implemented on
the Cisco ASR 1000 Aggregation Services Routers.
The following enhancements were made:
• This command was introduced in diagnostic
mode. The command can be entered in both
privileged EXEC and diagnostic mode on the
Cisco ASR 1000 Series Routers.
• The harddisk:, obfl:, stby-harddisk:, stby-
nvram:, stby-obfl:, stby-usb[0-1]:,and
usb[0-1]: directory options were added.

Usage Guidelines This command is valid only on Class C flash file systems.
When executing the mkdir directory command on a USB token device, you can create only two levels of
subdirectories under a directory. A new directory (third level directory) cannot be created on the USB
token, but you can copy files to the existing subdirectories.

Examples The following example creates a directory named newdir:

Router# mkdir newdir

Mkdir file name [newdir]?
Created dir flash:newdir
Router# dir

Cisco IOS Configuration Fundamentals Command Reference

468
 L through mode
mkdir

Directory of flash:
2 drwx 0 Mar 13 1993 13:16:21 newdir
8128000 bytes total (8126976 bytes free)

Related Commands Command Description

dir Displays a list of files on a file system.

rmdir Removes an existing directory in a Class C flash

file system.

Cisco IOS Configuration Fundamentals Command Reference

469
 L through mode
mkdir disk0:

mkdir disk0:
To create a new directory in a Flash file system, use the mkdir disk0:command.

mkdir disk0:

Syntax Description This command has no arguments or keywords.

Command Default This command has no default settings.

Command Modes EXEC

Command History Release Modification

12.2(14)SX Support for this command was introduced on the
Supervisor Engine 720.

12.2(17d)SXB Support for this command on the Supervisor Engine

2 was extended to the 12.2 SX release.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines This command is valid only on Flash file systems.

After you enter the mkdir disk0: command, you are prompted to enter the new directory filename.
To check your entry, enter the dir command.
To remove a directory, enter the rmdir command.

Examples This example shows how to create a directory named newdir:

Router# mkdir disk0:

Create directory filename [ ]? newdir
Created dir disk0: newdir
Router#

Cisco IOS Configuration Fundamentals Command Reference

470
 L through mode
mkdir disk0:

Related Commands Command Description

cd Changes the default directory or file system.

dir Displays a list of files on a file system.

rmdir Removes an existing directory in a Class C Flash

file system.

Cisco IOS Configuration Fundamentals Command Reference

471
 L through mode
mode

mode
To set the redundancy mode, use the mode command in redundancy configuration mode.

Syntax for 12.2S Release

mode {rpr | rpr-plus | sso}

Syntax for Cisco IOS XE Release 2.5 and Later Releases

mode {rpr | sso}

Syntax for 12.2XNE Release

mode sso

Syntax Description rpr Specifies Route Processor Redundancy (RPR)

mode.

rpr-plus Specifies Route Processor Redundancy Plus (RPR

+) mode.

sso Specifies stateful switchover (SSO) mode.

Command Default
• The default is SSO mode if the system is not configured for redundancy and the active and standby
supervisor engines have the same image.
• The default is RPR mode if different versions are installed.
• If redundancy is enabled, the default is the mode that you have configured.

Command Default
• The default is RPR+ mode if the system is not configured for redundancy and the active and standby
supervisor engines have the same image.
• The default is RPR mode if different versions are installed.
• If redundancy is enabled, the default is the mode that you have configured.

Command Default
• The default is SSO mode if the system is not configured for redundancy and the active and standby
supervisor engines have the same image.
• The default is RPR mode if different versions are installed.

Cisco IOS Configuration Fundamentals Command Reference

472
 L through mode
mode

Command Default • The default is SSO mode if the system is not configured for redundancy and the active and standby
supervisor engines have the same image.
• The default is RPR mode if different versions are installed.

Command Modes Redundancy configuration (config-red)

Command History Release Modification

12.2(14)SX This command was introduced on the Supervisor
Engine 720.

12.2(17b)SXA This command was modified. Support was added

for SSO mode and the default mode change.

12.2(17d)SXB This command was modified. Support was added

for multicast and unicast traffic.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2(33)XNE This command was modified. This command was

implemented on the Cisco 10000 router.

Cisco IOS XE Release 2.5 This command was modified. This command was
implemented on the Cisco ASR 1000 Series
Routers.

Usage Guidelines Cisco IOS Release 12.2S and 7600 Series Routers
SSO is not supported on Cisco 7600 series routers that are configured with a Supervisor Engine 2.
On releases prior to Release 12.2(17d)SXB, single router mode (SRM) with SSO redundancy does not
support stateful switchover for multicast traffic. When a switchover occurs, all multicast hardware
switching entries are removed and are then re-created and reinstalled in the hardware by the newly active
multilayer switch feature card (MSFC).
SRM/SSO is supported in the following releases only:
• Release 12.2(17b)SXA and subsequent rebuilds.
• Release 12.2(17d)SXB and subsequent rebuilds.
Nonstop forwarding (NSF) with SSO redundancy mode supports IPv4. NSF with SSO redundancy mode
does not support IPv6, Internetwork Packet Exchange (IPX), and Multiprotocol Label Switching (MPLS).
If you have configured MPLS on the Cisco 7600 series routers with redundant supervisor engines, you
must configure the Cisco 7600 series router in RPR mode. The switch should not be running in the default
mode of SSO.
Enter the redundancy command in global configuration mode to enter redundancy configuration mode.
You can enter the mode command within redundancy configuration mode.

Cisco IOS Configuration Fundamentals Command Reference

473
 L through mode
mode

Follow these guidelines when configuring your system for RPR+ mode:
• You must install compatible images on the active and standby supervisor engines to support RPR+
mode and SSO mode.
• Both supervisor engines must run the same Cisco IOS software version.
• Any modules that are not online at the time of a switchover are reset and reloaded on a switchover.
• The Forwarding Information Base (FIB) tables are cleared on a switchover. As a result, routed traffic
is interrupted until route tables reconverge.
The standby supervisor engine reloads on any change of mode and begins to work in the current mode.
When you use this command to force the standby supervisor engine to run as a Distributed Forwarding
Card (DFC) card, the uplink ports in the standby engine continue to be in use and are not disabled.
Cisco IOS Release XE Release 2.5 and ASR 1000 Series Routers
For Cisco ASR 1002 and 1004 routers, RRP and stateful switchover can be used to switch between Cisco
IOS processes. RPR and SSO need to be configured by the user, however, because a second Cisco IOS
process is not available by default on Cisco ASR 1002 and 1004 routers. Enter the redundancy command
in global configuration mode to enter redundancy configuration mode. You can enter the mode command
within redundancy configuration mode.
The Cisco ASR 1006 Router supports a second Route Processor. The second Cisco IOS process can run
only on the standby Route Processor. This means that hardware redundancy is available and RPR and SSO
do not need to be configured by the user because a second Cisco IOS process is available by default on the
Cisco ASR 1006 router.
RPR+ mode is not supported on the Cisco ASR 1000 Series Routers.
Cisco IOS Release 12.2XNE and 1000 Series Routers
Enter the redundancy command in global configuration mode to enter redundancy configuration mode.
You can enter the mode command within redundancy configuration mode.
RPR mode is not supported on the Cisco 10000 router.

Examples This example shows how to set the redundancy mode to RPR+:

Router(config)# redundancy
Router(config-red)# mode rpr-plus

This example shows how to set the redundancy mode to SSO:

Router(config)# redundancy
Router(config-red)# mode sso

Related Commands Command Description

redundancy Enters redundancy configuration mode.

redundancy force-switchover Forces a switchover from the active to the standby

supervisor engine.

route-converge-interval Configures the time interval after which the old FIB
entries are purged.

Cisco IOS Configuration Fundamentals Command Reference

474
L through mode
mode

Command Description
show redundancy Displays RF information.

show running-config Displays the status and configuration of the module

or Layer 2 VLAN.

Cisco IOS Configuration Fundamentals Command Reference

475
 L through mode
mode

Cisco IOS Configuration Fundamentals Command Reference

476
monitor event-trace through Q

Cisco IOS Configuration Fundamentals Command Reference

477
 monitor event-trace through Q
monitor event-trace (EXEC)

monitor event-trace (EXEC)

To monitor and control the event trace function for a specified Cisco IOS software subsystem component,
use the monitor event-trace command in privileged EXEC mode.

monitor event-trace component {clear | continuous | disable | dump [pretty] | enable | one-shot}

Cisco 10000 Series Routers

monitor event-trace component {disable | dump | enable | size | stacktrace}

Catalyst 6500 Series Switches and Cisco 7600 Series Routers

monitor event-trace all-traces {continuous [cancel] | dump [merged] [pretty]}
monitor event-trace l3 {clear | continuous [cancel] | disable | dump [pretty] | enable | interface
type mod/port | one-shot}
monitor event-trace spa {clear | continuous [cancel] | disable | dump [pretty] | enable | one-shot}
monitor event-trace subsys {clear | continuous [cancel] | disable | dump [pretty] | enable | one-
shot}

Syntax Description component Name of the Cisco IOS software subsystem

component that is the subject of the event trace. To
get a list of components that support event tracing,
use the monitor event-trace ? command.

clear Clears existing trace messages for the specified

component from memory on the networking device.

continuous Continuously displays the latest event trace entries.

disable Turns off event tracing for the specified component.

dump Writes the event trace results to the file configured

using the monitor event-trace command in global
configuration mode. The trace messages are saved
in binary format.

pretty (Optional) Saves the event trace message in ASCII

format.

enable Turns on event tracing for the specified component.

one-shot Clears any existing trace information from memory,

starts event tracing again, and disables the trace
when the trace reaches the size specified using the
monitor event-tracecommand in global
configuration mode.

Cisco IOS Configuration Fundamentals Command Reference

478
 monitor event-trace through Q
monitor event-trace (EXEC)

size Sets the number of messages that can be written to

memory for a single instance of a trace.
Note Some Cisco IOS software subsystem
components set the size by default. To
display the size parameter, use the show
monitor event-trace componentparameters
command.
When the number of event trace messages in
memory exceeds the size, new messages will begin
to overwrite the older messages in the file.

stacktrace Enables the stack trace at tracepoints.

all-traces Displays the configured merged-event traces.

merged (Optional) Dumps the entries in all event traces

sorted by time.

l3 Displays information about the Layer 3 trace.

spa Displays information about the Shared Port Adapter

(SPA) trace.

interface type mod / port Specifies the interface to be logged.

cancel (Optional) Cancels the continuous display of latest

trace entries.

subsys Displays information about the subsystem’s initial

trace.

Command Default The event trace function is disabled by default.

Command Modes Privileged EXEC (#)

Command History Release Modification

12.0(18)S This command was introduced.

12.2(8)T This command was integrated into Cisco IOS

Release 12.2(8)T.

12.2(14)SX Support for this command was introduced on the

Supervisor Engine 720.

Cisco IOS Configuration Fundamentals Command Reference

479
 monitor event-trace through Q
monitor event-trace (EXEC)

Release Modification
12.2(25)S This command was integrated into Cisco IOS
Release 12.2(25)S. The monitor event-trace cef
ipv4 clearcommand replaces the clear ip cef
event-logcommand.

12.2(28)SB This command was integrated into Cisco IOS

Release 12.2(28)SB and implemented on the Cisco
10000 series routers.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2(33)SXH This command was integrated into Cisco IOS

Release 12.2(33)SXH.

12.4(20)T This command was integrated into Cisco IOS

Release 12.4(20)T.

Usage Guidelines Use the monitor event-trace command to control what, when, and how event trace data is collected. Use
this command after you have configured the event trace functionality on the networking device using the
monitor event-trace command in global configuration mode.

Note The amount of data collected from the trace depends on the trace message size configured using the
monitor event-tracecommand in global configuration mode for each instance of a trace.

The Cisco IOS software allows for the subsystem components to define whether support for event tracing is
enabled or disabled at boot time. You can enable or disable event tracing in two ways: using the monitor
event-tracecommand in privileged EXEC mode or using the monitor event-tracecommand in global
configuration mode. To disable event tracing, you would enter either of these commands with the disable
keyword. To enable event tracing again, you would enter either of these commands with the enable
keyword.
To determine whether you can enable event tracing on a subsystem, use the monitor event-trace ?
commandto get a list of software components that support event tracing. To determine whether event
tracing is enabled by default for the subsystem, use the show monitor event-trace command to display
trace messages.
Use the show monitor event-trace command to display trace messages. Use the monitor event-trace
component dump command to save trace message information for a single event. By default, trace
information is saved in binary format. If you want to save trace messages in ASCII format, possibly for
additional application processing, use the monitor event-trace component dump pretty command.
To write the trace messages for all events currently enabled on a networking device to a file, enter the
monitor event-trace dumpcommand.
To configure the file where you want to save trace information, use the monitor event-trace command in
global configuration mode. The trace messages are saved in a binary format.

Cisco IOS Configuration Fundamentals Command Reference

480
 monitor event-trace through Q
monitor event-trace (EXEC)

Examples The following example shows the privileged EXEC commands to stop event tracing, clear the current
contents of memory, and reenable the trace function for the interprocess communication (IPC) component.
This example assumes that the tracing function is configured and enabled on the networking device.

Router# monitor event-trace ipc disable

Router# monitor event-trace ipc clear

Router# monitor event-trace ipc enable

The following example shows how the monitor event-trace one-shotcommand accomplishes the same
function as the previous example except in one command. In this example, once the size of the trace
message file has been exceeded, the trace is terminated.

Router# monitor event-trace ipc one-shot

The following example shows the command for writing trace messages for an event in binary format. In
this example, the trace messages for the IPC component are written to a file.

Router# monitor event-trace ipc dump

The following example shows the command for writing trace messages for an event in ASCII format. In
this example, the trace messages for the MBUS component are written to a file.

Router# monitor event-trace mbus dump pretty

Catalyst 6500 Series Switches and Cisco 7600 Series Routers Examples Only
This example shows how to stop event tracing, clear the current contents of memory, and reenable the trace
function for the SPA component. This example assumes that the tracing function is configured and enabled
on the networking device.

Router# monitor event-trace spa disable

Router# monitor event-trace spa clear

Router# monitor event-trace spa enable

Related Commands Command Description

monitor event-trace (global) Configures event tracing for a specified Cisco IOS
software subsystem component.

monitor event-trace dump-traces Saves trace messages for all event traces currently
enabled on the networking device.

show monitor event-trace Displays event trace messages for Cisco IOS
software subsystem components.

Cisco IOS Configuration Fundamentals Command Reference

481
 monitor event-trace through Q
monitor event-trace (global)

monitor event-trace (global)

To configure event tracing for a specified Cisco IOS software subsystem component, use the monitor
event-trace command in global configuration mode.

monitor event-trace component {disable | dump-file filename | enable | size number | stacktrace
number} timestamps [datetime [localtime] [msec] [show-timezone] | uptime]

Cisco 10000 Series Routers

monitor event-trace component {disable | dump-file filename | enable | clear | continuous | one-
shot}

Syntax Description component Name of the Cisco IOS software subsystem

component that is the object of the event trace. To
get a list of components that support event tracing,
use the monitor event-trace ? command.

disable Turns off event tracing for the specified component.

dump-file filename Specifies the file where event trace messages are
written from memory on the networking device.
The maximum length of the filename (path and
filename) is 100 characters, and the path can point
to flash memory on the networking device or to a
TFTP or FTP server.

enable Turns on event tracing for the specified component

provided that the component has been configured
using the monitor event-tracecommand.

size number Sets the number of messages that can be written to

memory for a single instance of a trace. Valid
values are from1 to 65536.
Note Some Cisco IOS software subsystem
components set the size by default. To
display the size parameter, use the show
monitor event-trace componentparameters
command.
When the number of event trace messages in
memory exceeds the configured size, new messages
will begin to overwrite the older messages in the
file.

stacktrace number Enables the stack trace at tracepoints and specifies

the depth of the stack trace stored. Valid values are
from 1 to 16.

Cisco IOS Configuration Fundamentals Command Reference

482
 monitor event-trace through Q
monitor event-trace (global)

timestamps (Optional) Includes time stamp information with

the event trace messages for the specified
component.

datetime (Optional) Specifies that the time stamp

information included with event trace messages will
consist of the date and time of the event trace.

localtime (Optional) Specifies that the time given in the time

stamp will be local time.

msec (Optional) Includes milliseconds in the time stamp.

show-timezone (Optional) Includes time zone information in the

time stamp.

uptime (Optional) Displays time stamped information

about the system uptime.

clear Clears existing trace messages for the specified

component from memory on the networking device.

continuous Continuously displays the latest event trace entries.

one-shot Clears any existing trace information from memory,

starts event tracing again, and disables the trace
when the trace reaches the size specified using the
monitor event-tracecommand.

Command Default Event tracing is enabled or disabled depending on the software component.

Command Modes Global configuration (config)

Command History Release Modification

12.0(18)S This command was introduced.

12.2(8)T This command was integrated into Cisco IOS

Release 12.2(8)T.

12.2(14)SX This command was integrated into Cisco IOS

Release 12.2(14)SX and implemented on the
Supervisor Engine 720.

12.2(25)S This command was integrated into Cisco IOS

Release 12.2(25)S.

Cisco IOS Configuration Fundamentals Command Reference

483
 monitor event-trace through Q
monitor event-trace (global)

Release Modification
12.2(28)SB This command was integrated into Cisco IOS
Release 12.2(28)SB and implemented on the Cisco
10000 series routers.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.4(20)T This command was integrated into Cisco IOS

Release 12.4(20)T.

Usage Guidelines Use the monitor event-trace command to enable or disable event tracing and to configure event trace
parameters for Cisco IOS software subsystem components.

Note Event tracing is intended for use as a software diagnostic tool and should be configured only under the
direction of a Technical Assistance Center (TAC) representative. In Cisco IOS software images that do not
provide subsystem support for the event trace function, the monitor event-trace command is not available.

The Cisco IOS software allows the subsystem components to define whether support for event tracing is
enabled or disabled by default. The command interface for event tracing allows you to change the default
two ways: using the monitor event-tracecommand in privileged EXEC mode or using the monitor event-
tracecommand in global configuration mode.
Additionally, default settings do not show up in the configuration file. If the subsystem software enables
event tracing by default, the monitor event-tracecomponentenable command will not show up in the
configuration file of the networking device; however, disabling event tracing that has been enabled by
default by the subsystem will create a command entry in the configuration file.

Note The amount of data collected from the trace depends on the trace message size configured using the
monitor event-tracecommand for each instance of a trace.

To determine whether you can enable event tracing on a subsystem, use the monitor event-trace ?
commandto get a list of software components that support event tracing.
To determine whether event tracing is enabled by default for the subsystem, use the show monitor event-
trace command to display trace messages.
To specify the trace call stack at tracepoints, you must first clear the trace buffer.

Examples The following example shows how to enable event tracing for the interprocess communication (IPC)
subsystem component in Cisco IOS software and configure the size to 4096 messages. The trace messages
file is set to ipc-dump in slot0 (flash memory).

configure terminal
!
monitor event-trace ipc enable
monitor event-trace ipc dump-file slot0:ipc-dump
monitor event-trace ipc size 4096

Cisco IOS Configuration Fundamentals Command Reference

484
 monitor event-trace through Q
monitor event-trace (global)

When you select Cisco Express Forwarding as the component for which to enable event tracing, you can
use the following additional arguments and keywords: monitor event-trace cef [events | interface | ipv6 |
ipv4][all]. The following example shows how to enable event tracing for IPv4 or IPv6 events of the Cisco
Express Forwarding component in Cisco IOS software:

configure terminal
!
monitor event-trace cef ipv4 enable
configure terminal
!
monitor event-trace cef ipv6 enable
exit
The following example shows what happens when you try to enable event tracing for a
component (in this case, adjacency events) when it is already enabled:
configure terminal
!
monitor event-trace adjacency enable
%EVENT_TRACE-6-ENABLE: Trace already enabled.

Related Commands Command Description

monitor event-trace (EXEC) Controls the event trace function for a specified
Cisco IOS software subsystem component.

monitor event-trace dump-traces Saves trace messages for all event traces currently
enabled on the networking device.

show monitor event-trace Displays event trace messages for Cisco IOS
software subsystem components.

Cisco IOS Configuration Fundamentals Command Reference

485
 monitor event-trace through Q
monitor event-trace dump-traces

monitor event-trace dump-traces

To save trace messages for all event traces currently enabled on the networking device, use the monitor
event-trace dump-tracescommand in privileged EXEC mode.

monitor event-trace dump-traces [pretty]

Syntax Description pretty (Optional) Saves the event trace message in ASCII
format.

Command Modes Privileged EXEC

Command History Release Modification

12.0(18)S This command was introduced.

12.2(8)T This command was integrated into Cisco IOS

Release 12.2(8)T.

Usage Guidelines Use the monitor event-trace dump-traces command to save trace message information for all event traces
currently enabled on a networking device. By default, trace information is saved in binary format. If you
want to save trace messages in ASCII format, possibly for additional application processing, use the
monitor event-trace dump-traces pretty command.
To write the trace messages for an individual trace event to a file, enter the monitor event-trace (EXEC)
command.
To configure the file where you want to save messages, use the monitor event-trace (global) command.

Examples The following example shows how to save the trace messages in binary format for all event traces enabled
on the networking device.

monitor event-trace dump-traces

The following example shows how to save the trace messages in ASCII format for all event traces enabled
on the networking device.

monitor event-trace dump-traces pretty

Cisco IOS Configuration Fundamentals Command Reference

486
 monitor event-trace through Q
monitor event-trace dump-traces

Related Commands Command Description

monitor event-trace (EXEC) Controls event trace function for a specified Cisco
IOS software subsystem component.

monitor event-trace (global) Configures event tracing for a specified Cisco IOS
software subsystem component.

show monitor event-trace Displays event trace messages for Cisco IOS
software subsystem components.

Cisco IOS Configuration Fundamentals Command Reference

487
 monitor event-trace through Q
monitor pcm-tracer capture-destination

monitor pcm-tracer capture-destination

To configure a location to save the Pulse Code Modulation (PCM) trace information, use the monitor pcm-
tracer capture-destination command in global configuration mode. To disable the configuration, use the
no form of this command.

monitor pcm-tracer capture-destination destination

no monitor pcm-tracer capture-destination

Syntax Description destination Destination to save the PCM trace information.

You can specify any of the following values:
• archive: --Saves trace to archive.
• flash: --Saves trace to flash memory.
• ftp: --Saves trace to an FTP network server.
• http: --Saves trace to an HTTP server.
• https: --Saves trace to a secure HTTP
(HTTPS) server.
• null: --Saves trace to file system.
• nvram: --Saves trace to the NVRAM of the
router.
• pram: --Saves trace to the permanent RAM
(PRAM) of the router.
• rcp: --Saves trace to a remote copy protocol
(RCP) network server.
• scp: --Saves trace to a network server that
supports Secure Shell (SSH).
• syslog: --Saves trace to the system log.
• system: --Saves trace to the system memory.
• tftp: --Saves trace to a TFTP network server.
• tmpsys: --Saves trace to a temporary system
location.

Command Default The PCM trace information is saved to the NVRAM.

Command Modes Global configuration (config)

Cisco IOS Configuration Fundamentals Command Reference

488
 monitor event-trace through Q
monitor pcm-tracer capture-destination

Command History Release Modification

15.0(1)M This command was introduced in a release earlier
than Cisco IOS Release 15.0(1)M.

Usage Guidelines You can use the monitor pcm-tracer capture-destination command to specify a location to save the PCM
trace information. When Cisco IOS software saves the data to network file systems, such as TFTP and FTP,
it assumes the location is valid and has write access.
After the PCM capture is complete, the router automatically copies the captured contents to the specified
location. The filename format at the destination location is as follows:

<Configured name>_tx_<DS0 slot>_<DS0 unit>_<DS0 channel>--For TX

<Configured name>_rx_<DS0 slot>_<DS0 unit>_<DS0 channel>--For RX

You can identify the dial feature card (DFC) channel from where the PCM is traced using the filename
format.
Consider the following example:

Router(config)# monitor pcm-tracer capture-destination tftp: ://223.255.254.254/

benzeer/cap/cap_data

In this example, two files are created for the data corresponding to each DS0s, one for each direction
(transmitter and receiver). When the debug pcmtracer command is enabled, the trace data is copied into
the following files:
• cap_data_tx_6_1_22 and cap_data_rx_6_1_22--This corresponds to the traffic flowing through DS0
6/1:22.
• cap_data_tx_6_1_22 and cap_data_rx_6_1_22--cap_data_tx_6_1_22 is the data in the transmit
direction (from the DFC to the system backplane) and cap_data_rx_6_1_22 is the data in the receiver
direction (to the DFC from the system backplane).

Examples The following example shows how to configure a router to save the PCM trace information to a flash drive:

Router# configure terminal

Router(config)# monitor pcm-tracer capture-destination flash:

Related Commands Command Description

debug pcmtracer Enables debugging for PCM tracing.

monitor pcm-tracer Monitors and controls the PCM trace function.

Cisco IOS Configuration Fundamentals Command Reference

489
 monitor event-trace through Q
monitor pcm-tracer delayed-start

monitor pcm-tracer delayed-start

To configure the delay time to start the Pulse Code Modulation (PCM) trace capture, use the monitor pcm-
tracer delayed-start command in global configuration mode. To disable the configuration, use the no form
of this command.

monitor pcm-tracer delayed-start seconds

no monitor pcm-tracer delayed-start

Syntax Description seconds Delay, in seconds. The range is from 1 to 2147483.

Command Default The default delay time is zero.

Command Modes Global configuration (config)

Command History Release Modification

15.0(1)M This command was introduced in a release earlier
than Cisco IOS Release 15.0(1)M.

Examples The following example shows how to configure the PCM tracer delay time to 1000 seconds:

Router# configure terminal

Router(config)# monitor pcm-tracer delayed-start 1000

Related Commands Command Description

monitor pcm-tracer Configures the PCM tracer information.

Cisco IOS Configuration Fundamentals Command Reference

490
 monitor event-trace through Q
monitor pcm-tracer profile

monitor pcm-tracer profile

To create Pulse Code Modulation (PCM) capture profiles, use the monitor pcm-tracer profile command
in global configuration mode. To disable the configuration, use the no form of this command.

monitor pcm-tracer profile profile-number

no monitor pcm-tracer profile profile-number

Syntax Description profile-number Profile number. The range is from 1 to 10.

Command Default PCM capture profiles are disabled.

Command Modes Global configuration (config)

Command History Release Modification

15.0(1)M This command was introduced in a release earlier
than Cisco IOS Release 15.0(1)M.

Usage Guidelines You must create at least one user profile under the channels that need to be traced. You can create the
following profile operations:
• Create a user profile identified by a profile number.
• Add one or more profiles. A user profile consists of capture groups in which the channels that are to be
traced are specified.
• Configure one or more capture groups under a profile.

Examples The following example shows how to create a PCM capture profile with profile number 1:

Router# configure terminal

Router(config)# monitor pcm-tracer profile 1

Related Commands Command Description

monitor pcm-tracer Configures the PCM tracer information.

Cisco IOS Configuration Fundamentals Command Reference

491
 monitor event-trace through Q
monitor permit-list

monitor permit-list
To configure a destination port permit list or add to an existing destination port permit list, use the monitor
permit-list command in global configuration mode. To delete from or clear an existing destination port
permit list, use the no form of this command.

Activate monitoring
monitor permit-list
no monitor permit-list

Activate monitoring on one port

monitor permit-list destination interface interface-type slot /port
no monitor permit-list destination interface interface-type slot /port

Activate monitoring on one range of ports

monitor permit-list destination interface interface-type slot /port-last-port
no monitor permit-list destination interface interface-type slot / port-last-port

Activate monitoring on two or more ranges of ports

monitor permit-list destination interface interface-type slot /port-last-port , [port-last-port]
no monitor permit-list destination interface interface-type slot /port-last-port , [port-last-port]

Syntax Description destination Specifies a destination port.

interface interface-type Specifies the interface type; valid values are

ethernet, fastethernet, gigabitethernet, or
tengigabitethernet

slot The slot that the interface module is installed in.

port Specifies a single port on an interface module, or

the first port on an interface module used in a range
of ports.

last-port (Optional) Specifies the port on an interface module

used as the last port in a range of ports.

, (Optional) Separates each instance of a port, or

range of ports, that are monitored. See the Usage
Guidelines and the Examples for more information.

Command Default Disabled

Cisco IOS Configuration Fundamentals Command Reference

492
 monitor event-trace through Q
monitor permit-list

Command Modes Global configuration

Command History Release Modification

12.2(18)SXE Support for this command was introduced on the
Supervisor Engine 720.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines To prevent accidental configuration of ports as destinations, you can create a permit list of the ports that are
valid for use as destinations. With a destination port permit list configured, you can only configure the ports
in the permit list as destinations.
When you enter multiple instances of interface interface-type slot/port-fastport, you must enter a space
before and after the comma. For example, interface interface-type slot/port-fastport , interface-type slot/
port-fastport , interface-type slot/port-fastport.

Examples This example shows how to configure a destination port permit list that includes Gigabit Ethernet ports 5/1
through 5/4, and activate monitoring:

Router# configure terminal

Router(config)# monitor permit-list destination interface gigabitethernet 5/1-4

Router(config)# monitor permit-list

This example shows how to configure a destination port permit list that includes Fast Ethernet ports 1/1-48,
2/1-48, and Gigabit Ethernet ports 3/1 through 3/4, and activate monitoring:

Router# configure terminal

Router(config)# monitor permit-list destination interface fastEthernet 1/1-48 ,

fastEthernet 2/1-48 , gigabitEthernet 3/1-4

Router(config)# monitor permit-list

Related Commands Command Description

show monitor permit-list Displays the permit-list state and interfaces
configured.

Cisco IOS Configuration Fundamentals Command Reference

493
 monitor event-trace through Q
monitor session egress replication-mode

monitor session egress replication-mode

To switch the egress-span mode from the default mode (either centralized or distributed depending on your
Cisco IOS software release), use the monitor session egress replication-modecommand in global
configuration mode. To return to the default mode, use the no form of the command.

Cisco IOS Release 12.2(33)SXH2a and Later Releases

monitor session egress replication-mode centralized
no monitor session egress replication-mode centralized

Cisco IOS Release 12.2(33)SXH, SXH1, and SXH2

monitor session egress replication-mode distributed
no monitor session egress replication-mode distributed

Syntax Description centralized In Cisco IOS Release 12.2(33)SXH2a and later

releases: Specifies centralized egress span
monitoring as the default mode.

distributed In Cisco IOS Release 12.2(33)SXH, SXH1, and

SXH2: Specifies distributed egress span monitoring
as the default mode.

Command Default Cisco IOS Releases 12.2(33)SXH2a and later releases: Centralized mode
Cisco IOS Releases 12.2(33)SXH, SXH1, and SXH2: Distributed mode

Command Modes Global configuration (config)

Command History Release Modification

12.2(33)SXH This command was introduced.

12.2(33)SXH2a The command was changed as follows:

• The default mode was changed from
distributed mode to centralized mode.
• The centralized keyword was removed and
the distributed keyword was added.

Cisco IOS Configuration Fundamentals Command Reference

494
 monitor event-trace through Q
monitor session egress replication-mode

Usage Guidelines

Note Prior to Cisco IOS Release 12.2(33)SXH and the introduction of this feature, the operating mode was
centralized and could not be changed.

Centralized egress span monitoring redirects traffic to the supervisor engine for egress monitoring.
Distributed egress span monitoring is performed in the ingress module. Distributed replication for Switched
Port Analyzer (SPAN), Remote SPAN (RSPAN), and Encapsulated RSPAN (ERSPAN) increases the total
throughput at the span destination.

Note Distributed egress span (DES) mode is applied to ASIC-based sessions only.

Examples
Cisco IOS Release 12.2(33)SXH, SXH1, and SXH2
The following example shows how to switch the egress-span mode from the distributed default to
centralized mode:

Router(config)# monitor session egress replication-mode centralized

The following example shows how to switch the egress-span mode from centralized back to distributed
mode:

Router(config)# no monitor session egress replication-mode centralized

Cisco IOS Release 12.2(33)SXH2a and Later Releases

The following example shows how to switch the egress-span mode from the centralized default to
distributed mode:

Router(config)# monitor session egress replication-mode distributed

The following example shows how to switch the egress-span mode from distributed back to centralized
mode:

Router(config)# no monitor session egress replication-mode distributed

Related Commands Command Description

show monitor session Displays the operational mode and configured
mode of the session and module session
capabilities.

Cisco IOS Configuration Fundamentals Command Reference

495
 monitor event-trace through Q
monitor session type

monitor session type

To configure a local Switched Port Analyzer (SPAN), RSPAN, or ERSPAN, use the monitor session
typecommand in global configuration mode. To remove one or more source or destination interfaces from
the SPAN session, use the no form of this command.

monitor session span-session-number type {erspan-destination | erspan-source | local | local-tx |

rspan-destination | rspan-source}
no monitor session span-session-number type {erspan-destination | erspan-source | local | local-
tx | rspan-destination | rspan-source}

Syntax Description span-session-number Number of the local SPAN or ERSPAN session;

valid values are from 1 to 66.

erspan-destination Specifies the ERSPAN destination-session

configuration mode.

erspan-source Specifies the ERSPAN source-session

configuration mode.

local Specifies the local SPAN session configuration

mode.

local-tx Specifies the local egress-only SPAN session

configuration mode.

rspan-destination Specifies the RSPAN destination-session

configuration mode.

rspan-source Specifies the RSPAN source-session configuration

mode.

Command Default This command has no default settings.

Command Modes Global configuration (config)

Command History Release Modification

12.2(18)SXE Support for this command was introduced on the
Supervisor Engine 720.

Cisco IOS Configuration Fundamentals Command Reference

496
 monitor event-trace through Q
monitor session type

Release Modification
12.2(18)SXF This command was changed as follows:
• Support for this command was introduced on
the Supervisor Engine 32.
• ERSPAN is supported in any switch fabric
module functionality switching mode.

12.2(33)SXH This command was changed to include the

following keywords:
• local
• local-tx
• rspan-destination
• rspan-source

Usage Guidelines Release 12.2(18)SXE and later releases support ERSPAN with the Supervisor Engine 720, hardware
revision 3.2 or higher. Enter the show module version | include WS-SUP720-BASE command to display
the hardware revision.
ERSPAN traffic is GRE-encapsulated SPAN traffic that can only be processed by an ERSPAN destination
session.
This command is not supported on Catalyst 6500 series switches that are configured with a Supervisor
Engine 2.
All ERSPAN source sessions on a switch must use the same source IP address. You enter the origin ip
address command to configure the IP address for the ERSPAN source sessions.
All ERSPAN destination sessions on a switch must use the same IP address. You enter the ip address
command to configure the IP address for the ERSPAN destination sessions. If the ERSPAN destination IP
address is not a Supervisor Engine 720 (for example, it is a network sniffer), the traffic arrives with the
GRE and RSPAN headers/encapsulation intact.
The ERSPAN source session destination IP address, which must be configured on an interface on the
destination switch, is the source of traffic that an ERSPAN destination session sends to the destination
ports. You configure the same address in both the source and destination sessions with the ip address
command.
The ERSPAN ID differentiates the ERSPAN traffic arriving at the same destination IP address from
different ERSPAN source sessions.
The local ERSPAN session limits are as follows:
• Total sessions--66
• Source sessions--2 (ingress or egress or both)
• Destination sessions--23
The monitor session type command creates a new ERSPAN session or allows you to enter the ERSPAN
session configuration mode. ERSPAN uses separate source and destination sessions. You configure the
source and destination sessions on different switches. The ERSPAN session configuration mode prompts
are as follows:
• Router(config-mon-erspan-src)--Indicates the ERSPAN source session configuration mode.

Cisco IOS Configuration Fundamentals Command Reference

497
 monitor event-trace through Q
monitor session type

• Router(config-mon-erspan-src-dst)--Indicates the ERSPAN source session destination configuration

mode.
• Router(config-mon-erspan-dst)--Indicates the ERSPAN destination session configuration mode.
• Router(config-mon-erspan-dst-src)--Indicates the ERSPAN destination session source configuration
mode
The table below lists the ERSPAN destination session configuration mode syntaxes.

Table 29 ERSPAN Destination Session Configuration Mode Syntaxes

Syntax Description
Global Configuration Mode

monitor session erspan-destination-session-number | rspan- Enters ERSPAN or RSPAN destination session configuration
destination-session-number type erspan-destination | erspan- mode and changes the prompt to the following:
destination Router(config-mon-erspan-dst)#
Router(config-mon-rspan-dst)#

Destination Session Configuration Mode

description session-description (Optional) Describes the ERSPAN or RSPAN destination

session.

shutdown (Optional) (Default) Inactivates the ERSPAN destination

session.

no shutdown Activates the ERSPAN destination session.

destination {single-interface | interface-list | interface-range | Associates the ERSPAN destination session number with the
mixed-interface-list } destination ports.

source Enters ERSPAN destination session source configuration mode

and changes the prompt to the following:
Router(config-mon-erspan-dst-src)#

Destination Session Source Configuration Mode

ip address ip-address [force] Configures the ERSPAN flow destination IP address, which
must also be configured on an interface on the destination
switch and be entered in the ERSPAN destination session
configuration.

erspan-id erspan-flow-id Configures the ID number used by the destination and

destination sessions to identify the ERSPAN traffic.

vrf vrf-name (Optional) Configures the VRF name of the packets in the
ERSPAN traffic.

The table below lists the ERSPAN source session configuration mode syntaxes.

Cisco IOS Configuration Fundamentals Command Reference

498
 monitor event-trace through Q
monitor session type

Table 30 ERSPAN or RSPAN Source Session Configuration Mode Syntaxes

Syntax Description
Global Configuration Mode

monitor session erspan-source-session-number type erspan- Enters ERSPAN or RSPAN source session configuration mode
source | rspan-source and changes the prompt as appropriate to the following:
Router(config-mon-erspan-src)#
Router(config-mon-rspan-src)#

Source Session Configuration Mode

description session-description (Optional) Describes the ERSPAN or RSPAN source session.

shutdown (Optional) (Default) Inactivates the ERSPAN or RSPAN

source session.

no shutdown Activates the ERSPAN or RSPAN source session.

source {{single-interface | interface-list | interface-range | Associates the ERSPAN or RSPAN source session number
mixed-interface-list | single-vlan | vlan-list | vlan-range | mixed- with the source ports or VLANs, and selects the traffic
vlan-list } [rx | tx | both]} direction to be monitored.

filter { single-vlan | vlan-list | vlan-range | mixed-vlan-list } (Optional) Configures source VLAN filtering when the
ERSPAN or RSPAN source is a trunk port.

description session-description (Optional) Describes the ERSPAN or RSPAN source session.

Source Session Destination Configuration Mode

ip address ip-address Configures the ERSPAN or RSPAN flow destination IP

address, which must also be configured on an interface on the
destination switch and be entered in the ERSPAN or RSPAN
destination session configuration.

erspan-id erspan-flow-id Configures the ID number used by the source and destination
sessions to identify the ERSPAN or RSPAN traffic.

origin ip address ip-address Configures the IP address used as the source of the ERSPAN or
RSPAN traffic.

ip {{ttlttl-value } | {precipp-value } | {dscpdscp-value }} (Optional) Configures the following packet values in the
ERSPAN or RSPAN traffic:
• ttl ttl -value --IP time-to-live (TTL) value
• prec ipp-value-- IP-precedence value
• dscp dscp-value-- IP-precedence value

vrf vrf-name (Optional) Configures the VRF name of the packets in the
ERSPAN or RSPAN traffic.

When you configure the monitor sessions, follow these syntax guidelines:
• erspan-destination-span-session-number can range from 1 to 66.

Cisco IOS Configuration Fundamentals Command Reference

499
 monitor event-trace through Q
monitor session type

• single-interface is interfacetype slot /port ; type is fastethernet, gigabitethernet, or

tengigabitethernet.
• interface-list is single-interface , single-interface , single-interface ...

Note In lists, you must enter a space before and after the comma. In ranges, you must enter a space before and
after the dash.

• interface-range is interfacetype slot /first-port - last-port .

• mixed-interface-list is, in any order, single-interface , interface-range , ...
• erspan-flow-id can range from 1 to 1023.
When you clear the monitor sessions, follow these syntax guidelines:
• The no monitor sessionsession-number command entered with no other parameters clears the session
session-number .
• session-range is first-session-number -last-session-number.

Note When you enter the no monitor session range command, do not enter spaces before or after the dash. If
you enter multiple ranges, do not enter spaces before or after the commas.

Use the monitor session type local command to configure ingress, egress, or both ingress and egress
SPAN sessions.
Use the monitor session type local-tx command to configure egress-only SPAN sessions.
When you enter the local or the local egress-only SPAN session configuration mode, the prompt changes
accordingly to Router(config-mon-local)# or Router(config-mon-local-tx)#, and the following commands
are available:
• description -- Describes the properties for this session using this syntax:
description description
The descriptioncan be up to 240 characters and cannot contain special characters or spaces.
• destination -- Specifies the destination and the destination properties using this syntax:
destination analysis-module num anomaly-detector-module num interface type number intrusion-
detection-module num
analysis-module num Specifies the SPAN destination analysis-module.

anomaly-detector-module num Specifies the SPAN destination anomaly-detector-

module.

interface type number Specifies the interface type and number as follows:
• GigabitEthernet mod /port
• port-channel num --Ethernet Channel of
interfaces; valid values are from 1 to 496.

ingress (Optional) Configures destinations to receive traffic

from attached devices.

Cisco IOS Configuration Fundamentals Command Reference

500
monitor event-trace through Q
monitor session type

learning (Optional) Enables MAC address learning from the

destinations, which allows the switch to transmit
traffic that is addressed to devices attached to the
destinations.

intrusion-detection-module num Specifies the SPAN destination intrusion-detection-

module.

• exit -- Exits from configuration session mode.

• filter vlan vlan-id -- Limits the SPAN source traffic to specific VLANs; valid values are from 1 to
4096.
• no -- Negates a command or sets its defaults.
• shutdown -- Shuts down this session
• source -- Specifies the SPAN source interface or VLAN using the following syntax:

cpu rp Associates the local SPAN session number with the

CPU on the route processor.

cpu sp Associates the local SPAN session number with the

CPU on the switch processor.

interface type number Specifies the interface type and number as follows:
• FastEthernet mod /port
• GigabitEthernet mod /port
• Port-channel num --Ethernet Channel of
interfaces; valid values are from 1 to 496.

vlan vlan-id Specifies the VLAN; valid values are from 1 to

4094.

, (Optional) Specifies another range of interfaces.

- (Optional) Specifies a range of interfaces.

both (Optional) Monitors the received and the

transmitted traffic.

rx (Optional) Monitors the received traffic only.

tx When you enter the local-tx keyword, the rx and (Optional) Monitors the transmitted traffic only.
both keywords are not available and the tx keyword
is required.

The local SPAN session limits are as follows:

• Total sessions--80
• Source sessions--2 (ingress or egress or both)
• Egress only--14
If you enter the filter keyword on a monitored trunk interface, only traffic on the set of specified VLANs is
monitored.

Cisco IOS Configuration Fundamentals Command Reference

501
 monitor event-trace through Q
monitor session type

Only one destination per SPAN session is supported. If you attempt to add another destination interface to a
session that already has a destination interface configured, you get an error. You must first remove a SPAN
destination interface before changing the SPAN destination to a different interface.
You can configure up to 64 SPAN destination interfaces, but you can have one egress SPAN source
interface and up to 128 ingress source interfaces only.
A SPAN session can either monitor VLANs or monitor individual interfaces, but it cannot monitor both
specific interfaces and specific VLANs. Configuring a SPAN session with a source interface and then
trying to add a source VLAN to the same SPAN session causes an error. Configuring a SPAN session with
a source VLAN and then trying to add a source interface to that session also causes an error. You must first
clear any sources for a SPAN session before switching to another type of source.
Port channel interfaces display in the list of interface options if you have them configured. VLAN
interfaces are not supported. However, you can span a particular VLAN by entering the monitor session
session source vlan vlan-id command.
When you configure the destination, use these guidelines:
• A single-interface is as follows:
◦ interface type slot/port; type is fastethernet, gigabitethernet, or tengigabitethernet.
◦ interface port-channel number

Note Destination port channel interfaces must be configured with the channel-group group-num mode on
command and the no channel-protocol command.

• An interface-list is single-interface, single-interface , single-interface ...

Note In lists, you must enter a space before and after the comma. In ranges, you must enter a space before and
after the dash.

• An interface-range is interface type slot / first-port - last-port.

• A mixed-interface-list is, in any order, single-interface , interface-range , ...
• A single-vlan is the ID number of a single VLAN.
• A single-list is single-vlan , single-vlan , single-vlan ...
• A vlan-range is first-vlan-ID - last-vlan-ID.
• A mixed-vlan-list is, in any order, single-vlan , vlan-range , ...
When you clear the monitor sessions, follow these syntax guidelines:
• The no monitor sessionsession-number command entered with no other parameters clears the session
session-number .
• session-range is first-session-number -last-session-number.

Note When you enter the no monitor session range command, do not enter spaces before or after the dash. If
you enter multiple ranges, do not enter spaces before or after the commas.

Cisco IOS Configuration Fundamentals Command Reference

502
 monitor event-trace through Q
monitor session type

Examples This example shows how to configure an ERSPAN source session number and enter the ERSPAN source
session configuration mode for the session:

Router(config)# monitor session 55 type erspan-source

Router(config-mon-erspan-src)#
This example shows how to configure an ERSPAN destination session number and enter the ERSPAN
destination session configuration mode for the session:

Router(config)# monitor session 55 type erspan-destination

Router(config-mon-erspan-dst)#
This example shows how to associate the ERSPAN destination session number with the destination ports:

Router(config-mon-erspan-dst) destination interface fastethernet 1/2 , 2/3

This example shows how to enter the ERSPAN destination session source configuration:

Router(config-mon-erspan-dst)# source
Router(config-mon-erspan-dst-src)#
This example shows how to enter the ERSPAN destination session source configuration mode:

Router(config-mon-erspan-dst)# source
Router(config-mon-erspan-dst-src)#
This example shows how to configure multiple sources for a session:

Router(config-mon-erspan-src)# source interface fastethernet 5/15 , 7/3 rx

Router(config-mon-erspan-src)# source interface gigabitethernet 1/2 tx
Router(config-mon-erspan-src)# source interface port-channel 102
Router(config-mon-erspan-src)# source filter vlan 2 - 3
Router(config-mon-erspan-src)#
This example shows how to enter the ERSPAN source session destination configuration mode:

Router(config-mon-erspan-src)# destination
Router(config-mon-erspan-src-dst)#
This example shows how to configure the ID number that is used by the source and destination sessions to
identify the ERSPAN traffic:

Router(config-mon-erspan-src-dst)# erspan-id 1005

Router(config-mon-erspan-src-dst)#
This example shows how to configure session 1 to monitor ingress traffic from Gigabit Ethernet port 1/1
and configure Gigabit Ethernet port 1/2 as the destination:

Router(config)# monitor session 1 type local

Router(config-mon-local)# source interface gigabitethernet 1/1 rx
Router(config-mon-local)# destination interface gigabitethernet 1/2
This example shows how to configure session 1 to monitor egress-only traffic from Gigabit Ethernet port
5/1 and configure Gigabit Ethernet port 5/2 as the destination:

Router(config)# monitor session 1 type local-tx

Router(config-mon-local)# source interface gigabitethernet 5/1 rx
Router(config-mon-local)# destination interface gigabitethernet 5/2
This example shows how to remove an interface from a session:

Router(config)# no monitor session 1 type local-tx

Cisco IOS Configuration Fundamentals Command Reference

503
 monitor event-trace through Q
monitor session type

Related Commands Command Description

monitor session type Creates an ERSPAN source session number or
enters the ERSPAN session configuration mode for
the session.

show monitor session Displays information about the ERSPAN, SPAN,

and RSPAN sessions.

Cisco IOS Configuration Fundamentals Command Reference

504
 monitor event-trace through Q
mop device-code

mop device-code
To identify the type of device sending Maintenance Operation Protocol (MOP) System Identification
(sysid) messages and request program messages, use the mop device-code command in global
configuration mode. To set the identity to the default value, use the no form of this command.

mop device-code commandmop device-code {cisco | ds200}

no mop device-code {cisco | ds200}

Syntax Description cisco Denotes a Cisco device code. This is the default.

ds200 Denotes a DECserver 200 device code.

Command Default Cisco device code

Command Modes Global configuration

Command History Release Modification

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 sysid messages and request program messages use the identity information indicated by this command.

Examples The following example identifies a DECserver 200 device as sending MOP sysid and request program
messages:

mop device-code ds200

Related Commands Command Description

mop sysid Enables an interface to send out periodic MOP
system identification messages.

Cisco IOS Configuration Fundamentals Command Reference

505
 monitor event-trace through Q
mop device-code

Cisco IOS Configuration Fundamentals Command Reference

506
 monitor event-trace through Q
mop retransmit-timer

mop retransmit-timer
To configure the length of time that the Cisco IOS software waits before resending boot requests to a
Maintenance Operation Protocol (MOP) server, use the mop retransmit-timer command in global
configuration mode. To reinstate the default value, use the no form of this command.

mop retransmit-timer seconds

no mop retransmit-timer

Syntax Description seconds Sets the length of time (in seconds) that the
software waits before resending a message. The
value is a number from 1 to 20.

Command Default 4 seconds

Command Modes Global configuration

Command History Release Modification

10.0 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines By default, when the software sends a request that requires a response from a MOP boot server and the
server does not respond, the message is re-sent after 4 seconds. If the MOP boot server and router are
separated by a slow serial link, it might take longer than 4 seconds for the software to receive a response to
its message. Therefore, you might want to configure the software to wait longer than 4 seconds before
resending the message if you are using such a link.

Examples In the following example, if the MOP boot server does not respond within 10 seconds after the router sends
a message, the server will resend the message:

mop retransmit-timer 10

Cisco IOS Configuration Fundamentals Command Reference

507
 monitor event-trace through Q
mop retransmit-timer

Related Commands Command Description

mop device-code Identifies the type of device sending MOP sysid
messages and requests program messages.

mop enabled Enables an interface to support the MOP.

Cisco IOS Configuration Fundamentals Command Reference

508
 monitor event-trace through Q
mop retries

mop retries
To configure the number of times the Cisco IOS software will resend boot requests to a Maintenance
Operation Protocol (MOP) server, use the mop retries command in global configuration mode. To
reinstate the default value, use the no form of this command.

mop retries count

no mop retries

Syntax Description count Indicates the number of times the software will
resend a MOP boot request. The value is a number
from 3 to 24. The default is 8.

Command Default 8 times

Command Modes Global configuration

Command History Release Modification

10.0 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Examples In the following example, the software will attempt to resend a message to an unresponsive host 11 times
before declaring a failure:

Router(config)# mop retries 11

Related Commands Command Description

mop device-code Identifies the type of device sending MOP sysid
messages and requests program messages.

mop enabled Enables an interface to support the MOP server.

Cisco IOS Configuration Fundamentals Command Reference

509
 monitor event-trace through Q
mop retries

Command Description
mop retransmit-timer Configures the length of time that the Cisco IOS
software waits before resending boot requests to a
MOP server.

Cisco IOS Configuration Fundamentals Command Reference

510
 monitor event-trace through Q
more

more
To display the contents of a file, use the morecommand in privileged EXEC mode.

more [/ascii | /binary | /ebcdic] url

Syntax Description /ascii (Optional) Displays a binary file in ASCII format.

/binary (Optional) Displays a file in hex/text format.

/ebcdic (Optional) Displays a binary file in EBCDIC

format.

url The URL of the file to display. A URL in the CLI

consists of a file-system prefix (such as system: or
nvram:), an optional path (such as a folder name),
and the name of a file.

Command Default The command displays the conent of a file in its native format. Optional formats include ascii, binary, and
ebcdic.

Command Modes Privileged EXEC (>)

Command History Release Modification

11.3 AA This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Cisco IOS XE Release 2.5 This command was implemented on Cisco ASR
1000 series routers.

Usage Guidelines The more system:running-config command displays the same output as the show running-config
command. The more nvram:startup-config command is recommended as a replacement for the show
startup-config command and the show configuration command.
You can use this command to display configuration files, as follows:
• The more nvram:startup-config command displays the startup configuration file contained in
NVRAM or specified by the CONFIG_FILE environment variable. The Cisco IOS software informs

Cisco IOS Configuration Fundamentals Command Reference

511
 monitor event-trace through Q
more

you whether the displayed configuration is a complete configuration or a distilled version. A distilled
configuration is one that does not contain access lists.
• The more system:running-config command displays the running configuration.
These commands show the version number of the software used when you last changed the configuration
file.
You can also display the contents of files on remote systems using the more command. For example, you
could display a saved running configuration file on an FTP server using more ftp://
username:password@ftp-host1/mydirectory/7200-basic-running-config. See the description of the
copy command for more information on file-system prefixes available in the Cisco IOS CLI.
Options for filtering and redirecting the output of this command are available by appending a pipe character
(|). See the Related Commands table for a list of more <url> command extensions.

Examples The following partial sample output displays the configuration file named startup-config in NVRAM:

Router# more nvram:startup-config

!
! No configuration change since last restart
! NVRAM config last updated at 02:03:26 PDT Thu Oct 2 1997
!
version 12.1
service timestamps debug uptime
service timestamps log uptime
service password-encryption
service udp-small-servers
service tcp-small-servers
.
.
.
end

The following is partial sample output from the more nvram:startup-config command when the
configuration file has been compressed:

Router#
more nvram:startup-config

Using 21542 out of 65536 bytes, uncompressed size = 142085 bytes

!
version 12.1
service compress-config
!
hostname rose
!
.
.
.
The following partial sample output displays the running configuration:

Router2# more system:running-config

Building configuration...
Current configuration:
!
version 12.1
no service udp-small-servers
no service tcp-small-servers
!
hostname Router2
!
.

Cisco IOS Configuration Fundamentals Command Reference

512
 monitor event-trace through Q
more

.
.
!
end

Related Commands Command Description

boot config Specifies the device and filename of the
configuration file from which the router configures
itself during initialization (startup).

more <url> begin Begins the output of any morecommand from a

matched string.

more <url> exclude Filters the output of any more command to exclude
a matched string.

more <url> include Filters the output of any more command to display
only the lines that match the specified string.

service compress-config Compresses startup configuration files.

show bootvar Displays the contents of the BOOT environment

variable, the name of the configuration file pointed
to by the CONFIG_FILE environment variable, the
contents of the BOOTLDR environment variable,
and the configuration register setting.

Cisco IOS Configuration Fundamentals Command Reference

513
 monitor event-trace through Q
more url begin

more url begin

To search the output of any morecommand, use the more url | begin command in EXEC mode. This
command begins unfiltered output of the more command with the first line that contains the regular
expression you specify.
{more url | begin regular-expression}

Syntax Description url The Universal Resource Locator (RLl) of the file to
display. More commands are advanced show
commands; for details, see the command reference
page in this book for the more command.

| A vertical bar (the “pipe” symbol) indicates that an

output processing specification follows.

regular-expression Any regular expression found in more command

output.

/ Specifies a search at a --More-- prompt that begins

unfiltered output with the first line that contains the
regular expression.

- Specifies a filter at a --More-- prompt that only

displays output lines that do not contain the regular
expression.

+ Specifies a filter at a --More-- prompt that only

displays output lines that contain the regular
expression.

Command Modes User EXEC

Privileged EXEC

Command History Release Modification

11.3 AA The more command was introduced.

12.0(1)T This extension of the more command was

introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Cisco IOS Configuration Fundamentals Command Reference

514
 monitor event-trace through Q
more url begin

Usage Guidelines The regular-expression argument is case sensitive and allows for complex matching requirements.
You can specify a new search at every --More-- prompt.
To search the remaining output of the more command, use the following command at the --More-- prompt:
/ regular-expression
To filter the remaining output of the more command, use one of the following commands at the --More--
prompt:
- regular-expression
+ regular-expression
When output volume is large, the search can produce long lists of output. To interrupt the output, press
Ctrl-^ (Ctrl-Shift-6) or Ctrl-Z.

Note Once you specify a filter for a more command, you cannot specify another filter at a --More-- prompt. The
first specified filter remains until the more command output finishes or until you interrupt the output. The
use of the keyword begin does not constitute a filter.

Because prior output is not saved, you cannot search or filter backward through prior output.

Examples The following is partial sample output of the more nvram:startup-config | begincommand that begins
unfiltered output with the first line that contain the regular expression “ip.” At the --More-- prompt, the
user specifies a filter to exclude output lines that contain the regular expression “ip.”

router# more nvram:startup-config | begin ip

ip subnet-zero
ip domain-name cisco.com
ip name-server 198.92.30.32
ip name-server 171.69.2.132
!
isdn switch-type primary-5ess
.
.
.
interface Ethernet1
ip address 5.5.5.99 255.255.255.0
--More--
-ip
filtering...
media-type 10BaseT
!
interface Serial0:23
encapsulation frame-relay
no keepalive
dialer string 4001
dialer-group 1
isdn switch-type primary-5ess
no fair-queue

Related Commands Command Description

more <url> exclude Filters more command output so that it excludes
lines that contain a particular regular expression.

Cisco IOS Configuration Fundamentals Command Reference

515
 monitor event-trace through Q
more url begin

Command Description
more <url> include Filters more command output so that it displays
only lines that contain a particular regular
expression.

show <command> begin Searches the output of any show command and
displays the output from the first instance of a
specified string.

show <command> exclude Filters show command output so that it excludes

lines that contain a particular regular expression.

show <command> include Filters show command output so that it displays

only lines that contain a particular regular
expression.

Cisco IOS Configuration Fundamentals Command Reference

516
 monitor event-trace through Q
more url exclude

more url exclude

To filter morecommand output so that it excludes lines that contain a particular regular expression, use the
more exclude command in EXEC mode.

{more url | exclude regular-expression}

Syntax Description url The Universal Resource Locator (URL) of the file
to display. More commands are advanced show
commands; for details, see the command reference
page in this book for the more command.
The Cisco IOS File System (IFS) uses URLs to
specify the location of a file system, directory, and
file. Typical URL elements include:
prefix:[directory/]filename
Prefixes can be local file systems or file locations,
such as nvram: or system:. Alternatively, you can
specify network locations using the following
syntax:
ftp: [[//[username [:password ]@]location ]/
directory ]/filename
tftp: [[//location ]/directory ]/filename
rcp: [[//[username @]location ]/directory ]/
filename

| A vertical bar (the “pipe” symbol) indicates that an

output processing specification follows.

regular-expression Any regular expression found in more command

output.

/ Specifies a search at a --More-- prompt that begins

unfiltered output with the first line that contains the
regular expression.

Command Modes EXEC

Command History Release Modification

11.3 AA The more command was introduced.

Cisco IOS Configuration Fundamentals Command Reference

517
 monitor event-trace through Q
more url exclude

Release Modification
12.0(1)T This extension of the more command was
introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The regular-expression argument is case sensitive and allows for complex matching requirements.
You can specify a new search at any --More-- prompt. To search the remaining output of the more
command, use the following command at the --More-- prompt:
/ regular-expression
When output volume is large, the search can produce long lists of output. To interrupt the output, press
Ctrl-^ (Ctrl-Shift-6) or Ctrl-Z.
Because prior output is not saved, you cannot search or filter backward through prior output.

Examples The following is partial sample output of the more nvram:startup-config | excludecommand. The use of |
exclude service in the command specifies a filter that excludes lines that contain the regular expression
“service.” At the --More-- prompt, the user searches for the regular expression “Dialer1,” which continues
filtered output with the first line that contains “Dialer1.”

router# more nvram:startup-config | exclude service

!
version 12.0
!
hostname router
!
boot system flash
no logging buffered
!
ip subnet-zero
ip domain-name cisco.com
.
.
.
--More--
/Dialer1
filtering...
interface Dialer1
no ip address
no ip directed-broadcast
dialer in-band
no cdp enable

Related Commands Command Description

more <url> begin Begins unfiltered output of the more command
with the first line that contains the regular
expression you specify.

Cisco IOS Configuration Fundamentals Command Reference

518
monitor event-trace through Q
more url exclude

Command Description
more <url> include Filters more command output so that it displays
only lines that contain a particular regular
expression.

show <command> begin Searches the output of any show command and
displays the output from the first instance of a
specified string.

show <command> exclude Filters show command output so that it excludes

lines that contain a particular regular expression.

show <command> include Filters show command output so that it displays

only lines that contain a particular regular
expression.

Cisco IOS Configuration Fundamentals Command Reference

519
 monitor event-trace through Q
more url include

more url include

To filter morecommand output so that it displays only lines that contain a particular regular expression, use
the more include command in EXEC mode.

{more url | include regular-expression}

Syntax Description url The Universal Resource Locator (URL) of the file
to display. More commands are advanced show
commands; for details, see the command reference
page in this book for the more command.

| A vertical bar (the “pipe” symbol) indicates that an

output processing specification follows.

regular-expression Any regular expression found in more command

output.

/ Specifies a search at a --More-- prompt that begins

unfiltered output with the first line that contains the
regular expression.

Command Modes EXEC

Command History Release Modification

11.3 AA The more command was introduced.

12.0(1)T This extension of the more command was

introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The regular-expression argument is case sensitive and allows for complex matching requirements.
You can specify a new search at any --More-- prompt. To search the remaining output of the more
command, use the following syntax at the --More-- prompt:
/ regular-expression
When output volume is large, the search can produce long lists of output. To interrupt the output, press
Ctrl-^ (Ctrl-Shift-6) or Ctrl-Z.
Because prior output is not saved, you cannot search or filter backward through prior output.

Cisco IOS Configuration Fundamentals Command Reference

520
 monitor event-trace through Q
more url include

Examples The following is partial sample output of the more nvram:startup-config | includecommand. It only
displays lines that contain the regular expression “ip.”

router# more nvram:startup-config | include ip

ip subnet-zero
ip domain-name cisco.com
ip name-server 198.92.30.32
ip name-server 171.69.2.132
description ip address 172.21.53.199 255.255.255.0
ip address 172.21.53.199 255.255.255.0

Related Commands Command Description

more <url> begin Begins unfiltered output of the more command
with the first line that contains the regular
expression you specify.

more <url> exclude Filters more command output so that it excludes

lines that contain a particular regular expression.

show <command> begin Searches the output of any show command and
displays the output from the first instance of a
specified string.

show <command> exclude Filters show command output so that it excludes

lines that contain a particular regular expression.

show <command> include Filters show command output so that it displays

only lines that contain a particular regular
expression.

Cisco IOS Configuration Fundamentals Command Reference

521
 monitor event-trace through Q
more flh:logfile

more flh:logfile
To view the system console output generated during the Flash load helper operation, use the more
flh:logfile privileged EXEC command.

more flh:logfile

Syntax Description This command has no arguments or keywords.

Command Modes Privileged EXEC

Command History Release Modification

11.3 AA This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines If you are a remote Telnet user performing the Flash upgrade without a console connection, this command
allows you to retrieve console output when your Telnet connection has terminated due to the switch to the
ROM image. The output indicates what happened during the download, and is particularly useful if the
download fails.
This command is a form of the more command. See the more command for more information.

Examples The following is sample output from the more flh:logfilecommand:

Router# more flh:logfile

%FLH: abc/igs-kf.914 from 172.16.1.111 to flash...
System flash directory:
File

Length Name/status

1 2251320

abc/igs-kf.914
[2251384 bytes used, 1942920 available, 4194304 total]
Accessing file 'abc/igs-kf.914' on 172.16.1.111...
Loading from 172.16.13.111:
Erasing device...... erased
Loading from 172.16.13.111:
- [OK -
2251320/4194304 bytes]
Verifying checksum... OK (0x97FA)
Flash copy took 79292 msecs
%FLH: Re-booting system after download

Cisco IOS Configuration Fundamentals Command Reference

522
 monitor event-trace through Q
more flh:logfile

Loading abc/igs-kf.914 at 0x3000040, size = 2251320 bytes [OK]

F3: 2183364+67924+259584 at 0x3000060
Restricted Rights Legend
Use, duplication, or disclosure by the Government is
subject to restrictions as set forth in subparagraph
(c) of the Commercial Computer Software - Restricted
Rights clause at FAR sec. 52.227-19 and subparagraph
(c) (1) (ii) of the Rights in Technical Data and Computer
Software clause at DFARS sec. 252.227-7013.
cisco Systems, Inc.
170 West Tasman Drive
San Jose, California 95134
Cisco Internetwork Operating System Software
Cisco IOS (tm) GS Software (GS7), Version 11.0
Copyright (c) 1986-1995 by cisco Systems, Inc.
Compiled Tue 06-Dec-94 14:01 by smith
Image text-base: 0x00001000, data-base: 0x005A9C94
cisco 2500 (68030) processor (revision 0x00) with 4092K/2048K bytes of
memory.
Processor board serial number 00000000
DDN X.25 software, Version 2.0, NET2 and BFE compliant.
ISDN software, Version 1.0.
Bridging software.
Enterprise software set supported. (0x0)
1 Ethernet/IEEE 802.3 interface.
2 Serial network interfaces.
--More--
1 ISDN Basic Rate interface.
32K bytes of non-volatile configuration memory.
4096K bytes of processor board System flash (Read ONLY)

Related Commands Command Description

more Displays a file.

Cisco IOS Configuration Fundamentals Command Reference

523
 monitor event-trace through Q
motd-banner

motd-banner
To enable the display of message-of-the-day (MOTD) banners on the specified line or lines, use the motd-
banner command in line configuration mode. To suppress the MOTD banners on the specified line or
lines, use the no form of this command.

motd-banner
no motd-banner

Syntax Description This command has no arguments or keywords.

Command Default Enabled on all lines.

Command Modes Line configuration

Command History Release Modification

11.1 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 MOTD banner when an EXEC session is
created on the specified line or lines. The MOTD banner is defined with the banner motd global
configuration command. By default, the MOTD banner is enabled on all lines. Disable the MOTD banner
on specific lines using the no motd-banner line configuration command.
The MOTD banners can also be disabled by the no exec-banner line configuration command, which
disables both MOTD banners and EXEC 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-bannercommand is enabled
or disabled. The table below summarizes the effects of the exec-banner command and the motd-banner
command.

Table 31 Banners Displayed Based On exec-banner and motd-banner Combinations

exec-banner (default) no exec-banner

motd-banner (default) MOTD banner None
EXEC banner

Cisco IOS Configuration Fundamentals Command Reference

524
 monitor event-trace through Q
motd-banner

exec-banner (default) no exec-banner

no motd-banner 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. The table below summarizes the effects of the
exec-banner command and the motd-banner command for reverse Telnet connections.

Table 32 Banners Displayed Based On exec-banner and motd-banner Combinations for Reverse Telnet
Sessions to Async Lines

exec-banner (default) no exec-banner

motd-banner (default) MOTD banner Incoming banner
Incoming banner

no motd-banner Incoming banner Incoming banner

Examples The following example suppresses the MOTD banner on vty lines 0 through 4:

line vty 0 4
no motd-banner

Related Commands Command Description

banner exec Defines and enables a customized banner to be
displayed whenever the EXEC process is initiated.

banner incoming Defines and enables a customized message to be

displayed when there is an incoming connection to
a terminal line from a host on the network.

banner motd Defines and enables a customized message-of-the-

day banner.

motd-banner Controls (enables or disables) the display of

message-of-the-day banners on a specified line or
lines.

Cisco IOS Configuration Fundamentals Command Reference

525
 monitor event-trace through Q
name-connection

name-connection
To assign a logical name to a connection, use the name-connectioncommand in user EXEC mode.

name-connection

Syntax Description This command has no arguments or keywords.

Command Default No logical name is defined.

Command Modes User EXEC

Command History Release Modification

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 can be useful for keeping track of multiple connections.
You are prompted for the connection number and name to assign. The where command displays a list of
the assigned logical connection names.

Examples The following example assigns the logical name blueto the connection:

Router> where
Conn Host Address Byte Idle Conn Name
* 1 doc-2509 172.30.162.131 0 0 doc-2509
Router> name-connection
Connection number: 1
Enter logical name:
blue
Connection 1 to doc-2509 will be named "BLUE" [confirm]

Related Commands Command Description

where Lists open sessions associated with the current
terminal line.

Cisco IOS Configuration Fundamentals Command Reference

526
monitor event-trace through Q
name-connection

Cisco IOS Configuration Fundamentals Command Reference

527
 monitor event-trace through Q
no menu

no menu
To delete a user menu from the configuration file, use the no menu command in global configuration
mode.

no menu menu-name

Syntax Description menu-name Name of the menu to delete from the configuration
file.

Command Default No default behavior or values.

Command Modes Global configuration

Command History Release Modification

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 remove any menu commands for a particular menu from the configuration file.
As with all global configuration commands, this command will only effect the startup configuration file
when you save the running configuration using the copy running-config startup-config EXEC command.

Examples The following example deletes the menu named Access1:

no menu Access1

Related Commands Command Description

menu (EXEC) Invokes a user menu.

menu command Specifies underlying commands for user menus.

Cisco IOS Configuration Fundamentals Command Reference

528
monitor event-trace through Q
no menu

Command Description
menu prompt Specifies the prompt for a user menu.

menu text Specifies the text of a menu item in a user menu.

menu title Creates a title, or banner, for a user menu.

Cisco IOS Configuration Fundamentals Command Reference

529
 monitor event-trace through Q
notify

notify
To enable terminal notification about pending output from other Telnet connections, use the notify
command in line configuration mode. To disable notifications, use the noform of this command.

notify
no notify

Syntax Description This command has no arguments or keywords.

Command Default Disabled

Command Modes Line configuration

Command History Release Modification

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 sets a line to inform a user that has multiple, concurrent Telnet connections when output is
pending on a connection other than the current one.

Examples In the following example, notification of pending output from connections is enabled on virtual terminal
lines 0 to 4:

Router(config)# line vty 0 4

Router(config-line)# notify

Related Commands Command Description

terminal notify Configures a line to inform a user that has multiple,
concurrent Telnet connections when output is
pending on a connection other than the current one.

Cisco IOS Configuration Fundamentals Command Reference

530
 monitor event-trace through Q
notify syslog

notify syslog
To enable the sending of notifications of configuration changes to a remote system message logging
(syslog), use the notify syslogcommand in configuration change logger configuration mode. To disable the
sending of notifications of configuration changes to the syslog, use the no form of this command.

notify syslog [contenttype {plaintext | xml}]

no notify syslog [contenttype {plaintext | xml}]

Syntax Description contenttype (Optional) Allows you to choose a format for the
configuration change messages that are sent via
syslog.

plaintext (Optional) Specifies that the configuration change

messages are sent as plain text.

xml (Optional) Specifies that the configuration change

messages are sent in XML format.

Command Default Notifications are not sent to the syslog.

Command Modes Configuration change logger configuration (config-archive-log-config)

Command History Release Modification

12.3(4)T This command was introduced.

12.2(25)S This command was integrated into Cisco IOS

Release 12.2(25)S.

12.2(27)SBC This command was integrated into Cisco IOS

Release 12.2(27)SBC.

12.2(33)SRA The contenttype plaintext, and xml keywords

were added.

12.2(33)SB This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco
10000 series.

Cisco IOS Configuration Fundamentals Command Reference

531
 monitor event-trace through Q
notify syslog

Usage Guidelines Enable the notify syslog command if you use the syslog to monitor your router. Syslog monitoring prevents
the need to gather configuration log information manually.

Examples The following example shows how to enable the router to send notifications (in XML format) to the syslog:

Router# configure terminal

!
Router(config)# archive
Router(config-archive)# log config
Router(config-archive-log-config)# notify syslog contenttype xml
Router(config-archive-log-config)# end

Related Commands Command Description

archive Enters archive configuration mode.

hidekeys Suppresses the display of password information in

configuration log files.

log config Enters configuration change logger configuration

mode.

logging enable Enables the logging of configuration changes.

logging size Specifies the maximum number of entries retained

in the configuration log.

show archive log config Displays entries from the configuration log.

Cisco IOS Configuration Fundamentals Command Reference

532
 monitor event-trace through Q
padding

padding
To set the padding on a specific output character, use the padding command in line configuration mode. To
remove padding for the specified output character, use the no form of this command.

padding ascii-number count

no padding ascii-number

Syntax Description ascii-number ACII decimal representation of the character.

count Number of NULL bytes sent after the specified

character, up to 255 padding characters in length.

Command Default No padding

Command Modes Line configuration

Command History Release Modification

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 when the attached device is an old terminal that requires padding after certain characters
(such as ones that scrolled or moved the carriage). See the “ASCII Character Set and Hex Values”
appendix for a list of ASCII characters.

Examples In the following example, the Return (decimal character 13) is padded with 25 NULL bytes on the console
line:

Router(config)# line console

Router(config-line)# padding 13 25

Cisco IOS Configuration Fundamentals Command Reference

533
 monitor event-trace through Q
padding

Related Commands Command Description

terminal padding Changes the character padding on a specific output
character for the current session.

Cisco IOS Configuration Fundamentals Command Reference

534
 monitor event-trace through Q
parity

parity
To define generation of a parity bit, use the parity command in line configuration mode. To specify no
parity, use the no form of this command.

parity {none | even | odd | space | mark}

no parity

Syntax Description none No parity. This is the default.

even Even parity.

odd Odd parity.

space Space parity.

mark Mark parity.

Command Default No parity.

Command Modes Line configuration

Command History Release Modification

10.0 This command was introduced.

12.4 This command was modified to enable parity

setting on Cisco AS5350 and Cisco AS5400
NextPort lines.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines Communication protocols provided by devices such as terminals and modems sometimes require a specific
parity bit setting. Refer to the documentation for your device to determine required parity settings.
If you use this command to set parity on Cisco AS5350 and Cisco AS5400 NextPort lines, do not also set
parity by means of S-register settings in a modemcap. (A modemcap is a series of parameter settings that
are sent to your modem to configure it to interact with a Cisco device in a specified way. Cisco IOS
software defines modemcaps that have been found to properly initialize most modems so that they function
properly with Cisco routers and access servers.)

Cisco IOS Configuration Fundamentals Command Reference

535
 monitor event-trace through Q
parity

Examples In the following example, even parity is configured for line 34:

Router(config)# line 34
Router(config-line)# parity even

Related Commands Command Description

terminal parity Defines the generation of the parity bit for the
current for the current session and line.

Cisco IOS Configuration Fundamentals Command Reference

536
 monitor event-trace through Q
parser cache

parser cache
To reenable the Cisco IOS software parser cache after disabling it, use the parser cache command in
global configuration mode. To disable the parser cache, use the no form of this command.

parser cache
no parser cache

Syntax Description This command has no arguments or keywords.

Command Default Parser cache is enabled by default.

Command Modes Global configuration

Command History Release Modification

12.1(5)T This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines The Parser Cache feature optimizes the parsing (translation and execution) of Cisco IOS software
configuration command lines by remembering how to parse recently encountered command lines,
decreasing the time required to process large configuration files.
The parser cache is enabled by default. However, if you wish to disable the parser cache, you may do so
using the no parser cache command in global configuration mode. To reenable the parser cache after it has
been disabled, use the parser cache command.
When the no parser cache is issued, the command line appears in the running configuration file. However,
if the parser cache is reenabled, no command line appears in the running configuration file.

Examples In the following example, the Cisco IOS software Parser Cache feature is disabled:

Router(config)# no parser cache

Cisco IOS Configuration Fundamentals Command Reference

537
 monitor event-trace through Q
parser cache

Related Commands Command Description

clear parser cache Clears the parse cache entries and hit/miss statistics
stored for the Parser Cache feature.

show parser statistics Displays statistics about the last configuration file
parsed and the status of the Parser Cache feature.

Cisco IOS Configuration Fundamentals Command Reference

538
 monitor event-trace through Q
parser command serializer

parser command serializer

To enable configuration access only to the users holding a configuration lock and to prevent other clients
from accessing the running configuration, use the parser command serializer command in global
configuration mode. To disable this configuration, use the no form of this command.

parser command serializer

no parser command serializer

Syntax Description This command has no arguments or keywords.

Command Default Access is granted only to the user holding the lock.

Command Modes Global configuration (config)

Command History Release Modification

12.2(33)SRE This command was introduced.

15.1(1)T This command was included in Cisco IOS Release

15.1(1)T.

Usage Guidelines The Parser Concurrency and Locking Improvements feature ensures that exclusive access is granted only to
a requested process and prevents other users from concurrently accessing the Cisco IOS configuration. That
is, it prevents simultaneous execution of two or more commands. Use the parser command serializer
command to configure the Parser Concurrency and Locking Improvements feature.

Examples The following example shows how to configure the Parser Concurrency and Locking Improvements
feature:

Router# configure terminal

Router(config)# parser command serializer

Cisco IOS Configuration Fundamentals Command Reference

539
 monitor event-trace through Q
parser command serializer

Related Commands Command Description

configuration mode exclusive Enables single-user (exclusive) access functionality
for the Cisco IOS CLI.

configure terminal lock Locks the running configuration into exclusive

configuration mode for the duration of your
configuration session.

test parser session-lock Tests the behavior of the Parser Concurrency and
Locking Improvements feature.

Cisco IOS Configuration Fundamentals Command Reference

540
 monitor event-trace through Q
parser config cache interface

parser config cache interface

To reduce the time required for the command-line interpreter to execute commands that manage the
running system configuration files, use the parser config cache interfacecommand in global configuration
mode. To disable the reduced command execution time functionality, use the no form of this command.

parser config cache interface

no parser config cache interface

Syntax Description This command has no arguments or keywords.

Command Default Disabled

Command Modes Global configuration (config)

Command History Release Modification

12.3(7)T This command was introduced.

12.2(25)S This command was integrated into Cisco IOS

Release 12.2(25)S.

12.2(27)SBC This command was integrated into Cisco IOS

Release 12.2(27)SBC.

12.2(33)SRC This command was integrated into Cisco IOS

Release 12.2(33)SRC.

12.2(33)SB This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco
10000 series.

12.2(33)SXI This command was integrated into Cisco IOS

Release 12.2(33)SXI.

Usage Guidelines Enable the parser config cache interfacecommand to reduce the execution time required for running
configuration management commands such as the show running-configuration, write terminal, and copy
system:running-configuration commands. Information for these configuration management commands is
supplied by nonvolatile generation (NVGEN) processes that query the system for configuration details. The
parser config cache interfacecommand is especially useful for managing large system configurations that
contain numerous interface configurations.

Cisco IOS Configuration Fundamentals Command Reference

541
 monitor event-trace through Q
parser config cache interface

Once enabled, the command provides faster execution of the NVGEN commands that process the running
system configuration by caching interface configurations in system memory, and by retrieving only
configuration information that has changed. For this reason, the device on which this command is enabled
must have enough memory available to store the interface configuration. For example, if the interface
configurations take up 15 KB of memory, using this command would require having an additional 15 KB
of memory space available.
The first time you display the configuration file, you will not see much evidence of improvement in
performance because the interface cache will be filled up. However, you will notice performance
improvements when you enter subsequent NVGEN-type commands such as the show running-
configuration EXEC command.
Each time the interface configuration is changed, the interface cache is flushed. Entering an NVGEN-type
command after modifying the interface configuration will once again not show any performance
improvement until the next NVGEN-type command is entered.

Examples The following example shows how to enable the functionality for reducing the time required for the
command-line interpreter to execute commands that manage the running system configuration files:

Router(config)# parser config cache interface

Related Commands Command Description

copy system:running-configuration Copies the running configuration to another
destination.

show running-configuration Displays the configuration currently running on the

terminal.

write terminal Displays the configuration currently running on the

terminal.

Cisco IOS Configuration Fundamentals Command Reference

542
 monitor event-trace through Q
parser config partition

parser config partition

To enable configuration partitioning, use the parser config partition command. To disable the partitioning
of the running configuration, use the noform of thiscommand.

parser config partition

no parser config partition

Syntax Description No arguments or keywords.

Command Default This command is enabled by default.

Command Modes Global configuration (config)

Command History Release Modification

12.2(33)SRB This command was introduced as part of the
Configuration Partitioning feature.

12.2(33)SB This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco
10000 series.

12.2(33)SXI This command was integrated into Cisco IOS

Release 12.2(33)SXI.

Usage Guidelines This command controls (enables or disables) the Configuration Partitioning feature.

Note This command is not related to disk partitions or disk partitioning.

To display the list of commands that make up the current running configuration for a specific part
(“partition”) of the system’s global running configuration, use the show running-config partition
command in privileged Exec mode.
The Configuration Partitioning feature uses a small amount of system resources. The no parser config
partition command allows you to disable this feature if the feature is not needed on your system.

Cisco IOS Configuration Fundamentals Command Reference

543
 monitor event-trace through Q
parser config partition

Note Only the no form of this command will appear in configuration files. To determine if config partitioning is
supported on your system and whether it is enabled, use the show running-config parser ? command.

Examples The following example shows how to disable partitioning of the system running configuration:

Router> enable
Router# config t

Enter configuration commands, one per line. End with CNTL/Z.

Router(config)# no parser config partition
System configured

Related Commands Command Description

show running-config partition Displays the list of commands that make up the
current running configuration for a specific part of
the system’s global running configuration. When
used with the ? CLI help keyword, can also be used
to determine the availability and status of the
Configuration Partitioning feature.

Cisco IOS Configuration Fundamentals Command Reference

544
 monitor event-trace through Q
parser maximum

parser maximum
To specify performance maximums for CLI operations use the parser maximum command in global
configuration mode. To clear any previously established maximums, us the No form of the command.

parser maximum {latencylimit | utilizationlimit}

no parser maximum {latency | utilization}

Syntax Description latency Specifies the maximum process latency to allow.

limit Numerical latency between 20 and 200.

utilization Specifies the maximum CPU utilization to allow.

limit Numerical CPU utilization between 1 and 100.

Command Default No performance maximums enabled by default.

Command Modes Global Configuration

Command History Release Modification

15.1(3)T This command was introduced.

Usage Guidelines The Parser Maximum feature provides a workaround in the event of a problem with the coding of a
protocol, allowing the error to be bypassed untill it can be corrected.

Examples The following example shows how to impose a latency limit of 100.

Router(config)#paser maximum latency 100

The following example shows how to clear latency limits.

Router(config)#no paser maximum latency

Cisco IOS Configuration Fundamentals Command Reference

545
 monitor event-trace through Q
parser maximum

Related Commands Command Description

parser cache The Parser Cache feature optimizes the parsing
(translation and execution) of Cisco IOS software
configuration command lines by remembering how
to parse recently encountered command lines,
decreasing the time required to process large
configuration files.

Cisco IOS Configuration Fundamentals Command Reference

546
 monitor event-trace through Q
partition

partition
To separate Flash memory into partitions on Class B file system platforms, use the partition command in
global configuration mode. To undo partitioning and to restore Flash memory to one partition, use the no
form of this command.

Cisco 1600 Series and Cisco 3600 Series Routers

partition flash-filesystem : [number-of-partitions] [partition-size]
no partition flash-filesystem:

All Other Class B Platforms

partition flash partitions [size1 size2]
no partition flash

Syntax Description flash-filesystem : One of the following Flash file systems, which
must be followed by a colon (:). The Cisco 1600
series can only use the flash: keyword.
• flash: -- Internal Flash memory
• slot0: -- Flash memory card in PCMCIA slot 0
• slot1: -- Flash memory card in PCMCIA slot 1

number-of-partitions (Optional) Number of partitions in Flash memory.

partition-size (Optional) Size of each partition. The number of

partition size entries must be equal to the number of
specified partitions.

partitions Number of partitions in Flash memory. Can be 1 or

2.

size1 (Optional) Size of the first partition (in megabytes).

size2 (Optional) Size of the second partition (in

megabytes).

Command Default Flash memory consists of one partition.

If the partition size is not specified, partitions of equal size are created.

Command Modes Global configuration

Cisco IOS Configuration Fundamentals Command Reference

547
 monitor event-trace through Q
partition

Command History Release Modification

10.3 This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines For the Cisco 1600 series and Cisco 3600 series routers, to undo partitioning, use the partition flash-
filesystem :1 or no partition flash-filesystem : command. For other Class B platforms, use either the
partition flash 1 or no partition flash command. If there are files in a partition other than the first, you
must use the erase flash-filesystem:partition-numbercommand to erase the partition before reverting to a
single partition.
When creating two partitions, you must not truncate a file or cause a file to spill over into the second
partition.

Note The partition command will only create 3MB or larger partitions and may not be used if the device memory
contains logging persistent files.

Examples The following example creates two partitions of 4 MB each in Flash memory:

Router(config)# partition flash 2 4 4

The following example divides the Flash memory card in slot 0 into two partitions, each 8 MB in size on a
Cisco 3600 series router:

Router(config)#
partition slot0: 2 8 8

The following example creates four partitions of equal size in the card on a Cisco 1600 series router:

Router(config)# partition flash: 4

Cisco IOS Configuration Fundamentals Command Reference

548
 monitor event-trace through Q
path (archive configuration)

path (archive configuration)

To specify the location and filename prefix for the files in the Cisco IOS configuration archive, use the
path command in archive configuration mode. To disable this function, use the no form of this command.

path url
no path url

Syntax Description url URL (accessible by the Cisco IOS file system) used
for saving archive files of the running configuration
file in the Cisco IOS configuration archive.

Command Default If this command is not configured, no location or filename prefix is specified for files in the Cisco IOS
configuration archive.

Command Modes Archive configuration (config-archive)

Command History Release Modification

12.3(7)T This command was introduced.

12.2(25)S This command was integrated into Cisco IOS

Release 12.2(25)S.

12.2(28)SB This command was integrated into Cisco IOS

Release 12.2(28)SB.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2(31)SB2 This command was implemented on the Cisco

10000 series.

12.2(33)SXH This command was integrated into Cisco IOS

Release 12.2(33)SXH.

12.2(33)SB This command was integrated into Cisco IOS

Release 12.2(33)SB and implemented on the Cisco
10000 series.

Cisco IOS Configuration Fundamentals Command Reference

549
 monitor event-trace through Q
path (archive configuration)

Usage Guidelines When this command is entered, an archive file of the running configuration is saved when the archive
config, write-memory, or copy running-config startup-config command is entered.
URLs are commonly used to specify files or location on the World Wide Web. On Cisco routers, URLs can
be used to specify the location of a file or directory on a router or a remote file server. The path command
uses a URL to specify the location and filename prefix for the Cisco IOS configuration archive.
The locations or file systems that you can specify in the url argument are as follows:
• If your platform has disk0--disk0:, disk1:, ftp:, pram:, rcp:, slavedisk0:, slavedisk1:, or tftp:
• If your platform does not have disk0--ftp:, http:, pram:, rcp:, or tftp:
The colon is required in the location format.
The filename of the first archive file is the filename specified in the url argument followed by -1. The
filename of the second archive file is the filename specified in the url argument followed by -2 and so on.
Because some file systems are incapable of storing the date and time that a file was written, the filename of
the archive file can contain the date, time, and router hostname. To include the router hostname in the
archive file filename, enter the characters $h (for example, disk0:$h). To include the date and time in the
archive file filename, enter the characters $t.
When a configuration archive operation is attempted on a local file system, the file system is tested to
determine if it is writable and if it has sufficient space to save an archive file. If the file system is read-only
or if there is not enough space to save an archive file, an error message is displayed.
If you specify the tftp: file server as the location with the path command, you need to create the
configuration file on the TFTP file server and change the file’s privileges before the archive config
command works properly.

Examples The following example of the path command shows how to specify the hostname, date, and time as the
filename prefix for which to save archive files of the running configuration. In this example, the time-
period command is also configured to automatically save an archive file of the running configuration every
20 minutes.

configure terminal
!
archive
path disk0:$h$t
time-period 20
end

The following is sample output from the show archive command illustrating the format of the resulting
configuration archive filenames.

Router# show archive

There are currently 3 archive configurations saved.
The next archive file will be named routerJan-16-01:12:23.019-4
Archive # Name
0
1 disk0:routerJan-16-00:12:23.019-1
2 disk0:routerJan-16-00:32:23.019-2
3 disk0:routerJan-16-00:52:23.019-3 <- Most Recent
4
5
6
7
8
9
10
11

Cisco IOS Configuration Fundamentals Command Reference

550
monitor event-trace through Q
path (archive configuration)

12
13
14

Cisco IOS Configuration Archive on the TFTP File Server

The following example shows how to use the path command to specify the TFTP file server, address
10.48.71.226, as the archive configuration location and router-cfg as the configuration filename. First you
create the configuration file on the TFTP server and change the file’s privileges, then you can save the
configuration file to the configuration archive.
The following example shows the commands to use to create the file and change the file’s privileges on the
TFTP server (UNIX commands):

> touch
router-cfg-1
> chmod
777 router-cfg-1

The following example show how to create the configuration archive, save the running configuration to the
archive, and display the files in the archive:

configure terminal
!
archive
path tftp://10.48.71.226/router-cfg
exit
exit
!
archive config
Router# show archive
The next archive file will be named tftp://10.48.71.226/router-cfg-2
Archive # Name
0
1 tftp://10.48.71.226/router-cfg-1 <- Most Recent
2
3
4
5
6
7
8
9
10
11
12
13
14

The following is sample output from the show archive command if you did not create the configuration file
on the TFTP server before attempting to archive the current running configuration file:

configure terminal
!
archive
path tftp://10.48.71.226/router-cfg
exit
exit
archive config
Router# show archive
The next archive file will be named tftp://10.48.71.226/router-cfg-1
Archive # Name
0
1
2
3
4
5

Cisco IOS Configuration Fundamentals Command Reference

551
 monitor event-trace through Q
path (archive configuration)

6
7
8
9
10
11
12
13
14

Related Commands Command Description

archive Enters archive configuration mode.

archive config Saves a copy of the current running configuration to

the Cisco IOS configuration archive.

configure confirm Confirms replacement of the current running

configuration with a saved Cisco IOS configuration
file.

configure replace Replaces the current running configuration with a

saved Cisco IOS configuration file.

maximum Sets the maximum number of archive files of the

running configuration to be saved in the Cisco IOS
configuration archive.

show archive Displays information about the files saved in the

Cisco IOS configuration archive.

time-period Sets the time increment for automatically saving an

archive file of the current running configuration in
the Cisco IOS configuration archive.

Cisco IOS Configuration Fundamentals Command Reference

552
 monitor event-trace through Q
periodic

periodic
To specify a recurring (weekly) time range for functions that support the time-range feature, use the
periodic command in time-range configuration mode. To remove the time limitation, use the no form of
this command.

periodic days-of-the-week hh:mm to [days-of-the-week] hh:mm

no periodic days-of-the-week hh:mm to [days-of-the-week] hh:mm

Syntax Description days-of-the-week The first occurrence of this argument is the starting
day or day of the week that the associated time
range is in effect. The second occurrence is the
ending day or day of the week the associated
statement is in effect.
This argument can be any single day or
combinations of days: Monday, Tuesday,
Wednesday, Thursday, Friday, Saturday, and
Sunday. Other possible values are:
• daily --Monday through Sunday
• weekdays --Monday through Friday
• weekend --Saturday and Sunday
If the ending days of the week are the same as the
starting days of the week, they can be omitted.

hh:mm The first occurrence of this argument is the starting

hours:minutes that the associated time range is in
effect. The second occurrence is the ending
hours:minutes the associated statement is in effect.
The hours:minutes are expressed in a 24-hour
clock. For example, 8:00 is 8:00 a.m. and 20:00 is
8:00 p.m.

to Entry of the to keyword is required to complete the

range “from start-time to end-time.”

Command Default No recurring time range is defined.

Command Modes Time-range configuration (config-time-range)

Cisco IOS Configuration Fundamentals Command Reference

553
 monitor event-trace through Q
periodic

Command History Release Modification

12.0(1)T This command was introduced.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

Usage Guidelines For Cisco IOS Release 12.2(11)T, IP and Internetwork Packet Exchange (IPX) extended access lists are the
only functions that can use time ranges. For further information on using these functions, refer to the Cisco
IOS IP Configuration Guide and the Cisco IOS AppleTalk and Novell IPX Configuration Guide.
The periodiccommand is one way to specify when a time range is in effect. Another way is to specify an
absolute time period with the absolute command. Use either of these commands after the time-range
global configuration command, which specifies the name of the time range. Multiple periodicentries are
allowed per time-range command.
If the end days-of-the-week value is the same as the start value, they can be omitted.
If a time-range command has both absolute and periodic values specified, then the periodic items are
evaluated only after the absolute start time is reached, and are not further evaluated after the absolute end
time is reached.

Note All time specifications are taken as local time. To ensure that the time range entries take effect at the
desired times, you should synchronize the system software clock using Network Time Protocol (NTP).

The table below lists some typical settings for your convenience:

Table 33 Typical Examples of periodic Command Syntax

If you want: Configure this:

Monday through Friday, 8:00 a.m. to 6:00 p.m. periodic weekday 8:00 to 18:00
only

Every day of the week, from 8:00 a.m. to 6:00 p.m. periodic daily 8:00 to 18:00
only

Every minute from Monday 8:00 a.m. to Friday periodic monday 8:00 to friday 20:00
8:00 p.m.

All weekend, from Saturday morning through periodic weekend 00:00 to 23:59
Sunday night

Saturdays and Sundays, from noon to midnight periodic weekend 12:00 to 23:59

Examples The following example configuration denies HTTP traffic on Monday through Friday from 8:00 a.m. to
6:00 p.m.:

Router# show startup-config

Cisco IOS Configuration Fundamentals Command Reference

554
 monitor event-trace through Q
periodic

.
.
.
time-range no-http
periodic weekdays 8:00 to 18:00
!
ip access-list extended strict
deny tcp any any eq http time-range no-http
!
interface ethernet 0
ip access-group strict in
.
.
.

The following example configuration permits Telnet traffic on Mondays, Tuesdays, and Fridays from 9:00
a.m. to 5:00 p.m.:

Router# show startup-config

.
.
.
time-range testing
periodic Monday Tuesday Friday 9:00 to 17:00
!
ip access-list extended legal
permit tcp any any eq telnet time-range testing
!
interface ethernet 0
ip access-group legal in
.
.
.

Related Commands Command Description

absolute Specifies an absolute start and end time for a time
range.

access-list (extended) Defines an extended IP access list.

deny (IP) Sets conditions under which a packet does not pass
a named IP access list.

permit (IP) Sets conditions under which a packet passes a

named IP access list.

time-range Enables time-range configuration mode and names

a time range definition.

Cisco IOS Configuration Fundamentals Command Reference

555
 monitor event-trace through Q
ping

ping
To diagnose basic network connectivity on AppleTalk, ATM, Connectionless Network Service (CLNS),
DECnet, IP, Novell IPX, or source-route bridging (SRB) networks, use the ping command in user EXEC or
privileged EXEC mode.

ping [[protocol [tag]]{host-name | system-address}]

Syntax Description protocol (Optional) Protocol keyword, either appletalk,

atm, clns, decnet, ipx, or srb. If a protocol is not
specified, a basic ping will be sent using IP (IPv4).
For extended options for ping over IP, see the
documentation for the ping ip command.
The ping atm interface atm, ping ip, ping ipv6,
ping sna, and ping vrfcommands are documented
separately.

tag (Optional) Specifies a tag encapsulated IP (tagIP)

ping.

host-name Hostname of the system to ping. If a host-name or

system-address is not specified at the command
line, it will be required in the ping system dialog.

system-address Address of the system to ping. If a host-name or

system-address is not specified at the command
line, it will be required in the ping system dialog.

Command Default This command has no default values.

Command Modes User EXEC (>) Privileged EXEC (#)

Command History Release Modification

10.0 This command was introduced.

12.0(7)T The ping sna command was introduced.

12.1(12c)E The ping vrf command was introduced.

12.2(2)T Support for the IPv6 protocol was added.

Cisco IOS Configuration Fundamentals Command Reference

556
 monitor event-trace through Q
ping

Release Modification
12.2(13)T The atmprotocol keyword was added.
The following keywords were removed because the
Apollo Domain, Banyan VINES, and XNS
protocols are no longer supported in Cisco IOS
software:
• apollo
• vines
• xns

12.2(28)SB This command was integrated into Cisco IOS

Release 12.2(28)SB.

12.2(25)SG This command was integrated into Cisco IOS

Release 12.2(25)SG.

12.2(33)SRA This command was integrated into Cisco IOS

Release 12.2(33)SRA.

12.2(33)SXH This command was integrated into Cisco IOS

Release 12.2(33)SXH.

Cisco IOS XE Release 2.1 This command was introduced on Cisco ASR 1000
Series Routers.

Usage Guidelines The ping command sends an echo request packet to an address then waits for a reply. Ping output can help
you evaluate path-to-host reliability, delays over the path, and whether the host can be reached or is
functioning. For example, the ping clns command sends International Organization for Standardization
(ISO) CLNS echo packets to test the reachability of a remote router over a connectionless Open System
Interconnection (OSI) network.
If you enter the ping command without any keywords or argument values, an interactive system dialog
prompts you for the additional syntax appropriate to the protocol you specify. (See the “Examples”
section.)
To exit the interactive ping dialog before responding to all the prompts, type the escape sequence. The
default escape sequence is Ctrl-^, X (Simultaneously press and release the Ctrl, Shift, and 6 keys and then
press the X key). The escape sequence will vary depending on your line configuration. For example,
another commonly used escape sequence is Ctrl-c.
The table below describes the test characters sent by the pingfacility.

Table 34 ping Test Characters

Character Description
! Each exclamation point indicates receipt of a reply.

Cisco IOS Configuration Fundamentals Command Reference

557
 monitor event-trace through Q
ping

Character Description
. Each period indicates that the network server timed
out while waiting for a reply.

U A destination unreachable error protocol data unit

(PDU) was received.

C A reply packet does not validate the reply data, and

hence is marked "Corrupted".
Note This character will only appear if the
"validate" option is selected in the ping
request.

I User interrupted test.

M A destination unreachable error protocol data unit

(PDU) was received (Type 3) MTU required but
DF bit set (code 4) with the “Next-Hop MTU” set
to a non-zero value. If the “Next-hop MTU“ is zero
then ‘U’ is printed.

? Unknown packet type.

& Packet lifetime exceeded.

Note Not all protocols require hosts to support pings. For some protocols, the pings are Cisco defined and can be
answered only by another Cisco router.

The availability of protocol keywords depends on what protocols are enabled on your system.
Issuing the ping command in user EXEC mode will generally offer fewer syntax options than issuing the
ping command in privileged EXEC mode.

Examples After you enter the ping command in privileged EXEC mode, the system prompts you for a protocol
keyword. The default protocol is IP.
If you enter a hostname or address on the same line as the ping command, the default action is taken as
appropriate for the protocol type of that name or address.
The following example is sample dialog from the ping command using default values. The specific dialog
varies somewhat from protocol to protocol.

Router# ping
Protocol [ip]:
Target IP address: 192.168.7.27
Repeat count [5]:
Datagram size [100]:
Timeout in seconds [2]:
Extended commands [n]:
Sweep range of sizes [n]:
Type escape sequence to abort.
Sending 5, 100-byte ICMP Echos to 192.168.7.27, timeout is 2 seconds:

Cisco IOS Configuration Fundamentals Command Reference

558
monitor event-trace through Q
ping

!!!!!
Success rate is 100 percent, round-trip min/avg/max = 1/2/4 ms

The table below describes the significant fields shown in the display.

Table 35 ping Field Descriptions for IP

Field Description
Protocol [ip]: Prompt for a supported protocol. Default: ip.

Target IP address: Prompt for the IP address or hostname of the

destination node you plan to ping. If you have
specified a supported protocol other than IP, enter
an appropriate address for that protocol here.
Default: none.

Repeat count [5]: Number of ping packets that will be sent to the
destination address. Default: 5.

Datagram size [100]: Size of the ping packet (in bytes). Default: 100
bytes.

Timeout in seconds [2]: Timeout interval. Default: 2 (seconds).

Extended commands [n]: Specifies whether a series of additional commands

appears.

Sweep range of sizes [n]: Allows you to vary the sizes of the echo packets
being sent. This capability is useful for determining
the minimum sizes of the maximum transmission
units (MTUs) configured on the nodes along the
path to the destination address. Packet
fragmentation contributing to performance
problems can then be reduced.

!!!!! Each exclamation point (!) indicates receipt of a

reply. A period (.) indicates that the network server
timed out while waiting for a reply. Other
characters may appear in the ping output display,
depending on the protocol type.

Success rate is 100 percent Percentage of packets successfully echoed back to

the router. Anything less than 80 percent is usually
considered problematic.

round-trip min/avg/max = 1/2/4 ms Round-trip travel time intervals for the protocol
echo packets, including minimum/average/
maximum (in milliseconds).

The following example verifies connectivity to the neighboring ATM device for the ATM permanent
virtual circuit (PVC) with the virtual path identifier (VPI)/virtual channel identifier (VCI) value 0/16:

Router# ping

Protocol [ip]:atm

Cisco IOS Configuration Fundamentals Command Reference

559
 monitor event-trace through Q
ping

ATM Interface:atm1/0

VPI value [0]:

VCI value [1]:16

Loopback - End(0), Segment(1) [0]:1

Repeat Count [5]:

Timeout [2]:
Type escape sequence to abort.
Sending 5, 53-byte segment OAM echoes, timeout is 2 seconds:
!!!!!
Success rate is 100 percent (5/5), round-trip min/avg/max = 1/1/1 ms

The table below describes the default ping fields shown in the display.

Table 36 ping Field Descriptions for ATM

Field Description
Protocol [ip]: Prompt for a supported protocol. Default: ip.

ATM Interface: Prompt for the ATM interface.

VPI value [0]: Prompt for the virtual path identifier. Default: 0.

VCI value [1]: Prompt for the virtual channel identifier. Default:1.

Loopback - End(0), Segment(1) [0]: Prompt to specify end loopback, which verifies
end-to-end PVC integrity, or segment loopback,
which verifies PVC integrity to the neighboring
ATM device. Default: segment loopback.

Repeat Count [5]: Number of ping packets that will be sent to the
destination address. Default: 5.

Timeout [2]: Timeout interval. Default: 2 (seconds).

!!!!! Each exclamation point (!) indicates receipt of a

reply. A period (.) indicates that the network server
timed out while waiting for a reply. Other
characters may appear in the ping output display,
depending on the protocol type.

Success rate is 100 percent Percentage of packets successfully echoed back to

the router. Anything less than 80 percent is usually
considered problematic.

round-trip min/avg/max = 1/1/1 ms Round-trip travel time intervals for the protocol
echo packets, including minimum/average/
maximum (in milliseconds).

Related Commands Command Description

ping atm interface atm Tests the connectivity of a specific PVC.

Cisco IOS Configuration Fundamentals Command Reference

560
monitor event-trace through Q
ping

Command Description
ping ip Tests network connectivity on IP networks.

ping ipv6 Tests the connection to a remote host on the

network using IPv6.

ping sna Tests network integrity and timing characteristics

over an SNA Switching network.

ping vrf Tests the connection in the context of a specific

VPN (VRF).

Cisco IOS Configuration Fundamentals Command Reference

561
 monitor event-trace through Q
ping (privileged)

ping (privileged)
To diagnose basic network connectivity on Apollo, AppleTalk, Connectionless Network Service (CLNS),
DECnet, IP, Novell IPX, VINES, or XNS networks, use the pingcommand in privileged EXEC command
mode.

ping [hostname | system-address | [protocol | tag] {hostname | system-address}] [data [hex-data-

pattern] | df-bit | repeat [repeat-count] | size [datagram-size] | source [source-address | async | bvi |
ctunnel | dialer | ethernet | fastethernet | lex | loopback | multilink | null | port-channel | tunnel |
vif | virtual-template | virtual-tokenring | xtagatm] | timeout [seconds] | validate]

Syntax Description hostname (Optional) Hostname of the system to ping.

system-address (Optional) Address of the system to ping.

protocol (Optional) Protocol to use for the ping. Valid values

are: apollo, appletalk, clns, decnet, ethernet, ip,
ipv6, ipx, srb, vines, xns.

tag (Optional) Specifies a tag encapsulated IP ping.

data (Optional) Specifies the data pattern.

hex-data-pattern (Optional) Hexidecimal value of the data in the

range of 0 to FFFF.

df-bit (Optional) Enables the “do not fragment” bit in the

IP header.

repeat (Optional) Specifies the number of times the ping

should be sent.

repeat-count (Optional) Integer in the range of 1 to 2147483647.

The default is 5.

size (Optional) Size, in bytes, of the ping datagram.

datagram-size (Optional) Integer in the range of 40 to 18024.

source (Optional) Device sending the ping

source-address