File Management Commands

bof

Syntax

bof

Context

<root>

Description

This command creates or edits the boot options file (BOF) for the specified local storage device.

A BOF specifies where the system searches for runtime images, configuration files, and other operational parameters during system initialization.

BOF parameters can be modified. Changes can be saved to a specified compact flash. The BOF must be located in the root directory of either an internal or external compact flash local to the system and have the mandatory filename of bof.cfg.

When modifications are made to in-memory parameters that are currently in use or operating, the changes are effective immediately. For example, if the IP address of the CSM Management port is changed, the change takes place immediately.

Only one entry of the BOF configuration command statement can be saved after the statement has been found to be syntactically correct.

When opening an existing BOF that is not the BOF used in the most recent boot, a message is issued notifying the user that the parameters do not affect the operation of the node.

The pound (#) sign is used at the beginning of the File syntax. Using the command file type bof.cfg displays the # character as a comment delimiter at the top of the raw file. No default BOF exists. The router boots with the factory default boot sequence and options.

Default

n/a

encrypt

Syntax

encrypt {on | off}

Context

bof

Description

This command enables or disables encryption of the BOF (bof.cfg) using the AES256 cipher algorithm.

After the BOF is encrypted, it can still be modified using the BOF interactive menu. Access to the BOF interactive menu is controlled by a password set with the password command.

After BOF encryption is configured, use the bof save command to save the encrypted file.

Default

encrypt off

Parameters

on

enables BOF encryption

off

disables BOF encryption

password

Syntax

password password[hash | hash2]

nopassword

Context

bof

Description

This command configures a password to access the BOF interactive menu at startup.

After the password is configured, the BOF interactive menu is accessible only when the correct password is entered. If the correct password is not entered within 30 s, the node reboots.

The no form of this command removes the configured password.

Default

no password

Parameters

password

specifies the password

If the hash or hash2 parameter is not configured, the password is entered in plaintext and the password length must be between 8 and 32 characters. A plaintext password cannot contain embedded nulls or end with ‟hash” or ‟hash2”.

If the hash or hash2 parameter is configured, the password is hashed and the password length must be between 1 and 64 characters.

hash

specifies that the password is entered in an encrypted form

hash2

specifies that the password is entered in a more complex encrypted form. The hash2 encryption scheme is node-specific and the password cannot be transferred between nodes.

save

Syntax

save [cflash-id]

Context

bof

Description

This command uses the boot option parameters currently in memory and writes them from the BOF to the specified compact flash.

The BOF must be located in the directory of the compact flash drives local to the system and have the mandatory filename of bof.cfg.

The BOF is saved to the compact flash drive associated with the active CSM. The slot name is not case-sensitive. You can use uppercase or lowercase ‟A” or ‟B”.

Command usage:

  • bof save — saves the BOF to the default drive (cf3:) associated with the active CSM (either in slot A or B)

  • bof save cf3: — saves the BOF to cf3: associated with the active CSM (either in slot A or B)

To save the BOF to a compact flash drive associated with the standby CSM (for example, the redundant (standby) CSM is installed in slot B), specify the -A or -B option.

Command usage:

  • bof save cf3-A: — saves the BOF to cf3: associated with the CSM in slot A whether it is active or standby

  • bof save cf3-B: — saves the BOF to cf3: associated with the CSM in slot B whether it is active or standby

The slot name is not case-sensitive. You can use uppercase or lowercase ‟A” or ‟B”.

The bof save and show bof commands allow you to save to or read from the compact flash of the standby CSM. Use the show card command to determine the active and standby CSM (A or B).

Default

saves must be explicitly executed; the BOF is saved to cf3: if a location is not specified

Parameters

cflash-id

the compact flash ID where the bof.cfg is to be saved (see Table: URL Types and Syntax for parameter descriptions and values)