Broadcom Offline and Online AdapterManagement UtilitiesVersion 10.2 User Guide

Broadcom Offline and Online AdapterManagement UtilitiesVersion 10.2 User Guide
Offline and Online Adapter
Management Utilities
Version 10.2
User Manual
P010071-01A Rev. A
Emulex Connects™ Servers, Storage and People
2
Copyright © 2003-2014 Emulex. All rights reserved worldwide. No part of this document may be reproduced by any
means or translated to any electronic medium without the prior written consent of Emulex.
Information furnished by Emulex is believed to be accurate and reliable. However, no responsibility is assumed by
Emulex for its use; or for any infringements of patents or other rights of third parties which may result from its use. No
license is granted by implication or otherwise under any patent, copyright or related rights of Emulex.
Emulex, the Emulex logo, AutoPilot Installer, AutoPilot Manager, BlockGuard, Connectivity Continuum,
Convergenomics, Emulex Connect, Emulex Secure, EZPilot, FibreSpy, HBAnyware, InSpeed, LightPulse, MultiPulse,
OneCommand, OneConnect, One Network. One Company., SBOD, SLI, and VEngine are trademarks of Emulex. All
other brand or product names referenced herein are trademarks or registered trademarks of their respective
companies or organizations.
Emulex provides this manual "as is" without any warranty of any kind, either expressed or implied, including but not
limited to the implied warranties of merchantability or fitness for a particular purpose. Emulex may make
improvements and changes to the product described in this manual at any time and without any notice. Emulex
assumes no responsibility for its use, nor for any infringements of patents or other rights of third parties that may
result. Periodic changes are made to information contained herein; although these changes will be incorporated into
new editions of this manual, Emulex disclaims any undertaking to give notice of such changes.
Emulex, 3333 Susan Street
Costa Mesa, CA 92626
Note: References to OCe11100 series products also apply to OCe11100R series products.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
Table of Contents
Table of Contents
1. Introduction .....................................................................................8
Offline Adapter Management Utility............................................................... 8
Online Adapter Management Utility ............................................................... 9
Key Capabilities........................................................................................ 9
Command Syntax .................................................................................... 10
Supported Platforms................................................................................ 11
Abbreviations ........................................................................................ 11
2. Installation..................................................................................... 13
Platform Prerequisites ............................................................................. 13
Linux ...............................................................................................13
Offline Adapter Management Utility .............................................................. 13
Offline Adapter Standalone Management Utility................................................ 13
Online Adapter Management Utility .............................................................. 13
Offline Adapter Management Utility - NIC Only ................................................. 13
Windows ...........................................................................................14
FreeBSD ...........................................................................................14
Installing the Offline Adapter Management Utility for Linux ............................... 14
Updating...........................................................................................14
Uninstalling .......................................................................................15
Extracting the Online Adapter Management Utility for Linux.............................. 15
Updating...........................................................................................15
Uninstalling .......................................................................................15
Installing the Offline Adapter Management Utility for Linux (NIC Only) ................. 16
Updating...........................................................................................16
Uninstalling .......................................................................................16
Installing the Offline Adapter Management Utility for Windows PE....................... 16
Updating...........................................................................................17
Uninstalling .......................................................................................17
Extracting the Online Adapter Management Utility for Windows ......................... 17
Updating...........................................................................................17
Uninstalling .......................................................................................17
Extracting the Driver Files from the Offline Adapter Management
Utility for Windows ................................................................................. 18
Extracting the Offline Adapter Standalone Management
Utility (Linux and Windows PE)................................................................... 18
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
3
Table of Contents
Offline Adapter Management Utility Installation for FreeBSD.............................. 19
Updating...........................................................................................19
Uninstalling .......................................................................................20
Firmware and Boot Code .......................................................................... 20
3. Adapter Management Utility Command Line Interface ............................... 21
Auto-Discovery (/auto) ............................................................................. 21
Downgrade (/downgrade or /g) ................................................................... 22
Force Firmware and Boot Code (/f or /ff /fb) ................................................. 23
Force Boot Code (/fb) .............................................................................. 24
Force Firmware (/ff)................................................................................ 25
Firmware Matrix Directory Change (/fmd) ..................................................... 26
Firmware Flash Override (/fo).................................................................... 26
Help (/h or /?) ........................................................................................ 27
Image Directory Change (/id) ..................................................................... 27
Image Version Display (/iv) ........................................................................ 28
Log (/log) .............................................................................................. 28
Preview (/p) .......................................................................................... 28
Process FC HBAs Only (/fc) ........................................................................ 29
Process UCNAs and CFAs (/ucna) ................................................................. 30
Query (/q)............................................................................................. 30
Ramdrive (/ramdrive) - (Windows Offline Adapter Management Utility only) .......... 31
Remote (/remote) - (Online Adapter Management Utility only) ........................... 31
Rewrite (/rewrite or /e)............................................................................ 31
Silent (/s).............................................................................................. 33
Discover UCNAs using SysFS (/sysfs) ............................................................. 33
Update (/update) .................................................................................... 34
Verbose (/v) .......................................................................................... 35
VPD (/vpd) ............................................................................................ 36
XML Output (/xml) .................................................................................. 37
4. Offline Adapter Management Utility Command Line Interface ..................... 38
Running the Offline Adapter Management Utility from the Command Prompt ......... 38
Running the Standalone Adapter Management Utility ....................................... 39
Windows ...........................................................................................39
Linux ...............................................................................................40
Supported Commands .............................................................................. 42
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
4
Table of Contents
Viewing the Syntax for Commands (help or ?)...............................................44
Resetting an Adapter (reset)...................................................................45
Running the Power-On Self-Test (posttest) ..................................................45
Viewing Adapter Information ..................................................................... 45
Viewing Emulex Conventional Names Instead of VPD (- /c)...............................45
Viewing the Offline Adapter Management Utility
Version Information (version) ..................................................................46
Viewing VPD ......................................................................................46
Viewing Boot Device Information (readbootdevice) ........................................47
Viewing BootBIOS Versions (listboot) .........................................................47
Viewing Adapter Attributes (hbaattr) ........................................................47
Viewing All Adapters in the System (listhba) ................................................48
Viewing the WWN of All Adapters in the System (listwwn) ...............................49
Viewing the MAC Address (listmac) ...........................................................49
Viewing Firmware Program Revisions (listrev) ..............................................50
Viewing Selected Configuration Regions (readconfig) .....................................50
Firmware and Boot Code Download Commands............................................... 51
Downloading a File (download) ................................................................51
Accessing the Flash Device Directly (directdownload) .....................................51
World Wide Name Commands..................................................................... 52
Writing WWN and Updating NVPARMS (writewwn) .........................................52
Saving WWN data to a file (savewwn) ........................................................53
Restoring WWN and Updating NVPARMS (restorewwn).....................................53
Restoring NVPARMS (restorenvwwn) ..........................................................53
Restoring the IEEE address (restoredefwwn) ................................................54
Boot Code Commands .............................................................................. 54
Enabling or Disabling BootBIOS or Boot Code (enableboot/disableboot) ...............54
Selecting a Boot Device (setbootdevice) .....................................................55
Enabling or Disabling Boot Devices (enablebootdevice/disablebootdevice)............55
Read All Alternative Boot Devices (readaltboot) ...........................................55
Selecting One or More Alternate Boot Devices (setaltboot)...............................56
Configuration Commands .......................................................................... 57
Updating Configuration Regions (config) .....................................................57
Update by Name ..................................................................................... 57
Update by Number................................................................................... 57
Viewing Personality Information (personalityInfo) ........................................... 58
Changing Personality Information (changePersonality) ..................................... 58
Running Tests ........................................................................................ 59
Running the External Loopback Test (extloopback) ........................................59
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
5
Table of Contents
Running the Internal Loopback Test (intloopback) .........................................60
Running the PCI Loopback Test (pciloopback) ..............................................60
Running the DMATest............................................................................61
Using Script Files .................................................................................... 61
Creating Script Files .............................................................................61
Script File Commands ...........................................................................62
Repeating a Series of Commands (repeat) ....................................................... 62
Enabling or Disabling Test Messages on the Screen (screendisplay) ......................... 62
Updating Non-volatile WWNN (scriptwwnn) ..................................................... 63
Updating Non-volatile WWPN (scriptwwpn) ..................................................... 63
Updating Volatile WWNN (scriptvwwnn) ......................................................... 64
Updating Volatile WWPN (scriptvwwpn) ......................................................... 65
Creating a Log (logfile) .........................................................................65
5. Offline and Online Adapter Management Utility Status Messages .................. 68
6. Offline LPCfg Error Codes .................................................................. 70
7. Troubleshooting .............................................................................. 73
Unsupported Driver ................................................................................. 73
Updating Adapters without Boot Code .......................................................... 73
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
6
List of Tables
List of Tables
Table 4-1
Table 5-1
Table 6-1
Supported Commands for the Offline Adapter Management Utility...............42
Elxflash Status Messages .................................................................68
LPCfg Error Codes .........................................................................70
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
7
1. Introduction
Offline Adapter Management Utility
1. Introduction
This document explains how to use the adapter management utility kits for Linux and
Windows pre-boot environments (offline management), as well as, the FreeBSD
operating system.
You can also use adapter management utility kits for production environments referred
to as the online adapter management utility.
Offline Adapter Management Utility
The Offline Adapter Management Utility kits allow you to configure Emulex® adapters
before you install or boot a server operating system. You can also use a Standalone
Offline Adapter Management utility, which allows you to update firmware on Emulex
adapters without needing to install any tools. See “Running the Standalone Adapter
Management Utility” on page 39 for more information.
The offline utility includes:



winlpcfg/Elxflash for Windows
linlpcfg/Elxflash for Linux
linlpcfg/Elxflash for FreeBSD
The winlpcfg and the linlpcfg are management utilities for adapter configuration and
diagnostics for Windows and Linux respectively. linlpcfg is also used for the FreeBSD
operating system. The lpcfg utility can also download firmware, but you must
manually select which adapters to update.
Elxflash is a firmware download utility. When the /auto switch is used, Elxflash
automatically chooses the "best" image to download. When the fwmatrix.txt file is used,
you choose which images to apply to adapters.
Additionally, Linux has an offline utility for network interface card (NIC) adapters
only. This utility uses operating system-provided features and utilities to discover
Universal Converged Network Adapters (UCNAs) and download firmware. This
utility relies on the inbox driver for supported distributions and only supports UCNAs.
See “Offline Adapter Management Utility - NIC Only” on page 13 for more
information.
Note: The Offline Adapter Management utility, except for the standalone version,
must be installed on your system before you can run it. While the standalone
utility does not need to be installed before it is run, you must go to the directory
into which the standalone utility was extracted and run it from the command
prompt.
See “Offline Adapter Management Utility Command Line Interface” on page 38 for
further information on the offline utility.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
8
1. Introduction
Online Adapter Management Utility
Online Adapter Management Utility
The Online Adapter Management Utility uses a command line interface allowing you
to build scripts for automated and unattended firmware and boot code download
solutions for Emulex LightPulse® Fibre Channel (FC) host bus adapters (HBAs),
LightPulse® FC and Fibre Channel over Ethernet/network interface card (FCoE/NIC)
Converged Fabric Adapters (CFAs), and OneConnectTM UCNAs that are in production
systems. You can also download firmware and boot code on local and remote machines
simultaneously. The Standalone Adapter Management utility, which allows you to
update firmware on Emulex adapters without needing to install any tools, is also
available. See “Running the Standalone Adapter Management Utility” on page 39 for
more information.
The Online Adapter Management Utility uses auto-discovery (/auto) so you do not
need to maintain the fwmatrix.txt configuration file. When auto-discovery is invoked,
the utility automatically discovers local adapters and performs selected operations such
as: /ff (force firmware), /fb (force boot), /update, /downgrade, and /rewrite.
When using auto-discovery you must populate the firmware and boot subdirectories
with image files for specific adapter models. Auto-discovery requires the use of Emulex
defined firmware and boot code file names in their respective directories.
If you do not want to use auto-discovery, the Online Adapter Management Utility can
update the firmware or boot code of an adapter using the fwmatrix.txt configuration
file. When using the fwmatrix.txt file, you must update each supported adapter's type,
firmware, and boot code entries and place the corresponding firmware and boot code
images into their respective directories. The fwmatrix.txt file enables all operations that
are used with auto-discovery.
Note: Unlike the offline utility, you do not install the online utility; you extract it.
Once extracted, you must go to the directory into which the online utility was
extracted and run it from the command prompt.
Key Capabilities
Key capabilities include the following functionality that are available on all versions of
the utility unless otherwise indicated:



Auto-discovers adapters and does not use the fwmatrix.txt configuration file.
Downgrades firmware or boot code if the downgrade version is older than the
version that is currently installed on an adapter.
Forces a boot code download on an adapter.
Note: /fb is not available in the ElxflashOfffline_NIC_Only kit.

Processes FC HBAs only.
Note: This functionality is not available in the ElxflashOfffline_NIC_Only
kit.

Forces a firmware download on an adapter.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
9
1. Introduction
Command Syntax

Uses the flash file on supported UCNAs.
Note: This functionality is available for Elxflash Offline and Elxflash
Standalone only.








Changes the base directory where fwmatrix.txt is located.
Provides online help.
Changes the base directory where the firmware and boot code directories are
located.
Displays an image file's version.
Appends the output of the Adapter Management Utility to a log file.
Previews a download of firmware or boot code and allows you to preview the
actions Elxflash will take given additional switches.
Prints a query.
Allows the temp path to be changed.
Note: This functionality is available for Elxflash Offline and Elxflash
Standalone for Windows only.

Discovers remote HBAs and allows remote download support.
Note: This functionality is available for Elxflash Online only.







Explicitly re-flashes the firmware or boot code on an adapter if the rewrite
version is the same as or more recent than the version currently installed on the
adapter.
Prevents all output from being displayed on a standard output device..
Processes UCNAs only.
Updates firmware or boot code if the update version is greater than the version
currently installed on an adapter.
Displays detailed messages.
Displays the VPD model name, instead of the Emulex model name, on
supported adapters.
Displays utility output in xml format.
Command Syntax
In all cases, the commands are given with the prefix os. When you enter any command,
you must replace os with either:


win – for the WinPE Offline Adapter Management Utility commands, for use on
WinPE machines.
./lin – for the Linux Offline Adapter Management Utility commands, for use on
Linux and FreeBSD machines.
The Offline Adapter Management Utility commands are not case-sensitive, nor are
their arguments. You can enter them in upper, lower, or mixed case. However, for
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
10
1. Introduction
Supported Platforms
Linux operating systems, Emulex recommends using linlpcfg (all lowercase) for the
Offline Adapter Management Utility commands (for example, ./linlpcfg listhba).
The Offline Adapter Management Utility commands require both:


One space between the command name and the first argument.
One space between additional arguments.
Note: Do not put a space before or after the equal sign within an argument.
WWN values are reported and specified with two 4-byte hexadecimal words – WWN
word 0 (w0) and WWN word 1 (w1). Concatenate the w0 and w1 values to make the
full WWN.
For detailed information on using the command line interface, see chapter 3., “Adapter
Management Utility Command Line Interface,” on page 21 and chapter 4., “Offline
Adapter Management Utility Command Line Interface,” on page 38.
Supported Platforms
The online and offline applications can be used on Windows and Linux, or as a
standalone utility for Window and Linux. FreeBSD supports Elxflash Offline.
For supported adapters, and supported versions of operating systems and platforms,
see the Emulex website.
Abbreviations
BIOS
basic input-output system
CFA
Converged Fabric Adapter
CNA
Converged Network Adapter
DUD
driver update disk
EFI
Extensible Firmware Interface
EROM
erasable read-only memory
FC
Fibre Channel
FCoE
Fibre Channel over Ethernet
F/W
firmware
HBA
host bus adapter
hex
hexidecimal
IEEE
Institution of Electrical and Electronics Engineers
GUI
graphical user interface
iSCSI
internet Small Computer System Interface
LUN
logical unit number
MAC
media access control
MILI
Management Interface Library
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
11
1. Introduction
Abbreviations
NIC
network interface card (or controller)
PCI
peripheral controller interface
PCI_ID
PCI device identification number
POST
power-on self-test
ROM
read-only memory
SAN
storage area network
UCNA
Universal Converged Network Adapter
VPD
vital product data
WWN
world wide name
WWNN
world wide node name
WWPN
world wide port name
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
12
2. Installation
Platform Prerequisites
2. Installation
Platform Prerequisites
Linux
The Linux platform requires additional software, such as libraries, to run the different
versions of the Offline/Online utility. This section provides the prerequisites.
Note: The Linux driver must be installed on the system for the Elxflash applications to
work properly.
Offline Adapter Management Utility

libnl library
Offline Adapter Standalone Management Utility


libnl library
libsysfs
Online Adapter Management Utility

OneCommand Manager core or enterprise kit
Offline Adapter Management Utility - NIC Only
RHEL 5.6 and later



Inbox NIC driver
ethtool
libsysfs
RHEL 6.1, RHEL 7.0 and later




Inbox NIC driver
ethtool
libsysfs
pcutils-libs
SLES 11 SP1 and later




Inbox NIC driver
ethtool
sysfsutils
pcituils
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
13
2. Installation
Installing the Offline Adapter Management Utility for Linux
CentOS 6.1 and later




Inbox NIC driver
ethtool
libsysfs
pcutils-libs
Windows
There are no prerequisites for Windows.
FreeBSD
The FreeBSD platform requires additional software, such as libraries, to run the
different versions of the Offline utility. These prerequisites are listed below and
provided by the operating system.




libstdc++
libm
libc
libgcc
Note: BASH is required to run the install and uninstall scripts. If it is not installed, you
must install the BASH package, which is part of the FreeBSD distribution.
Installing the Offline Adapter Management Utility for
Linux
The Offline Adapter Management utility for Linux uses an install script to install the
utility. The install script determines the correct architecture and distribution and
updates the existing ElxflashOffline and Elxlinlpcfg files. If there are no existing
ElxflashOffline or Elxlinlpcfg files, the install script installs the packaged
ElxflashOffline and Elxlinlpcfg files.
To install the Offline Adapter Management utility for Linux:
1. Untar the installation tarball.
2. Run the install script located on the root of the installation kit.
Example:
$ tar zxvf elxflashOffline-<platforms>-<version>-<rel>.tgz
$ cd elxflashOffline-<platforms>-<version>-<rel>
$ ./install.sh
Updating
To update an existing Offline Adapter Management utility for a Linux installation, run
the install.sh script to update the ElxflashOffline and Elxlinlpcfg files.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
14
2. Installation
Extracting the Online Adapter Management Utility for Linux
Uninstalling
The Offline Adapter Management utility for Linux uses an uninstall script to uninstall
the utility. The uninstall script executes specific actions depending on the switches that
are used.


./uninstall.sh – Uninstalls ElxflashOffline and Elxlinlpcfg
./uninstall.sh -h – Displays a summary of all available switches
To uninstall the Offline Adapter Management Utility for Linux, run the uninstall script
located on the root of the installation kit.
Example:
$ cd elxflashOffline-<platforms>-<version>-<rel>
$ ./uninstall.sh
Extracting the Online Adapter Management Utility
for Linux
The Online Adapter Management utility for Linux uses a .tgz file that you extract into
an appropriate directory.
To extract the Online Adapter Management utility for Linux:
1. Untar the elxflashOnline tarball that matches the target architecture and operating
system.
2. Copy the elxflashOnline-<version>-<rel> directory to the directory you choose.
Example:
$ tar zxvf elxflashOnline-<platforms>-<version>-<rel>.tgz
$ cd elxflashOnline-<platforms>-<version>-<rel>/<arch>/<os>
Note: To run the Online Adapter Management Utility, you must install the
OneCommand Manager application and the adapter drivers. These components
are not included in the Online Adapter Management Utility - Linux Kit.
Updating
To update the Online Adapter Management utility for Linux, untar the new version of
the elxflashOnline tarball that matches the target architecture and operating system,
and delete the old version.
Uninstalling
To remove the Online Adapter Management utility for Linux, remove the
elxflashOnline-<platforms>-<version>-<rel> directory that was created during
extraction.
Example:
$ rm -rf elxflashOnline-<platforms>-<version>-<rel>
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
15
2. Installation
Installing the Offline Adapter Management Utility for Linux (NIC Only)
Installing the Offline Adapter Management Utility for
Linux (NIC Only)
The install script determines the correct architecture and distribution, and upgrades the
existing ElxflashOffline and Elxlinlpcfg files. If there are no existing ElxflashOffline or
Elxlinlpcfg files, the install script installs the packaged ElxflashOffline and Elxlinlpcfg
files.
To install the Offline Adapter Management utility for Linux (NIC only):
1. Untar the installation tarball.
2. Run the install script located in the root directory of the installation kit.
Example:
$ tar zxvf elxflashOffline_NIC Only-<platforms>-<version>-<rel>.tgz
$ cd elxflashOffline-<platforms>-<version>-<rel>
$ ./install.sh
Updating
To update the Offline Adapter Management utility for Linux (NIC only), run the
install.sh script to upgrade the ElxflashOffline file.
Uninstalling
To uninstall the Offline Adapter Management utility for Linux (NIC only), run the
uninstall script located in the root directory of the installation kit.
The uninstall script executes specific actions depending on the switches used.


./uninstall.sh – Uninstalls ElxflashOffline and Elxlinlpcfg
./uninstall.sh -h – Displays a summary of all available switches
Example:
$ cd elxflashOffline-<platforms>-<version>-<rel>
$ ./uninstall.sh
Installing the Offline Adapter Management Utility for
Windows PE
To install the Offline Adapter Management utility for Windows PE:
1. Unzip the Offline-WinPE-<version>-<rel>.zip.
2. Change the directory to the correct architecture subdirectory.
3. Run setupElxAll-<arch>.exe.
The following components are installed:


Storport UCNA driver
Storport Fibre Channel (FC) driver
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
16
2. Installation
Extracting the Online Adapter Management Utility for Windows


OneConnect iSCSI and NIC drivers
winLpCfg/Elxflash Offline
Note: The setupElxAll-<arch>.exe file is compatible only with WinPE. It does not
function with any version of Windows Server.
Updating
On an existing Windows PE Offline Adapter Management utility installation, run
Offline-WinPE-<arch>-<version>-<rel>.exe.
The installer uninstalls the existing version and then installs the updated version.
Uninstalling
To uninstall the Offline Adapter Management utility for Windows PE, run the
following commands:
X:\>cd "X:\ProgramData\Tarma Installer\{AE1F1CA1-B626-4447-9208-14607187EC3D}"
X:\>setup.exe /remove
Extracting the Online Adapter Management Utility
for Windows
To extract the Online Adapter Management utility for Windows:
1. Unzip the ElxflashOnline-windows-<version>-<rel>.zip file.
2. Copy the win32 or x64 directory to the location you choose.
Note: To run the Online Adapter Management Utility, you must install the
OneCommand Manager application and the adapter drivers. These components
are not included in the Online Adapter Management Utility for Windows.
Updating
To update the Online Adapter Management utility for Windows, unzip the new
version and delete the old version.
Uninstalling
To uninstall the Online Adapter Management utility for Windows, remove the win32
or x64 directory that was created during installation.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
17
2. Installation
Extracting the Driver Files from the Offline Adapter Management Utility for Windows
Extracting the Driver Files from the Offline Adapter
Management Utility for Windows
To extract the driver files from the offline adapter management utility files, you can use
the installer or the command line. When extracting these files, all files, both x64 and
x86, are extracted to <Drive>:\My Documents\Emulex\Drivers. This location is
hard-coded and cannot be changed.
Note: Extracting all the drivers takes an additional 28 MB. By default, Windows PE
allocates only 32 MB of writeable memory. The size of the writable memory
may be increased when building the WinPE ISO image.
You can extract the driver files using the GUI mode by running the installer or you can
use the command line in silent mode.
To extract the drivers from the offline adapter management utility for Windows:
GUI Mode
1. Run the installer.
2. From the Installation Options screen, select Extract All Drivers, and deselect
Install elxApp_Drivers (64-bit).
3. Click Install to continue.
Silent Mode
From the command line, type
start/wait SetupElxAll-x64.exe/q2 extract=2
Note: Values for the “extract” parameter are:



0 —Install the package; do not extract drivers. (DEFAULT)
1 —Install the package; extract drivers
2 —Do not install the package; extract drivers.
Extracting the Offline Adapter Standalone
Management Utility (Linux and Windows PE)
The Offline Adapter Standalone Management utility is not installed; you must extract it
from its zip file. Once you extract the utility, the following directories are created. The
Linux executable files are extracted to the lx\ directory, or the Windows executable
files are extracted to the win\ directory.




boot\
firmware\
lx\
win\
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
18
2. Installation
Offline Adapter Management Utility Installation for FreeBSD
In Windows, for example, three directories should be visible in the kit's root directory
after you extract the standalone utility. The top level “boot” directory and “firmware”
directory are the default directories in which elxflash looks for firmware and boot code
images. Ensure that firmware and boot code are located in these directories.
# dir
07/05/2012
07:02 PM
<DIR>
.
07/05/2012
07:02 PM
<DIR>
..
07/02/2012
03:14 PM
<DIR>
boot
07/02/2012
03:14 PM
<DIR>
firmware
07/02/2012
03:15 PM
<DIR>
win
The Offline Adapter Standalone Management utility has the same dependencies as the
offline utility. See “Platform Prerequisites” on page 13.
Note: There are no update or uninstall procedures for the Offline Adapter Standalone
Management utility. When a new version is available, you extract it, replacing
the older version.
Offline Adapter Management Utility Installation for
FreeBSD
The Offline Adapter Management Utility installation for FreeBSD uses an install script.
The install script determines the correct architecture and distribution and performs the
following operations:


Installs the ElxflashOffline utility and linlpcfg
Temporarily mounts /proc
Note: For security reasons, /proc is not mounted by default; however, Elxflash and
linlpcfg require that /proc be mounted in order to run. Verify /proc is mounted
before running Elxflash or linlpcfg.
To install the Offline Adapter Management utility for FreeBSD:
1. Untar the installation tarball.
2. Run the install script located in the root directory of the installation kit.
For example:
# tar xvf elxflashOffline-<platforms>-<version>-<rel>.tgz
# cd elxflashOffline-<platforms>-<version>-<rel>
# ./install.sh
Updating
To update the Offline Adapter Management utility for FreeBSD, uninstall the old
version and then unzip the new version.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
19
2. Installation
Firmware and Boot Code
Uninstalling
To uninstall the Offline Adapter Management utility for FreeBSD:
Run the uninstall script located in the root directory of the installation kit.
For example:
# cd elxflashOffline-<platforms>-<version>-<rel>
# ./uninstall.sh
Firmware and Boot Code
Firmware images are available on the Emulex support site at:
http://www.emulex.com. All firmware image files are expected to be in the
sub-directory named "firmware". All boot code image files are expected to be in the
sub-directory named "boot". The HBA types are always Emulex model names.
Note: OneConnect models (FCoE, iSCSI, and NIC) may share the same Emulex model
name, but may run different protocols. For example, an Emulex model
OCe10102 can be an FCoE, iSCSI, or NIC UCNA.
When the fwmatrix.txt file is used, the Elxflash model name must include the highest
protocol being used on that model. An adapter's Elxflash model name can be seen by
running the /query command.
Notes:


On an FCoE/NIC adapter, the highest protocol is FCoE. On an iSCSI/NIC
adapter, the highest protocol is iSCSI.
Ensure that there are no spaces in the in the fwmatrix.txt model name to avoid a
firmware update failure.
For example:
# ./elxflash /q
HBA=OCe11100-iSCSI, Port Type=iSCSI, MAC=00:00:C9:AD:AD:21, PCI ID=712, VID=19A2,
SSID=E702, SVID=10DF, Firmware=4.0.493.0, Boot Code=2.0.21.768
HBA=OCe11100-iSCSI, Port Type=iSCSI, MAC=00:00:C9:AD:AD:25, PCI ID=712, VID=19A2,
SSID=E702, SVID=10DF, Firmware=4.0.493.0, Boot Code=2.0.21.768
HBA=OCe11100-iSCSI, Port Type=NIC, MAC=00:00:C9:AD:AD:20, PCI ID=710, VID=19A2,
SSID=E702, SVID=10DF, Firmware=4.0.493.0, Boot Code=2.0.21.768
HBA=OCe11100-iSCSI, Port Type=NIC, MAC=00:00:C9:AD:AD:24, PCI ID=710, VID=19A2,
SSID=E702, SVID=10DF, Firmware=4.0.493.0, Boot Code=2.0.21.768
elxflash.exe: All required queries succeeded - Return Code=0
Note: The OCe11100 UCNA in the example above is an iSCSI adapter, which has
the Elxflash model name of OCe11100-iSCSI.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
20
3. Adapter Management Utility Command Line Interface
Auto-Discovery (/auto)
3. Adapter Management Utility Command Line
Interface
There are two supported modes for each Adapter Management Utility (Elxflash)
switch. The first mode relies on the fwmatrix.txt file. It is your responsibility to update
the firmware and boot code directories with the appropriate firmware and boot code
images.
Note: Ensure that there are no spaces in the in the fwmatrix.txt model name to avoid a
firmware update failure.
The second mode is auto-discovery. When the /auto switch is used with the following
switches, the Adapter Management Utility automatically discovers adapters and, using
the firmware and boot subdirectories, performs the specified operation on each
adapter.






/f
/ff
/fb
/downgrade
/rewrite
/update
Auto-Discovery (/auto)
Usage: /auto
The auto-discovery switch instructs the Adapter Management Utility to ignore the
fwmatrix.txt file, automatically discover local adapters, and perform specified
operations employing an additional switch using the firmware and boot directories.
The /auto switch must be used with an additional operational switch such as:






/f
/ff
/fb
/downgrade
/rewrite
/update
Example usage:
./elxflash /auto /update – Updates the firmware and boot code using the firmware
and boot directories.

The fwmatrix.txt file is ignored. You must place the desired versions of
firmware in the firmware directory.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
21
3. Adapter Management Utility Command Line Interface
Downgrade (/downgrade or /g)


Using the firmware subdirectory, the Adapter Management Utility
automatically discovers the best matching firmware for each installed and
supported adapter.
If multiple versions of firmware or boot code are found for an adapter, the
Adapter Management Utility uses the most recent version when performing the
firmware download.
Downgrade (/downgrade or /g)
Usage: /downgrade or /g
The downgrade switch downgrades the firmware or boot code of each adapter if the
currently installed versions are more recent than the downgrade versions. This switch
cannot be used with the /update or /rewrite commands.
Example usage:
./elxflash /downgrade /auto – Downgrades the firmware or boot code using
auto-discovery.




The fwmatrix.txt file is ignored. You must place the desired downgrade
versions of firmware or boot code in their respective directories.
If the downgrade versions are older than the currently installed versions on the
adapter, then the downgrade versions are downloaded to the adapter.
If multiple downgrade versions of firmware or boot code are found for an
adapter, the next-previous downgrade versions are downloaded to the adapter.
When performing the boot code downgrade operation, the Adapter
Management Utility first tries to match by adapter family and boot type. If a
match is not found, the Adapter Management Utility then tries to match by boot
type. If the utility matches by boot type and multiple versions of boot code are
detected, downgrade chooses the downgrade file in the following order:
1.
2.
3.
4.
5.
Universal (U)
Pair (P)
Open (O)
EFI (E)
x86 (B)
./elxflash /downgrade – Downgrades the firmware or boot code using the fwmatrix.txt
file.


For each installed and supported adapter, the current firmware or boot code
versions are compared with the versions specified in fwmatrix.txt.
If the downgrade versions in fwmatrix.txt are older than the currently installed
versions, the downgrade versions of firmware or boot code are downloaded to
that adapter.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
22
3. Adapter Management Utility Command Line Interface
Force Firmware and Boot Code (/f or /ff /fb)
FC Adapter Download Summary
<date><time>
HBA=<model>, Port Type=<port_type>, WWN=<wwn>,
Update=<Boot Code|Firmware>, Image=<image>, New=<version>,
Old=<version>, Status=<description>
FCoE Adapter Download Summary
<date><time>
HBA=<model>, Port Type=<port_type>, WWN=<wwn>,
Update=Firmware, Image=<image>, New=<version>, Old=<version>,
Status=<description>
iSCSI and NIC-only Adapter Summary
<date><time>
HBA=<model>, Port Type=<port_type>, MAC=<mac_address>,
Update=Firmware, Image=<image>, New=<version>, Old=<version>,
Status=<description>
Return Code=<n>
where <description> is Success or Error, and <n> = 0 for completion with no errors or a
non-zero error code for any error.
Notes:


FCoE, iSCSI, and NIC-only adapters require a system reboot to activate new
firmware.
If the preview switch is used, the Status=<description> field displays
“Preview.”
Force Firmware and Boot Code (/f or /ff /fb)
Usage: /f -or- /ff /fb
The force firmware and boot code switch forces a firmware and boot code download to
an adapter regardless of the current version on the adapter, and is performed
regardless of any additional operational switches given on the command line.
Example usage:
./elxflash /f /auto – Forces a firmware and boot code download using auto-discovery.


The fwmatrix.txt file is ignored. You must place the desired versions of
firmware and boot code in their respective directories.
If multiple versions of firmware or boot code are found for an adapter, the
Adapter Management Utility uses the most recent versions when performing
the firmware and boot code downloads.
./elxflash /f – Forces a firmware and boot code download using the fwmatrix.txt file.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
23
3. Adapter Management Utility Command Line Interface
Force Boot Code (/fb)

For each installed and supported adapter, forces a download of firmware and
boot code using the versions specified in the fwmatrix.txt file.
FC Adapter Download Summary
<date><time>
HBA=<model>, Port Type=<port_type>, WWN=<wwn>,
Update=<Boot Code|Firmware>, Image=<image>, New=<version>,
Old=<version>, Status=<description>
FCoE Adapter Download Summary
<date><time>
HBA=<model>, Port Type=<port_type>, WWN=<wwn>,
Update=Firmware, Image=<image>, New=<version>, Old=<version>,
Status=<description>
iSCSI and NIC-only Adapter Summary:
<date><time>
HBA=<model>, Port Type=<port_type>, MAC=<mac_address>,
Update=Firmware, Image=<image>, New=<version>, Old=<version>,
Status=<description>
Return Code=<n>
where <description> is Success or Error, and <n> = 0 for completion with no errors or a
non-zero error code for any error.
Notes:


FCoE, iSCSI, and NIC-only adapters require a system reboot to activate new
firmware.
If the preview switch is used, the Status=<description> field displays
“Preview.”
Force Boot Code (/fb)
Usage: /fb
The force boot code switch forces a boot code download to an adapter regardless of the
boot code version installed on the adapter, and of any additional operational switches
given on the command line.
Example usage:
./elxflash /fb /auto – Forces a boot code download using auto-discovery.

The fwmatrix.txt file is ignored. You must place the desired versions of boot
code in the boot directory.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
24
3. Adapter Management Utility Command Line Interface
Force Firmware (/ff)

If multiple versions of boot code are found for an adapter, the Adapter
Management Utility uses the most recent version when performing the boot
code download.
./elxflash /fb – Forces a boot code download using the fwmatrix.txt file.

For each installed and supported adapter, forces a download of boot code using
the boot code version specified in the fwmatrix.txt file.
FC Adapter Download Summary
<date><time>
HBA=<model>, Port Type=<port_type>, WWN=<wwn>,
Update=Boot Code, Image=<image>, New=<version>, Old=<version>,
Status=<description>
Return Code=<n>
where <description> is Success or Error, and <n> = 0 for completion with no errors or a
non-zero error code for any error.
Notes:


If the preview switch is used, the Status=<description> field displays
“Preview.”
The force boot code (/fb) switch applies only to legacy Fibre Channel HBAs.
Force Firmware (/ff)
Usage: /ff
The force firmware switch forces a firmware download to an adapter regardless of the
firmware version installed on the adapter, and regardless of any additional operational
switches given on the command line.
Example usage:
./elxflash /ff /auto – Forces a firmware download using auto-discovery.


The fwmatrix.txt file is ignored. You must place the desired versions of
firmware in the firmware directory.
If multiple versions of firmware are found for an adapter, the Adapter
Management Utility uses the most recent version when performing the
firmware download.
./elxflash /ff – Forces a firmware download using the fwmatrix.txt file.

For each installed and supported adapter, forces a download of firmware using
the firmware version specified in the fwmatrix.txt file.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
25
3. Adapter Management Utility Command Line Interface
Firmware Matrix Directory Change (/fmd)
FC and FCoE Adapter Download Summary
<date><time>
HBA=<model>, Port Type=<port_type>, WWN=<wwn>,
Update=Firmware, Image=<image>, New=<version>, Old=<version>,
Status=<description>
iSCSI and NIC-only Adapter Summary
<date><time>
HBA=<model>, Port Type=<port_type>, MAC=<mac_address>,
Update=Firmware, Image=<image>, New=<version>, Old=<version>,
Status=<description>
Return Code=<n>
where <description> is Success or Error, and <n> = 0 for completion with no errors or a
non-zero error code for any error.
Notes:


FCoE, iSCSI, and NIC-only adapters require a system reboot to activate new
firmware.
If the preview switch is used, the Status=<description> field displays
“Preview.”
Firmware Matrix Directory Change (/fmd)
Usage: /fmd=<directory>
The firmware matrix directory change switch changes the location of the base directory
in which fwmatrix.txt is located.
Firmware Flash Override (/fo)
Usage: /fo
The flash override switch is used to execute a firmware download using the flash
executable file on supported UCNAs.
Note: The flash override switch applies to Linux ElxflashOffline and Elxflash
Standalone only.
Example usage:
./elxflash /f /auto /fo – Forces a firmware and boot code download using
auto-discovery, and downloads the firmware to supported UCNAs using the flash
executable file.

The fwmatrix.txt file is ignored. The desired versions of firmware and boot code
must be placed in their respective directories.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
26
3. Adapter Management Utility Command Line Interface
Help (/h or /?)


If multiple versions of firmware and boot code are found for an adapter,
Elxflash uses the most recent versions when performing the firmware and boot
code downloads.
The flash executable file is used to download firmware to supported UCNAs.
Example usage:
./elxflash /f /fo – Forces a firmware and boot code download using the
fwmatrix.txt file, and downloads the firmware to supported UCNAs using the flash
executable file.


For each installed and supported adapter, a forced download of firmware and
boot code occurs using the versions specified in the fwmatrix.txt file.
The flash executable file is used to download firmware to supported UCNAs.
Help (/h or /?)
Usage: /h or /?
The help switch displays a help message detailing instructions on how to use the
Adapter Management Utility.
Image Directory Change (/id)
Usage: /id=<image_directory>
The image directory switch is used to specify the location of the firmware and boot
code directories.
Example usage:
./elxflash /f /auto /id=/tmp – Forces a firmware and boot code download using
auto-discovery. Elxflash looks for the firmware and boot code directories in the /tmp
directory.



The fwmatrix.txt file is ignored. The desired versions of firmware and boot code
must be placed in their respective directories.
In this example firmware must be placed in the /tmp/firmware directory and
boot code must be placed in the /tmp/boot directory.
If multiple versions of firmware or boot code are found for an adapter, Elxflash
uses the most recent versions when performing the firmware and boot code
downloads.
./elxflash /f /i=/tmp – Forces a firmware and boot code download using the
fwmatrix.txt file. Elxflash look for the firmware and boot code directories in the /tmp
directory.


For each installed and supported adapter, a forced download of firmware and
boot code occurs using the versions specified in the fwmatrix.txt file.
In this example firmware must be placed in the /tmp/firmware directory and
boot code must be placed in the /tmp/boot directory.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
27
3. Adapter Management Utility Command Line Interface
Image Version Display (/iv)
Note: This switch was “/i” in previous versions of the online/offline utility.
Image Version Display (/iv)
Usage: /iv=<image file>
The image version display switch displays the firmware image file’s version number.
Example usage:
./elxflash /iv=firmware/A11460.grp
1.1.46.0
Note: The image version display switch requires a path to the firmware image file in
order to decode image file's version.
Log (/log)
Usage: /log=<logfile.txt>
The log switch appends the output of the Adapter Management Utility to a text file.
Log can be used with any switch.
Preview (/p)
Usage: /p
The preview switch provides a download preview of all adapters that the Adapter
Management Utility can update using either auto-discovery or the fwmatrix.txt file.
The preview switch can be used with any of the operational switches, such as:





/ff
/fb
/downgrade
/rewrite
/update
When the preview switch is used, the Adapter Management Utility displays a
download summary, but does not actually perform the download.
Each adapter's download preview displays the adapter's old and new image version.
The old image version represents the image version that is currently on the adapter.
The new image version represents the image version that the Adapter Management
Utility would use during a download.
Example usage:
./elxflash /preview /auto /update – Previews an upgrade of firmware or boot
code using auto-discovery.

The fwmatrix.txt file is ignored. You must place the desired update versions of
firmware or boot code in their respective directories.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
28
3. Adapter Management Utility Command Line Interface
Process FC HBAs Only (/fc)


If the update versions are higher than the currently installed versions on the
adapter, the Adapter Management Utility provides a download preview for
each adapter that can be updated.
If multiple update versions of firmware or boot code are found for an adapter,
the Adapter Management Utility provides a download preview using the most
recent versions.
./elxflash /preview – Previews an upgrade of firmware or boot code using the
fwmatrix.txt file.


For each installed and supported adapter, the current firmware and boot code
versions are compared with the versions specified in fwmatrix.txt.
If the update versions in fwmatrix.txt are more recent than the currently
installed versions, the Adapter Management Utility provides a download
preview of firmware or boot code for each adapter that can be updated.
FC Adapter Download Summary
<date><time>
HBA=<model>, Port Type=<port_type>, WWN=<wwn>,
Update=<Boot Code|Firmware>, Image=<image>, New=<version>,
Old=<version>, Status=Preview
FCoE Adapter Download Summary
<date><time>
HBA=<model>, Port Type=<port_type>, WWN=<wwn>,
Update=Firmware, Image=<image>, New=<version>, Old=<version>,
Status=Preview
iSCSI and NIC-only Adapter Download Summary
<date><time>
HBA=<model>, Port Type=<port_type>, MAC=<mac_address>,
Update=Firmware, Image=<image>, New=<version>, Old=<version>,
Status=Preview
Process FC HBAs Only (/fc)
Usage: /fc
The process FC HBAs only switch causes elxflash to act only on FC HBAs.
Example usage:
./elxflash /q /fc - Only FC HBAs are displayed for a query.
./elxflash /auto /up /fc - Applies auto update only to FC HBAs.
When doing a firmware or boot code update and the /fc switch is used, only FC HBAs
are updated; UCNAs are not displayed.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
29
3. Adapter Management Utility Command Line Interface
Process UCNAs and CFAs (/ucna)
Notes:


/fc is not available on ElxflashOffline_NIC_only.
This switch supports LPe16202 CFAs in FC mode.
Process UCNAs and CFAs (/ucna)
Usage: /ucna
The Process UCNA and CFAs switch causes elxflash to act only on UNCAs or CFAs.
Example usage:
./elxflash /q /ucna - Only UCNAs are displayed for a query.
./elxflash /auto /up /ucna - Apply auto update only to UCNAs.
When doing a firmware or boot code update and the /ucna switch is used, only
UCNAs are updated; FC HBAs are not displayed.
Note: This switch supports LPe16202 CFAs in NIC mode.
Query (/q)
Usage: /q
The query switch displays an adapter's model, WWN or MAC address, PCI_ID,
firmware version, and boot code version. Query can be used with any switch.
FC Adapter Status Summary
HBA=<model>, Port Type=<port_type>, WWN =<wwn>, Firmware=<version>,
Boot Code=<version>, Boot Code enable=<status>
FCoE Adapter Status Summary
HBA=<model>, Port Type=<port_type>, WWN =<wwn>, Firmware=<version>,
Boot Code=<version>
iSCSI and NIC-only Adapter Status Summary
HBA=<model>, Port Type=<port_type>, MAC =<mac_address>,
Firmware=<version>, Boot Code=<version>
Notes:


On FC adapters, the query switch displays boot code version information only if
the adapter has boot code installed.
When the query switch is used with an operational switch, the query also
includes an additional field called “Supported Firmware” or “Supported Boot
Code”.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
30
3. Adapter Management Utility Command Line Interface
Ramdrive (/ramdrive) - (Windows Offline Adapter Management Utility only)
For example:
C:\elxflashStandalone-windows-10.0.567.22-1\win>elxflash.bat /q
HBA=LPe16002, Port Type=FC, WWN=10:00:00:00:C9:D1:6A:52, PCI ID=E200, VID=10DF,
SSID=E206, SVID=10DF, Firmware=1.1.48.0, Boot Code=KT803A10, Boot Enabled=1
HBA=LPe16002, Port Type=FC, WWN=10:00:00:00:C9:D1:6A:53, PCI ID=E200, VID=10DF,
SSID=E206, SVID=10DF, Firmware=1.1.48.0, Boot Code=KT803A10, Boot Enabled=1
HBA=OCe10100-FCoE, Port Type=FCoE, WWN=10:00:00:90:FA:30:44:1D, PCI ID=0704, VID=19A2,
SSID=E602, SVID=10DF, Firmware=4.9.118.0, Boot Code=2.0.42.0
HBA=OCe10100-FCoE, Port Type=FCoE, WWN=10:00:00:90:FA:30:44:21, PCI ID=0704, VID=19A2,
SSID=E602, SVID=10DF, Firmware=4.9.118.0, Boot Code=2.0.42.0
HBA=OCe10100-iSCSI, Port Type=iSCSI, MAC=00:00:C9:A9:B8:C8, PCI ID=0702, VID=19A2,
SSID=E602, SVID=10DF, Firmware=4.9.118.0, Boot Code=2.0.42.0
HBA=OCe10100-iSCSI, Port Type=iSCSI, MAC=00:00:C9:A9:B8:CA, PCI ID=0702, VID=19A2,
SSID=E602, SVID=10DF, Firmware=4.9.118.0, Boot Code=2.0.42.0
HBA=OCe10100-iSCSI, Port Type=NIC, MAC=00:00:C9:A9:B8:C7, PCI ID=0700, VID=19A2,
SSID=E602, SVID=10DF, Firmware=4.9.118.0, Boot Code=2.0.42.0
HBA=OCe10100-iSCSI, Port Type=NIC, MAC=00:00:C9:A9:B8:C9, PCI ID=0700, VID=19A2,
SSID=E602, SVID=10DF, Firmware=4.9.118.0, Boot Code=2.0.42.0
HBA=OCe10100-FCoE, Port Type=NIC, MAC=00:90:FA:30:44:1C, PCI ID=0700, VID=19A2,
SSID=E602, SVID=10DF, Firmware=4.9.118.0, Boot Code=2.0.42.0
HBA=OCe10100-FCoE, Port Type=NIC, MAC=00:90:FA:30:44:20, PCI ID=0700, VID=19A2,
SSID=E602, SVID=10DF, Firmware=4.9.118.0, Boot Code=2.0.42.0
Ramdrive (/ramdrive) - (Windows Offline Adapter
Management Utility only)
Usage: /ramdrive=<drive letter>[:]
The ramdrive switch specifies the drive for creating temporary and log files. The
default is drive X; the default drive in Windows PE.
Remote (/remote) - (Online Adapter Management
Utility only)
Usage: /remote
The remote switch enables updates on remote in-band adapters.
Rewrite (/rewrite or /e)
Usage: /rewrite -or- /e
The rewrite switch updates the firmware or boot code of each adapter if the installed
versions are earlier than or the same as the rewrite versions. This switch cannot be used
with /update or /downgrade.
Example usage:
./elxflash /rewrite /auto – Rewrites the firmware boot code using
auto-discovery.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
31
3. Adapter Management Utility Command Line Interface
Rewrite (/rewrite or /e)




The fwmatrix.txt file is ignored. You must place the desired rewrite versions of
firmware or boot code in their respective directories.
If the rewrite versions are more recent than or the same as the versions installed
on the adapter, then the rewrite versions are downloaded to the adapter.
If multiple rewrite versions of firmware or boot code are found for an adapter,
the most recent versions are downloaded to the adapter.
When performing the boot code rewrite operation, the Adapter Management
Utility first tries to match by adapter family and boot type. If a match is not
found, the Adapter Management Utility then tries to match by boot type. If the
utility matches by boot type, and multiple versions of boot code are detected,
rewrite always chooses in the following order:
1.
2.
3.
4.
5.
Universal (U)
Pair (P)
Open (O)
EFI (E)
x86 (B)
./elxflash /rewrite – Rewrites the firmware or boot code using the fwmatrix.txt
file.


For each installed and supported adapter, the current firmware or boot code
versions are compared with the versions in fwmatrix.txt.
If the currently installed versions are less than or equal to the rewrite versions in
fwmatrix.txt then the rewrite versions of firmware or boot code are downloaded
to the adapter.
FC Adapter Download Summary
<date><time>
HBA=<model>, Port Type=<port_type>, WWN=<wwn>,
Update=<Boot Code|Firmware>, Image=<image>, New=<version>,
Old=<version>, Status=<description>
FCoE Adapter Download Summary
<date><time>
HBA=<model>, Port Type=<port_type>, WWN=<wwn>,
Update=Firmware, Image=<image>, New=<version>, Old=<version>,
Status=<description>
iSCSI and NIC-only Adapter Download Summary
<date><time>
HBA=<model>, Port Type=<port_type>, MAC=<mac_address>,
Update=Firmware, Image=<image>, New=<version>, Old=<version>,
Status=<description>
Return Code=<n>
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
32
3. Adapter Management Utility Command Line Interface
Silent (/s)
where <description> is Success or Error, and <n> = 0 for completion with no errors or a
non-zero error code for any error.
Notes:


FCoE, iSCSI, and NIC-only adapters require a system reboot to activate new
firmware.
If the preview switch is also used, the Status =<description> field displays
“Preview.”
Silent (/s)
Usage: /s
The silent switch prevents all output from being displayed.
Example usage:
./elxflash /f /auto /s – Forces a firmware and boot code download using
auto-discovery and mutes all output to stdout.



The fwmatrix.txt file is ignored. The desired versions of firmware and boot code
must be placed in their respective directories.
If multiple versions of firmware and/or boot code are found for an adapter,
Elxflash uses the most recent versions when performing the firmware and boot
code downloads.
No output is printed to stdout.
./elxflash /f /s – Forces a firmware and boot code download using the
fwmatrix.txt file and mutes all output to stdout.


For each installed and supported adapter, a download of firmware and boot
code is forced using the versions specified in the fwmatrix.txt file.
No output is printed to stdout.
Discover UCNAs using SysFS (/sysfs)
Note: This switch requires that libsysfs is installed. If the libsysfs library is not found,
the /sysfs switch is not available.
Usage: /sysfs + operational switch
/sysfs is an operational switch that discovers UCNA functions using the SysFS tool and
executes firmware downloads by using the ethtool or SysFS tool. The /sysfs switch is
used with any switch that displays adapter information, for example /q, or any
combination of switches that executes a download. The following switches can be used:




/f - force firmware and boot code
/fb - force boot code
/ff - force firmware
/downgrade or /g
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
33
3. Adapter Management Utility Command Line Interface
Update (/update)



/query or /q
/rewrite or /e
/update
For example, “./elxflash /sysfs /auto /f” discovers UCNA NIC functions using SysFS
and discovers legacy FC functions using LpCfg. It forces a firmware download on
UCNA adapters using ethtool or SysFS and forces a firmware and boot code download
on legacy FC adapters using LpCfg.
Notes:



Only UCNA NIC functions are displayed. Displaying iSCSI and FCoE
functions is not supported.
When /sysfs is used, the VPD model name is not available.
The /sysfs switch is available on ElxflashStandalone on RHEL 5, SLES 10
SP4, RHEL 6, and SLES 11 SP1+ only.
Example:
/elxflash /sysfs /q
Update (/update)
Usage: /update
The update switch updates the firmware or boot code of each adapter if the currently
installed versions are less than the update versions. This switch cannot be used with
/downgrade or /rewrite.
Example usage:
./elxflash /update /auto – Upgrades the firmware or boot code using
auto-discovery.




The fwmatrix.txt file is ignored. You must place the desired update versions of
firmware or boot code in their respective directories.
If the update versions are higher than the currently installed versions on the
adapter then the update versions are downloaded to the adapter.
If multiple update versions of firmware or boot code are found for an adapter,
the most recent versions are downloaded to the adapter.
When performing the boot code update operation, the Adapter Management
Utility uses the most recent boot code version found. Since multiple compatible
versions of boot code may exist, the most recent version is selected in the
following order:
1.
2.
3.
4.
5.
Universal (U)
Pair (P)
Open (O)
EFI (E)
x86 (B)
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
34
3. Adapter Management Utility Command Line Interface
Verbose (/v)
Note: The most recent boot code version is downloaded regardless of the installed
boot code. This allows upgrading from one type of boot code to another
type.
./elxflash /update – Upgrades the firmware or boot code using the fwmatrix.txt
file.


For each installed and supported adapter, the current firmware and boot code
versions are compared with the versions specified in fwmatrix.txt.
If the update versions in fwmatrix.txt are more recent than the currently
installed versions, then the update versions of firmware or boot code are
downloaded to that adapter.
FC Adapter Download Summary
<date><time>
HBA=<model>, Port Type=<port_type>, WWN=<wwn>,
Update=<Boot Code|Firmware>, Image=<image>, New=<version>,
Old=<version>, Status=<description>
FCoE Adapter Download Summary
<date><time>
HBA=<model>, Port Type=<port_type>, WWN=<wwn>,
Update=Firmware, Image=<image>, New=<version>, Old=<version>,
Status=<description>
iSCSI and NIC-only Adapter Download Summary
<date><time>
HBA=<model>, Port Type=<port_type>, MAC=<mac_address>,
Update=Firmware, Image=<image>, New=<version>, Old=<version>,
Status=<description>
Return Code=<n>
where <description> is Success or Error, and <n> = 0 for completion with no errors or a
non-zero error code for any error.
Note: FCoE, iSCSI, and NIC-only adapters require a system reboot to activate new
firmware.
Verbose (/v)
Usage: /v
The verbose switch displays progress messages and can be used with any switch. When
this switch is used, the following information is displayed:


A download summary for all adapters that had successful or failed downloads
A summary of unsupported adapters, if applicable
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
35
3. Adapter Management Utility Command Line Interface
VPD (/vpd)

A per adapter message for each adapter that the Adapter Management Utility
did not update
FC Adapter Download Summary
<date><time>
HBA=<model>, Port Type=<port_type>, WWN=<wwn>,
Update=<Boot Code|Firmware>, Image=<image>, New=<version>,
Old=<version>, Status=<description>
FCoE Adapter Download Summary
<date><time>
HBA=<model>, Port Type=<port_type>, WWN=<wwn>,
Update=Firmware, Image=<image>, New=<version>, Old=<version>,
Status=<description>
iSCSI and NIC-only Adapter Download Summary
<date><time>
HBA=<model>, Port Type=<port_type>, MAC=<mac_address>,
Update=Firmware, Image=<image>, New=<version>, Old=<version>,
Status=<description>
Return Code=<n>
where <description> is Success or Error, and <n> = 0 for completion with no errors or a
non-zero error code for any error.
VPD (/vpd)
Note: The VPD command applies to ElxflashOffline and Elxflash Standalone utilities
only.
Usage: /vpd
The vpd command displays the VPD model name for supported adapters. You must
use the VPD command with one of the following switches:








/f - Force firmware and boot
/fb - force boot code
/ff - force firmware
/xml - XML output
/downgrade or /g
/query or /q
/rewrite or /e
/update
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
36
3. Adapter Management Utility Command Line Interface
XML Output (/xml)
Note: The vpd command does not display any information if used without the
switches listed above. If you attempt to use the /vpd command without the
switches listed above, an error message is displayed.
If the VPD command is used in conjunction with the fwmatrix.txt file, the model name
in the fwmatrix.txt file must match the VPD model name reported by Elxflash.
Supported adapters include legacy FC adapters that support VPD and OCe11102 and
later UCNA adapters.
Note: Displaying the VPD model name for OCe10100 UCNAs is not supported.
XML Output (/xml)
Usage: /xml
The xml switch displays utility output in xml format.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
37
4. Offline Adapter Management Utility Command Line Interface
Running the Offline Adapter Management Utility from the Command Prompt
4. Offline Adapter Management Utility
Command Line Interface
The Offline Adapter Management Utility allows you to configure Emulex adapters
before you install or boot a server operating system.
The Offline Adapter Management Utility includes:


winlpcfg
linlpcfg
You can use the Offline Adapter Management Utility to do the following:










View information on an Emulex adapter
Reset the adapter
Download firmware and boot code files
Select a boot device
Read and update WWNs
Enable boot code
Update configuration regions
Set the adapter to use soft jumpers
Run diagnostic tests
Read and process script files
Running the Offline Adapter Management Utility
from the Command Prompt
Note: You must start the WinPE and Linux Offline Adapter Management Utility at the
command prompt.
1. Boot the system with a supported operating system.
2. Start the Offline Adapter Management Utility with a valid command or a valid
script file name.

To start an Offline Adapter Management Utility from the command line, move
to the directory where the executable file resides and type
oslpcfg <valid command> (replace os with ./lin or win as appropriate)

For example, starting the WinPE Offline Adapter Management Utility with
a reset command:
winlpcfg reset n=2

For example, starting the Linux Offline Adapter Management Utility with a
reset command:
./linlpcfg reset n=2

To start an Offline Adapter Management Utility with a script file name, from
the directory where the oslpcfg.exe file resides, type
oslpcfg @<script file name>
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
38
4. Offline Adapter Management Utility Command Line Interface
Running the Standalone Adapter Management Utility

For example, starting an Offline Adapter Management Utility with
script1.txt in the c:\test directory:
oslpcfg @C:\test\script1.txt
Note: To redirect screen output to a file, add <filename> at the end of each command.
For example:
oslpcfg listboot n=1 >result.out
Note: For more information on script files, see “Creating Script Files” on page 61 and
“Script File Commands” on page 62.
Running the Standalone Adapter Management Utility
The Standalone Adapter Management Utility allows you to update firmware on
Emulex adapters without needing to install any tools. No drivers are included in the
Standalone kit. No applications are installed because the utility runs from inside the kit.
The Standalone Adapter Management Utility has the same capability as the Offline
Adapter Management Utility, except that you use the following scripts to run the
utility:


Windows – winlpcfg.bat and elxflash.bat
Linux – linplcfg.sh and elxflash.sh
Windows
1. Extract kit contents.
2. Change directory (cd) to elxflashStandalone-windows-<version>.
The following directories should be present:
boot\

firmware\

win\
3. For Elxflash, copy firmware images to the firmware directory. Copy boot images to
the boot directory.

Note: For Elxflash, each operating system architecture directory includes a
fwmatrix.txt file. You must use the fwmatrix.txt directory that matches the
current operating system architecture.
4. Change directory (cd) to the win directory.
The following files and directories should be present:




win32\
x64\
elxflash.bat
winlpcfg.bat
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
39
4. Offline Adapter Management Utility Command Line Interface
Running the Standalone Adapter Management Utility
The elxflash.bat script is used to configure the environment, run elxflash, and revert
any changes before exiting. This script installs the MILI service if it is not installed.
The winlpcfg.bat script is used to configure the environment, run winlpcfg, and
revert any changes before exiting. This script installs the MILI service if it is not
installed.
Notes:
The MILI service is temporarily installed. The service is removed once the script
execution is completed.

If OneCommand Manager is installed, the OneCommand Manager libraries are
used by the elxflash and winlpcfg utilities.

The winlpcfg.bat and elxflash.bat scripts call the native versions of elxflash.exe
and winlpcfg.exe. For example, on Windows x64, the 64-bit utilities are called.

The adapter being managed by the Standalone Adapter Management utility
must not be managed simultaneously by other Emulex utilities including
OneCommand Manager.
5. To update firmware and bootcode on an adapter in Windows, type

# elxflash.bat /auto /up
To display a list of HBAs in Windows, type
# winlpcfg.bat
listhba
from the Win directory
Each time elxflash or lpcfg is run, a log file is created. On Windows these files are
called:
C:\clu\log\elxflash.log
C:\clu\log\winlpcfg.log
Linux
Note: Running 32-bit applications on Linux x86_64 is not supported. The .bat file only
runs native executable files.
1. Extract kit contents.
2. Change directory (cd) to elxflashStandalone-linux-<version>.
The following directories should be present:
boot\

firmware\

lx\
3. For Elxflash, copy firmware images to the firmware directory. Copy boot images to
the boot directory.

Note: For Elxflash, each operating system architecture directory includes a
fwmatrix.txt file. You must use the fwmatrix.txt directory that matches the
current operating system architecture.
4. Change directory (cd) to the lx directory.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
40
4. Offline Adapter Management Utility Command Line Interface
Running the Standalone Adapter Management Utility
The following files and directories should be present:





i386\
x86_64\
ppc64\
elxflash.sh
linlpcfg.sh
The elxflash.sh script is used to configure the environment, run elxflash, and revert
any changes before exiting. This script installs the MILI daemon if it is not installed.
The linlpcfg.sh script is used to configure the environment, run linlpcfg, and revert
any changes before exiting. This script installs the MILI daemons if they are not
installed.
Notes:
The MILI service is temporarily installed. The service is removed once the script
execution is completed.

If OneCommand Manager is installed, the OneCommand Manager libraries are
used by the elxflash and linlpcfg utilities.

The linlpcfg.sh and elxflash.sh scripts call the native versions of elxflash and
linlpcfg. For example, on Linux x86_64, the 64-bit utilities are called.

The adapter being managed by the Standalone Adapter Management utility
must not be managed simultaneously by other Emulex utilities including
OneCommand Manager.
5. To update firmware and bootcode on an adapter, type

# ./elxflash.sh /auto up
To display a list of HBAs, type
# ./linlpcfg.sh
listhba
Each time elxflash or lpcfg is run, a log file is created. On Linux these files are
called:
/var/log/clu/elxflash.log
/var/log/clu/linlpcfg.log
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
41
4. Offline Adapter Management Utility Command Line Interface
Supported Commands
Supported Commands
Table 4-1 lists all Offline Adapter Management Utility commands that are supported or
not supported on Emulex adapters on various platforms.

indicates commands are supported on both winlpcfg and linlpcfg.
L indicates commands are supported only on linlpcfg.
FCoE only indicates commands are supported only by FCoE adapters.
Table 4-1 Supported Commands for the Offline Adapter Management Utility
FC Adapters
COMMANDS
FCoE, NIC, and iSCSI Adapters
x86
x64
PPC
x86
x64
Operating
RH 5.6+
RH 5.6+
RH 5.6+
RH 5.6+
RH 5.6+
Systems
RH 6.1+
RH 6.1+
RH 6.1+
RH 6.1+
RH 6.1+
SLES 11.1+
SLES 11.1+
SLES 11.1+
SLES 11.1+
SLES 11.1+
WinPE 2.1+
WinPE 2.1+
WinPE 2.1+
WinPE 2.1+
Ubuntu 11.x,
Ubuntu 12.x
Ubuntu 13.x
(Elxflash
Standalone on
OneConnect
adapters only)
Ubuntu 11.x,
Ubuntu 12.x
Ubuntu 13.x
(Elxflash
Standalone on
OneConnect
adapters only)
Debian 5.x
Debian 6.x
Debian 7.x
(Elxflash
Standalone on
OneConnect
adapters only)
Debian 5.x
Debian 6.x
Debian 7.x
(Elxflash
Standalone on
OneConnect
adapters only)
config


L
FCoE only
FCoE only
L
L
L
N/A
N/A
disableboot


L
N/A
N/A
disablebootdevice


L
FCoE
FCoE
N/A
N/A
N/A




L


See “Notes on Supported
Commands” on page 44.
directDownload
See “Notes on Supported
Commands” on page 44.
dmatest
See “Notes on Supported
Commands” on page 44.
download
See “Notes on Supported
Commands” on page 44.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
42
4. Offline Adapter Management Utility Command Line Interface
Supported Commands
Table 4-1 Supported Commands for the Offline Adapter Management Utility (Continued)
FC Adapters
COMMANDS
FCoE, NIC, and iSCSI Adapters
x86
x64
PPC
x86
x64
enableboot


L
N/A
N/A
enablebootdevice


L
FCoE
FCoE
extloopback


L


hbaattr





h or ? (Help)


L


intloopback


L


listboot


L
N/A
N/A
listhba


L


listrev


L
FCoE only
FCoE only
listmac
N/A
N/A
N/A
NIC, iSCSI
NIC, iSCSI
listwwn


L
FCoE only
FCoE only
logfile


L


pciloopback


L
FCoE only
FCoE only
posttest


L
N/A
N/A
N/A
N/A
N/A


N/A
N/A
N/A


readaltboot


L
FCoE only
FCoE only
readbootdevice


L
FCoE only
FCoE only
readconfig


L
FCoE only
FCoE only
reset


L
FCoE only
FCoE only
restoredefwwn


L
FCoE only
FCoE only
restorenwwn


L
FCoE only
FCoE only
restorewwn


L
FCoE only
FCoE only
savewwn


L
FCoE only
FCoE only
screendisplay


L
FCoE only
FCoE only
scriptvwwnn


L
FCoE only
FCoE only
scriptvwwpn


L
FCoE only
FCoE only
See “Notes on Supported
Commands” on page 44.
personalityinfo
See “Notes on Supported
Commands” on page 44.
changepersonality
See “Notes on Supported
Commands” on page 44.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
43
4. Offline Adapter Management Utility Command Line Interface
Supported Commands
Table 4-1 Supported Commands for the Offline Adapter Management Utility (Continued)
FC Adapters
COMMANDS
FCoE, NIC, and iSCSI Adapters
x86
x64
PPC
x86
x64
scriptwwnn


L
FCoE only
FCoE only
scriptwwpn


L
FCoE only
FCoE only
setaltboot


L
FCoE only
FCoE only
setbootdevice


L
FCoE only
FCoE only
version


L


vpd


L




L
FCoE only
FCoE only
See “Notes on Supported
Commands”” on
page 44.
writewwn
Notes on Supported Commands




The Config, DirectDownload, DmaTest, and postTest commands are not
supported by 16-Gb adapters.
The download command does not support a= <adapter name> with UCNAs
and the LPe16000 family of adapters.
DmaTest is supported on OneConnect adapters only.
PersonalityInfo and changePersonality are supported on OCe10100 and
OCe11100 series adapters only.
VPD is not supported for OCe10100 NIC functions.
Viewing the Syntax for Commands (help or ?)
To view the syntax for all available commands, type
oslpcfg help
or
oslpcfg ?
To view the syntax for a specific command, type
oslpcfg help <command>
or
oslpcfg ? <command>
For example, either:
oslpcfg help download
or
oslpcfg ? download
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
44
4. Offline Adapter Management Utility Command Line Interface
Viewing Adapter Information
returns a response similar to the following:
download <n=adapter> <i=imagepath>
or
download <a=adaptertype> <i=imagepath>
Resetting an Adapter (reset)
This command resets a specific adapter or all adapters in the system.
Syntax:
To reset one adapter, type
oslpcfg reset n=<adapter number>
To reset all adapters in the system, type
oslpcfg reset n=all
Running the Power-On Self-Test (posttest)
This command runs the POST on the selected adapter.
To run the adapter POST test, type
oslpcfg posttest n=<all/adapter number>
The following example runs the POST test on adapter #1.
oslpcfg posttest n=1
Viewing Adapter Information
Viewing Emulex Conventional Names Instead of VPD (- /c)
Adding /c to any command that uses the a= parameter to return adapter data causes
the command to return an Emulex conventional model for the adapter rather than the
model name in the adapter. /c can be used for any command that displays the model
name. For instance, the following commands use the a= parameter and show this
behavior.



Note:
config
download
directdownload
The offline utility does not always display the model name of the adapter being
tested.
For example:


Emulex conventional model name (using /c switch) – LPe16002
VPD model name– LPe1104-M6-D
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
45
4. Offline Adapter Management Utility Command Line Interface
Viewing Adapter Information
Viewing the Offline Adapter Management Utility Version
Information (version)
This command shows the Offline Adapter Management Utility version information.
To view this information, type
oslpcfg version
Viewing VPD
This command shows the VPD of the adapter specified by its number.
To display VPD, type
oslpcfg vpd n=<adapter number>
The following examples show VPD output:
winlpcfg.exe vpd n=1
Sample legacy FC response:
Product Name
: LPe12002, 8GB/S, 2-PORT, FC, PCI EXPRESS HBA, DIAG, OPTICS
PN (Part Number)
:LPE12002-M8
SN (Serial Number)
:VM80175529
V0
:VM80175529
V1
:Emulex LPe12002-M8 8Gb 2-port PCIe Fibre Channel Adapter
V2
:LPe12002-M8
V3
:T2:78,T3:79,7A,7B,7D,7E,7F,T7:73,TB:73,TFF:78
V4
:0
Command completed, NO Error
Sample LPe 16000 HBA response:
Product Name
:Emulex LightPulse LPe16002-M6-D 2-Port 16Gb Fibre Channel
Adapter, FC PF
PN (Part Number)
:LPe16002-M6-D
SN (Serial Number)
:99999999
MN (Manufacture ID)
:1028
VS
:DSV1028VPDR.VER1.0
VP
:NPY2
VM
:PMT7
VV
:NMVEMULEX CORPORATION
VT
:DTINIC
V0
:99999999
V1
:Emulex LightPulse LPe16002-M6-D 2-Port 16Gb Fibre Channel
Adapter
V2
:LPe16002-M6-D
Command completed, NO Error
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
46
4. Offline Adapter Management Utility Command Line Interface
Viewing Adapter Information
Viewing Boot Device Information (readbootdevice)
This command shows the WWN, the LUN (in decimal format), and the topology in use
for the currently selected boot device.
To show this information, type
oslpcfg readbootdevice n=<adapter number>
The following example reads WWN and LUN for adapter #1:
oslpcfg readbootdevice n=1
Viewing BootBIOS Versions (listboot)
This command lists all the BootBIOS versions, with indices (base 1) and code names,
which are loaded in the flash of the adapter and specified by its number. If the selected
adapter does not have any BootBIOS loaded, it returns error code 39.
Note: Because this application uses base 1 indices, if you had three ports in the
application they would be port 1, port 2, and port 3.
To list BootBIOS versions, type
oslpcfg listboot n=<adapter number>
The following example lists BootBIOS versions that are loaded on adapter #3:
oslpcfg listboot n=3
Viewing Adapter Attributes (hbaattr)
This command displays adapter information.
To list the adapter attributes for all installed adapters, type
oslpcfg hbaattr
To list the adapter attributes for one adapter, type
oslpcfg hbaattr n=<adapter_number>
Sample response:
oslpcfg hbaattr n=5
Command: hbaattr n=5
HBA
: 5
Permanent Mac
: 00:00:C9:D5:6A:4B
Function Type
: iSCSI
Device ID
: 0712
Vendor ID
: 19A2
Sub Device ID
: E702
Sub Vendor ID
: 10DF
PCI Bus Number
: 3
PCI Dev Number
: 0
PCI Fun Number
: 2
BER
: 0
Port Number
: 0
ControllerStatus
: Alive
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
47
4. Offline Adapter Management Utility Command Line Interface
Viewing Adapter Information
Manufacturer
: Emulex Corporation
ModelNumber
: OCe11102-FM
Description
: Emulex OneConnect OCe11102-FM 2-port PCIe 10GbE CNA
Capabilities
Initiator
: TCP offload, Raw Ethernet, Virtual Machines, iSCSI
ActiveFirmwareVersion
: 10.0.657.0
FirmwareVersionOnFlash
: 10.0.654.14
BIOSVersion
: 10.0.657.0
BootCodeVersion
: 2.0.281.768
FirmwareStatus
: Working
FCoEUniversalVersion
: 7.06a7
FCoEx86BIOSVersion
: 4.03a6
FCoEEFIVersion
: 5.20a2
FCoEFCODEVersion
: 4.01a2
UEFINICVersion
: 10.0.657.0
UEFIFCODEVersion
: 10.0.657.0
UEFIiSCSIVersion
: 10.0.657.0
PHYFirmwareVersion
: N/A
PHYCRCConfigId
: N/A
BladeEngineOnDieTemperature
: 57
IPLFilename
: C32FELXD
PCIExpressLinkSpeed
: 2.5 GHz
PCIExpressBusWidth
: x4
FFVName
: N/A
Command completed, NO Error
Viewing All Adapters in the System (listhba)
This command lists all installed adapters in the system. Information includes the
adapter number (base 1), the IEEE address assigned by the manufacturer, the
functional firmware, the adapter type, and possible mailbox errors.
To list all adapters in the system, type
oslpcfg listhba
Sample response:
HBA 1: 10000000 C9D16A52 Functional FW: 10.0.654.3 devID:E200 Bus:4 Dev:0 Func:0
LPe16002-M6-D
HBA 2: 10000000 C9D16A53 Functional FW: 10.0.654.3 devID:E200 Bus:4 Dev:0 Func:1
LPe16002-M6-D
HBA 3: FCoE 10000000 C9F18DED BE:1 Functional FW: 4.2.324.11 devID:704 Bus:6 Dev:0
Func:2 OCe10100
HBA 4: FCoE 10000000 C9F18DEF BE:1 Functional FW: 4.2.324.11 devID:704 Bus:6 Dev:0
Func:3 OCe10100
HBA 5: iSCSI MAC:00.00.C9.D5.6A.4B BE:0 Functional FW: 10.0.657.0 devID:712 Port:0
Bus:3 Dev:0 Func:2 OCe11102-FM
HBA 6: iSCSI MAC:00.00.C9.D5.6A.4F BE:0 Functional FW: 10.0.657.0 devID:712 Port:1
Bus:3 Dev:0 Func:3 OCe11102-FM
HBA 7: NIC MAC:00.00.C9.D5.6A.4A BE:0 Functional FW: 10.0.657.0 devID:710 Port:0 Bus:3
Dev:0 Func:0 OCe11102-FM
HBA 8: NIC MAC:00.00.C9.D5.6A.4E BE:0 Functional FW: 10.0.657.0 devID:710 Port:1 Bus:3
Dev:0 Func:1 OCe11102-FM
HBA 9: NIC MAC:00.00.C9.F1.8D.EE BE:1 Functional FW: 4.2.324.11 devID:700 Port:1 Bus:6
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
48
4. Offline Adapter Management Utility Command Line Interface
Viewing Adapter Information
Dev:0 Func:1 OCe10100
HBA 10: NIC MAC:00.00.C9.F1.8D.EC BE:1 Functional FW: 4.2.324.11 devID:700 Port:0
Bus:6 Dev:0 Func:0 OCe10100
Note: listHBA with option -/c displays the FC HBA conventional model names
instead of the model names contained in the VPD.
Viewing the WWN of All Adapters in the System (listwwn)
This command lists all adapters installed in the system and shows the factory-assigned
WWN, the non-volatile WWPN, and the WWNN used to identify an adapter in the
SAN.
The factory-assigned WWN is an IEEE address that cannot be changed in the field. The
non-volatile WWN can be modified in the field and persists after a restart of the
operating system. The full factory-assigned WWN and non-volatile WWN are a
concatenation of the two 8-character values (word 0 and word 1) that are shown for
each. You can modify the non-volatile WWPN and WWNN using either the writewwn
command or the scriptwwpn and scriptwwnn commands. For more information on the
writewwn command, see “Writing WWN and Updating NVPARMS (writewwn)” on
page 52.
If the system does not have any Emulex adapters installed, it returns error code 45.
To show the WWN information, type:
oslpcfg listwwn
Sample response:
adapter 1: LPe11002
Factory IEEE:
10000000
C92774AF
Non-Volatile WWPN: 10A2A2A2 C92774AF,
WWNN: 20A2A2A2 C92774AF
adapter 2: LPe11002
Factory IEEE:
10000000
C92774AE
Volatile WWPN: 10FFFFFF C92774AE,
WWNN: 20FFFFFF 00000000
adapter 3: LPe11004-M4
Factory IEEE:
10000000
C93CCE08
Non-Volatile WWPN: 10A3A3A3 C93CCE08,
WWNN: 20A3A3A3 C93CCE08
adapter 4: LPe11004-M4
Factory IEEE:
10000000
C93CCE09
Volatile WWPN: 10000000 C93CCE09,
WWNN: 20000000 C93CCE09
Viewing the MAC Address (listmac)
This command shows the MAC address of a NIC UCNA port.
To view the MAC address of a NIC UCNA port, type
oslpcfg listmac n=<adapter number>
Sample response:
adapter 2: NIC Permanent MAC 00-00-c9-5b-3a-f4 MAC 00-00c9-5b3ac2
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
49
4. Offline Adapter Management Utility Command Line Interface
Viewing Adapter Information
Viewing Firmware Program Revisions (listrev)
This command shows the firmware versions in the adapter’s flash memory, specified
by their numbers.
To show revisions, type
oslpcfg listrev n=<adapter number>
The following example lists information for adapter #3:
oslpcfg listrev n=3
Sample response:
Chipset Rev:
BIU:
1001206D
SM FW:
0BC12792
FW Rev:
Current FW:
SLI-3 Overlay
Kernel Rev:
FFC01213
Kernel
LP110021.20a3
Init FW:
LP11002Init Load 2.72a2
(BS2.72A2)
SLI-2:
LP11002Overlay 2.72a2
(B2F2.72A2)
SLI-3:
LP11002Overlay 2.72a2
(B3F2.72A2)
FC-PH Version Supported:
Highest FC-PH Version Supported = 4.3
Lowest FC-PH Version Supported = 4.3
Feature Availability = 0000 00ef
Viewing Selected Configuration Regions (readconfig)
This command shows the contents of the selected configuration region up to the
initialized length or the specified byte count (if the initialized length is less than the
specified byte count). Valid region numbers are 0 to 32. You must initialize the
configuration region first by writing data to it.
Note: If you are using an FCoE adapter, the readconfig command only supports
reading configuration region 8 and 32.
To read a configuration, type
oslpcfg readconfig n=<adapter number> r=<region number> l=<byte count>
The following example reads the configuration for adapter #1, region 0, byte count 20:
oslpcfg readconfig n=1 r=0 l=20
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
50
4. Offline Adapter Management Utility Command Line Interface
Firmware and Boot Code Download Commands
Sample Response:
00000000:
00000008:
00000010:
10000000
20000000
00000000
c93ccce08
c93ccce08
Firmware and Boot Code Download Commands
Downloading a File (download)
This command downloads a firmware or boot code file to a specific adapter.
The adapter name is the name that appears when you run the listHBA command. For
more information on the listHBA command, see “Viewing All Adapters in the System
(listhba)” on page 48.
To download a firmware image file to an adapter specified by its number, type
oslpcfg download n=<adapter number> i=<firmware image filename>
The following example downloads the zb200a1.prg (x86) BootBIOS file to adapter # 6;
in this example, the x86 BootBIOS file is for an LPe11000 adapter:
oslpcfg download n=6 i=zb200a1.prg
Note: Boot code on OneConnect and 16Gb adapters is updated by downloading
firmware. LPcfg does not support updating boot code separately these adapters.
Accessing the Flash Device Directly (directdownload)
This command directly accesses the flash device on the adapter without using the
adapter firmware. This feature is useful in downloading a ROM file image if the
firmware has been corrupted. The adapter name is the name that appears when you
run the listHBA command. You can also use “default” for the adapter name if there is
only one single-channel adapter or one dual-channel adapter in the system. For more
information on the listHBA command, see “Viewing All Adapters in the System
(listhba)” on page 48.
Notes:


You cannot use directdownload in a script file.
UCNAs and LPe16000 family of adapters do not support directdownload.
You can use this feature on the following Emulex adapters:LP21000 and LP21002.
To access the flash device on the adapter directly, type (all on one line)
oslpcfg directdownload a=<adapter name/default> i=<firmware image
filename> s=<selection 0 or 1>
where s=1 saves the existing VPD.
The following example accesses the flash device on an LPe12000 HBA:
oslpcfg directdownload a=lpe12000 i=C:\image\ud100a8.rom s=1
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
51
4. Offline Adapter Management Utility Command Line Interface
World Wide Name Commands
The following example accesses the flash device if the offline utility cannot detect the
adapter type and there is only one single-channel adapter or one dual-channel adapter
in the system:
oslpcfg directdownload a=default i=C:\image\ud100a8.rom s=1
Caution:
In versions prior to 5.1 or with option s=0 in version 5.1,the ROM images
used with the directdownload command may not contain certain VPD
information (for example, serial number, adapter model, or manufacturer).
Direct download of a ROM image that has not been confirmed to contain the
correct VPD image updates the board's firmware, but it also clears the VPD.
The board will function. If you use calls for VPD in your applications, the
information may be changed or missing.
World Wide Name Commands
Writing WWN and Updating NVPARMS (writewwn)
This command allows you to enter word 0 and word 1 of the WWPN or WWNN from
the keyboard or a barcode scanner to update a specified adapter’s NVPARMS with a
new WWPN or WWNN. The new WWPN and WWNN are used the next time the
adapter is discovered. The adapter stores the original WWPN and WWNN in another
region of the memory so it can be used to identify the adapter as it was manufactured.
The WWN can also be read with a barcode scanner.
The Write WWN prompts for the WWPN and WWNN cannot be used in a script file.
The scriptwwnn and scriptwwpn commands use values entered with the command
and can be used in a script file.
Caution:
Use the writewwn command with caution. If you use the same WWPN or
WWNN on more than one adapter in a fabric, unpredictable results may
occur.
Note: Word 0 of WWNN and WWPN names must follow one of the following
formats:
10000xxx
2xxxxxxx
3xxxxxxx
5xxxxxxx
To modify the WWPN and WWNN, type
oslpcfg writewwn n=<adapter number>
The offline utility prompts you to enter new data:




WWPN word 0
WWPN word 1
WWNN word 0
WWNN word 1
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
52
4. Offline Adapter Management Utility Command Line Interface
World Wide Name Commands
The following example writes the WWPN and WWNN for adapter #1.
oslpcfg writewwn n=1
Enter or Scan value for WWPN word 0 now
Enter a value.
10000000
The system echoes what you entered, followed by the next prompt:
10000000
Enter or Scan value for WWPN word 1 now
Saving WWN data to a file (savewwn)
This command reads the original words 0 and 1 of the IEEE address, installed by
manufacturing, from configuration regions 16 (or 32) of the adapter (specified by its
number) and saves the configuration region information in the selected WWN file.
To save the WWN data to a file, type
oslpcfg savewwn n=<adapter number> c=<wwn filename>
The following example reads the configuration region information on adapter #4 and
saves it to the contents of the ctwwn.sav file:
oslpcfg savewwn n=4 c=ctwwn.sav
Restoring WWN and Updating NVPARMS (restorewwn)
This command restores words 0 and 1 of the IEEE address from a specified file created
with the savewwn command and uses them to update the NVPARMS port name with
this IEEE address.
To restore the WWN, type
oslpcfg restorewwn n=<adapter number> c=<wwn filename>
The following example updates the NVPARMS on adapter #4 with the ctwwn.sav file.
oslpcfg restorewwn n=4 c=ctwwn.sav
Restoring NVPARMS (restorenvwwn)
This command restores the non-volatile WWPN and WWNN to the adapter, replacing
any volatile WWPN and WWNN data, without powering off the adapter.
If the adapter does not have firmware that supports the volatile WWN, the following
error message appears:
Write Volatile Parms Error. Reported Error 48
If this occurs, install firmware that supports the volatile WWN.
To restore the non-volatile WWN, type
oslpcfg restorenvwwn n=<adapter number>
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
53
4. Offline Adapter Management Utility Command Line Interface
Boot Code Commands
The following example restores the non-volatile WWN on adapter #2.
oslpcfg restorenvwwn n=2
Restoring the IEEE address (restoredefwwn)
This command reads the IEEE address (assigned by the manufacturer) and writes it to
the non-volatile WWPN and WWNN.
To restore the IEEE address, type
oslpcfg restoredefwwn n=<adapter number>
The following example restores the IEEE address on adapter #2.
oslpcfg restoredefwwn n=2
Boot Code Commands
You must enable BootBIOS before you can issue setBootDevice and setAltBoot
commands. If necessary, use the enableboot command to enable BootBIOS. (See
“Enabling or Disabling BootBIOS or Boot Code (enableboot/disableboot)” on page 54
for more information.)
To set the boot device with the offline utility, run the following commands in this order:
1. Use the listboot command to verify that the BootBIOS is present. (See “Viewing
BootBIOS Versions (listboot)” on page 47 for more information.)
Example:
oslpcfg listboot n=1
Sample return:
bootBIOS 1 (enabled): ZB2.01A2
bootBIOS 2 (disabled): ZB2.01A1
2. Use the setbootdevice command to set the boot device. (See “Selecting a Boot
Device (setbootdevice)” on page 55 for more information.)
3. Configure the system BIOS so the adapter boot device is the highest in the boot
order.
Enabling or Disabling BootBIOS or Boot Code
(enableboot/disableboot)
This command enables or disables the BootBIOS (boot code) (selected by its index) for
the specified adapter number. Index i is one of the indices (base 1) shown when you run
the listboot command.
To enable BootBIOS, type
oslpcfg enableboot n=<adapter number> i=<index>
The following example enables BootBIOS on adapter #6:
oslpcfg enableboot n=6 i=1
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
54
4. Offline Adapter Management Utility Command Line Interface
Boot Code Commands
To disable BootBIOS, type
oslpcfg disableboot n=<adapter number>
The following example disables BootBIOS on adapter #6:
oslpcfg disableboot n=6
Selecting a Boot Device (setbootdevice)
This command sets the boot device specified by its WWN, LUN, and desired topology.


Set t to 0 for arbitrated loop.
Set t to 1 for point-to-point.
The selected device boots when the system reboots.
The boot code must be enabled before issuing the setbootdevice command.
To set the boot device, type (all on one line)
oslpcfg setbootdevice n=<adapter number> w0=<wwpn word 0> w1=<wwpn
word 1> l=<Decimal ID of LUN> t=<topology>
Note: Enter the LUN number in decimal format.
The following example sets the boot device on adapter #1, LUN #46 with a desired
topology of arbitrated loop:
oslpcfg setbootdevice n=1 w0=a1b2c3d4 w1=b946a4e8 l=46 t=0
Note: If port login fails after 50 msecs, the command is retried once.
Enabling or Disabling Boot Devices
(enablebootdevice/disablebootdevice)
After using the setBootDevice command, you can enable or disable the boot device by
using the enablebootdevice or disablebootdevice command.
To enable the boot device, type
oslpcfg enablebootdevice n=<adapter number>
To disable the boot device, type
oslpcfg disablebootdevice n=<adapter number>
Read All Alternative Boot Devices (readaltboot)
This command shows the WWN and LUN numbers in decimal format of all possible
alternate boot devices. You can have up to seven alternate boot devices.
To read all alternate boot devices, type (all on one line)
oslpcfg readaltboot n=1
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
55
4. Offline Adapter Management Utility Command Line Interface
Boot Code Commands
Sample response:
Alt Boot 1Boot Device WWN:
10000000
Boot Device LUN:
1
C920A4D6
Alt Boot 2Boot Device WWN:
10000000
Boot Device LUN:
4
C920A4D8
Alt Boot 3Boot Device WWN:
10000000
Boot Device LUN:
3
C920A4DA
Alt Boot 4Boot Device WWN:
10000000
Boot Device LUN:
2
C920A4DC
Alt Boot 5Boot Device WWN:
10000000
Boot Device LUN:
1
C920A4DE
Alt Boot 6Boot Device WWN:
Boot Device LUN:
10000000
C920A4F2
14
Selecting One or More Alternate Boot Devices (setaltboot)
This command sets alternate boot devices. You can set up to seven alternate boot
devices, that is, index i can be from 1 to 7.
Note: The boot code must be enabled before you issue the setAltBoot command.
To set up one or more alternate boot devices, type (all on one line)
oslpcfg setaltboot n=<adapter number> i=<index> w0=<wwpn word 0>
w1=<wwpn word 1> l=<Decimal ID of LUN>
The following example sets the alternate boot device on adapter #1, LUN #3:
oslpcfg setaltboot n=1 i=1 w0=12345678 w1=a842b6 l=3.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
56
4. Offline Adapter Management Utility Command Line Interface
Configuration Commands
Configuration Commands
Updating Configuration Regions (config)
There are two forms of configuration:


Configure all adapters of a given adapter name at once
Configure a single adapter by its number
Valid region numbers range from 0 to 32.
Update by Name
To update a specified configuration region on all adapters of the same selected name,
type (all on one line)
oslpcfg config a=<adapter name> r=<region number> c=<configuration
filename>
Note: The adapter name is the name that appears when you run the listHBA
command. For more information on the listHBA command, see “Viewing All
Adapters in the System (listhba)” on page 48.
The following example updates region 6 of all LP11000 adapters with ctplus1.cfl:
oslpcfg config a=lp11000 r=6 c=ctplus1.cfl
The following example updates region 17 of all ABC24-FC56 adapters with
d:\dfplus1.cfl:
oslpcfg config a=ABC24-FC56 r=17 c=d:\dfplus1.cfl
Note: The size of the .cfl file for configuration region update can be up to 2028 bytes.
Update by Number
To update a specified configuration region for one adapter, type (all on one line)
oslpcfg config n=<adapter number> r=<region number>
c=<configuration filename>
The following example updates region 17 of adapter number 4 with heplus1.cf1:
oslpcfg config n=4 r=17 c=heplus1.cfl
The following example updates region 6 of adapter number 2 with d:\dfplus1.cf1:
oslpcfg config n=2 r=6 c=d:\dfplus1.cfl
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
57
4. Offline Adapter Management Utility Command Line Interface
Viewing Personality Information (personalityInfo)
Viewing Personality Information (personalityInfo)
Note: The personalityInfo command applies to OneConnect adapters only.
This command displays the current personality and the available personalities.
To view personality information, type
oslpcfg personalityInfo n=<adapter index>
where adapter index is obtained from the listHBA command.
The following example lists the personalityInfo on adapter #3:
oslpcfg personalityInfo n=3
Sample response:
Current Personality: FCoE
Configured Personality: FCoE
Available Personalities:
NIC
iSCSI
FCoE
Command completed, NO Error
Changing Personality Information
(changePersonality)
Note: The personalityInfo command applies to OneConnect adapters only.
This command changes the personality of the adapter to the selected one.
To change personality, type
oslpcfg changePersonality n=<adapter index> p=<personality string>
The following example changes the personality information on adapter #3:
oslpcfg changePersonality n=3 p=iSCSI
Sample response:
Please REBOOT the system now to activate the Personality change
Command completed, NO Error
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
58
4. Offline Adapter Management Utility Command Line Interface
Running Tests
Running Tests
Note: Since the extloopback, intloopback, and pciloopback commands do not support
testing on all installed adapters, the o=3 option applies to running linlpcfg with
the script command. The o=3 option instructs lpcfg to ignore errors and
continue script execution.
Running the External Loopback Test (extloopback)
Note: Extloopback is not supported LPe16000 series FC adapters.
This command runs the external loopback test. You must put a loopback plug in each
adapter channel to be tested. You can test a specific adapter in the system. Specify the
number of times you want the test to repeat, and direct the test response if an error is
found.
The option on error choices are:



o=1 stops the test on the first error
o=2 ignores three errors and stops the test on the fourth error
o=3 ignores errors and continues the test
Note: extloopback does not support testing all installed adapters using n=all.
To run the external loopback test on LightPulse adapters, type (all on one line)
oslpcfg extloopback n=<adapter number> r=<repeat count> o=<option on
error>
Note: You must put a loopback plug in each port tested for extloopback.
To run external loopback test on OneConnect adapters, type (all on one line)
oslpcfg extLoopback n=<adapter index> p=<pattern> c=<byte count>
r=<repeat count>
where:



p = 3 to 8-HEX byte pattern
c = 1500 to 8192
r = 1 to 4096
The following example runs the external loopback test 50 times on adapter #1 and stops
the test if an error occurs:
oslpcfg extloopback n=1 r=50 o=1
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
59
4. Offline Adapter Management Utility Command Line Interface
Running Tests
Running the Internal Loopback Test (intloopback)
This command runs the internal loopback test. You can run the test on a specific
adapter in the system. Specify the number of times you want the test to repeat, and
direct the test response if an error occurs.
The option on error choices are:



o=1 stops the test on the first error
o=2 ignores three errors and stops the test on the fourth error
o=3 ignores errors and continues the test
Notes:


intloopback does not support testing all installed adapters using n=all.
Do not use the internal loopback test on Emulex blade adapters.
To run the internal loopback test, type (all on one line)
oslpcfg intloopback n=<adapter number> r=<repeat count> o=<option on
error>
To run internal loopback test on OneConnect adapters, type (all on one line)
oslpcfg intLoopback n=<adapter index> p=<pattern> c=<byte count>
r=<repeat count> t=<type>
where:




p = 3 to 8-HEX byte pattern
c = 1500 to 8192
r = 1 to 4096
t=2
The following example runs the internal loopback test 100 times on adapter #1 and
stops the test if an error occurs:
oslpcfg intloopback n=1 r=100 o=1
Running the PCI Loopback Test (pciloopback)
This command runs the PCI loopback test. You can run the test on a specific adapter or
on all adapters in the system. Specify the number of times you want the test to repeat,
and direct the test response if an error occurs.
The option on error choices are:



o=1 stops the test on the first error
o=2 ignores three errors and stops the test on the fourth error
o=3 ignores errors and continues the test
Note: pciloopback does not support testing all installed adapters using n=all.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
60
4. Offline Adapter Management Utility Command Line Interface
Using Script Files
To run the PCI loopback test, type (all on one line)
oslpcfg pciloopback n=<all/adapter number> r=<repeat count>
o=<option on error>
The following example runs the PCI loopback test 100 times on all adapters in the
system and stops the testing if any errors occurs.
oslpcfg pciloopback n=<adapter_number> r=100 o=1
Running the DMATest
This command runs the DMA test, which is a direct memory access test of the memory
on the adapter. You can run the test on a specific adapter in the system and specify the
number of times you want the test to repeat.
Notes:


DMATest does not support testing all installed adapters using n=all.
Do not use the DMA test on Emulex blade adapters.
To run the DMA test, type (all on one line)
oslpcfg dmatest <n=adapter> <p=pattern> <c=byte-count>
<r=repeat-count>
The following example runs the DMA test two times on adapter #1:
oslpcfg dmatest n=1 p=abcde c=1500 r=2
Using Script Files
Creating Script Files
You can group commands together and run them using a script file. You can also enter
comment lines, which begin with a semicolon. Each line follows the same command
syntax as those documented in this manual. Using the offline utility, you can



Run commands entered in a script file. Use the @ command to run the script file.
Run commands multiple times. Add the repeat command as the last line of the
script file.
Create a log of test results. Add the logfile command as the first line of the script
file.
To run a script file type:
oslpcfg @<scriptname.txt>
The following example runs the script “script1.txt” that resides in the current directory
and executes all the commands in that script file.
oslpcfg @script1.txt
Note: To interrupt and stop any script, press <S> on the keyboard.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
61
4. Offline Adapter Management Utility Command Line Interface
Using Script Files
Script File Commands
The following is a sample script file. Each command follows the syntax covered above.
The comment lines begin with a semicolon (;):
version
screendisplay o=0
;download a=lpe11000 i=c:\temp\zd272a2.all
;reset n=1 s=0
;reset n=2 s=0
reset n=all s=0
listboot n=1
enableboot n=1 i=2
; pciloopback n=1 r=10 o=1
; pciloopback n=2 r=10 o=2
; pciloopback n=all r=50 o=3
intloopback n=1 r=10 o=1
intloopback n=2 r=10 o=1
extloopback n=1 r=40 o=3
extloopback n=2 r=40 o=3
;repeat r=10
Repeating a Series of Commands (repeat)
Enter this command at the end of a script file to repeat a series of commands from the
beginning of the script file a specific number of times.
Note: To interrupt and stop the repeat command, press <S> on the keyboard.
To repeat the series of commands in the script file, add the following as the last line of
the file:
repeat r=<repeat count>
The following example repeats the series of commands in the script file 10 times.
repeat r=10
Enabling or Disabling Test Messages on the Screen
(screendisplay)
This command enables or disables test message display on the screen.


o=0 – Prevents messages from appearing
o=1 – Enables messages
Note: This command is supported only in script files.
To enable or disable test message displays, add the following line to the script:
screendisplay o=<display option>
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
62
4. Offline Adapter Management Utility Command Line Interface
Using Script Files
In the following script file example, messages from the version and listhba commands
are output to the log file and to the screen. After the screendisplay command is set to 0,
all successive commands (download, listboot, and enableboot) result messages are
output only to the log file, not to the screen.
version
listhba
screendisplay o=0
download a=lpe11000 i=c:\temp\zd272a2.all
listboot n=2
enableboot n=2 i=1
Updating Non-volatile WWNN (scriptwwnn)
This command reads the WWNN words 0 and 1 from the command line to update the
non-volatile WWNN. You can also include this command in a script file. When the
adapter is discovered, the new WWNN value is used. The adapter retains the original
WWNN in another region of the firmware.
Caution:
Use the scriptwwnn command with caution. If you use the same WWNN on
more than one adapter in a fabric, unpredictable results may occur.
To change WWNN words 0 and 1 from the command line, type (all in one line)
oslpcfg scriptwwnn n=<adapter number> w0=<wwnn word 0> w1=<wwnn word 1>
The following example updates non-volatile WWNN word 0 and word 1 for adapter
#1:
oslpcfg scriptwwnn n=1 w0=10000345 w1=B620A1B2
Notes:


Word 0 of WWNN and WWPN names must follow one of the following
formats:
10000xxx
2xxxxxxx
3xxxxxxx
5xxxxxxx
If the scriptvwwnn command has been used previously, the adapter continues
to use that WWNN until you change the WWNN with the restorenvwwn
command.
Updating Non-volatile WWPN (scriptwwpn)
This command reads WWPN words 0 and 1 from the command line to update the
non-volatile WWPN. You can also include this command in a script file. When it is
discovered, the adapter uses the new WWNN value. It does not use the original IEEE
address assigned by manufacturing (located in Configuration Region 16 or 32).
Caution:
Use the scriptwwpn command with caution. If you use the same WWPN on
more than one adapter in a fabric, unpredictable results may occur.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
63
4. Offline Adapter Management Utility Command Line Interface
Using Script Files
Note: If the scriptvwwnn command has been used previously, the adapter continues
to use that WWPN until you change the WWPN with the restorenvwwn
command.
To change WWPN words 0 and 1 from the command line, type (all in one line)
oslpcfg scriptwwpn n=<adapter number> w0=<wwpn word 0> w1=<wwpn word
1>
The following example updates the non-volatile WWPN word 0 word 1 for adapter #1:
oslpcfg scriptwwpn n=1 w0=20A2D6B8 w1=C920A1B2
Updating Volatile WWNN (scriptvwwnn)
This command reads the WWNN words 0 and 1 from the command line to update the
volatile WWNN. When next discovered, the adapter uses this new WWNN. It does not
use the original IEEE address assigned by manufacturing (located in Configuration
Region 16 or 32) nor does it use the value entered by the writewwn or scriptwwnn
commands.
If the adapter does not have firmware that supports the volatile WWN, the following
error message appears:
Write Volatile Parms Error. Reported Error 48
If this occurs, install firmware that supports the volatile WWN.
Notes:


Word 0 of WWNN and WWPN names must follow one of the following
formats:
10000xxx
2xxxxxxx
3xxxxxxx
5xxxxxxx
Once you issue this command, the volatile WWNN is used by the adapter until
the restorenvwwn command is issued or the system is restarted.
Caution:
Use the scriptvwwnn command with caution. If you use the same volatile
WWNN on more than one adapter in a fabric, unpredictable results may
occur.
To change volatile WWNN words 0 and 1 from the command line, type (all in one line)
oslpcfg scriptvwwnn n=<adapter number> w0=<wwnn word 0> w1=<wwnn word 1>
The following example updates the volatile WWNN word 0 word 1 for adapter #1:
oslpcfg scriptvwwnn n=1 w0=20A2D6B8 w1=C920A1B2
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
64
4. Offline Adapter Management Utility Command Line Interface
Using Script Files
Updating Volatile WWPN (scriptvwwpn)
This command reads the WWPN words 0 and 1 from the command line to update the
volatile WWPN. When next discovered, the adapter uses this new WWPN. It does not
use the original IEEE address assigned by manufacturing (located in Configuration
Region 16 or 32) nor does it use the value entered by the writewwn or scriptwwpn
commands.
If the adapter does not have firmware that supports the volatile WWN, the following
error message appears:
Write Volatile Parms Error. Reported Error 48
If this occurs, install firmware that supports the volatile WWN.
Notes:


Word 0 of WWNN and WWPN names must follow one of the following
formats:
10000xxx
2xxxxxxx
3xxxxxxx
5xxxxxxx
Once you issue this command, the volatile WWNN is used by the adapter until
the restorenvwwn command is issued or the system is restarted.
Caution:
Use the scriptvwwnn command with caution. If you use the same VWWNN
on more than one adapter in a fabric, unpredictable results may occur.
To change VWWPN words 0 and 1 from the command line, type (all in one line)
oslpcfg scriptvwwpn n=<adapter number> w0=<wwpn word 0> w1=<wwpn word 1>
The following example updates the volatile WWPN word 0 word 1 for adapter #1:
oslpcfg scriptvwwpn n=1 w0=20A2D6B8 w1=C920A1B2
Creating a Log (logfile)
This command creates a log file with a specified directory and file name. The default
log file is lpcfglog.txt and is created in the system’s current directory.
Note: This command is supported only in script files. Make it the first command in the
script.
To create a log file use the following command as the first command in your script file,
type
logfile l=<filename>
The following example creates a file called lplog.txt in the d:\ directory:
logfile l=d:\log\lplog.txt
Results of all commands are recorded in a log file. Unless otherwise specified by the
logfile command, the default log file is Lpcfglog.txt in the current directory.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
65
4. Offline Adapter Management Utility Command Line Interface
Using Script Files
Sample log file:
>>>>>>>> Test Script starts on Tue Jul 31 14:52:36 2007>>>>>>>>
listhba
adapter 1:
C96C146D
Functional FW: WS2.70A5
LPe1150-F4
adapter 2:
C94B0718
Functional FW: ZS2.72A2
LPe11002-F4
extloopback n=all r=500 o=1
**Start tests on Adapter 1
Run EXT Loopback
Pass 500 test(s)
*Complete tests on Adapter 1, NO error
**Start tests on Adapter 2
Run EXT Loopback
Pass 500 test(s)
*Complete tests on Adapter 2, NO error
intloopback n=all r=500 o=1
**Start tests on Adapter 1
Run INT Loopback
Pass 500 test(s)
*Complete tests on Adapter 1, NO error
**Start tests on Adapter 2
Run INT Loopback
Pass 500 test(s)
*Complete tests on Adapter 2, NO error
pciloopback n=all r=500 o=1
**Start tests on Adapter 1
Run PCI Loopback
Pass 500 test(s)
*Complete tests on Adapter 1, NO error
**Start tests on Adapter 2
Run PCI Loopback
Pass 500 test(s)
*Complete tests on Adapter 2, NO error
extloopback n=all r=500 o=1
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
66
4. Offline Adapter Management Utility Command Line Interface
Using Script Files
**Start tests on Adapter 1
EXTLB: Error - Link is not UP
Encounter Error, stop all tests
>>>>>>> Test Script stops on Tue Jul 31 14:53:45 2007
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
67
5. Offline and Online Adapter Management Utility Status Messages
Using Script Files
5. Offline and Online Adapter Management
Utility Status Messages
The Offline Adapter Management Utility takes a less stringent approach to reporting
status messages when used with auto-discovery. An error message is returned only
when the Offline Adapter Management Utility reports a failure during a download or if
the firmware and boot directories cannot be located.
Table 5-1 Elxflash Status Messages
Message
Number Message Title
Message Details
0
GOOD_ALL_UPGRADES_OK
Returned if any of the discovered adapters
had a successful download performed.
1
GOOD_NO_UPDATES_NEEDED
Returned if any of the discovered adapters
did not need an update, downgrade, or
rewrite operation.
This should never be returned during a force
firmware or force boot code download
operation.
2
ERROR_ALL_UPGRADES_FAILED
Returned if all attempted downloads failed.
3
ERROR_SOME_UPGRADES_FAILED
Returned if some of the attempted
downloads failed.
4
ERROR_EMULEX_APPS_COMMAND
Returned if Elxflash cannot execute an
external executable such as:
• oslpcfg (elxflashOffline)
• hbacmd (elxflashOnline)
• ethool (ElxflashOFfline NIC Only)
5
ERROR_NO_SUPORTED_HBA_FOUND
Returned if no supported adapters are
found.
6
ERROR_DIRECTORY_NOT_FOUND
Returned if the firmware or boot directories
are missing. Depending on the operation,
auto-discovery expects the firmware or boot
directories to exist as subdirectories in the
root of the package directory.
7
GOOD_NO_UPGRADES_AVAILABLE
Returned if none of the discovered adapters
had a matching image in the firmware or
boot directories. In this case only, a
matching image is an image that the
adapter accepts regardless of the download
operation being performed.
8
ERROR_NOT_ADMIN_USER
Returned when you attempt to run the
executable file and do not have
administrator (Windows) or root (Linux)
privileges.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
68
5. Offline and Online Adapter Management Utility Status Messages
Using Script Files
Table 5-1 Elxflash Status Messages (Continued)
Message
Number Message Title
Message Details
9
ERROR_UNSUPPORTED_OS
Used by the Exlflash Standalone execution
scripts. Returned when the scripts are run
on an unsupported operating system.
10
ERROR_UNSUPPORTED_ARCH
Used by the Exlflash Standalone execution
scripts and returned when the scripts are
run on an unsupported architecture.
11
GOOD_ALL_UPGRADES_OK_SKIPPED_UNSUP_O An unsupported OCe10100 was discovered,
C10
but all downloads to the other adapters
succeeded.
12
GOOD_NO_UPDATES_NEEDED_SKIPPED_UNSUP
_OC10
13
ERROR_ALL_UPGRADES_FAILED_SKIPPED_UNSU An unsupported OCe10100 was discovered,
P_OC10
and all downloads to the other adapters
failed.
14
ERROR_SOME_UPGRADES_FAILED_SKIPPED_UNS An unsupported OCe10100 was discovered,
UP_OC10
and some downloads to the other adapters
failed.
15
ERROR_NO_SUPPORTED_HBA_SKIPPED_UNSUP
_OC10
16
GOOD_NO_UPGRADES_AVAILABLE_SKIPPED_UN An unsupported OCe10100 was discovered,
SUP_OC10
but no applicable firmware or boot code
images were found for supported adapters.
19
ERROR_IMAGE_VERSION
An unsupported OCe10100 was discovered,
and no updates were needed on the other
adapters.
An unsupported OCe10100 was discovered,
but no other adapters were discovered.
An error occurred when decoding the image
version. The image file has an invalid
extension, or elxflash was unable to decode
the image file's version.
Note: This is returned only when using the
/iv=<image_version> switch.
20
ERROR_MISSING_DEP
Offline and Online Adapter Management Utilities Version 10.2 User Manual
The application is missing one or more
dependencies.
P010071-01A Rev. A
69
6. Offline LPCfg Error Codes
Using Script Files
6. Offline LPCfg Error Codes
The following table lists the offline LPCfg error codes.
Table 6-1 LPCfg Error Codes
Error Code
Description
0
No error
1
Invalid adapter number
2
Mailbox command error
3
No valid boot (BIOS) code found
4
Open file error
5
Invalid configuration region
6
Invalid adapter name
7
Download error
8
Invalid boot (BIOS) code index
9
Link not up for external loopback test
10
Link not up for internal loopback test
11
Invalid jumper selection (in jumper command)
12
Invalid alternate configuration region (in jumper command)
13
PCI loopback test fails
14
Adapter reset error
15
Read configuration region error
16
No VPD information available
17
No command in command line
18
Open log file error
19
Read wakeup parameters error
20
Update wakeup parameters error
21
Incorrect test parameters
22
Stopped by user
23
Internal loopback test fails
24
External loopback test fails
25
Error exists after four retries
26
Invalid command
27
Incorrect syntax
28
Command supported only in script files
29
Read_rev error
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
70
6. Offline LPCfg Error Codes
Using Script Files
Table 6-1 LPCfg Error Codes (Continued)
Error Code
Description
30
Dump configuration region error
31
Read file error
32
Short file error
33
Read NVPARMS error
34
Write NVPARMS error
35
Command does not support all adapters
36
Invalid LUN number
37
No boot (BIOS) code enabled
38
Update configuration region error
39
No boot (BIOS) found
40
Dump memory error
41
Update EROM error
42
Delete load entry error
43
Write WWN error
44
Not supported in script files
45
No Emulex adapter found
46
Invalid Alternate Boot Device Index
47
Cannot restart adapter
48
Write volatile parameters error
49
POST test error
50
Incorrect symbols
51
Invalid length
52
Invalid topology
53
No event log
54
Read event log
55
Invalid input value
56
No libdfc library
57
Non-numeric input
58
No valid WWN
59
Region cleanup
60
Region initialization
62
Unable to allocate memory
63
DFC_InitDiagEnv error
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
71
6. Offline LPCfg Error Codes
Using Script Files
Table 6-1 LPCfg Error Codes (Continued)
Error Code
Description
64
DFC_ReadPciCfg error
65
No driver installed
66
No valid driver
67
Not valid adapter type
68
Not valid image
69
Long file error
70
Incompatible image
71
Not supported
72
MILI service not started
73
Script not supported
74
MILI not started
75
No NIC adapter
76
Personality information
77
Personality change
78
Administrator rights error
79
SLI-4 management error
80
Reboot required
83
Application is missing one or more dependencies.
141
General error from MILI
200
General error
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
72
7. Troubleshooting
Unsupported Driver
7. Troubleshooting
The force firmware (/ff), force boot (/fb), and force firmware and boot code (/f)
switches take precedence over the /downgrade, /update, and /rewrite switches. If /ff,
/fb, or /f are used, the /downgrade, /update, and /rewrite switches are ignored.
The following examples illustrate this behavior:
1. ./elxflash /ff /update
a. /update is ignored.
b. Performs a force firmware operation on all installed and supported adapters.
2. ./elxflash /fb /update
a. /update is ignored.
b. Performs a force boot code operation on all installed and supported adapters.
3. ./elxflash /ff /downgrade
a. /downgrade is ignored
b. Performs a force firmware operation on all installed and supported adapters.
4. /elxflash /fb / downgrade
a. /downgrade is ignored.
b. Performs a force boot code operation on all installed and supported adapters.
5. ./elxflash /ff /rewrite
a. /rewrite is ignored
b. Performs a force firmware operation on all installed and supported adapters.
6. ./elxflash /fb / rewrite
a. /rewrite is ignored.
b. Performs a force boot code operation on all installed and supported adapters.
Unsupported Driver
The Offline Adapter Management Utility outputs an error similar to the following if an
unsupported driver is installed on the system:
elxflash: no supported Emulex HBA's found - Return Code=1
If an error similar to the above occurs, verify that the correct version of the driver is
installed. For supported adapters, and supported versions of operating systems and
platforms, see the Emulex website.
Updating Adapters without Boot Code
The Offline Adapter Management Utility reports an adapter's boot code version as
“NONE” when the adapter does not have boot code installed. The Offline Adapter
Management Utility does not update, downgrade, or rewrite the boot area if boot code
is not present, but firmware will still be updated or downgraded without boot code.
You can force a boot code download using auto-discovery or the fwmatrix.txt file.
Offline and Online Adapter Management Utilities Version 10.2 User Manual
P010071-01A Rev. A
73
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement