Cisco ME 3800X, ME 3600X ME 3600X-24CX Switch Command Reference, Release 15.3(3)S

Cisco ME 3800X, ME 3600X, and ME 3600X-24CX Switch
Boot Loader Commands

This appendix describes the boot loader commands on the Cisco ME 3800X and ME 3600X switch. During normal boot loader operation, you are not presented with the boot loader command-line prompt. You gain access to the boot loader command line if the switch is set to manually boot, if an error occurs during power-on self-test (POST) DRAM testing, or if an error occurs while loading the operating system (a corrupted Cisco IOS image). You can also access the boot loader if you have lost or forgotten the switch password.

Note The default switch configuration allows an end user with physical access to the switch to recover from a lost password by interrupting the boot process while the switch is powering up and then entering a new password. The password recovery disable feature allows the system administrator to protect access to the switch password by disabling part of this functionality and allowing the user to interrupt the boot process only by agreeing to set the system back to the default configuration. With password recovery disabled, the user can still interrupt the boot process and change the password, but the configuration file (config.text) and the VLAN database file (vlan.dat) are deleted. For more information, see the software configuration guide for this release.

You can access the boot loader through a switch console connection at 9600 bps. Disconnect and then reconnect the switch power cord. After the switch performs POST, the switch begins the autoboot process. The boot loader prompts the user for a break key character during the boot-up sequence, as shown in this example:

***** The system will autoboot in 5 seconds ***** 

Send "break character" to prevent autobooting. 

The break key character is different for each operating system.

•On a SUN work station running UNIX, Ctrl-C is the break key.

•On a PC running Windows 2000, Ctrl-Break is the break key.

Cisco TAC has tabulated break keys for most common operating systems and has provided an alternative break key sequence for terminal emulators that do not support the break keys. To view this table, see:

http://www.cisco.com/en/US/products/hw/routers/ps133/products_tech_note09186a0080174a34.shtml

When you enter the break key, the boot loader switch: prompt appears.

The boot loader performs low-level CPU initialization, performs POST, and loads a default operating system image into memory.

arp

To display the contents the Address Resolution Protocol (ARP) table, use the arp command in boot loader mode.

arp [ip_address]

Syntax Description

Command Modes

Boot loader

Command History

Usage Guidelines

The ARP table has the IP-address-to-MAC-address mappings.

Examples

This example shows how to display the ARP table:

Switch: arp 172.20.136.8

arp'ing 172.20.136.8...

172.20.136.8 is at 00:1b:78:d1:25:ae, via port 0

boot

To load and boot an executable image and to enter the command-line interface, use the boot command in boot loader mode.

boot [-post | -n | -p | flag] filesystem:/file-url ...

Syntax Description

Defaults

The switch attempts to automatically boot the system by using information in the BOOT environment variable. If this variable is not set, the switch attempts to load and execute the first executable image it can by performing a recursive, depth-first search throughout the flash file system. In a depth-first search of a directory, each encountered subdirectory is completely searched before continuing the search in the original directory.

Command Modes

Boot loader

Command History

Usage Guidelines

When you enter the boot command without any arguments, the switch attempts to automatically boot the system by using the information in the BOOT environment variable, if any. If you supply an image name for the file-url variable, the boot command attempts to boot the specified image.

When you set boot loader boot command options, they are executed immediately and apply only to the current boot loader session. These settings are not saved for the next boot operation.

Filenames and directory names are case sensitive.

Examples

This example shows how to boot the switch using the new-image.bin image:

Switch: boot flash:/new-images/new-image.bin

After entering this command, you are prompted to start the setup program.

Related Commands

cat

To display the contents of one or more files, use the cat command in boot loader mode.

cat filesystem:/file-url ...

Syntax Description

Command Modes

Boot loader

Command History

Usage Guidelines

Filenames and directory names are case sensitive.

If you specify a list of files, the contents of each file appears sequentially.

Examples

This example shows how to display the contents of two files:

Switch: cat flash:/new-images/info flash:env_vars

version_suffix: image-name

version_directory: image-name

image_name: image-name.bin

ios_image_file_size: 63984644 

total_image_file_size: 8133632 

image_feature: IP|LAYER_3|PLUS|MIN_DRAM_MEG=128

image_family: me340x

info_end:

BAUD=57600

MANUAL_BOOT=no

Related Commands

copy

To copy a file from a source to a destination, use the copy command in boot loader mode.

copy [-b block-size] filesystem:/source-file-url filesystem:/destination-file-url

Syntax Description

Defaults

The default block size is 4 KB.

Command Modes

Boot loader

Command History

Usage Guidelines

Filenames and directory names are case sensitive.

Directory names are limited to 45 characters between the slashes (/); the name cannot contain control characters, spaces, deletes, slashes, quotes, semicolons, or colons.

Filenames are limited to 45 characters; the name cannot contain control characters, spaces, deletes, slashes, quotes, semicolons, or colons.

If you are copying a file to a new directory, the directory must already exist.

Examples

This example show how to copy a file at the root:

Switch: copy flash:test1.text flash:test4.text

.

File "flash:test1.text" successfully copied to "flash:test4.text"

You can verify that the file was copied by entering the dir filesystem: boot loader command.

Related Commands

delete

To delete one or more files from the specified file system, use the delete command in boot loader mode.

delete filesystem:/file-url ...

Syntax Description

Command Modes

Boot loader

Command History

Usage Guidelines

Filenames and directory names are case sensitive.

The switch prompts you for confirmation before deleting each file.

Examples

This example shows how to delete two files:

Switch: delete flash:test2.text flash:test5.text

Are you sure you want to delete "flash:test2.text" (y/n)?y

File "flash:test2.text" deleted

Are you sure you want to delete "flash:test5.text" (y/n)?y

File "flash:test2.text" deleted 

You can verify that the files were deleted by entering the dir flash: boot loader command.

Related Commands

dir

To display a list of files and directories on the specified file system, use the dir command in boot loader mode.

dir filesystem:/file-url ...

Syntax Description

Command Modes

Boot loader

Command History

Usage Guidelines

Directory names are case sensitive.

Examples

This example shows how to display the files in flash memory:

Switch: dir flash:

Directory of flash:/

    3  -rwx        1839   Mar 01 2002 00:48:15  config.text

   11  -rwx        1140   Mar 01 2002 04:18:48  vlan.dat

   21  -rwx          26   Mar 01 2002 00:01:39  env_vars

    9  drwx         768   Mar 01 2002 23:11:42  html

   16  -rwx        1037   Mar 01 2002 00:01:11  config.text

   14  -rwx        1099   Mar 01 2002 01:14:05  homepage.htm 

   22  -rwx          96   Mar 01 2002 00:01:39  system_env_vars

   17  drwx        192    Mar 06 2002 23:22:03  image-name

15998976 bytes total (6397440 bytes free) 

Table A-1 describes the fields in the display.

Related Commands

flash_init

To initialize the flash file system, use the flash_init command in boot loader mode.

flash_init

Syntax Description

This command has no arguments or keywords.

Defaults

The flash file system is automatically initialized during normal system operation.

Command Modes

Boot loader

Command History

Usage Guidelines

During the normal boot process, the flash file system is automatically initialized.

Use this command to manually initialize the flash file system. For example, you use this command during the recovery procedure for a lost or forgotten password.

format

To format the specified file system and destroy all data in that file system, use the format command in boot loader mode.

format filesystem:

Syntax Description

Command Modes

Boot loader

Command History

Usage Guidelines

Caution Use this command with care; it destroys all data on the file system and renders your system unusable.

fsck

To check the file system for consistency, use the fsck command in boot loader mode.

fsck [-test | -f] filesystem:

Syntax Description

Defaults

No file system check is performed.

Command Modes

Boot loader

Command History

Usage Guidelines

To stop an in-progress file system consistency check, disconnect the switch power and then reconnect the power.

Examples

This example shows how to perform an extensive file system check on flash memory:

Switch: fsck -test flash:

help

To display the available commands, use the help command in boot loader mode.

help

Syntax Description

This command has no arguments or keywords.

Command Modes

Boot loader

Command History

Usage Guidelines

You can also use the question mark (?) to display a list of available boot loader commands.

memory

To display memory heap utilization information, use the memory command in boot loader mode.

memory

Syntax Description

This command has no arguments or keywords.

Command Modes

Boot loader

Command History

Examples

This example shows how to display memory heap utilization information:

Switch: memory

Text:   0x00700000 - 0x0071cf24 (0x0001cf24 bytes)

Rotext: 0x00000000 - 0x00000000 (0x00000000 bytes)

Data:   0x0071cf24 - 0x00723a0c (0x00006ae8 bytes)

Bss:    0x0072529c - 0x00746f94 (0x00021cf8 bytes)

Heap:   0x00756f98 - 0x00800000 (0x000a9068 bytes)

Bottom heap utilization is 22 percent.

Top heap utilization is 0 percent.

Total heap utilization is 22 percent.

Total bytes: 0xa9068 (692328)

Bytes used: 0x26888 (157832)

Bytes available: 0x827e0 (534496)

Alternate heap utilization is 0 percent.

Total alternate heap bytes: 0x6fd000 (7327744)

Alternate heap bytes used: 0x0 (0)

Alternate heap bytes available: 0x6fd000 (7327744)

Table A-2 describes the fields in the display.

mgmt_clr

To clear the Ethernet management port statistics, use the mgmt_clr command in boot loader mode.

mgmt_clr

Syntax Description

This command has no arguments or keywords.

Command Modes

Boot loader

Command History

Examples

This example shows how to clear the Ethernet management port statistics:

Switch: mgmt_clr

mgmt_init

To initialize the Ethernet management port, use the mgmt_init command in boot loader mode.

mgmt_init

Syntax Description

This command has no arguments or keywords.

Command Modes

Boot loader

Command History

Usage Guidelines

Use the mgmt_init command only during debugging of the Ethernet management port.

Examples

This example shows how to initialize the Ethernet management port:

Switch: mgmt_init

mgmt_show

To display the Ethernet management port statistics, use the mgmt_show command in boot loader mode.

mgmt_show

Syntax Description

This command has no arguments or keywords.

Command Modes

Boot loader

Command History

Examples

This example shows how to display the Ethernet management port statistics:

Switch: mgmt_show

Statistics                Received    Transmitted

---------------------------------------------------

good frame bytes      :         60            120

good frames           :          1              2

bad frames            :          0              0

dropped frames        :          0              0

queue overflowed      :          0              0

memory access errors  :          0              0

mkdir

To create one or more new directories on the specified file system, use the mkdir command in boot loader mode.

mkdir filesystem:/directory-url ...

Syntax Description

Command Modes

Boot loader

Command History

Usage Guidelines

Directory names are case sensitive.

Directory names are limited to 45 characters between the slashes (/); the name cannot contain control characters, spaces, deletes, slashes, quotes, semicolons, or colons.

Examples

This example shows how to make a directory called Saved_Configs:

Switch: mkdir flash:Saved_Configs

Directory "flash:Saved_Configs" created

This example shows how to make two directories:

Switch: mkdir flash:Saved_Configs1 flash:Test

Directory "flash:Saved_Configs1" created

Directory "flash:Test" created

You can verify that the directory was created by entering the dir filesystem: boot loader command.

Related Commands

more

To display the contents of one or more files, use the more command in boot loader mode.

more filesystem:/file-url ...

Syntax Description

Command Modes

Boot loader

Command History

Usage Guidelines

Filenames and directory names are case sensitive.

If you specify a list of files, the contents of each file appears sequentially.

Examples

This example shows how to display the contents of two files:

Switch: more flash:/new-images/info flash:env_vars

version_suffix: image-name

version_directory: image-name 

image_name: image-name.bin 

ios_image_file_size: 63984644 

total_image_file_size: 8133632 

image_feature: IP|LAYER_3|PLUS|MIN_DRAM_MEG=128

image_family: family 

info_end:

BAUD=57600

MANUAL_BOOT=no

Related Commands

peek

To read data from a memory location, use the peek command in boot loader mode.

peek location

Syntax Description

Command Modes

Boot loader

Command History

Examples

This example shows how to read data from a memory location:

Switch: peek 0xfff80000

ox4BE000=102

ping

To send ICMP ECHO REQUEST packets to a network host, use the ping command in boot loader mode.

ping ip-address

Syntax Description

Command Modes

Boot loader

Command History

Examples

This example shows how to send an echo request packet to a network host:

Switch: ping 1.1.1.1 255.255.255.0

poke

To write data to one writable memory location, use the poke command in boot loader mode.

poke location

Syntax Description

Command Modes

Boot loader

Command History

Examples

This example shows how to write data to a writeable memory location:

Switch: poke 0xfff80000

ox4BE000=102

rename

To rename a file, use the rename command in boot loader mode.

rename filesystem:/source-file-url filesystem:/destination-file-url

Syntax Description

Command Modes

Boot loader

Command History

Usage Guidelines

Filenames and directory names are case sensitive.

Directory names are limited to 45 characters between the slashes (/); the name cannot contain control characters, spaces, deletes, slashes, quotes, semicolons, or colons.

Filenames are limited to 45 characters; the name cannot contain control characters, spaces, deletes, slashes, quotes, semicolons, or colons.

Examples

This example shows a file named config.text being renamed to config1.text:

Switch: rename flash:config.text flash:config1.text

You can verify that the file was renamed by entering the dir filesystem: boot loader command.

Related Commands

reset

To perform a hard reset on the system, use the reset command in boot loader mode. A hard reset is similar to power-cycling the switch, clearing the processor, registers, and memory.

reset

Syntax Description

This command has no arguments or keywords.

Command Modes

Boot loader

Command History

Examples

This example shows how to reset the system:

Switch: reset

Are you sure you want to reset the system (y/n)?y

System resetting...

Related Commands

rmdir

To remove one or more empty directories from the specified file system, use the rmdir command in boot loader mode.

rmdir filesystem:/directory-url ...

Syntax Description

Command Modes

Boot loader

Command History

Usage Guidelines

Directory names are case sensitive and limited to 45 characters between the slashes (/); the name cannot contain control characters, spaces, deletes, slashes, quotes, semicolons, or colons.

Before removing a directory, you must first delete all the files in the directory.

The switch prompts you for confirmation before deleting each directory.

Examples

This example shows how to remove a directory:

Switch: rmdir flash:Test

You can verify that the directory was deleted by entering the dir filesystem: boot loader command.

Related Commands

set

To set or display environmental variables that can be used to control the boot loader or any other software running on the switch, use the set command in boot loader mode.

set variable value

Note Under normal circumstances, it is not necessary to alter the setting of the environment variables.

Syntax Description

Defaults

The environment variables have these default values:

MANUAL_BOOT: No (0)

BOOT: Null string

ENABLE_BREAK: No (Off or 0) (the automatic boot process cannot be interrupted by pressing the Break key on the console).

HELPER: No default value (helper files are not automatically loaded).

PS1: switch:

CONFIG_FILE: config.text

BAUD: 9600 bps

HELPER_CONFIG_FILE: No default value (no helper configuration file is specified).

SWITCH_NUMBER: 1

SWITCH_PRIORITY: 1

Note Environment variables that have values are stored in the flash file system in various files. The format of these files is that each line contains an environment variable name and an equal sign followed by the value of the variable. A variable has no value if it is not listed in this file; it has a value if it is listed in the file even if the value is a null string. A variable that is set to a null string (for example, " ") is a variable with a value. Many environment variables are predefined and have default values.

Command Modes

Boot loader

Command History

Usage Guidelines

Environment variables are case sensitive and must be entered as documented.

Environment variables that have values are stored in flash memory outside of the flash file system.

Under normal circumstances, it is not necessary to alter the setting of the environmental variables.

The MANUAL_BOOT environment variable can also be set by using the boot manual global configuration command.

The BOOT environment variable can also be set by using the boot system filesystem:/file-url global configuration command.

The ENABLE_BREAK environment variable can also be set by using the boot enable-break global configuration command.

The HELPER environment variable can also be set by using the boot helper filesystem:/file-url global configuration command.

The CONFIG_FILE environment variable can also be set by using the boot config-file flash:/file-url global configuration command.

The HELPER_CONFIG_FILE environment variable can also be set by using the boot helper-config-file filesystem:/file-url global configuration command.

The HELPER_CONFIG_FILE environment variable can also be set by using the boot helper-config-file filesystem:/file-url global configuration command.

The boot loader prompt string (PS1) can be up to 120 printable characters except the equal sign (=).

Examples

This example shows how to change the boot loader prompt:

Switch: set PS1 loader: 

loader: 

You can verify your setting by using the set boot loader command.

Related Commands

set_param

To write system parameters to the system flash memory, use the set_param command in boot loader mode.

set_param

Syntax Description

This command has no arguments or keywords.

Command Modes

Boot loader

Command History

Examples

This example shows how to write system parameters to system flash memory.

Switch: set_param

sleep

To pause for a specified number of seconds, use the sleep command in boot loader mode.

sleep value

Syntax Description

Command Modes

Boot loader

Command History

Examples

This example shows how to pause the boot loader process for 30 seconds:

Switch: sleep 30

type

To display the contents of one or more files, use the type command in boot loader mode.

type filesystem:/file-url ...

Syntax Description

Command Modes

Boot loader

Command History

Usage Guidelines

Filenames and directory names are case sensitive.

If you specify a list of files, the contents of each file appears sequentially.

Examples

This example shows how to display the contents of two files:

Switch: type flash:/new-images/info flash:env_vars

version_suffix: image-name 

version_directory: image-name

image_name: image-name.bin

ios_image_file_size: 63984644

total_image_file_size: 8133632

image_feature: IP|LAYER_3|PLUS|MIN_DRAM_MEG=128

image_family: family

info_end: 

BAUD=57600

MANUAL_BOOT=no

Related Commands

unset

To reset one or more environmental variables, use the unset command in boot loader mode.

unset variable ...

Note Under normal circumstances, it is not necessary to alter the setting of the environment variables.

Syntax Description

Command Modes

Boot loader

Command History

Usage Guidelines

Under normal circumstances, it is not necessary to alter the setting of the environmental variables.

The MANUAL_BOOT environment variable can also be reset by using the no boot manual global configuration command.

The BOOT environment variable can also be reset by using the no boot system global configuration command.

The ENABLE_BREAK environment variable can also be reset by using the no boot enable-break global configuration command.

The HELPER environment variable can also be reset by using the no boot helper global configuration command.

The CONFIG_FILE environment variable can also be reset by using the no boot config-file global configuration command.

The HELPER_CONFIG_FILE environment variable can also be reset by using the no boot helper-config-file global configuration command.

Examples

This example shows how to reset the prompt string to its previous setting:

Switch: unset PS1

Switch:

Related Commands

version

To display the boot loader version, use the version command in boot loader mode.

version

Syntax Description

This command has no arguments or keywords.

Command Modes

Boot loader

Command History

Examples

This example shows how to display the boot loader version:

Switch: version

switch-name Boot Loader (xxxxx-HBOOT-M) Version 12.2(xx)EX

Compiled Wed 12-Sept-05 14:58 by devgoyal

Switch: