# Auxiliary DOS Utilities

Overview

Running IBAUtil

Command Line Parameters

Supported Flash Devices

## Overview

The Intel® PROSet II configuration and diagnostic utility requires use of the Windows* operating environment. For systems without Windows, Intel provides a utility (IBAUtil) for installing and configuring the Boot Agent using the DOS environment. IBAUtil is a utility program that provides an alternative means for modifying the adapter configuration settings. IBAUtil supports both the PRO/100 and PRO/1000 family of adapters. Use IBAUtil to:

- change the default settings of your Intel WfM-compatible adapter.

- enable/disable the Wake-on-LAN (WOL) and Intel® Boot Agent capabilities.

- allow in-the-field upgrades to the image stored in the flash component of the NIC.

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 two adapters should 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.

| NOTES: The Intel® PRO/1000 T Desktop Adapter and Intel® PRO/100 S Family of Adapters are shipped with the Boot Agent enabled for both WOL and PXE.
| The Intel® PRO/1000 XT Server Adapter is 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.
IBAUtil is not intended as a utility for LAN-On-Motherboard (LOM) implementations. 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 the IBAUtil utility to enable the Boot Agent before using IBAUtil or Intel PROSet to upgrade the image stored in the NIC. If IBAUtil reports the Boot Agent as Invalid, run IBAUtil with the -UPGRADE option to refresh 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 \BOOTAGNT directory. Always check the Intel Customer Support website for the latest Boot Agent information and images.

## Running IBAUtil

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

> IBAUTIL [-option]...

| NOTE: IBAUtil (for DOS) must be run with the computer booted to DOS only. This utility cannot be run in a DOS window in any Microsoft Windows* product or in DOS compatibility mode in IBM OS/2*.

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

## Command Line Parameters

IBAUtil accepts up to 16 simultaneous parameters and does not perform both operations if orthogonal 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 orthogonal 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.

If you enter IBAUTIL without any command line options, it displays a listing of all of the 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 the IBAUtil. When -IMAGEVERSION is set, all other parameters except -EXITCODES and -HELP are ignored.
-ALL | Selects all adapters found in 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.
-BLINK | Provides a method for identifying an adapter. This feature is currently only supported on the PRO/1000 product line.
-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 PRO/1000 line of adapters as well as the PRO/100 line of adapters. Note that some 82557 based NICs may not have a big enough Flash to receive the upgrade. 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 | Set 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 Intel 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:

| NOTE: If you run IBAUtil without any command line options, the utility displays a list of all the adapters found in your system.

#### 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 -BOOTENABLE

## Supported Flash Devices

Please note that even though a part may be listed here, it may not work on all the hardware supported by IBAUtil. Some flash devices listed here are for PRO/100 adapters only and cannot be used on PRO/1000 adapters. Consult the appropriate hardware design documentation to find out which flash devices work with what controllers.

Vendor | Part Number
--- | ---
AMD | 28F020
ATMEL | AT49BV512
ATMEL | AT29LV512
ATMEL | AT49LV010
ATMEL | AT49LV020
ATMEL | AT49LV040
ATMEL | AT49LV001N
CATALYST | 28F256
CATALYST | 28F512
CATALYST | 28F010
CATALYST | 28F020
INTEL | 28F010
INTEL | 28F020
SGS | 28F512
SST | 29LE512
SST | 39SF512
SST | 39VF512
SST | 39VF010
SST | 39VF020
ST MICRO | 28F512
ST MICRO | 29W512B

Copyright © 2002 Intel Corporation. Legal Information