-
Router Products Command Reference
-
About This Manual
-
Router Product Overview
-
User Interface Commands
-
System Image, Microcode Image, and Configuration File Load Comm
-
Terminal Line and Modem Support Commands
-
System Management Commands
-
Interface Commands
-
ATM Commands
-
DDR Commands
-
Frame Relay Commands
-
ISDN Commands
-
LAN Emulation Commands
-
SMDS Commands
-
X.25 Commands
-
Apollo Domain Commands
-
AppleTalk Commands
-
Banyan VINES Commands
-
DECnet Commands
-
IP Commands
-
IP Routing Protocols Commands
-
ISO CLNS Commands
-
Novell IPX Commands
-
XNS Commands
-
Source-Route Bridging Commands
-
Remote Source-Route Bridging Commands
-
DLSw+ Configuration Commands
-
STUN and BSTUN Configuration Commands
-
LLC2 and SDLC Configuration Commands
-
IBM Network Media Translation Commands
-
DSPU and SNA Service Point Configuration Commands
-
SNA Frame Relay Access Support Commands
-
APPN Configuration Commands
-
IBM Channel Attach Configuration Commands
-
References and Recommended Reading
-
Ethernet Type Codes
-
Regular Expressions
-
ASCII character Set
-
Platform Support
-
Switching Appendix
-
Table Of Contents
System Image, Microcode Image, and Configuration File Load Commands
System Image, Microcode Image, and Configuration File Load Commands
This chapter provides detailed descriptions of the commands used to load and copy system images, microcode images, and configuration files. System images contain the system software. Microcode images contain microcode to be downloaded to various hardware devices. Configuration files contain commands entered to customize the function of the router.
Note
Commands in this chapter that have been replaced by new commands continue to perform their normal functions in the current release, but are no longer documented. Support for these commands will cease in a future release. maps the old commands with their replacements.
Table 3-1 Mapping Old Commands to New Commands
For router configuration information and examples, refer to the "Loading System Images, Microcode Images, and Configuration Files" chapter in the Router Products Configuration Guide.
async-bootp
To configure extended BOOTP requests for asynchronous interfaces as defined in RFC 1084, use the async-bootp global configuration command. Use the no form of this command to restore the default.
async-bootp tag [:hostname] data
no async-bootpSyntax Description
Table 3-2 Async-BOOTP Tag Keywords
Default
If no extended BOOTP commands are entered, the router software generates a gateway and subnet mask appropriate for the local network.
Command Mode
Global configuration
Usage Guidelines
Use the EXEC command show async-bootp to list the configured parameters. Use the no
async-bootp command to clear the list.Examples
The following example illustrates how to specify different boot files: one for a PC, and one for a Macintosh. With this configuration, a BOOTP request from the host on 128.128.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 :128.128.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.0The following example specifies a negative time offset of the local subnetwork of -3600 seconds:
async-bootp time-offset -3600The following example specifies the IP address of a time server:
async-bootp time-server 128.128.1.1Related Command
boot
To boot the router manually from the rom prompt, use the boot ROM monitor command.
This manual reload is only used for troubleshooting purposes, and the options directly depend upon hardware possibilities.
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 rommon monitor prompt, issuing a prior reset command is necessary for the boot to be always successful.
boot
boot filename [ip-address]
boot flash [filename]
boot flash [partition-number:] [filename]
boot [flash] [device:filename] (Cisco 7000/7010 with 11.x roms only )
boot device:[filename] (Cisco 4500, 7000, and 7500 series)Syntax Description
Default
If you enter the boot command and press Return, the router boots from ROM by default.
If you enter the boot flash command without a filename, the first valid file in Flash memory is loaded.
For other defaults, see the Syntax Description section.
Command Mode
ROM monitor
Usage Guidelines
Use this command only when your router cannot find the configuration information needed in nonvolatile random-access memory (NVRAM). To get to the ROM monitor prompt (>), enter the reload EXEC command, and then press the Break key during the first 60 seconds of startup, or change the boot bits in the configuration register to zero, for manual booting, and then issue the reload command.
Refer to the Cisco 7000 Hardware Installation and Maintenance publication for the correct jumper settings for the Cisco 7000 series.
Examples
In the following example, the router is manually booted from ROM:
> bootF3:(ROM Monitor copyrights)In the following example, a router boots the file routertest from a network server with the IP address 131.108.15.112:
> boot routertest 131.108.15.112F3:(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 flashF3: 1858656+45204+166896 at 0x1000Booting gs7-k from flash memory RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR [OK - 1903912/13765276 bytes]F3: 1858676+45204+166896 at 0x1000(ROM Monitor copyrights)In the following example, the boot flash command is used with the filename gs7-k. That is the file that will be loaded.
> boot flash gs7-kF3: 1858656+45204+166896 at 0x1000Booting gs7-k from flash memory RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR [OK - 1903912/13765276 bytes]F3: 1858676+45204+166896 at 0x1000(ROM Monitor copyrights)In the following example, the boot flash flash command boots the relocatable image file igs-bpx-l from partition 2 in Flash memory:
> boot flash flash:2:igs-bpx-lF3: 3562264+98228+303632 at 0x30000B4(ROM Monitor copyrights)Use the following example if the rxboot image has been inadvertently erased. (The IOS is directly launched from the ROM monitor without the intermediate xboot stage. This startup requires less system memory.)
> boot flash:c4500-j-mz.103-7In the following example, the 7000 with 11.0 roms accepts the flash keyword for compatibility but ignores it, and boots from slot0:
> boot flash slot0:gs7-k-mz.103-9F3: 8468+3980384+165008 at 0x1000In the following example, the new rommon requires new syntax.
rommon 8 > b flash flash:c4500-j-mz.103-12boot of "flash flash:c4500-j-mz.103-12" using boot helper "bootflash:c4500-xboot.101-1" failedIn the following example, the command did not function because it must be entered in lowercase.
rommon 10 > BOOTcommand "BOOT" not foundRelated Command
boot bootldr
To specify a Flash device and filename containing the rxboot image that ROM uses for booting, use the boot bootldr global configuration command. Use the no form of the command to remove this rxboot image specification.
boot bootldr device: filename
no boot bootldrSyntax Description
Default
There is no default Flash device or filename.
Command Mode
Global configuration
Usage Guidelines
Use this command only with the Cisco 7000 series or Cisco 7500 series. The boot bootldr command sets the BOOTLDR environment variable in the current running configuration. You must specify both the device and the filename.
Note
The no form of the command sets the BOOTLDR environment variable to a null string. On the Cisco 7500 series, a null string causes the first image file in bootflash to be used as the rxboot image that ROM uses for booting.
Examples
In the following example, the internal Flash memory on a Cisco 7000 series contains the rxboot image:
boot bootldr flash:boot-imageThe following example specifies that the Flash memory card inserted in slot 0 of the RP or RSP card contains the rxboot image:
boot bootldr slot0:boot-imageRelated Commands
copy running-config startup-config
show boot
show flashboot bootstrap
To configure the filename that is used to boot a secondary bootstrap image, use the boot bootstrap global configuration command. Use the no form of this command to disable booting from a secondary bootstrap image.
boot bootstrap flash [filename]
no boot bootstrap flash [filename]
boot bootstrap mop filename [mac-address] [interface]
no boot bootstrap mop filename [mac-address] [interface]
boot bootstrap [tftp] filename [ip-address]
no boot bootstrap [tftp] filename [ip-address]Syntax Description
Default
No secondary bootstrap
Command Mode
Global configuration
Usage Guidelines
The boot bootstrap command, in conjunction with setting bit 9 on the configuration register of an AGS, CGS, or MGS router, causes the router to load a secondary bootstrap image over the network. The secondary bootstrap image then loads the specified system image file. The name of the secondary bootstrap file is boot-csc3 or boot-csc4, depending on the router model. See the appropriate hardware installation guide for details on 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 allows you to load a larger system image through a smaller secondary image.
Example
In the following example, the system image file sysimage-2 will be loaded by using a secondary bootstrap image:
boot bootstrap sysimage-2boot buffersize
To modify the buffer size used to load configuration files, use the boot buffersize global configuration command. Use the no form of this command to return to the default setting.
boot buffersize bytes
no boot buffersizeSyntax Description
bytes
Specifies the size of the buffer to be used. There is no minimum or maximum size that can be specified.
Default
Buffer size of the NVRAM
Command Mode
Global configuration
Usage Guidelines
Normally, the router uses a buffer the size of the system NVRAM to hold configuration commands read from the network. You can increase this size if you have a very complex configuration.
Example
The following example sets the buffer size to 64000:
configure terminalboot buffersize 64000boot config
To specify the device and filename of the configuration file from which the router configures itself during initialization (startup), use the boot config global configuration command. Use the no form of the command to remove this specification.
boot config device:filename
no boot config
Syntax Description
Default
NVRAM (nvram:)
Command Mode
Global configuration
Usage Guidelines
Use this command only with the Cisco 7000 series or Cisco 7500 series. 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).
Note
If you specify nvram: as the device, and it contains only a distilled version of the configuration, the router displays an error message and does not update the CONFIG_FILE environment variable. (A distilled configuration is one that does not contain access lists.) If you specify a configuration file in the filename argument that does not exist or is not valid, the router displays an error message and does not update the CONFIG_FILE environment variable.
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 router detects a problem with NVRAM or the configuration it contains, the router enters setup mode. Refer to the Router Products Getting Started Guide for more information on the setup command facility.
When you use the no form of this command, the router returns to using the NVRAM configuration as the startup configuration.
Examples
In the following example, the first line specifies that a Cisco 7000 series router should use the configuration file router-config located in internal Flash memory to configure itself during initialization. The second 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^ZRouter# copy running-config startup-configThe following example instructs a Cisco 7500 series router to use the configuration file router-config located on the Flash memory card inserted in the second PCMCIA slot of the RSP card during initialization. The second 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^ZRouter# copy running-config startup-configRelated Commands
copy running-config startup-config
show boot
show flashboot host
To change the default name of the host configuration filename from which you want to load configuration commands, use the boot host global configuration command. Use the no form of this command to restore the host configuration filename to the default.
boot host mop filename [mac-address] [interface]
no boot host mop filename [mac-address] [interface]
boot host [tftp | rcp] filename [ip-address]
no boot host [tftp | rcp] filename [ip-address]Syntax Description
Default
The router uses its host name to form a host configuration filename. To form this name, the router converts its name to all lowercase letters, removes all domain information, and appends -confg.
Command Mode
Global configuration
Usage Guidelines
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 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.
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. The second is the host configuration file containing commands that apply to one network server in particular.
Example
The following example sets the host filename to wilma-confg at address 192.31.7.19:
boot host /usr/local/tftpdir/wilma-confg 192.31.7.19Related Commands
boot network
To change the default name of the network configuration file from which you want to load configuration commands, use the boot network global configuration command. Use the no form of this command to restore the network configuration filename to the default.
boot network mop filename [mac-address] [interface]
no boot network mop filename [mac-address] [interface]
boot network [tftp | rcp] filename [ip-address]
no boot network [tftp | rcp] filename [ip-address]Syntax Description
Default
The default filename is network-config. The default transfer protocol type is TFTP, if neither tftp nor rcp is specified.
Command Mode
Global configuration
Usage Guidelines
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 rcp or TFTP requests correctly. 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 information in NVRAM. If the configuration information in NVRAM is invalid or missing, the service config command is enabled automatically.
The network server will attempt to load two configuration files from remote hosts. The first is the network configuration file containing commands that apply to all network servers on a network. Use the boot network command to identify the network configuration file.
The rcp software requires that a client send the remote username on each rcp request to the network server. When the boot network rcp command is executed, the router software sends the router host name as the both the remote and local usernames. The rcp implementation searches for the configuration files to be used relative to the account directory of the remote username on the network server, if the server has a directory structure, for example, as do UNIX systems.
Note
If you copy the system image to a personal computer used as a file server, the remote host computer must support the remote shell (rsh) protocol.
Examples
The following example changes the network configuration filename to bridge_9.1 and uses the default broadcast address:
boot network bridge_9.1service configThe following example changes the network configuration filename to bridge_9.1, specifies that rcp is to be used as the transport mechanism, and gives 131.108.1.111 as the IP address of the server on which the network configuration file resides:
boot network rcp bridge_9.1 131.108.1.111service configRelated Commands
boot system
To specify the system image that the router loads at startup, use one of the following boot system global configuration commands. Use a no form of this command to remove the startup system image specification.
boot system flash [device:][partition-number:][filename]
no boot system flash [device:][partition-number:][filename]
boot system mop filename [mac-address] [interface]
no boot system mop filename [mac-address] [interface]
boot system rom
no boot system rom
boot system [rcp | tftp] filename [ip-address]
no boot system [rcp | tftp] filename [ip-address]
no boot systemSyntax Description
Default
If you 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 for booting from a network server. 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). See the appropriate hardware installation guide for details on the configuration register and default filename. See also the command config-register. See also the "Syntax Description" section preceding this section.
On the Cisco 7000 series and Cisco 7500 series, if you omit a keyword (flash, mop, rom, rcp, or tftp) from the boot system command, the system defaults to booting from a system image stored on a TFTP server.
Command Mode
Global configuration
Usage Guidelines
For this command to work, the config-register command must be set properly.
Enter 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—then the router tries them in the order in which they appear in the configuration file. Use the boot system rom command to specify use of the ROM system image as a backup to other boot commands in the configuration.
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
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 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.)
The rcp protocol requires that a client send the remote username in an rcp request to a server. When the router executes the boot system rcp command, by default the router software sends the router host name as the both the remote and local usernames. The rcp software searches for the system image to boot from the remote server relative to the directory of the remote username (if the server has a directory structure as UNIX systems do, for example).
To force the router to stop booting, press the Break key during the first 60 seconds of startup. The router will enter ROM Monitor mode, where you can change the configuration register or boot the router manually.
For the Cisco 7000 series and the Cisco 7500 series, the boot system command modifies the BOOT environment variable in the running configuration. The BOOT environment variable specifies a list of bootable images on various devices.
For routers with the RP card (Cisco 7000 series), valid devices are flash and slot0. On the Cisco 7000 series, the following forms of the boot system command specify a list of bootable images in the BOOT environment variable:
•
no boot system flash flash:[filename]•
no boot system flash slot0:[filename]•
no boot system mop filename [mac-address] [interface]•
no boot system rom•
no boot system tftp filename [ip-address]•
no boot system rcp filename [ip-address]You can omit the device flash: from the boot system flash flash:[filename] command because the default device on a Cisco 7000 series is flash. Therefore, boot system flash [filename] is the same as boot system flash flash:[filename].
For routers with the RSP card (Cisco 7500 series), valid devices are bootflash, slot0, slot1, and tftp. On the Cisco 7500 series, the following forms of the boot system command specify a list of bootable images in the BOOT environment variable:
•
no boot system flash bootflash:[filename]•
no boot system flash slot0:[filename]•
no boot system flash slot1:[filename]•
no boot system tftp filename [ip-address]
Note
If an entry in the BOOT environment variable list does not specify a device, the router assumes the device is tftp. When tftp is the device, the router first loads the rxboot image to boot the system image file from a network server. If an entry in the BOOT environment variable list specifies an invalid device, the router skips that entry. To view the contents of the BOOT environment variable, use the show boot command.
To remove a single entry from the bootable image list, use the no form of a specific command. For example, to remove the entry that specifies a bootable image on a Flash memory card inserted in the second slot of the RSP card, 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. Issuing this command sets the BOOT environment variable to a null string, wiping out all entries. 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 running-config startup-config command.
Note
Examples
The following example illustrates a list specifying two possible internetwork locations for a system image, with the ROM software being used as a backup:
boot system cs3-rx.90-1 192.31.7.24 boot system cs3-rx.83-2 192.31.7.19 boot system romThe following example boots the system boot relocatable image file igs-bpx-l from partition 2 of the Flash device:
boot system flash flash:2:igs-bpx-lThe following example instructs the router to boot from and image located on the Flash memory card inserted in slot 0 of the Cisco 7000 RP card or the Cisco 7500 series RSP card:
boot system flash slot0:new-configRelated Commands
config-register
copy flash rcp
copy flash tftp
copy rcp flash
copy running-config startup-config
copy tftp flash
ip rcmd remote-username
show bootcd
To set the default Flash device for the system, use the cd EXEC command.
cd [device:]
Syntax Description
Default
For the Cisco 7000 series, flash is the initial default device and the default device when you omit the device: argument.
For the Cisco 7500 series, slot0 is the initial default device and the default device when you omit the device: argument.
Command Mode
EXEC
Usage Guidelines
Use this command only with the Cisco 7000 series or the Cisco 7500 series. For all EXEC commands that have an optional device: argument, the system uses the device specified by the cd command when you omit the optional device: argument. For example, the dir command contains an optional device: argument and displays a list of files on a Flash memory device. When you omit this device: argument, the system shows a list of the files on the Flash device specified by the cd command.
Example
The following example sets the default device to the Flash memory card inserted in the slot 0 of the RP or RSP card:
cd slot0:Related Commands
copy
delete
dir
pwd
show flash
undeleteconfig-register
To change the router configuration register settings, use the config-register global configuration command.
config-register value
Syntax Description
Default
For the router models without Flash memory, the default is 0x101, which causes the router to boot from ROM and the Break key to be ignored. For router models with Flash memory, the default is 0x10F, which causes the router to boot from Flash memory and the Break key to be ignored.
Command Mode
Global configuration
Usage Guidelines
This command applies only to the Cisco 2000, Cisco 3000, Cisco 4000 series, or to the Cisco 7000 series. All other models use a hardware configuration register.
The lowest four bits of the configuration register (bits 3, 2, 1, and 0) form the boot field. The boot field determines if the router boots manually, from ROM, or from Flash or the network. Bit 8 controls the console Break key; when set to 1, it causes the Break key to be ignored. The remaining bits control other features of the router and are typically set to 0.
To change the boot field value and leave all other bits set to their default values, follow these guidelines:
•
•
•
For more information about the configuration register bit settings and default filenames, see the appropriate router hardware installation guide.
Example
In the following example, the configuration register is set to boot the system image from Flash memory:
config-register 0x010FRelated Commands
configure
To enter global configuration mode, use the configure privileged EXEC command. You must be in global configuration mode to enter global configuration commands.
configure {terminal | memory | network}
Syntax Description
terminal
Executes configuration commands from the terminal.
memory
For all platforms except the Cisco 7000 series and the Cisco 7500 series, executes the commands stored in NVRAM.
For the Cisco 7000 series and the Cisco 7500 series, executes the configuration specified by the CONFIG_FILE environment variable.
network
The copy rcp running-config or copy tftp running-config command replaces the configure network command. If you use rcp, see the copy rcp command for more information on copy rcp running-config. If you use TFTP, see the copy tftp command for more information on copy tftp running-config.
Default
For all platforms except the Cisco 7000 series and the Cisco 7500 series, there is no default.
For the Cisco 7000 series and the Cisco 7500 series, the router uses the NVRAM configuration (if valid) when the CONFIG_FILE environment variable does not exist or is null (such as at first-time startup).
Command Mode
Privileged EXEC
Usage Guidelines
If you do not specify terminal or memory, the router prompts you for the source of configuration commands. If you specify terminal, the router executes the commands you enter at the system prompts.
On all platforms except the Cisco 7000 series and the Cisco 7500 series, if you specify memory, the router executes the commands located in NVRAM. On the Cisco 7000 series and the Cisco 7500 series, if you specify memory, the router executes the commands pointed to by the CONFIG_FILE environment variable. The CONFIG_FILE environment variable specifies the device and filename of the configuration file that the router uses to configure itself during initialization. Possible devices are as follows:
•
•
•
•
•
