iSCSI DOS Utility

iSCSIUtl is a DOS utility for programming the Intel® iSCSI Boot firmware on iSCSI boot-capable adapters.

NOTE: Updating the adapter's flash ROM using iSCSIUtl will erase any existing Intel Boot Agent image from the flash ROM.

iSCSIUtl without command line parameters will display a list of all iSCSI boot-capable adapters in the system. In order to maintain versions of the firmware, Intel iSCSI Boot requires all adapters in the system to have the same version of the firmware.

iSCSIUtl is located on the software installation CD in the \APPS\iSCSI\iSCSIUtl directory. Always check the Intel Customer Support (http://support.intel.com) website for the latest Intel iSCSI Boot information and component updates. Enter "iSCSI Boot" in the search field.

For more information on iSCSIUtl see the document iscsiutl.txt located in the \APPS\iSCSI\iSCSIUtl directory of the software installation CD.


Running iSCSIUtl

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

ISCSIUTL [-option]...
NOTES:
  • iSCSIUtl must be run with the computer booted to DOS only.

  • Rebooting is required after executing iSCSIUtl to make adapter's settings valid.



Command Line Parameters

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

The parameters, 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 ISCSIUTL 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 Intel iSCSI Boot firmware version stored within iSCSIUtl. When -IMAGEVERSION is set, all other parameters except -EXITCODES and -HELP are ignored.
Adapter Selection Options
Parameter Description
-ALL Selects all Intel iSCSI Boot-capable adapters found in system.
-NIC=XX Selects a specific adapter (1-16). Not valid with use of -UP parameter.
Image Programming Options
Parameter Description
-UP
Programs the Intel iSCSI Boot image into the flash of all iSCSI-capable ports in the system. If programming with the -ALL command, the preexisting flash in network adapters will be overwritten.  If -AUTO or -QUIET is not specified, the user is prompted to write over the existing image before upgrading.
Utility Options
Parameter Description
-AUTO or -QUIET Runs iSCSIUtl without asking for user intervention. This parameter must be used with -NIC or -ALL if there is more than one adapter in the system. It will run without -ALL or -NIC=xx if there is only one adapter 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 flash ROM access for Option ROM.
-FLASHDISABLE or -FD Disables flash ROM access for Option ROM.
EEPROM Settings Options
Parameter Description
-WOLDISABLE or -WOLD                    Disables wake and PME bit in EEPROM.
-WOLENABLE or -WOLE                    Enables wake and PME bit in EEPROM.
Save/Restore Options
Parameter Description
-SAVE                   Saves iSCSI Boot settings in the EEPROM to a disk file on the selected iSCSI-capable port. Need to specify a file name by -FILE parameter.

WARNING: For security reasons it is recommended that CHAP settings are disabled when using save/restore.

-RESTORE                    Restores previously saved iSCSI Boot settings on the selected iSCSI-capable port. Need -FILE parameter to specify the saved data.
-FILE Specifies a file name for -SAVE or -RESTORE parameters by –FILE = [filename].

All other parameters will generate an error.


Examples

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

Example 1:

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

ISCSIUTL -ALL -UP

If iSCSIUtl finds any adapter with a pre-installed Intel Boot Agent image, you will be prompted whether you want to erase the image and replace it with Intel iSCSI Boot. Type Y (yes) to erase the pre-installed image and install Intel iSCSI Boot.

Example 2:

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

ISCSIUTL -NIC=1 -FLASHENABLE

Example 3:

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

ISCSIUTL -ALL -FD

Example 4:

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

ISCSIUTL -NIC=2 -WOLENABLE

Example 5:

To get help, enter:

ISCSIUTL -?


DOS Exit Codes

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


Code Name Value
All iSCSIUtl operations completed successfully 0
Bad command line parameter 1
No supported PCI network adapters detected 2
Invalid adapter selected 3
FLASH operation failed 4
EEPROM read operation failed 5
EEPROM write operation failed 6
Image is missing or corrupt 7
Operator termination 8
LOM not supported for selected operation 9
Network adapter port is not bootable 10
Network adapter FLASH memory is disabled 11
FLASH memory too small for selected image 12
Boot protocol not supported on adapter 13
Selected boot protocol is not supported 16
Network adapter does not support iSCSI 14


Last modified on 1/04/07 3:10p Revision 6