Upgrade, Enable, or Disable Flash with the Intel® Ethernet Flash Firmware Utility
Use the Intel® Ethernet Flash Firmware Utility (BootUtil) to program the PCI option ROM on the flash memory of supported Intel PCI and PCI-Express-based network adapters. You can use BootUtil to update configurations.
Download Intel Ethernet Flash Firmware Utility
BootUtil is a utility program that changes the default settings of your Intel® Ethernet adapter. You can use BootUtil to enable or disable the Wake-on-LAN and Intel® Boot Agent capabilities, and enable or disable some settings used by the Boot Agent. BootUtil also allows for in-the-field upgrades to the image stored in the flash component of the NIC.
- BootUtil replaces older utilities and provides the functionality of the older IBAUTIL, ISCSIUTL, LANUTIL , and FLAUTIL utilities that were found in the PROBOOT, ISBoot, and, PROEFI web packs.
- BootUtil supports all the adapters supported by the previous utilities.
- BootUtil is not intended as a utility for LAN-On-Motherboard (LOM) implementations. Adjustments made to BootROM settings on LOM implementations may not affect how the adapter operates.
| Note | Updating the adapter flash memory using BootUtil erases any existing firmware image from the flash memory. |
Running BootUtil
BootUtil accepts one executable option and its associated non-executable options in an execution. If conflicting executable options (such as -FLASHENABLE and -UPDATE used together) are supplied, BOOTUTIL exits with an error.
The options, where applicable, are listed in logical groups. If you run BootUtil without any command line options, it displays a listing of all of the supported Intel network adapters found in the system.
| General Options | |
| Parameter | Description |
| -HELP or -? | Displays a list of command-line options. |
| -EXITCODES | Displays exit codes returned to the OS by BootUtil. |
| -IMAGEVERSION or -IV | Displays firmware types and version numbers from a resource image. If used with the -FILE option, the resource image is in the FLB file. If used with the -NIC option, the resource image is in the adapter flash. If used with the -ALL option, each resource image is continuously displayed for all adapters. |
| -E | Enumerates all supported network ports in the system. |
| -O=[FILENAME] | Must be used with E or NIC. |
| -I=[FILENAME] | Reads iSCSI boot configuration options from [FILENAME] script file and program settings on the selected port. |
| -FILE=[FILENAME] | Specifies the file name for -SAVEIMAGE, -RESTOREIMAGE, -SAVECONFIG or -RESTORECONFIG option. |
| Flash Programming Options | |
| Parameter | Description |
| -UP or -UPDATE=[ROMType] [-FILE=Filename] | Updates the flash memory of the adapter specified by the -NIC option with the given FLB flash firmware image file. If -QUIET is not specified, the user is prompted to confirm overwriting the existing firmware image before upgrading. If a File name is not provided, the utility looks for the default bootimg.FLB file that has all image types. The following examples use pxe, but could also be efi, efi64, FCoE or iSCSI. If your adapter supports a combo option ROM, the following command option automatically detects the supported combo image and programs the adapter with that image. |
| -SAVEIMAGE | Saves the existing flash firmware image in the flash memory of the adapter specified by the -NIC option to a disk file. The destination file specifies the -FILE option. |
| -RESTOREIMAGE | Restores a previously-saved flash firmware image to the same network adapter using the -NIC option. The source file specifies the -FILE option. |
| -QUIET | Runs BootUtil without confirmation prompts. This option is used with -IMAGEVERSION, -UP, -UPDATE, -RESTOREIMAGE, or -HELP option. |
| Power Management Options | |
| Parameter | Description |
| -WOLENABLE or -WOLE | Enables Wake On Lan (WOL) functionality on the selected port. |
| -WOLDISABLE or -WOLD | Disables Wake On Lan (WOL) functionality on the selected port. |
| Adapter Selection Options | |
| Parameter | Description |
| -ALL | Selects all supported network ports found in the system. |
| -NIC=XX | Selects a specific network port in the system. If used without any executable option, it prints the iSCSI boot configuration of the selected port, or saves it in the file when the -O option is used. |
| -TARGET=XX | This is an FCoE-specific selection option. Legal values are 1, 2, 3, and 4. This option is required for configuration commands -WWPN, -FCOELUN, FCOEVLAN, and -BOOTORDER. |
| -BLINK | Blinks the LED on the selected port for ten seconds. |
| Adapter Flash Enable/Disable Options | |||
| Parameter | Description | ||
| -FLASHENABLE or -FE | Enables the capability to run the flash firmware on the selected adapter. | ||
| -FLASHDISABLE or -FD | Disables the capability to run the flash firmware on the selected adapter. | ||
| -BOOTENABLE=[PXE, ISCSIPRIMARY, ISCSISECONDARY, FCOE, or DISABLED] | Selects flash firmware type to enable or disable on the selected port. The combo option ROM could have all capabilities. The monolithic option ROM has either PXE, FCoE, or iSCSI capability but not all. This command will NOT WORK on monolithic Option ROMs.
| ||
BOOTENABLE=DISABLED
Disables FCoE, iSCSI and PXE functionalities for legacy BIOS.
BOOTENABLE=ISCSIPRIMARY
Enables port as iSCSI primary and disables PXE/FCoE for legacy BIOS.
BOOTENABLE=ISCSISECONDARY
Enables port as iSCSI secondary and disables PXE/FCoE for legacy BIOS.
BOOTENABLE=PXE
Enables PXE and disables iSCSI/FCoE boot for legacy BIOS.
BOOTENABLE=FCOE
Enables FCoE and disables iSCSI/PXE boot for legacy BIOS.
| PXE Boot Configuration options (can be used with -NIC or -ALL) | |
| Parameter | Description |
| -DEFAULTCONFIG or -DEFCFG | Sets the PXE configuration of the selected NIC back to default settings. |
| -SETUPENABLE or -STE | Enables Setup Menu. |
| -SETUPDISABLE OR -STD1 | Disables Setup Menu. |
| -TITLEENABLE OR -TLE | Enables Initial Title Message. |
| -TITLEDISABLE OR -TLD | Disables Initial Title Message. |
| -MESSAGEENABLE or -MSE | Enables display of the Control-S Setup message when PXE initializes. The Control-S Setup message is no longer available in the newer boot agent versions, which frees up space in the option ROM. |
| -MESSAGEDISABLE or -MSD1 | Disables display of the Control-S Setup message when PXE initializes. |
| -SETWAITTIME=X or -SWT=X1 | Set the setup delay time for the NIC to X seconds. Valid delay times are 0, 2, 3, and 5. |
| -MODE | Writes the given MODE setting to EEPROM of the given NIC(s). |
1 These are no longer available due to space limitations. The menu was removed to free up space as we are limited to 64KB for option ROMs. Try the -TLE or -TLD instead to enable and disable, alternatively.
| iSCSI Boot Configuration Options | |
| Parameter | Description |
| -SAVECONFIG | Saves a snapshot of iSCSI boot configurations on the selected port to a binary file. Need to specify the file name by the -FILE option. WARNING: For security reasons, it's recommended that CHAP settings are disabled when using this option. |
| -RESTORECONFIG | Restores previously saved iSCSI boot configuration snapshot on the selected port. Need the -FILE option to specify the saved data. WARNING: This feature can create multiple primary or secondary ports if the same command is issued to multiple ports. Review the boot priority setting in the iSCSI setup menu for the next system boot. |
| Port Configuration Options for iSCSI Initiator | |
| You can use these options either individually with the -NIC=XX option, or in a script file with the -I option. The value is specified in -[OPTION]=[VALUE] format. | |
| -[OPTION]=[VALUE] | Description |
| -INITIATORNAME | Specifies the iSCSI Qualified Name (IQN) for the initiator. |
| -INITIATORIP | Specifies the initiator IPv4 address in dotted decimal notation. |
| -INITIATORDHCP | Enables or disables DHCP client in the initiator. |
| -NETMASK | Specifies the initiator subnet mask in dotted decimal notation. |
| -GATEWAY | Specifies the gateway IPv4 address in dotted decimal notation. |
| -BOOTPRIORITY | Specifies iSCSI boot priority as PRIMARY, SECONDARY or DISABLE. |
| iSCSI Target Configuration Options | |
| You can use these options either individually with the -NIC=XX option, or in a script file with the -I option. The value is specified in -[OPTION]=[VALUE] format. | |
| -[OPTION]=[VALUE] | Description |
| -TARGETNAME | Specifies the iSCSI Qualified Name (IQN) for the target. |
| -TARGETIP | Specifies the target IPv4 address in dotted decimal notation. |
| -TARGETDHCP | ENABLE or DISABLE to get the target information from DHCP Root Path. |
| -TARGETPORT | Specifies the TCP port number on the target to connect to. |
| -BOOTLUN | Specifies the LUN number to boot from. |
| Authentication Configuration Options | |||
| You can use these options either individually with the -NIC=XX option, or in a script file with the -I option. The value is specified in -[OPTION]=[VALUE] format. | |||
| -[OPTION]=[VALUE] | Description | ||
| -AUTHENTICATIONMETHOD | Specifies either NONE, CHAP or MutualCHAP | ||
| -CHAPUSERNAME | Specifies CHAP user name. | ||
| -CHAPSECRET | Specifies a secret text string to go with the CHAP user name. | ||
| -MUTUALCHAPSECRET | Specifies the reverse (target) CHAP secret text string. | ||
| FCoE General Configuration Options | These options have to be used with the -NIC=XX option. They cannot be used with the -ALL option. | ||
| -WWPNPREFIX | Specifies the Prefix to use for the WWPN. The prefix is comprised of 4 hex digits. Separators '-' or ':' are allowed but optional. Example: BOOTUTIL -NIC=1 -WWPNPREFIX=20-00 | ||
| -WWNNPREFIX | Specifies the Prefix to use for the WWNN. The prefix is comprised of 4 hex digits. Separators '-' or ':' are allowed but optional. Example: BOOTUTIL -NIC=1 -WWNNPREFIX=10-00 | ||
| FCoE Target Configuration Options | These Options require the use of both the -NIC=XX Option AND the -TARGET=XX Option. The -ALL option is not allowed. | ||
| -WWPN | Specifies the WWPN for the selected Target. The WWPN consists of 16 HEX digits or 8 bytes. Each byte can be separated with '-' or ':' as an optional separator. Example: BOOTUTIL -NIC=1 -TARGET=1 -WWPN=00-11-22-33-44-55-66-77 | ||
| -FCOELUN | Specifies the LUN for the selected FCoE Target. Valid range is 0..255. | ||
| -FCOEVLAN | Specifies the VLAN to use in order to connect to the selected target. Valid range is 0..4094. | ||
| -BOOTORDER | Specifies the boot order for the selected target. Valid range is 1-4. If 0 is specified, then target is excluded from the boot order. Boot order values of 1-4 can only be assigned once to target(s) across all FCoE boot-enabled ports.
| ||
The CHAP Authentication feature of this product requires the following acknowledgements:
- This product includes cryptographic software written by Eric Young (eay@cryptsoft.com).
- This product includes software written by Tim Hudson (tjh@cryptsoft.com).
- This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit.
Exit codes
BootUtil returns exit codes to the OS environment. Possible exit codes are listed below:
| Code Name | Value |
| All BootUtil operations completed successfully | 0 |
| Bad command line parameter | 1 |
| No supported network port detected | 2 |
| Invalid network port selected | 3 |
| FLASH operation failed | 4 |
| EEPROM read operation failed | 5 |
| EEPROM write operation failed | 6 |
| File content is missing or corrupt | 7 |
| Operator termination | 8 |
| LOM not supported for selected operation | 9 |
| Network port is not bootable | 10 |
| FLASH memory is disabled for flash firmware | 11 |
| FLASH memory too small for selected firmware | 12 |
| Programming iSCSI boot configurations failed | 13 |
| System memory allocation failed | 14 |
| File operation failed | 15 |
| FCoE operation failed | 16 |
| Related topics |
| Download Intel® Ethernet Flash Firmware Utility |
| Download the User Guide |