Back to Contents Page

Auxiliary DOS Utilities: Intel® Boot Agent User Guide

Overview
Running IBAUtil
Command Line Parameters

Overview

Intel provides IBAUtil for installing and configuring the Boot Agent in a DOS environment. IBAUtil supports both the Intel PRO/100 and PRO/1000 families of adapters.

Use IBAUtil to:

NOTE: Use Intel® PROSet to configure the Intel Boot Agent in Windows*.

Wake-On-LAN: When enabled, the adapter can react to special "wake up" packets and power up the computer without end-user intervention. However, there is a higher power draw when the system is in the suspended state once this is enabled. It is strongly recommended that no more than one adapter have this feature enabled per machine.

Intel Boot Agent: When enabled, the computer can initiate PXE/RPL boot if a valid flash image is present on the NIC.

NOTE: The Intel PRO/1000 XT Server Adapter, Intel PRO/100 Server Adapter, and the Intel 82540EM Based Network Connection are shipped with the Boot Agent disabled for both WOL and PXE.

To enable or disable WOL or Boot Agent features, you MUST use IBAUtil. Other tools, like Intel PROSet, can only be used to upgrade the Boot Agent image and change Boot Agent configuration settings.

While IBAUtil may be able to adjust the EEPROM settings on LOM implementations, those changes may not affect how the adapter operates.

If the Boot Agent on the NIC is currently disabled, use IBAUtil to enable it before using IBAUtil or Intel PROSet to upgrade the image stored in the NIC. A reboot is required for any changes to take effect.

IBAUtil is located on the CD-ROM in the \APPS\BOOTAGNT directory. Always check with Customer Support for the latest Boot Agent information and images.

Back to Top

Running IBAUtil

The syntax for issuing IBAUtil command line parameters in DOS is:

IBAUTIL [-option]...

NOTE: IBAUtil must be run with the computer booted to DOS only. This utility will not run in a DOS window in any Microsoft Windows product.
CAUTION: If you use a third-party (non-Intel) boot ROM solution with an Intel adapter and run Intel Boot Agent utilities, you may corrupt the contents of your flash ROM, rendering it useless.

Back to Top

Command Line Parameters

IBAUtil accepts up to 16 simultaneous parameters and does not perform both operations if opposing parameters (like the commands -FLASHENABLE -FLASHDISABLE used together) are supplied. If opposing parameters are specified, IBAUtil exits with an error.

The parameters are grouped with their opposing pairs, where applicable. Note that -HELP, -EXITCODES and -IMAGEVERSION have special overriding characteristics. Unless noted, all other parameters may be used in conjunction with all other parameters.

NOTE: If you enter IBAUTIL without any command line options, it displays a listing of all of the WFM-compliant Intel network adapters found in your system.

 

Parameter Description
-HELP or -? Displays command line help and exits. When -HELP is set, all other parameters are ignored.
-EXITCODES Displays exit code help. When -EXITCODES are set, all other parameters except -HELP are ignored.
-IMAGEVERSION or -IV Displays the PXE versions stored within IBAUtil. When -IMAGEVERSION is set, all other parameters except -EXITCODES and -HELP are ignored.
-ALL Selects all adapters found in the system, works for both EEPROM and Flash activity.
-NIC=XX Selects a specific adapter (1-16).
-AUTO or -QUIET Runs IBAUtil without asking for user intervention. It does NOT create a backup image. This parameter must be used with -NIC or -ALL if there is more than one NIC in the system. It runs without -ALL or -NIC=xx if there is only one NIC in the system.
-UPGRADE or -UP Downloads the Boot Agent stored within IBAUtil to the adapters in the system. User intervention is required to answer questions about backups and to select the appropriate NIC unless -AUTO is used. IBAUtil contains Boot Agent images for both the Intel PRO/1000 and PRO/100 families of adapters. Consult your adapter documentation for more details.
-DEFAULTCONFIG or -DEFCFG Resets Configuration and Control words in the EEPROM back to default settings.
-FLASHENABLE or -FE Enables Boot ROM.
-FLASHDISABLE or -FD Disables Boot ROM.
-WOLDISABLE or -WOLD Disables WOL bit on Fast Ethernet and disables APMPME and APME EEPROM bits on Gigabit.
-WOLENABLE or -WOLE Enables WOL bit on Fast Ethernet and enables APMPME and APME EEPROM bits on Gigabit.
-SETUPENABLE or -STE Enables Setup Menu.
-SETUPDISABLE OR -STD Disables Setup Menu.
-TITLEENABLE OR -TLE Enables Initial Title Message.
-TITLEDISABLE OR -TLD Disables Initial Title Message.
-PROTOCOLENABLE OR -PROE Enables Changing the Boot Protocol Option.
-PROTOCOLDISABLE OR -PROD Disables Changing the Boot Protocol Option.
-ORDERENABLE OR -ORDE Enables Changing the Boot Order Option.
-ORDERDISABLE OR -ORDD Disables Changing the Boot Order Option.
-LWSENABLE OR -LWSE Enables Changing the Legacy OS Wakeup Support Option.
-LWSDISABLE OR -LWSD Disables Changing the Legacy OS Wakeup Support Option.
-SETWAITTIME=X or -SWT=X Sets the setup delay time for the NIC to X seconds. Valid delay times are 0, 2, 3, and 5. Only the first instance of this parameter is valid. All other instances of the parameter generate an error.
-RPL Sets the network boot protocol to RPL.
-PXE Sets the network boot protocol to PXE.
-MODE=X Sets the Customization Control word in the EEPROM to the value specified by X. No range checking or validation is done. X must be in hexadecimal format. This should only be used under direction of Customer Support.

All other parameters will generate an error.

DOS Error Codes

IBAUtil returns codes to the DOS command line when an error occurs. Possible error codes are listed below:

Code Name Value
success 0
operator termination 1
invalid NIC 2
bad command line parameter 3
EEPROM checksum failure 4
EEPROM read failure 5
EEPROM write failure 6
EEPROM dump failure 7
(not used) 8
no memory 9
no NICs found 10
 
NOTE: As part of the UPGRADE code path, IBAUtil saves the backup image to the current directory if the user elects to make a backup. If that directory is on a RAM drive, the backup image will not be available after the machine reboots. IBAUtil makes no effort to warn the user about this.

Examples

The following examples show how to enter some typical IBAUtil command lines:

Example 1:

To disable WOL on all Intel network adapters, enter:

IBAUTIL -ALL -WOLDISABLE
Example 2:

To enable WOL on the second Intel network adapter found in your system, enter:

IBAUTIL -NIC=2 -WOLENABLE

Example 3:

To update the Boot Agent image on all Intel network adapters, enter:

IBAUTIL -ALL -UPGRADE
Example 4:

To Enable the Boot ROM on the first Intel network adapter found in your system, enter:

IBAUTIL -NIC=1 -FE

Please read all restrictions and disclaimers.

Back to Contents Page     Back to Top