Intel® iSCSI Network Adapter FLASH Upgrade Utility

Introduction

Intel iSCSI Network Adapter Boot Configuration Utility (iSCSIUtl) is a DOS utility for modifying iSCSI boot configuration settings and upgrading firmware in the flash memory on iSCSI boot-capable Intel network 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 options will display a list of all iSCSI boot-capable Intel network adapters in the system. iSCSIUtl will also allow the user to enable or disable Intel iSCSI Boot firmware on specific port by using -FLASHENABLE or -FLASHDISABLE option.

When run with the -UP option, iSCSIUtl will upgrade the flash memory of all the adapters in the system. In order to maintain versions of the firmware, Intel iSCSI Boot requires all the adapters in the system to have the same version of the firmware. iSCSIUtl is also able to upgrade the firmware of any versions from the FLB format file by using the -UPDATEFILE option.

iSCSIUtl allows the user to individually configure each setting option by -NIC=xx -[OPTION]=[VALUE] options, or multiple options in a script file by the -I option.

iSCSIUtl is located on the software installation CD in the \APPS\iSCSI\iSCSIUtl directory. 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.


Running iSCSIUtl

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

iSCSIUtl -[OPTION] or -[OPTION]=[VALUE]
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 Options

iSCSI Configuration Utility 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 a list of options.
-EXITCODES Displays exit codes returned to the OS by iSCSIUtl.
-E Enumerates all iSCSI boot-capable ports in the system.
-O=[FILENAME] Redirects configuration output to [FILENAME] text file.
-I=[FILENAME] Reads iSCSI boot configuration options from [FILENAME] script file and program settings on the selected port.
-IMAGEVERSION or -IV Displays the version number of Intel iSCSI Boot firmware stored within iSCSIUtl.
Flash Programming Options
Parameter Description
-UP
Programs the Intel iSCSI Boot firmware into the flash memory of all iSCSI-capable ports in the system. If programming with the -ALL option, the pre-existing PXE/RPL firmware in the flash memory of the adapters will be overwritten. If -QUIET is not specified, the user is prompted to write over the existing firmware before upgrading.
-UPDATEFILE=[FILENAME] Updates the flash memory with Intel iSCSI boot firmware from a given FLB format file.
-QUIET Runs iSCSIUtl without confirmation prompts. This option is used with the -UP or -RESTORE option.
Configuration Options  
Parameter Description
-SAVE                   Saves a snapshot of iSCSI boot configurations on the selected port to a binary file. Need to specify the file name by -FILE parameter.

WARNING: For security reasons it is recommended that CHAP settings are disabled when using the -SAVE options.

-RESTORE                    Restores previously-saved iSCSI boot configuration snapshot on the selected port. Need -FILE parameter to specify the saved data.

WARNING: This feature may create multiple primary or secondary ports. Review the boot priority setting in the firmware setup for the next system boot.

Power Management Options  
Parameter Description
-WOLDISABLE or -WOLD Disables Wake On Lan (WOL) functionality on the selected port.
-WOLENABLE or -WOLE Enables Wake On Lan (WOL) functionality on the selected port.
Adapter Selection Options
Parameter Description
-ALL Selects all iSCSI-capable ports found in the system.
-NIC=XX Selects a specific iSCSI-capable port in the system. Invalid to use with the -UP parameter. If used without any other parameters, prints the configuration of the selected NIC.
-BLINK Blinks the LED on the selected port for ten seconds.
Adapter Flash Enable/Disable Options
Parameter Description
-FLASHENABLE or -FE Enables the flash memory on the selected port. At least one iSCSI-capable port in the system must be enabled in order to execute Intel iSCSI Boot firmware.
-FLASHDISABLE or -FD Disables the flash memory on the selected port. The flash memory must be disabled on all adapters in the system to disable Intel iSCSI Boot firmware during system start up.

Port Configuration Options for Initiator

These options can either be used individually with the -NIC=XX option, or in a script file with the -I option.

-[OPTION]=[VALUE]

Description

-INITIATORNAME Specifies the iSCSI Qualified Name (IQN) for the initiator.
-INITIATORIP Specifies the initiator IPv4 address in dotted decimal notation.
-INITIATORDHCP ENABLE or DISABLE 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 whether the selected port is primary, secondary, or disabled.

Port Configuration Options for Target

These options can either be used individually with the -NIC=XX option, or in a script file with the -I option.

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

These options can either be used individually with the -NIC=XX option, or in a script file with the -I option.

-[OPTION]=[VALUE]

Description

-AUTHENTICATIONMETHOD Specifies either NONE or CHAP.
-CHAPUSERNAME Specifies CHAP user name.
-CHAPSECRET Specifies a password to go with the CHAP username.



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

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

Example 6:

Command to load the iSCSI boot configurations from a text script file:

ISCSIUTL -I CONFIG.TXT -ALL

Example 7:

Command to enable DHCP on the first Intel adapter:

ISCSIUTL -NIC=1 -INITIATORDHCP=ENABLE


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 11/27/07 9:57a Revision 13