ROM Monitor Overview

ROM Monitor Overview

The ROM Monitor is a bootstrap program that initializes the hardware and boots the Cisco IOS XE software when you power on or reload a router. When you connect a terminal to the router that is in ROM Monitor mode, the ROM Monitor (rommon 1>) prompt is displayed.

During normal operation, users do not use ROM Monitor mode. ROM Monitor mode is used only in special circumstances, such as reinstalling the entire software set, resetting the router password, or specifying a configuration file to use at startup.

The ROM Monitor software is known by many names. It is sometimes called ROMMON because of the CLI prompt in ROM Monitor mode. The ROM Monitor software is also called the boot software , boot image , or boot helper. Although it is distributed with routers that use the Cisco IOS XE software, ROM Monitor is a separate program from the Cisco IOS XE software. During normal startup, the ROM Monitor initializes the router, and then control passes to the Cisco IOS XE software. After the Cisco IOS XE software takes over, the ROM Monitor is no longer in use.

Environmental Variables and the Configuration Register

Two primary connections exist between ROM Monitor and the Cisco IOS XE software: the ROM Monitor environment variables and the configuration register.

The ROM Monitor environment variables define the location of the Cisco IOS XE software and describe how to load it. After the ROM Monitor has initialized the router, it uses the environment variables to locate and load the Cisco IOS XE software.


Caution

Be caucious to change ROMMON variables, because it may cause unexpected consequences.

The configuration register is a software setting that controls how a router starts up. One of the primary uses of the configuration register is to control whether the router starts in ROM Monitor mode or Administration EXEC mode. The configuration register is set in either ROM Monitor mode or Administration EXEC mode as needed. Typically, you set the configuration register using the Cisco IOS XE software prompt when you need to use ROM Monitor mode. When the maintenance in ROM Monitor mode is complete, you change the configuration register so the router reboots with the Cisco IOS XE software.

Accessing ROM Monitor Mode with a Terminal Connection

When the router is in ROM Monitor mode, you can access the ROM Monitor software only from a terminal connected directly to the console port of the card. Because the Cisco IOS XE software (EXEC mode) is not operating, nonmanagement interfaces are not accessible. Basically, all Cisco IOS XE software resources are unavailable. The hardware is available, but no configuration exists to make use of the hardware.

Network Management Access and ROM Monitor Mode

It is important to remember that ROM Monitor mode is a router mode, not a mode within the Cisco IOS XE software. It is best to remember that ROM Monitor software and the Cisco IOS XE software are two separate programs that run on the same router. At any given time, the router runs only one of these programs.

One area that can be confusing when using ROM Monitor and the Cisco IOS XE software is the area that defines the IP configuration for the Management Ethernet interface. Most users are comfortable with configuring the Management Ethernet interface in the Cisco IOS XE software. When the router is in ROM Monitor mode, however, the router does not run the Cisco IOS XE software, so that Management Ethernet interface configuration is not available.

When you want to access other devices, such as a TFTP server, while in ROM Monitor mode on the router, you must configure the ROM Monitor variables with IP access information.


Note
TFTP access variables are currently not supported on the IR8340 platform.

Access ROM Monitor Mode

The following sections describe how to enter the ROMMON mode, and contains the following sections:

Checking the Current ROMMON Version

To display the version of ROMmon running on a router, use the show rom-monitor command . To show all variables that are set in ROMmon, use show romvar. 

Router#show rom-monitor r0
==========================================================

System Bootstrap, Version v0.33, DEVELOPMENT SOFTWARE
Copyright (c) 1994-2021 by cisco Systems, Inc.
Compiled Mon Jul 12 18:53:57 2021 by gilchen

Router# show romvar
ROMMON variables:
PS1 = rommon ! >
DEVICE_MANAGED_MODE = autonomous
CRYPTO_BI_THPUT = 50000
TEMPLATE = advanced
DISABLE_USB_FLASH = no
DISABLE_CC_AUTH = 1
DISABLE_SD_FLASH = no
PASSWD_RECOVERY = no
ENABLE_BREAK = no
ENABLE_FLASH_PRIMARY_BOOT = no
BAUD = 9600
LICENSE_BOOT_LEVEL =
SKIP_CHIPGUARD = 1
RET_2_RTS =
BOOT = flash:ir8340-universalk9.BLD_POLARIS_DEV_LATEST_20210322_153228.SSA.bin,12;flash:ir8340-universalk9.BLD_POLARIS_DEV_LATEST_20210323_184154.SSA.bin,12;
BSI = 0
RET_2_RCALTS =
RANDOM_NUM = 404654831

If your configuration register was set to hex value 0x0 or 0x1820, reload operation will bring you to the ROMmon mode command prompt (rommon 1>). Invoking the set command at the prompt (rommon 1> set) will display the same information as "show romvar" above in IOS/XE exec mode. 

rommon 2 >set
BOOT=flash:ir8340-universalk9.BLD_POLARIS_DEV_LATEST_20210710_191629_V17_7_0_60.SSA.bin,12;
BSI=0
CRYPTO_BI_THPUT=50000
DEVICE_MANAGED_MODE=autonomous
LICENSE_BOOT_LEVEL=
PS1=rommon ! >
RANDOM_NUM=1822515242
RET_2_RCALTS=1630484680
RET_2_RTS=
SKIP_CHIPGUARD=1
TEMPLATE=advanced
rommon 3 >

Commonly Used ROM Monitor Commands

The following table summarizes the commands commonly used in ROM Monitor. For specific instructions on using these commands, refer to the relevant procedure in this document.

Table 1. Commonly Used ROM Monitor Commands

ROMMON Command

Description

boot image

Manually boots a Cisco IOS XE software image.

boot image –o config-file-path

Manually boots the Cisco IOS XE software with a temporary alternative administration configuration file.

confreg

Changes the config-register setting.

dev

Displays the available local storage devices.

dir

Displays the files on a storage device.

reset

Resets the node.

set

Displays the currently set ROM Monitor environmental settings.

sync

Saves the new ROM Monitor environmental settings.

unset

Removes an environmental variable setting.

Examples

The following example shows what appears when you enter the ? command on a router: 

rommon 3 >?
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
alias set and/or display command aliases
boot boot up an external process
cpuinfo display processor information
confreg configuration register utility
ctchallenge Generate a challenge for dev key install
ctinstkey Parse the response and install dev key
ctiskeyinstalled checks if devkey installed and display it
ctremkey Remove the devkey from Aikido
ctrespsave Store parts of incoming response
dev display the device table
dir list files in a file system
efi_shell launch the UEFI SHELL enviroment
flwr burn new BIOS onto the bootrom
help monitor built-in command(s) help
history display monitor command history
meminfo display main memory information
repeat repeat a monitor command
reset system reset
set display the monitor environment
showmon display currently selected ROM monitor
sync write monitor environment to NVRAM
token display board's unique token identifier
unalias unset an alias
unset unset a variable from the monitor environment
rommon 4 >

Changing the ROM Monitor Prompt

You can change the prompt in ROM Monitor mode by using the PS1= command as shown in the following example: 

rommon 4 >PS1="IR8340 rommon ! >"
IR8340 rommon 5 >

Changing the prompt is useful if you are working with multiple routers in ROM Monitor at the same time. This example specifies that the prompt should be “IR8340 rommon ”, followed by the line number, and then followed by “ > “ by the line number.

Displaying the Configuration Register Setting

To display the current configuration register setting, enter the showmon command without parameters as follows: 

IR8340 rommon 8 >showmon


System Bootstrap, Version v0.33, DEVELOPMENT SOFTWARE
Copyright (c) 1994-2021 by cisco Systems, Inc.
Compiled Mon Jul 12 18:53:57 2021 by root


!!! DEBUG SECURE-BOOT CPLD Version Installed. For INTERNAL USE ONLY !!!

Current image running : Boot ROM0

Last reset cause (0x00000002): LocalSoft
IR8340-K9 platform with 8388608 Kbytes of main memory

IR8340 rommon 9 >

The configuration register setting is labeled Virtual Configuration Register . Enter the no command to avoid changing the configuration register setting.

Environment Variable Settings

The ROM Monitor environment variables define the attributes of the ROM Monitor. Environmental variables are entered like commands and are always followed by the equal sign (=). Environment variable settings are entered in capital letters, followed by a definition. For example: 


IP_ADDRESS=10.0.0.2

Under normal operating conditions, you do not need to modify these variables. They are cleared or set only when you need to make changes to the way ROM Monitor operates.

This section includes the following topics:

Frequently Used Environmental Variables

The following table shows the main ROM Monitor environmental variables. For instructions on how to use these variables, see the relevant instructions in this document. The IR8340 boot loader does not support netboot, so any setting like environment variables IP_ADDRESS, IP_SUBNET_MASK, DEFAULT_GATEWAY, TFTP_SERVER, TFTP_FILE are not used.

Table 2. Frequently Used ROM Monitor Environmental Variables

Environmental variable

Description

BOOT= path/file

Identifies the boot software for a node. This variable is usually set automatically when the router boots.

Displaying Environment Variable Settings

To display the current environment variable settings, enter the set command : 

IR8340 rommon 8 >showmon


System Bootstrap, Version v0.33, DEVELOPMENT SOFTWARE
Copyright (c) 1994-2021 by cisco Systems, Inc.
Compiled Mon Jul 12 18:53:57 2021 by root


!!! DEBUG SECURE-BOOT CPLD Version Installed. For INTERNAL USE ONLY !!!

Current image running : Boot ROM0

Last reset cause (0x00000002): LocalSoft
IR8340-K9 platform with 8388608 Kbytes of main memory

IR8340 rommon 9 >

Entering Environment Variable Settings

Environment variable settings are entered in capital letters, followed by a definition. The following example shows the environmental variables that can be configured in ROMmon mode.: 


rommon 1 > confreg 0x0
rommon 1> BOOT_WDOG = DISABLE
rommon 1> BOOT = IR8340-K9_image_name

Saving Environment Variable Settings

To save the current environment variable settings, enter the sync command: 


rommon > sync

Note
Environmental values that are not saved with the sync command are discarded whenever the system is reset or booted.

Exiting ROM Monitor Mode

To exit ROM Monitor mode, you must change the configuration register and reset the router.

Procedure

  Command or Action Purpose

Step 1

confreg

Example:


rommon 1> confreg

Initiates the configuration register configuration prompts.

Step 2

Respond to each prompt as instructed.

See the example that follows this procedure for more information.

Step 3

reset

Example:


rommon 2> reset

Resets and initializes the router.

Configuration Example


rommon 3 > confreg
           Configuration Summary
   (Virtual Configuration Register: 0x0)
enabled are:
 [ 0 ] break/abort has effect
 [ 1 ] console baud: 9600
 boot: ...... the ROM Monitor
do you wish to change the configuration? y/n  [n]:  y
 enable  "diagnostic mode"? y/n  [n]:  
 enable  "use net in IP bcast address"? y/n  [n]:  
 enable  "load rom after netboot fails"? y/n  [n]:  
 enable  "use all zero broadcast"? y/n  [n]:  
 disable "break/abort has effect"? y/n  [n]:  
 enable  "ignore system config info"? y/n  [n]:  
 change console baud rate? y/n  [n]:  
change the boot characteristics? y/n  [n]:  
           Configuration Summary
   (Virtual Configuration Register: 0x0)
enabled are:
 [ 0 ] break/abort has effect
 [ 1 ] console baud: 9600
 boot: ...... the ROM Monitor
do you wish to change the configuration? y/n  [n]:

Upgrading the ROMmon for a Router

ROMmon upgrade on the IR8340-K9 router is automatically done when the image is booted. The latest version of the ROMmon is bundled with the IOSXE image. An algorithm detects if the current running version is older than the bundled version, if so, it is automatically upgraded. If the current running version is equal to the bundled version no upgrade is executed. For every successful upgrade, the router is automatically rebooted in order for the new version to get loaded and executed.:

Procedure

Step 1

(Optional) Run the show rom-monitor slot command on the router to see the current release numbers of ROMmon on the hardware. See the Checking the Current ROMMON Version for information about interpreting the output of the command that you run.

Step 2

If autoboot has not been enabled by using the config-register 0x2102 command, run the boot filesystem:/file-location command at the ROMmon prompt to boot the Cisco IOS XE image, where filesystem:/file-location is the path to the consolidated package file. The ROMmon upgrade is not permanent for any piece of hardware until the Cisco IOS XE image is booted.

Step 3

Run the enable command at the user prompt to enter the privileged EXEC mode after the boot is complete.

Step 4

Run the show rom-monitor slot command to verify whether the ROMmon has been upgraded.