4.13. BOF command reference

This command configures the boot options file (BOF) for the specified local storage device.

A BOF file 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 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 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 BOF exists.

This command enables and disables encryption of the BOF using AES256 and SHA256.

When the BOF is encrypted on the compact flash, it is still reachable using the BOF interactive menu during node startup, and fields can be modified using this menu.

This command creates a key used by AES256 and SHA256 algorithms for configuration file encryption and hashing. This key is used for all configuration files (primary, secondary, and tertiary).

After creating or deleting a key, use the admin save command to save the configuration file with the current encryption key state.

The no form of this command deletes the encryption key.

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.

Command usage:

This command securely stores BOF passwords in the bof.cfg file in an encrypted format.

Note: When this command is enabled or disabled, the system resets the BOF password to the default password. Nokia recommends that after enabling or disabling this command, the user should change the password using the bof>bof-password command.

This command configures a pause, in seconds, at the start of the boot process that allows the user to interrupt system initialization at the console.

When the user interrupts system initialization, the user is allowed to manually override the parameters defined in the BOF.

Only one wait command can be defined in the BOF.

This command configures a BOF password. The user must provide the password to edit the BOF parameters in the boot loader.

This command also implements a mechanism for password recovery. If the user forgets the password, it can be reset to factory default. When a password is reset, as a security measure to prevent a malicious access to the configuration files, the system also resets the flash to factory defaults (that is, it removes all files from the flash, except 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 set up the box using the same steps used to boot the box the first time after it was received from the factory. During bootup after a reboot, the user can use the factory default password password to edit the BOF parameters. After the factory default password is used, Nokia recommends that the user should change the password.

Note: Nokia strongly recommends that you should not rename the cf1:\boot.tim and cf1:\both.tim files. These files should be retained in case the system needs them during the password recovery procedure. Nokia also recommends making a backup of all the image files, configuration files, and other data. Enabling or disabling the secure-bof-password command resets the BOF password to the default password. See secure-bof-password for more information.

The no form of this command deletes the configured password and resets to the default password. The no form is supported only when secure-bof-password enable is configured.

This command allows the user to enable or disable the serial port console for use.

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

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 up and 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 configures 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 others. 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. Use the config>system>snmp>no shutdown command to enable SNMP access.

If persist is enabled and the admin>save file-url command is executed with an FTP path used as the file-url parameter, 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 an operator sets the location for the persistency file, the system will checks to ensure that the disk has enough free space. If this there is not enough free space, persistency does not become active and a trap is generated. In this case, the operator must free adequate disk space. Until disk space is freed, the system performs a space availability check every 30 seconds. As soon as the space is available, persistency will become active on the next (30 second) check.

This command configures 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.

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 configures 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 configures 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 the command removes the secondary-config configuration.

This command configures 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 the command removes the secondary-image configuration.

This command configures 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 the command removes the tertiary-config configuration.

This command configures 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 configures the system in either access-uplink mode or network mode.

In access-uplink mode, the device allows for configuration of the port in access-uplink mode and allows for use of access-uplink SAPs for service configuration. In this mode, the system boots up with all ports configured in access mode. The user can modify the port mode to access-uplink after system boot up, but the software does not allow the mode to be set to network. The software allows the user to configure services to use only either access SAPs or access-uplink SAPs, but not MPLS-based SDPs. This mode is supported on the 7210 SAS-T.

In network mode, the device allows for configuration of the port in network mode and allows the use of network IP interfaces and MPLS-based SDPs for service configuration. In this mode, the system boots up with all ports configured in network mode. The user can modify the port mode to access after system boot up, but the software does not allow the mode to be set to access-uplink. The software allows the user to configure services to use only either access SAPs or MPLS-based SDPs, but not access uplink SAPs. This mode is supported on the 7210 SAS-T.

Note: Ensure that service entities related to MPLS mode are not enabled when the device is configured in access-uplink mode and vice-versa. The system does not enforce this.

This command configures 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 uplinkA 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 boot option file (BOF).

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

Note: The uplinkA-autoneg command is not valid for 10gig ports. Therefore, whenever the user selects 10gig ports as uplinkA port, the uplinkA-autoneg command is defaulted to no uplinkA-autoneg, speed as uplinkA-speed 10000, 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 the auto-negotiate feature on this port.

Note: The uplinkB-autoneg command is not valid for 10gig ports. Therefore, whenever the user selects 10gig 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 duplex mode of the uplinkA port when auto-negotiation is disabled in the running configuration and the BOF.

It also 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 uplinkA-autoneg command is not valid for 10gig ports, therefore, whenever the user selects 10gig ports as uplinkA-port, the uplinkA-autoneg command is defaulted to no uplinkA-autoneg, speed as uplinkA-speed 10000, duplex as uplinkA-duplex full, as shown in the following output sample.

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 10gig ports. Therefore, whenever the user selects 10gig 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 sample.

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

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

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

The no form of this command removes all the 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 port 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 10gig ports. Therefore, whenever the user selects 10gig ports as uplinkA-port, the uplinkA-autoneg command is defaulted to no uplinkA-autoneg, speed as uplinkA-speed 10000, duplex as uplinkA-duplex full, as shown in the following output example.

This command configures the speed for the uplinkB port 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 10gig ports. Therefore, whenever the user selects 10gig ports as uplinkB-port, the uplinkB-autoneg command defaults 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 a VLAN ID to be used on uplinkA.

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

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

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

This command assigns an IP address to the management Ethernet port in the running configuration and the BOF. Deleting a BOF address entry is not allowed from a telnet session.

Note: The following caveats apply for the eth-mgmt-address command: The active and standby options are only available on the 7210 SAS-R6 and 7210 SAS-R12, and on the 7210 SAS-Sx 1/10GE and 7210 SAS-S 1/10GE when the chassis-role parameter is set to standalone-vc. On the 7210 SAS-Sx 1/10GE and 7210 SAS-S 1/10GE, choosing the active option configures the IP address on the active CPM node, and is used by the network manager to operate the virtual chassis (VC). Choosing the standby option configures the IP address on the standby CPM node.

The no form of this command deletes the IP address assigned to the Ethernet port.

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

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

This command allows the user to enable or disable the out-of-band management Ethernet port for use during boot up.

The no form of this command enables the port.

This command configures the duplex mode of the management Ethernet 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.

This command configures a static route entry for the management Ethernet port in the running configuration and the BOF.

This command allows manual configuration of static routing table entries. These static routes are only used by traffic generated by the Ethernet port. To reduce configuration, manual address aggregation should be applied where possible.

A static default (0.0.0.0 or 0) route cannot be configured on the management Ethernet port. A maximum of ten static routes can be configured on the management Ethernet port.

The no form of this command deletes the static route.

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

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

This command configures the host system.

When operating in satellite mode, the setting for the host-type BOF parameter must be consistent with the value of the chassis-role parameter; otherwise, on reboot the node will not boot up correctly. See BOF chassis-role and host-type parameters for 7210 SAS-Mxp, 7210 SAS-Sx 1/10GE, 7210 SAS-S 1/10GE, and 7210 SAS-Sx 10/100GE for more information.

It is not necessary to configure the host-type value when the chassis role is set to standalone.

For nodes that are destined to operate in a virtual chassis (VC) set up, it is not necessary to configure the host-type value when the bootloader chassis-role parameter is set to standalone-vc.

The no form of this command removes the host-type setting.

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 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 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.