Auxiliary DOS Utilities

Overview

The LAN software configuration and diagnostic utility requires use of the Windows* operating environment. For non-Windows systems, vides 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 the 100, 1000 and 10GbE family of adapters. Use IBAUtil to:

change the Boot Agent settings of your WfM-compatible adapter.
enable/disable the Wake-on-LAN (WOL) and Boot Agent capabilities.
allow in-the-field upgrades to the image stored in the flash component of the NIC.

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

NOTES:

The 1000 T Desktop Adapter and 100 S Family of Desktop Adapters are shipped with Boot Agent enabled for PXE.
1000, 100, and 10GbE Server Adapters are shipped with the Boot Agent disabled.

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.

To enable or disable WOL or Boot Agent features you MUST use IBAUtil. Other tools, like the software, 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 the software to upgrade the image stored in the NIC. A reboot is required for any changes to take effect.

IBAUtil is located on the supplied driver CD in the APPS\BOOTAGNT directory.

Running IBAUtil

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

IBAUTIL [-option]...

CAUTION: If you use a third-party (non-Intel) boot ROM solution with an adapter and run Boot Agent utilities, you may erase or replace the contents of your flash ROM.

NOTES:

IBAUtil (for DOS) must be run with the computer booted to DOS only.

The Boot Agent column in IBAUtil only displays the Boot Agent version when Boot Agent is enabled.

Command Line Parameters

IBAUtil accepts up to 16 simultaneous parameters. If conflicting parameters (such as -FLASHENABLE -FLASHDISABLE used together) are supplied, IBAUtil exits with an error.

The parameters are, where applicable are listed in logical groups. Note that -HELP, -EXITCODES and -IMAGEVERSION have special overriding characteristics. Unless noted, all other parameters may be used in conjunction with any other parameter.

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

General Options
Parameter	Description
`-HELP or -?`	Displays command line help and exits. When -HELP is used, 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.

Adapter Selection Options
Parameter	Description
`-ALL`	Selects all adapters found in system, works for both EEPROM and Flash activity.
`-NIC=XX`	Selects a specific adapter (1-16).

Image Programming Options
Parameter	Description
`-UP -UPGRADE or -INSTALL {PXEBOOT\|RPLBOOT}`	Programs a Boot Agent image into the FLASH on the selected NIC. If the user specifies -UPGRADE or -INSTALL with one or more additional keywords, IBAUtil will attempt to install the requested image or images into the NIC’s FLASH. The -PXEBOOT and -RPLBOOT keywords may be used singly or in any combination. The EFI64 keywords may only be used singly. If -AUTO is not specified and -SAVE is not specified, and the FLASH is not blank, the user is prompted to save the existing image before upgrading.
`-SAVE`	Saves the existing Boot Agent and EEPROM settings to a disk file. The file will be named based on the PCI Vendor and Device ID of the NIC. If this is specified on the same command line as -UPGRADE, the save is performed before the upgrade.
`-RESTORE`	Restores a previously-saved Boot Agent image. IBAUtil will look for a file name based on the PCI Vendor and Device ID of the NIC. If -RESTORE is specified on the same command line as -UPGRADE, an error is generated.

Utility Options
Parameter	Description
`-AUTO or -QUIET`	Runs IBAUtil without asking for user intervention. If used with the -UPGRADE option, it will 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 will run without -ALL or -NIC=xx if there is only one NIC in the system.
`-BLINK`	Provides a method for identifying an adapter. Blinks the LED on the selected adapter for ten seconds.
`-FLASHENABLE or -FE`	Enables Boot ROM.
`-FLASHDISABLE or -FD`	Disables Boot ROM.

EEPROM Settings Options
Parameter	Description
`-DEFAULTCONFIG or -DEFCFG`	Resets Configuration and Control words in the EEPROM to default settings. Specifically, word 30h in the EEPROM is set to 0100h and word 31h is set to 4000h. On dual-port adapters, words 34h and 35h are also set to these values. The checksum in the EEPROM is updated to account for these new values. No other words in the EEPROM are modified.
`-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.
`-RPLBOOT`	Sets the network boot protocol to RPL.
`-PXEBOOT`	Sets the network boot protocol to PXE.
`-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.

All other parameters will generate an error.

DOS Exit Codes

IBAUtil returns exit codes to the DOS environment. Possible exit codes are listed below:

Code Name	Value
success	0
bad command line parameter	1
no supported adapters found	2
invalid adapter selected	3
flash update operation failed	4
EEPROM read failure	5
EEPROM write failure	6
boot image missing or corrupt	7
IBA_OPERATOR_TERMINATION	8
LOM device not supported	9
network port not bootable	10
nic flash disabled	11
nic flash too small	12
boot protocol not supported on adapter	13
RPL not supported on adapter	16
PXE not supported on adapter	17

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 Update the Boot Agent image on all network adapters, enter:

IBAUTIL -ALL -UPGRADE

Example 2:

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

IBAUTIL -NIC=1 -FE

Example 3:

To disable the flash ROM on all network adapters, enter:

IBAUTIL -ALL -FD

Example 4:

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

IBAUTIL -NIC=2 -WOLENABLE

Last modified on 9/19/05 2:55p Revision 7

	CAUTION: If you use a third-party (non-Intel) boot ROM solution with an adapter and run Boot Agent utilities, you may erase or replace the contents of your flash ROM.
	NOTES: IBAUtil (for DOS) must be run with the computer booted to DOS only. The Boot Agent column in IBAUtil only displays the Boot Agent version when Boot Agent is enabled.