4.12. BOF Command Reference

This command creates or edits the boot option 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, and 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 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 console speed 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.

No default boot option file exists.

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

The BOF is located in the root directory of the internal compact flash drive local to the system and has the mandatory filename bof.cfg. Saves must be explicitly executed. BOF is saved at the same location as the location of the boot.tim file, which is used for booting the system.

Command usage:

This command configures a pause, in seconds, at the start of the boot process, which allows system initialization to be interrupted at the console.

When system initialization is interrupted, the operator is allowed to manually override the parameters defined in the BOF.

Only one wait command can be defined in the BOF.

This command enables the context to configure a BOF password. The user must provide the configured password to edit the BOF parameters in the boot loader.

It also implements a mechanism for password recovery, if the user forgets the password. If the user forgets the password, it can be reset to factory default. As a security measure, to prevent a malicious access to the configuration files, when the password is reset to default, the system also resets the flash to factory defaults (that is, it removes all the files from the flash except for the boot image file (cf1:\boot.tim) and TiMOS image file (cf1:\both.tim)) and reboots the node with the factory default settings.

After boot up, the user must setup the box using the same steps as used to boot the box the first time when it was received from the factory. The user can use the factory default password password to edit the BOF parameters after the boot up subsequent to reboot and choose to change the password again.

Note: It is highly recommended that user does not rename cf1:\boot.tim and cf1:\both.tim, if the system needs to retain them during the password recovery procedure. Additionally, it is highly recommended that the user makes a backup of all the image files, configuration files, and other data.

This command enables or disables the serial port console for use.

In remote deployments this command provides an additional security mechanism for the user. The console can be disabled to prevent unauthorized access to the system.

Note: The console is always available for use when the device is booting up. This command is applicable only after the TiMOS image (both.tim) is running successfully. If the user executes this command in the BOF CLI context, the command takes effect only during the next boot. A BOF save operation must be performed after executing the console-disabled command.

The no form of this command enables the console.

This command configures the console port baud rate.

When this command is issued to edit the BOF used for the most recent boot, the BOF and the active configuration are changed immediately.

The no form of this command reverts to the default value.

This command specifies whether the system will preserve system indexes when a save command is executed. During a subsequent boot, the index file is read along with the configuration file. As a result, a number of system indexes are preserved between reboots, including the interface index, and so on. This reduces resynchronizations of the Network Management System (NMS) with the affected network element.

In the event that persist is on and the reboot with the appropriate index file fails, SNMP is operationally shut down to prevent the management system from accessing and possibly synchronizing with a partially booted or incomplete network element. To enable SNMP access, enter the config>system>snmp>no shutdown command.

If persist is enabled and the admin save file-url command is executed with an FTP path used as the file-url parameter value, two FTP sessions simultaneously open to the FTP server. The FTP server must be configured to allow multiple sessions from the same login, otherwise, the configuration and index files will not be saved correctly.

Note: Persistency files (.ndx) are saved on the same disk as the configuration files and the image files. When a user sets the location for the persistency file, the system will check to ensure that the disk has enough free space. If this there is not enough free space, the persistency will not become active and a trap will be generated. Then, it is up to the operator to free adequate disk space. In the meantime, the system will perform a space availability check every 30 seconds. As soon as the space is available the persistency will become active on the next (30 second) check.

This command specifies the name and location of the primary configuration file.

The system attempts to use the configuration specified in primary-config. If the specified file cannot be located, the system automatically attempts to obtain the configuration from the location specified in secondary-config and then the tertiary-config.

Note: If an error in the configuration file is encountered, the boot process aborts.

The no form of this command removes the primary-config configuration.

This command specifies the primary directory location for runtime image file loading.

The system attempts to load all runtime image files configured in the primary-image first. If this fails, the system attempts to load the runtime images from the location configured in the secondary-image. If the secondary image load fails, the tertiary image specified in tertiary-image is used.

The no form of this command removes the primary-image configuration.

This command specifies the name and location of the secondary configuration file.

The system attempts to use the configuration as specified in secondary-config if the primary config cannot be located. If the secondary-config file cannot be located, the system attempts to obtain the configuration from the location specified in the tertiary-config.

If an error in the configuration file is encountered, the boot process aborts.

The no form of this command removes the secondary-config configuration.

This command specifies the secondary directory location for runtime image file loading.

The system attempts to load all runtime image files configured in the primary-image first. If this fails, the system attempts to load the runtime images from the location configured in the secondary-image. If the secondary image load fails, the tertiary image specified in tertiary-image is used.

The no form of this command removes the secondary-image configuration.

This command specifies the name and location of the tertiary configuration file.

The system attempts to use the configuration specified in tertiary-config if both the primary and secondary config files cannot be located. If this file cannot be located, the system boots with the factory default configuration.

If an error in the configuration file is encountered, the boot process aborts.

The no form of this command removes the tertiary-config configuration.

This command specifies the tertiary directory location for runtime image file loading.

The system attempts to load all runtime image files configured in the primary-image first. If this fails, the system attempts to load the runtime images from the location configured in the secondary-image. If the secondary image load fails, the tertiary image specified in tertiary-image is used.

The no form of this command removes the tertiary-image configuration.

This command specifies the IP address used for a ping-test after the system boots.

The no form of this command removes the ping-address configuration. Setting a value of 0 also removes the ping-address configuration.

This command configures the uplink-A address.

The no form of this command sets the uplinkA to use DHCP to get the IP and the show bof value reflects 0 for this parameter.

This command configures the uplink-B address.

The no form of this command sets the uplinkB to use DHCP to get the IP, and the show bof value reflects 0 for this parameter.

This command enables speed and duplex auto-negotiation on the uplinkA port in the running configuration and the BOF.

The no form of this command disables auto-negotiate on this port.

Note: The uplinkA-autoneg command is not valid for 10GE ports. Therefore, whenever the user selects 10GE ports as uplinkA-port, the uplinkA-autoneg command is defaulted to no uplinkA-autoneg, speed as uplinkA-speed 10000, and duplex as uplinkA-duplex full, as shown in the following output example.

This command enables speed and duplex Auto-negotiation on the uplinkB port in the running configuration and the BOF.

The no form of this command disables auto-negotiate on this port.

Note: The uplinkB-autoneg command is not valid for 10GE ports. Therefore, whenever the user selects 10GE ports as uplinkB-port, the uplinkB-autoneg command is defaulted to no uplinkB-autoneg, speed as uplinkB-speed 10000, and duplex as uplinkB-duplex full, as shown in the following output example.

This command configures the duplex mode of the uplinkA port when auto-negotiation is disabled in the running configuration and the BOF.

This command also enables the context to configure the duplex mode of the Ethernet port. If the port is configured to auto-negotiate, this parameter will be ignored.

Note: The uplinkA-autoneg command is not valid for 10GE ports. Therefore, whenever the user selects 10GE ports as uplinkA-port, the uplinkA-autoneg command is defaulted to no uplinkA-autoneg, speed as uplinkA-speed 10000, and duplex as uplinkA-duplex full, as shown in the following output example.

This command configures the duplex mode of the uplinkB port when auto-negotiation is disabled in the running configuration and the BOF.

This configuration command allows for the configuration of the duplex mode of the Ethernet port. If the port is configured to auto-negotiate, this parameter will be ignored.

Note: The uplinkB-autoneg command is not valid for 10GE ports. Therefore, whenever the user selects 10GE ports as uplinkB-port, the uplinkB-autoneg command defaults to no uplinkB-autoneg, speed as uplinkB-speed 10000, duplex as uplinkB-duplex full, as shown in the following output example.

This command configures the primary port to be used for boot up.

The no form of this command removes all uplinkA parameters from the BOF.

This command configures the secondary port to be used for bootup.

The no form of this command removes all uplinkB parameters from the BOF.

This command configures an uplinkA static route.

This command configures an uplinkB static route.

This command configures the speed for the uplinkA when auto-negotiation is disabled in the running configuration and the BOF.

If the port is configured to auto-negotiate, this parameter is ignored.

Note: The uplinkA-autoneg command is not valid for 10GE ports. Therefore, whenever the user selects 10GE ports as uplinkA-port, the uplinkA-autoneg command defaults to no uplinkA-autoneg, speed as uplinkA-speed 10000, and duplex as uplinkA-duplex full, as shown in the following output example.

This command configures the speed for the uplinkB when auto-negotiation is disabled in the running configuration and the BOF.

If the port is configured to auto-negotiate, this parameter is ignored.

Note: The uplinkB-autoneg command is not valid for 10GE ports. Therefore, whenever the user selects 10GE ports as uplinkB port, the uplinkB-autoneg command is defaulted to no uplinkB-autoneg, speed as uplinkB-speed 10000, and duplex as uplinkB-duplex full, as shown in the following output example.

This command specifies a VLAN ID to be used on uplinkA.

The no form of this command is used to send untagged packets on uplinkA.

This command specifies a VLAN ID to be used on uplinkB.

The no form of this command is used to send untagged packets on uplinkB.

This command configures the domain name used when performing DNS address resolution. This is a required parameter if DNS address resolution is required. Only a single domain name can be configured. If multiple domain statements are configured, the last one encountered is used.

The no form of this command removes the domain name from the configuration.

This command configures the primary DNS server used for DNS name resolution. DNS name resolution can be used when executing ping, traceroute, and service-ping, and when defining file URLs. DNS name resolution is not supported when DNS names are embedded in configuration files.

The no form of this command removes the primary DNS server from the configuration.

This command configures the secondary DNS server for DNS name resolution. The secondary DNS server is used only if the primary DNS server does not respond.

DNS name resolution can be used when executing ping, traceroute, and service-ping, and also when defining file URLs. DNS name resolution is not supported when DNS names are embedded in configuration files.

The no form of this command removes the secondary DNS server from the configuration.

This command configures the tertiary DNS server for DNS name resolution. The tertiary DNS server is used only if the primary DNS server and the secondary DNS server do not respond.

DNS name resolution can be used when executing ping, traceroute, and service-ping, and also when defining file URLs. DNS name resolution is not supported when DNS names are embedded in configuration files.

The no form of this command removes the tertiary DNS server from the configuration.