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

C O N T E N T S

Introduction

Cisco IOS IFS Command Syntax 2 Obtaining Documentation Obtaining Support and Security Guidelines 4

A through B

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

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

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

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

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

viii

Cisco IOS Configuration Fundamentals Command Reference

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

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

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

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

xii

Cisco IOS Configuration Fundamentals Command Reference

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

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

943

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

xiv

Cisco IOS Configuration Fundamentals Command Reference

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

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

xvi

Cisco IOS Configuration Fundamentals Command Reference

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

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

1439

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

xviii

Cisco IOS Configuration Fundamentals Command Reference

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

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

Introduction

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:mypassword1@example.com/configfiles

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: disk0:

Cisco IOS Configuration Fundamentals Command Reference

Boot flash memory. Rotating disk media.

Introduction

Cisco IOS IFS Command Syntax

Prefix Description

flash: partition-number

flh: null:

nvram:

slavebootflash:

slavenvram: slaveslot0: slaveslot1: slot0:

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.

Flash load helper log files. Null destination for copies. You can copy a remote

file to null to determine its size. NVRAM. This is the default location for the

running-configuration file. Internal Flash memory on a slave RSP card of a

router configured with Dual RSPs. NVRAM on a slave RSP card. First PCMCIA card on a slave RSP card. Second PCMCIA card on a slave RSP card. First PCMCIA Flash memory card.

slot1: xmodem:

Second PCMCIA Flash memory card. 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

Introduction

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

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

activation-character

To define the character you ent er at a vacant terminal to begin a terminal session, use the activationcharacter 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

A through B

Syntax Description

Command Default

Command Modes

Command History

Usage Guidelines

ascii-number Decimal representation of the activation character.

Return (decimal 13)

Line configuration (config-line)

Release Modification

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

software Releases.

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 execcharacter-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

A through B

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

Command Default

Command Modes

Command History

mode Command mode of the original and alias

commands.

command-alias Command alias. original-command Original command syntax.

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.

Global configuration

Release

10.3 This command was introduced.

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

Modification

Release 12.2(33)SRA.

15.0M

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

Command Alias Original Command

h help

Default Command Aliases

Cisco IOS Configuration Fundamentals Command Reference

The command alias ip-vrf has been replaced with alias vrf-af.

alias

A through B

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”:

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

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.

Examples

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”

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

alias

A through B

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

Cisco IOS Configuration Fundamentals Command Reference

Command show aliases

Description

Displays command aliases.

A through B

Enters archive configuration mode. Confirms replacement of the current running

configuration with a saved Cisco IOS configuration file.

Cisco IOS Configuration Fundamentals Command Reference

A through B

archive config

Command Description

configure replace

maximum

path

show archive

time-period

Replaces the current running configuration with a saved Cisco IOS configuration file.

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

Specifies the location and filename prefix for the files in the Cisco IOS configuration archive.

Displays information about the files saved in the Cisco IOS configuration archive.

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

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

A through B

Syntax Description

Command Default

Command Modes

Command History

This command has no arguments or keywords.

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

Privileged EXEC (#).

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

Examples

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

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

A through B

archive log config persistent save

Related Commands

Command Description

log config

Enters configuration change logger configuration mode.

logging enable logging persistent

Enables the logging of configuration changes. Enables the configuration logging persistent

feature.

Cisco IOS Configuration Fundamentals Command Reference

archive tar

A through B

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:/fileurl [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

A through B

archive tar

/table source-url

/xtract source-url flash:/ file-url [dir/file...]

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.

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

Command Modes

Command History

The TAR archive file is not created.

Privileged EXEC (#)

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

archive tar

A through B

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

Examples

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.

The following example shows how to create a TAR file. The command writes the contents of the newconfigs 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

A through B

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

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

data List of IP addresses entered in dotted decimal

Table 5 tag Keyword Options

Keyword Description

bootfile

subnet-mask mask

time-offset offset

(Optional) This entry applies only to the specified host. The :hostname argument accepts both an IP address and a logical host name.

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

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.

Dotted decimal address specifying the network and local subnetwork mask (as defined by RFC 950).

Signed 32-bit integer specifying the time offset of the local subnetwork in seconds from Coordinated Universal Time (UTC).

gateway address

time-server address

IEN116-server address

nbns-server address

Cisco IOS Configuration Fundamentals Command Reference

Dotted decimal address specifying the IP addresses of gateways for this subnetwork. A preferred gateway should be listed first.

Dotted decimal address specifying the IP address of time servers (as defined by RFC 868).

Dotted decimal address specifying the IP address of name servers (as defined by IEN 116).

Dotted decimal address specifying the IP address of Windows NT servers.

async-bootp

A through B

Keyword Description

DNS-server address

log-server address

quote-server address

lpr-server address

impress-server address

rlp-server address

hostname name

bootfile-size value

Dotted decimal address specifying the IP address of domain name servers (as defined by RFC 1034).

Dotted decimal address specifying the IP address of an MIT-LCS UDP log server.

Dotted decimal address specifying the IP address of Quote of the Day servers (as defined in RFC 865).

Dotted decimal address specifying the IP address of Berkeley UNIX Version 4 BSD servers.

Dotted decimal address specifying the IP address of Impress network image servers.

Dotted decimal address specifying the IP address of Resource Location Protocol (RLP) servers (as defined in RFC 887).

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

A two-octet value specifying the number of 512octet (byte) blocks in the default boot file.

Command Default

Command Modes

Command History

Usage Guidelines

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

Global configuration

Release

Modification

10.0 This command was introduced.

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

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

A through B

async-bootp

Examples

Related Commands

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

Command Description show async bootp

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

Cisco IOS Configuration Fundamentals Command Reference

attach

A through B

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

Command Default

Command Modes

Command History

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.

No default behavior or values.

Privileged EXEC

Release

11.2GS This command was introduced on the Cisco 12000

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

Modification

series.

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

A through B

attach

Usage Guidelines

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

Caution After you enter the attach or remote login command to access another console from your switch, if you

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.

Cisco 7600 Series and Catalyst 6500 Series

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 Switchsp#, 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:

Examples

•

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#

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

attach

A through B

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:

Related Commands

Console#

attach 3

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

Command attach shelf

execute-on slot

remote login

Description

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

Executes commands remotely on a specific line card, or on all line cards simultaneously.

Accesses the Cisco 7600 series router console or a specific module.

Cisco IOS Configuration Fundamentals Command Reference

A through B

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

Command Default

Command Modes

Command History

Usage Guidelines

This command has no arguments or keywords.

Autobaud detection is disabled. Fixed speed of 9600 bps.

Line configuration

Release Modification

10.0 This command was introduced.

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

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

auto-sync

A through B

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

config-register

bootvar

running-config

standard

Specifies synchronization of the startup configuration files.

Specifies synchronization of the configuration register values.

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.

Specifies synchronization of the running configuration files.

Specifies synchronization of all of the system files (startup configuration, boot variables, and config configuration registers).

Command Default

Command Modes

Cisco IOS Configuration Fundamentals Command Reference

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)

Main CPU redundancy configuration (config-r-mc)

A through B

auto-sync

Command History

Usage Guidelines

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.

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

auto-sync

A through B

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.

Related Commands

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

Command

redundancy main-cpu

Description

Enters redundancy configuration mode. Enters main CPU redundancy configuration mode.

Cisco IOS Configuration Fundamentals Command Reference

A through B

autoupgrade disk-cleanup

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

command.

autoupgrade disk-cleanup

Syntax Description

Command Default

Command Modes

crashinfo

(Optional) Deletes crashinfo files during diskcleanup 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 filesystem that supports the undelete operation) during disk-cleanup before an image is downloaded.

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.

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

autoupgrade disk-cleanup

A through B

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

A through B

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

autoupgrade ida url

Syntax Description

Command Default

Command Modes

Command History

Usage Guidelines

Examples

url URL of the IDA server.

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

Global configuration (config)

Release Modification

12.4(15)T This command was introduced.

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

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

autoupgrade disk-cleanup

autoupgrade status email

Cisco IOS Configuration Fundamentals Command Reference

Description

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

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

autoupgrade ida url

A through B

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

A through B

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]]

autoupgrade status email

Syntax Description

Command Default

Command Modes

Command History

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.

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.

Global configuration (config)

Release

Modification

12.4(15)T This command was introduced.

Usage Guidelines

Examples

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

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

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

Cisco IOS Configuration Fundamentals Command Reference

autoupgrade status email

A through B

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

A through B

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

banner exec d message d no banner exec

Syntax Description

Command Default

Command Modes

Command History

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.

Disabled (no EXEC banner is displayed).

Global configuration

Release

10.0 This command was introduced.

11.3(7.5)AA Token functionality was introduced.

Modification

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

banner exec

A through B

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

Examples

$(hostname) $(domain) $(line) $(line-desc)

Displays the host name for the router. Displays the domain name for the router. Displays the vty or tty (asynchronous) line number. Displays the description attached to the line.

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 banner incoming

Description

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 banner slip-ppp

Defines a customized message-of-the-day banner. 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

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

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

A through B

Syntax Description

Command Default

Command Modes

Command History

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.

Disabled (no incoming banner is displayed).

Global configuration

Release

10.0 This command was introduced.

11.3(7.5)AA Token functionality was introduced.

Modification

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

Cisco IOS Configuration Fundamentals Command Reference

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

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.

Table 7 banner incoming Tokens

Token Information Displayed in the Banner

Examples

$(hostname) $(domain) $(line) $(line-desc)

Displays the host name for the router. Displays the domain name for the router. Displays the vty or tty (asynchronous) line number. Displays the description attached to the line.

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 banner exec

Description

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

Cisco IOS Configuration Fundamentals Command Reference

banner incoming

A through B

Command Description banner login

banner motd banner slip-ppp

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

Defines a customized message-of-the-day banner. 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

A through B

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

banner login d message d no banner login

Syntax Description

Command Default

Command Modes

Command History

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.

Disabled (no login banner is displayed).

Global configuration

Release

10.0 This command was introduced.

11.3(7.5)AA Token functionality was introduced.

Modification

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

banner login

A through B

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.

Table 8 banner login Tokens

Token Information Displayed in the Banner

Examples

$(hostname) $(domain) $(line) $(line-desc)

Displays the host name for the router. Displays the domain name for the router. Displays the vty or tty (asynchronous) line number. Displays the description attached to the line.

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 banner exec

Description

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

Cisco IOS Configuration Fundamentals Command Reference

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

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

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.

A through B

banner motd d message d no banner motd

Syntax Description

Command Default

Command Modes

Command History

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.

Disabled (no MOTD banner is displayed).

Global configuration

Release

10.0 This command was introduced.

11.3(7.5)AA Token functionality was introduced.

Modification

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

Cisco IOS Configuration Fundamentals Command Reference

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

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.

Table 9 banner motd Tokens

Token Information Displayed in the Banner

Examples

$(hostname) $(domain) $(line) $(line-desc)

Displays the host name for the router. Displays the domain name for the router. Displays the vty or tty (asynchronous) line number. Displays the description attached to the line.

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 banner exec

Description

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

banner motd

A through B

Command Description banner slip-ppp

exec-banner

motd-banner

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

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

Controls (enables or disables) the display of message-of-the-day banners on a specified line or lines.

Cisco IOS Configuration Fundamentals Command Reference

A through B

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

banner slip-ppp

Syntax Description

Command Default

Command Modes

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.

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.

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

Cisco IOS Configuration Fundamentals Command Reference

banner slip-ppp

A through B

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

Examples

$(hostname) $(domain) $(peer-ip) $(gate-ip) $(encap)

Displays the host name of the router. Displays the domain name of the router. Displays the IP address of the peer machine. Displays the IP address of the gateway machine. 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.

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 banner exec

Description

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

A through B

banner slip-ppp

Command Description banner motd

ppp slip

Defines and enables a customized message-of-theday banner.

Initiates a connection to a remote host using PPP. Initiates a connection to a remote host using SLIP.

Cisco IOS Configuration Fundamentals Command Reference

boot

A through B

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]

Syntax Description

Cisco 1800 Series, 2800 Series, and 3800 Series Routers

boot usbflash0 [:filename]

file-url

URL of the image to boot (for example, boot tftp://

172.16.15.112/routertest).

Cisco IOS Configuration Fundamentals Command Reference

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.

tftp-ip-address

flash

usbflash0

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.)

(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. Boots the router from Flash memory. Note that this

keyword is required in some boot images. Boot the first file in USB Flash 0. If the optional

filename argument is used, the router boots the specified image from USB Flash.

This option uses the first image in (compact)

Note

Flash as the boot loader and loads the image from USB Flash.

Cisco IOS Configuration Fundamentals Command Reference

boot

A through B

Command Default

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.

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

Command History

Usage Guidelines

ROM monitor

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.

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

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

boot

A through B

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:

Related Commands

> 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:

Command continue

Description

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

Cisco IOS Configuration Fundamentals Command Reference

A through B

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

boot bootldr file-url boot bootldr command no boot bootldr

Syntax Description

Command Default

Command Modes

Command History

Usage Guidelines

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

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

Global configuration (config)

Release Modification

11.0 The command was introduced.

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

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.

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

boot bootldr

A through B

Examples

Related Commands

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

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

A through B

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

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

filename

tftp

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

mop

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

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

Boots the router from flash memory. (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.

(Optional) Boots the router from a system image stored on a TFTP server.

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

Boots the router from a DECnet Maintenance Operation Protocol (MOP) server.

use the question mark (?) online help function.

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

Cisco IOS Configuration Fundamentals Command Reference

boot bootstrap

A through B

Command Default

Command Modes

Command History

No secondary bootstrap is configured.

Global configuration (config)

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

Examples

Related Commands

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.

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

Command

boot

Description

Boots the router manually.

Cisco IOS Configuration Fundamentals Command Reference

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

boot config

A through B

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

Command Default

Command Modes

file-system-prefix :

directory/

filename Name of the configuration file. device :

nvbypass

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

Global configuration (config)

File system, followed by a colon (for example,

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

(Optional) File system directory where the configuration file is located, followed by a forward slash (/).

Device identification, followed by a colon; see the “Usage Guidelines” section for a list of the valid values.

(Optional) Specifies that the distilled configuration is not written to nonvolatile random access memory (NVRAM).

Command History

Cisco IOS Configuration Fundamentals Command Reference

Release

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

Modification

Release 12.2(33)SRA.

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

boot config

A through B

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

Related Commands

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 routerconfig 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

Command copy system:running-config nvram:startup-

config show bootvar

Description

Saves the environment variable from the running configuration to the startup configuration.

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

A through B

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

Command Default

Command Modes

Command History

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]

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.

Global configuration

Release

10.0 This command was introduced.

Modification

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

boot host

A through B

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 routerconfg.

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:

The username specified in the file-URL, if a username is specified.

1 2

The username set by the ip rcmd remote-username command, if the command is configured. 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:

The username specified in the boot host command, if a username is specified.

The username set by the ip ftp username command, if the command is configured. Anonymous.

The router sends the first valid password in the following list:

The password specified in the boot host command, if a password is specified.

The password set by the ip ftp password command, if the command is configured.

Cisco IOS Configuration Fundamentals Command Reference

A through B

boot host

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

Related Commands

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

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

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.

A through B

boot network remote-url no boot network remote-url

Syntax Description

Command Default

Command Modes

Command History

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]

The default filename is network-config.

Global configuration

Release

10.0 This command was introduced.

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

Modification

Release 12.2(33)SRA.

Usage Guidelines

Cisco IOS Configuration Fundamentals Command Reference

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

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.

Note

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 routerconfg.

Loading a Configuration File Using rcp

When you load a configuration file from a server using rcp, the Cisco IOS software sends the first valid username in the following list:

The username specified in the file-URL, if a username is specified.

1 2

The username set by the ip rcmd remote-username command, if the command is configured. The router host name.

Note

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:

The username specified in the boot network command, if a username is specified.

The username set by the ip ftp username command, if the command is configured. Anonymous.

Cisco IOS Configuration Fundamentals Command Reference

boot network

A through B

The router sends the first valid password in the following list:

The password specified in the boot network command, if a password is specified.

The password set by the ip ftp password command, if the command is configured. 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

Related Commands

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

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

A through B

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

Syntax Description

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]

file-url

filename The TFTP filename of the system image to load at

The URL of the system image to load at system startup.

system startup.

Cisco IOS Configuration Fundamentals Command Reference

boot system

A through B

flash

flash-fs :

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.

(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

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

boot system

A through B

Command Default

Command Modes

Command History

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.

Global configuration

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.

Usage Guidelines

Note

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.

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.

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

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

boot system

A through B

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.

Examples

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

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

A through B

boot system

Related Commands

Command Description boot

config-register confreg

Boots the router manually. Changes the configuration register settings. Changes the configuration register settings while in

ROM monitor mode.

copy copy system:running-config nvram:startup-

config ip rcmd remote username

Copies any file from a source to a destination. Copies the running configuration to the startup

configuration. 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

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.

A through B

Command History

Examples

Release

12.3(3), 12.3(4)T, 12.0(26)S, 12.0(27)SV,

12.3(3)B,

In the following example, a boot command is entered, and the boot-start-marker and boot-end-marker flags

Modification

The boot-start-marker and boot-end-marker flags were introduced.

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

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

boot bootstrap

Description

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 hostspecific (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

boot-end-marker

A through B

Cisco IOS Configuration Fundamentals Command Reference

A through B

boot-start-marker

•

boot bootstrap

•

boot config

•

boot host

•

boot network

•

boot system

boot-start-marker

Command History

Release

12.3(3), 12.3(4)T, 12.0(26)S, 12.0(27)SV, 12.3(3)B

Modification

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

Cisco IOS Configuration Fundamentals Command Reference

Specifications and Main Features

Frequently Asked Questions

User Manual

C O N T E N T S

Introduction

Cisco IOS IFS Command Syntax

Obtaining Documentation Obtaining Support and Security Guidelines

A through B

activation-character

alias

archive

archive config

archive log config persistent save

archive tar

async-bootp

attach

autobaud

auto-sync

autoupgrade disk-cleanup

autoupgrade ida url

autoupgrade status email

banner exec

banner incoming

banner login

banner motd

banner slip-ppp

boot

boot bootldr

boot bootstrap

boot config

boot host

boot network

boot system

boot-end-marker

boot-start-marker