1. PEAK876-877_LAN.zip Driver
2. iscsiutl.txt File Contents

iscsiutl.txt Driver File Contents (PEAK876-877_LAN.zip)

Intel(R) iSCSI Remote Boot Utility
==================================

Nobember 5, 2009

CONTENTS
========
- DISCLAIMER
- INTRODUCTION
- RUNNING iSCSIUtl
- COMMAND LINE OPTIONS
- EXAMPLES
- EXIT CODES


DISCLAIMER
==========
This ISCSIUTL.TXT as well as the software described in it is furnished under
license and may only be used or copied in accordance with the terms of the
license. The information in this manual is furnished for informational
use only, is subject to change without notice, and should not be construed
as a commitment by Intel Corporation. Intel Corporation assumes no
responsibility or liability for any errors or inaccuracies that may appear
in this document or any software that may be provided in association with
this document.

Except as permitted by such license, no part of this document may be
reproduced, stored in a retrieval system, or transmitted in any form or
by any means without the express written consent of Intel Corporation.


INTRODUCTION
============
Intel(R) iSCSI Remote Boot Utility (iSCSIUtl) is a DOS utility used to program
the PCI option ROM on the flash memory of supported Intel PCI-Express-based 
network adapters and to update configurations. iSCSIUtl is particularly 
designed for IA32/EM64T server platforms, and does not support value and mobile
network devices.

NOTE: Updating the adapter's flash memory using iSCSIUtl will erase any existing
flash firmware images from the flash memory, such as Intel(R) Boot Agent (PXE) 
or the UEFI network driver.

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 flash 
firmware, Intel(R) iSCSI Remote Boot requires all the adapters in the system
to have the same version of the flash firmware. iSCSIUtl is also able
to upgrade the flash firmware of any versions from the FLB format file
by using the -UPDATE option.

iSCSIUtl without command line options will display a list of all supported
Intel network ports in the system. iSCSIUtl will also allow the user to enable
or disable the flash memory on specific ports by using -FLASHENABLE or
-FLASHDISABLE option in order to control access to the flash firmware from
the system.

iSCSIUtl allows the user to individually set iSCSI boot configurations 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 or
http://www.intel.com/support/network/iscsi/remoteboot/) website
for the latest information and component updates.


RUNNING iSCSIUtl
================
The syntax for issuing iSCSIUtl command line options is:

ISCSIUTL -[OPTION] or -[OPTION]=[VALUE]

NOTE: iSCSIUtl must be run with the computer booted to DOS only. Rebooting is
required after executing iSCSIUtl to make updated settings valid.


COMMAND LINE OPTIONS
====================
iSCSIUtl accepts one executable option and its associated non-executable
options in an execution. If conflicting executable options (such as 
-FLASHENABLE and -UPDATE used together) are supplied, ISCSIUTL exits with an
error.

The options, where applicable, are listed in logical groups.

NOTE: If you run iSCSIUtl without any command line options, the utility
displays a list of all supported Intel network ports found in the system.

GENERAL OPTIONS:
    -HELP or -?
      Displays a list of command line options.
    -EXITCODES
      Displays exit codes returned to the OS environment by iSCSIUtl.
    -IMAGEVERSION or -IV
      Displays flash firmware types and version numbers from a resource image.
      If used by itself, the resource is the iSCSIUtl embedded image.
      If used with the -FILE option, the resource image is in the FLB file.
      If used with the -NIC option, the resource image is in the adapter flash.
      If used with the -ALL option, each resource image is continuously
      displayed for all adapters.
    -E
      Enumerates all supported network ports in the system.
    -O=[FILENAME]
      Redirects all text output to [FILENAME] file for the -E option.
    -I=[FILENAME]
      Reads iSCSI boot configuration options from [FILENAME] script file and
      program settings on the selected port.
    -FILE=[FILENAME]
      Specifies the file name for -SAVEIMAGE, -RESTOREIMAGE, -SAVECONFIG or
      -RESTORECONFIG option.

POWER MANAGEMENT OPTIONS:
    -WOLENABLE or -WOLE
      Enables Wake On Lan (WOL) functionality on the selected port.
    -WOLDISABLE or -WOLD
      Disables Wake On Lan (WOL) functionality on the selected port.

ADAPTER SELECTION OPTIONS:
    -ALL
      Selects all supported network ports found in the system.
    -NIC=XX
      Selects a specific network port in the system. If used without any
      executable option, it prints the iSCSI boot configuration of the
      selected port, or saves it in the file when the -O option is used.
    -BLINK
      Blinks the LED on the selected port for ten seconds.

ADAPTER FLASH ENABLE/DISABLE OPTIONS:
    -FLASHENABLE or -FE
      Enables the capability to run the flash firmware on the selected adapter.
    -FLASHDISABLE or -FD
      Disables the capability to run the flash firmware on the selected adapter.

FLASH PROGRAMMING OPTIONS:
    -UP
      Programs the Intel iSCSI Option ROM into the flash memory of
      all supported network adapters in the system. The pre-existing flash
      firmware image in the flash memory of the adapters will be overwritten.
      If -QUIET is not specified, the user is prompted to confirm overwriting
      the existing flash firmware image before upgrading.
    -UPDATE=[FILENAME]
      Updates the flash memory of the adapter specified by the -NIC option with
      the given FLB flash firmware image file.
    -SAVEIMAGE
      Saves the existing flash firmware image in the flash memory of the adapter
      specified by the -NIC option to a disk file. The destination file is
      specified by the -FILE option.
    -RESTOREIMAGE
      Restores a previously-saved flash firmware image to the same network
      adapter using the -NIC option.
     The source file is specified by the -FILE option.
    -QUIET
      Runs iSCSIUtl without confirmation prompts. This option is used with
      -IMAGEVERSION, -UP, -UPDATE, -RESTOREIMAGE, or -HELP option.

ISCSI BOOT CONFIGURATION OPTIONS:
    -SAVECONFIG
      Saves a snapshot of iSCSI boot configurations on the selected port to a
      binary file. Need to specify the file name by the -FILE option.
      WARNING: For security reasons it is recommended that CHAP settings are
      disabled when using this option.
    -RESTORECONFIG
      Restores previously-saved iSCSI boot configuration snapshot on the
      selected port. Need the -FILE option to specify the saved data.
      WARNING: This feature may create multiple primary or secondary ports if
      the same command is issued to multiple ports. Review the boot priority
      setting in the iSCSI setup menu for the next system boot.
    -EXPANSIONROMMENU=[ENABLE or DISABLE]
      Enable or disable "CTRL-D" setup menu.

PORT CONFIGURATION OPTIONS FOR ISCSI INITIATOR:
    These options can either be used individually with the -NIC=XX option,
    or in a script file with the -I option. The value is specified in
    -[OPTION]=[VALUE] format.
    -INITIATORNAME
      Specifies the iSCSI Qualified Name (IQN) for the initiator.
    -INITIATORIP
      Specifies the initiator IPv4 address in dotted decimal notation.
    -INITIATORDHCP
      Enables or disables DHCP client for the initiator.
    -NETMASK
      Specifies the initiator subnet mask in dotted decimal notation.
    -GATEWAY
      Specifies the gateway IPv4 address in dotted decimal notation.
    -BOOTPRIORITY
      Specifies iSCSI boot priority as PRIMARY, SECONDARY or DISABLE.
    -CONNWAITTIME
      Specifies the timeout value in second for ARP.

ISCSI TARGET CONFIGURATION OPTIONS:
    These options can either be used individually with the -NIC=XX option,
    or in a script file with the -I option. The value is specified in
    -[OPTION]=[VALUE] format.
    -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. The value is specified in
    -[OPTION]=[VALUE] format.
    -AUTHENTICATIONMETHOD
      Specifies either NONE, CHAP or MUTUALCHAP.
    -CHAPUSERNAME
      Specifies CHAP user name
    -CHAPSECRET
      Specifies a secret text string to go with the CHAP user name.
    -MUTUALCHAPSECRET
      Specifies the reverse (target) CHAP secret text string.

The CHAP Authentication feature of this product requires the following
acknowledgements:
This product includes cryptographic software written
by Eric Young (eay@cryptsoft.com).
This product includes software written by Tim Hudson (tjh@cryptsoft.com).
This product includes software developed by the OpenSSL Project for use in
the OpenSSL Toolkit. (http://www.openssl.org/)


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

Example 1:
To enable the flash firmware on the first network adapter for the system to be
capable of executing the flash firmware.
    ISCSIUTL -NIC=1 -FLASHENABLE

Example 2:
To disable the flash firmware on all the network adapters.
    ISCSIUTL -ALL -FD

Example 3:
To display ISCSIUTL embedded flash firmware versions.
    ISCSIUTL -IMAGEVERSION

Example 4:
To update the Intel iSCSI Option ROM on all the network adapters in the system.
    ISCSIUTL -UP -ALL

Example 5:
To update the flash memory with FLB flash firmware image file to the fourth
network adapter.
    ISCSIUTL -NIC=4 -UPDATE=ISCSI.FLB

Example 6:
To get help descriptions.
    ISCSIUTL -?

Example 7:
To enable DHCP for the iSCSI initiator on all the network ports in the system.
    ISCSIUTL -INITIATORDHCP=ENABLE -ALL

Example 8:
To load the iSCSI boot configurations from a text script file to the first
network port.
    ISCSIUTL -I=CONFIG.TXT -NIC=1


EXIT CODES
==========
iSCSIUtl returns an exit code to the OS environment. Possible exit codes are
listed below:

Code Name                                      Value
----------------------------------------------+-----
All iSCSIUtl operations completed successfully   0
Bad command line parameter                       1
No supported network port detected               2
Invalid network port selected                    3
FLASH operation failed                           4
EEPROM read operation failed                     5
EEPROM write operation failed                    6
File content is missing or corrupt               7
Operator termination                             8
LOM not supported for selected operation         9
Network port is not bootable                    10
FLASH memory is disabled for flash firmware     11
FLASH memory too small for selected firmware    12
Programming iSCSI boot configurations failed    13
System memory allocation failed                 14
File operation failed                           15