2400, 2500, 2600, 2700 Series Fibre Channel Adapters
3200 Series Intelligent Ethernet Adapters
4000 Series iSCSI Adapters
8100, 8200, 8300 Series Converged Network Adapters
10000 Series FabricCache Adapters
SN0054667-00 Y
User’s Guide—QConvergeConsole CLI
2400, 2500, 2600, 2700, 3200, 4000, 8100, 8200, 8300, and 10000 Series Adapters
Document Revision History
Revision A, December 13, 2010
Revision B, March 31, 2011
Revision C, October 19, 2011
Revision D, September 12, 2012
Revision E, November 12, 2012
Revision F, March 19, 2013
Revision G, May 6, 2013
Revision H, October 18, 2013
Revision J, April 17, 2014
Revision K, June 17, 2014
Revision L, July 2, 2014
Revision M, October 10, 2014
Revision N, March 23, 2015
Revision P, August 24, 2015
Revision R, February 23, 2016
Revision T, June 28, 2016
Revision W, September 29, 2016
Revision X, January 13, 2017
Revision Y, September 15, 2017
ChangesSections Affected
Added installation command for Ubuntu (aarch64).“Installing QConvergeConsole CLI in a Linux Envi-
ronment” on page 7
Added uninstallation command for Ubuntu
(aarch64).
Updated the -i command example that shows
how to determine if the adapter port is not online
because the switch port is currently under D_Port
diagnostic mode (loop down).
“Uninstalling QConvergeConsole CLI in a Linux
Environment” on page 13
“-i (FC Adapter Information; FC VPD Information;
FC VFC Information)” on page 100
Added a new -mbiv command example that
shows how to display the adapter flash information
from the last update.
“-mbiv” on page 113
iiSN0054667-00 Y
User’s Guide—QConvergeConsole CLI
2400, 2500, 2600, 2700, 3200, 4000, 8100, 8200, 8300, and 10000 Series Adapters
Added a footnote regarding the Adapter Type Selection option.
Added new option, FC Flash Information, to the
FC Adapter Information menu.
Added new Principal Fabric WWN and Adjacent Fabric WWN items in the example
output.
Added information for the new FC Flash Informa-tion option.
Changed the name of the Fibre Channel Adapter
Configuration menu to FC Adapter Configuration.
In the command example, changed the parameter
name from Enable LR to Enable LR Ext. Credits.
In the menu example, changed the option from
Enable LR to Enable LR Ext. Credits
and added a bullet to the note to indicate that the
Enable LR Ext. Credits options allow you to
enable either 10km or 5km and verify the current
setting.
“Adapter Information” on page 199
“FC Adapter Information (-i)” on page 199
“FC Port Information” on page 200
“FC Flash Information” on page 205
“Adapter Configuration” on page 205
“Display HBA Parameters (-c)” on page 209
“Configure HBA Parameters (-n)” on page 210
Updated the FEC Configuration Menu options.“FEC (-fec)” on page 242
Changed the name of the BB Credit option to BB Credit Recovery.
Updated the FC Adapter Update menu with new
and changed options.
Changed the name of the FC SerDes Table Update option to FC Board Config Update.
Removed the note that indicated that the option
was only for blades and mezzanine adapters.
Changed the name of the FC Dump option to FC Firmware Dump.
Changed the name of the FC Diagnostics menu
to FC Adapter Diagnostics, and added and
changed items on that menu.
Changed the name of the FC Ping Test menu to Device Ping Test.
“BB Credit Recovery (-bbcr)” on page 243
“Adapter Updates” on page 243
“FC Board Config Update (-sp)” on page 249
“FC Firmware Dump (-fwdump)” on page 249
“Adapter Diagnostics” on page 250
“Device Ping Test (-fcp)” on page 259
iiiSN0054667-00 Y
User’s Guide—QConvergeConsole CLI
2400, 2500, 2600, 2700, 3200, 4000, 8100, 8200, 8300, and 10000 Series Adapters
Added new options on the FC Adapter Diagnos-tics menu.
This guide describes QConvergeConsole® (QCC) CLI, a management tool that is
used to configure and manage QLogic
Ethernet Adapters, iSCSI Adapters, Converged Network Adapters, FastLinQ™
Intelligent Ethernet Adapters, and FabricCache
Intended Audience
This guide is for system administrators who are responsible for installing,
configuring, and managing QLogic adapters using QConvergeConsole CLI.
What Is in This Guide
This guide contains the basic information you need to get started with the
QConvergeConsole CLI tool.
This preface specifies the intended audience, summarizes the contents of this
guide, explains the QConvergeConsole CLI help system, lists related documents,
describes the typographic conventions used in this guide, refers you to the QLogic
license agreements, and provides technical support and contact information.
The remainder of the user’s guide is organized into the following parts and
chapters:
Part I General CLI Information
Chapter 1 System Requirements lists the hardware, software, and operating
system requirements needed for successful operation of the QCC CLI tool.
®
Fibre Channel Adapters, Intelligent
®
Adapters within SANs.
Chapter 2 Installing and Uninstalling QConvergeConsole CLI describes how
to download, install, and uninstall the QCC CLI tool.
Chapter 3 Getting Started describes how to start the QCC CLI tool on
Windows
to view detailed information about command parameters and options.
®
, Linux®, and Solaris® platforms. This chapter also describes how
Part II Noninteractive Commands
Chapter 4 General Noninteractive Commands describes and shows
examples of the general noninteractive commands that apply to protocols
supported by the QCC CLI tool: NIC, Fibre Channel, and iSCSI.
xxviSN0054667-00 Y
Preface
What Is in This Guide
Chapter 5 NIC Noninteractive Commands describes the noninteractive NIC
command synt
ax and parameters.
Chapter 6 Fibre Channel Noninteractive Commands de
no
ninteractive Fibre Channel command syntax and parameters.
Chapter 7 iSCSI Noninteractive Commands describes the noninte
iSCSI command synt
ax and parameters.
Chapter 8 NIC Partitioning (NPAR) Noninteractive Commands de
no
ninteractive NIC Partitioning (NPAR) command syntax and parameters.
scribes the
ractive
scribes the
Part III Interactive Commands
Chapter 9 NIC Interactive Commands contains a description of the QCC CLI
tool’s NIC interactive mode menus.
Chapter 10 Fibre Channel Interactive Commands contains a d
the
QCC CLI Fibre Channel interactive mode menus.
escription of
Chapter 11 Converged Network Adapter Interactive Commands contains a
scription of the QCC CLI tool’s Converged Network Ada
de
mode menus for th
e NIC, iSCSI, Fibre Channel, and NPAR functions.
Chapter 12 Setting Up NPAR Using Interactive Commands contains
for
setting up NIC Partitioning (NPAR) using the intera
pter interactive
steps
ctive mode menus of
the QCC CLI tool.
Part IV FabricCache Commands
Chapter 13 Getting Started with FabricCache CLI provides the general
formation to help you get started using the FabricCache CLI tool,
in
stallation, getting help, scripting, and usage.
in
including
Chapter 14 General FabricCache CLI Keywords provides the de
an
d syntax for each of the general keywords that apply to all commands.
scription
Chapter 15 FabricCache CLI Command Reference provides the description,
syntax, and examples of each of the common FCA CLI commands.
commands are list
ed in alphabetic order by category.
The
Chapter 16 FabricCache CLI API Error Codes lists the error codes that exist
the API and explains the meaning of each.
in
Appendix A NIC Partitioning (NPAR) Overview provides an overview of
pa
rtitioning.
NIC
At the end of this guide is a glossary of terms and an index to help you quickly
locate the information you need.
xxviiSN0054667-00 Y
Preface
NOTE
CAUTION
What Is in the Help System
What Is in the Help System
The QConvergeConsole CLI help system (qaucli -h) contains a condensed
version of the NIC, Fibre Channel, iSCSI, and NPAR noninteractive commands
that are described in the following:
Chapter 5 NIC Noninteractive Commands
Chapter 6 Fibre Channel Noninteractive Commands
Chapter 7 iSCSI Noninteractive Commands
Chapter 8 NIC Partitioning (NPAR) Noninteractive Commands
Related Materials
For additional help installing or using QConvergeConsole CLI, refer to the
following related documents posted on the QLogic Web site:
http://driverdownloads.qlogic.com
QConvergeConsole CLI Read Me
For information about the QConvergeConsole GUI tool, refer to the following
document:
Installation Guide—QConvergeConsole GUI (part number SN0054669-00)
For additional information related to 10000 Series Adapters, including caching
and clustering, refer to the following document:
User’s Guide—QLogic FabricCache Adapter, 10000 Series (part number
SN0054680-00)
For information related to supported operating systems and known issues, refer to
the following documents:
QLogic FabricCache 10000 Series Adapter Firmware Read Me and Release
Notes
Host CLI for QLogic 10000 Series Adapter Read Me and Release Notes
Documentation Conventions
This guide uses the following documentation conventions:
provides additional information.
without an alert symbol indicates the presence of a hazard
that could cause damage to equipment or loss of data.
xxviiiSN0054667-00 Y
Preface
Documentation Conventions
Te xt in blue font indicates a hyperlink (jump) to a figure, table, or section in
this guide, and links to Web sites are shown in underlined blue
example:
Table 9-2 lists problems related to the user interface and remote agent.
See “Installation Checklist” on page 6.
For more information, visit www.qlogic.com
Te xt in bold font indicates user interface elements such as a menu items,
buttons, check boxes, or column headings. For example:
Click the Start button, point to Programs, point to Accessories, and
Under Notification Options, select the Warning Alarms check box.
Te xt in Courier font indicates a file name, directory path, or command line
text. For example:
To return to the root directory from anywhere in the file structure:
then click Command Prompt.
cd /root and press ENTER.
Type
. For
.
Issue the following command: sh ./install.bin.
Key names and key strokes are indicated with UPPERCASE:
Press CTRL+P.
Press the UP ARROW key.
Te xt in italics indicates terms, emphasis, variables, or document titles. For
example:
For a complete listing of license agreements, refer to the QLogic
Software End User License Agreement.
What are shortcut keys?
To enter the date type mm/dd/yyyy (where mm is the month, dd is the
day, and yyyy is the year).
Topic titles between quotation marks identify related topics either within this
manual or in the online help, which is also referred to as the help system
throughout this document.
Command Line Interface Documentation Conventions
This section discusses documentation conventions that are specific to the
command line interface (CLI).
Plain text indicates items that you must type as shown. For example:
qaucli -pr nic -ei
xxixSN0054667-00 Y
Preface
Documentation Conventions
< > (angle brackets) around text indicate a variable whose value you specify.
For example:
<se
[ ] (square brackets) indicate an optional parameter. For example:
[<file_name>] means specify a file name, or omit it to select
| (vertical bar) indicates mutually exclusive options; select one option only
For example:
on|off
1|2|3|4
... (ellipsis) indicates that the preceding item may be repeated. For example:
x... means one or more instances of x.
[x...] means zero or more instances of x.
{ } (braces) denote a parameter group that you can specify one or more
times.
Whe
pa
rameters to avoid logical ambiguity. For example:
a|b c is ambiguous
{(a|b) c} means a or b, followed by c
{a|(b c)} means either a, or
rial_number>
ault file name.
def
n used together, ( ) (parentheses) and { } (braces) indicate g
b c
the
.
rouping of
Conventions for Interactive Commands
Documentation conventions that are specific to the menu-driven CLI commands
include the following:
Breadcrumbs line: Section headings for interactive commands include
bre
adcrumbs line that shows the sequence of menu options from
Menu to the current topic.
at you access the Flash Update option by selecting option 3 (on the Ma
th
enu), option 1 (on the second menu), and option 1 (on the third menu):
M
3. Adapter Updates
Noninteractive command equivalents: Some interactive commands have
ninteractive command equivalents. For such commands, the
no
corresponding noninteractive option is listed at the end of the section
heading in parentheses. For example, the following heading f
in
teractive Fibre Channel command FC Adapter Information indicates that
the noninteractive equivalent is the -i command line optio
the
Refer to the QLogic Software End User License Agreement for a complete listing
of all license agreements affecting this product.
Technical Support
Customers should contact their authorized maintenance provider for technical
support of their QLogic products. QLogic-direct customers may contact QLogic
Technical Support; others will be redirected to their authorized maintenance
provider. Visit the QLogic support Web site listed in Contact Information for the
latest firmware and software updates.
For details about available service plans, or for information about renewing and
extending your service, visit the Service Program Web page:
The QLogic Web site provides periodic updates to product firmware, software,
and documentation.
To download firmware, software, and documentation:
1.Go to the QLogic Downloads and Documentation page:
http://driverdownloads.qlogic.com
2.In the search box, type the name of your QLogic adapter model.
3.In the search results list, locate and select the firmware, software, or
documentation for your product.
4.View the product details Web page to ensure that you have the correct
firmware, software, or documentation. For additional information, click Read Me and Release Notes under Support Files.
5.Click Download Now.
6.Save the file to your computer.
7.If you have downloaded firmware, software, drivers, or boot code, follow the
installation instructions in the Read Me document.
Instead of typing a model name in the search box, you can perform a guided
search as follows:
1.Click the product type tab: Adapters, Switches, Routers, or ASICs.
2.Click the corresponding button to search by model or operating system.
3.Click an item in each selection column to define the search, and then click
Go.
xxxiSN0054667-00 Y
Preface
Technical Support
4.Locate the firmware, software, or document you need, and then click the
item’s name or icon to download or open the item.
Training
QLogic Global Training maintains a Web site at www.qlogictraining.com offering
online and instructor-led training for all QLogic products. In addition, sales and
technical professionals may obtain Associate and Specialist-level certifications to
qualify for additional benefits from QLogic.
Contact Information
QLogic Technical Support for products under warranty is available during local
standard working hours excluding QLogic Observed Holidays. For Support phone
numbers, see the Contact Support link:
support.qlogic.com
Support Headquarters
QLogic Web Site
Technical Support Web Site
Technical Support E-mail
Technical Training E-mail
Knowledge Database
The QLogic knowledge database is an extensive collection of QLogic product
information that you can search for specific solutions. QLogic is constantly adding
to the collection of information in the database to provide answers to your most
urgent questions. Access the database from the QLogic Support Center:
support.qlogic.com
QLogic Corporation
12701 Whitewater Drive
Minnetonka, MN 55343 USA
www.qlogic.com
support.qlogic.com
support@qlogic.com
training@qlogic.com
xxxiiSN0054667-00 Y
Part I
General CLI Information
Part I of this guide provides general information about QConvergeConsole CLI in
the following chapters:
Chapter 1 System Requirements
Chapter 2 Installing and Uninstalling QConvergeConsole CLI
Chapter 3 Getting Started
1SN0054667-00 Y
1System Requirements
NOTE
QConvergeConsole CLI is a management tool that centralizes management and
configuration of QLogic adapters within the entire network (LAN and SAN). For
optimum performance, QConvergeConsole CLI requires the hardware, software,
and operating systems listed in this chapter:
Hardware Requirements
“Software Requirements” on page 3
“Operating System Requirements” on page 3
“Supported QLogic Adapters” on page 4
Hardware Requirements
For the latest information on supported hardware, refer to the
QConvergeConsole CLI Read Me and Release Notes.
QConvergeConsole CLI requires the following minimum hardware for the
workstation server:
Server.
“Operating System Requirements” on page 3
Processor. Intel® Core™ or AMD64 processor.
Memory. 256MB of physical RAM to run QConvergeConsole CLI.
Hard disk space. About 110MB disk space.
The minimum hardware requirements for the adapter are as follows:
Adapters. One or more of the QLogic adapters listed under “Supported
QLogic Adapters” on page 4.
Single-processor or multiprocessor server or workstation. See
for a list of operating systems.
2SN0054667-00 Y
1–System Requirements
NOTE
NOTE
NOTE
Software Requirements
The minimum requirements for a SAN environment are as follows
Storage. Fibre Channel or iSCSI devices, such as disks and RAID
subsystems. QConvergeConsole CLI supports most Fibre Channel and
iSCSI devices. For details, see the Interoperability Guide—Storage Networking, which you can download from the following QLogic Web page:
http://connect.qlogic.com/interopguide/info.asp
Tape devices and backup protection software must support persistent binding
Software Requirements
For the latest information on supported software, refer to the
QConvergeConsole CLI Read Me and Release Notes documents.
QConvergeConsole CLI requires the following software for the server on which
your adapter is physically installed:
:
.
Administrative privileges to perform management functions
QLogic adapter drivers for your operating system
To download QLogic adapter drivers and agents, see the QLogic
Corporation Web site:
http://driverdownloads.qlogic.com
Operating System Requirements
QConvergeConsole CLI runs on the following platforms:
Microsoft
Red Hat
Novell
Oracle
Solaris
Citrix
®
Windows Server®
®
Linux® Advance Server/Enterprise Server
®
SUSE
®
Linux Unbreakable Enterprise Kernel (UEK) R2 (2.6.39-400 kernel)
®
®
XenServer
®
Linux Enterprise Server (SLES®)
SPARC® and Solaris x86
®
3SN0054667-00 Y
1–System Requirements
NOTE
NOTE
Supported QLogic Adapters
For an up-to-date list of supported operating system versions, refer to the
QConvergeConsole CLI Read Me, which can be downloaded from the
QLogic Corporation Web site:
http://driverdownloads.qlogic.com
Supported QLogic Adapters
QConvergeConsole CLI supports the following QLogic-branded adapters:
2400, 2500, 2600, and 2700 Series Fibre Channel Adapters
3200 Series Intelligent Ethernet Adapters
4000 Series iSCSI Adapters
8100, 8200, and 8300 Series Converged Network Adapters
10000 Series FabricCache Adapters
For information about QLogic adapters, refer to the QLogic
Corporation Web site:
http://www.qlogic.com/Products/adapters
To determine support for OEM-branded adapters, please contact your OEM.
4SN0054667-00 Y
2Installing and Uninstalling
NOTE
QConvergeConsole CLI
This chapter describes how to download, install, and uninstall QConvergeConsole
CLI.
Downloading QConvergeConsole CLI
“Installing QConvergeConsole CLI” on page 6
“Uninstalling QConvergeConsole CLI” on page 11
QConvergeConsole CLI configures QLogic adapters on the local system
(where it is installed) only. It cannot configure adapters on remote systems.
Downloading QConvergeConsole CLI
Follow this procedure to download the QConvergeConsole CLI package file from
the QLogic Web site to your computer.
To download QConvergeConsole CLI from the QLogic Web site:
1.Go to the QLogic Downloads and Documentation page:
http://driverdownloads.qlogic.com
2.In the search box, type the model name of your QLogic adapter.
Alternatively, you can use a guided search, as described in “Downloading
Updates” on page xxxi.
3.In the search results list, locate and select the QConvergeConsole CLI
version for your operating system.
4.View the product details Web page to ensure that you have the correct
QConvergeConsole CLI.
5.(Optional) For additional information, click the Read Me and Release Notes
under Support Files.
5SN0054667-00 Y
2–Installing and Uninstalling QConvergeConsole CLI
NOTE
Installing QConvergeConsole CLI
6.Click Download Now.
7.Save the file to your computer
.
Installing QConvergeConsole CLI
The installation procedures differ depending on the operating system:
Installing QConvergeConsole CLI in a Windows Environment
Installing QConvergeConsole CLI in a Linux Environment
Installing QConvergeConsole CLI in a Solaris Environment
Installing QConvergeConsole CLI in a Windows Environment
You can install QConvergeConsole CLI from the command prompt using the
Microsoft
Standard Windows Interactive (CLI) Installation
Quiet or Silent Windows Installation
Passive Windows Installation
®
Windows Installer (MSI). Use one of the following methods:
You can also configure the installation using MSI commands. To see a
summary of MSI commands, type msiexec at the command prompt.
To obtain more information about MSI, visit the Microsoft Web site.
Standard Windows Interactive (CLI) Installation
To begin a standard installation of QConvergeConsole CLI on a Microsoft
Windows operating system, unzip the file that you saved in Step 7 of
“Downloading QConvergeConsole CLI” on page 5. Then, issue one of the
following commands on a command line:
QConvergeConsoleCLI-<version>_win.msi
or
QConvergeConsoleCLI-<version>_win_x64.msi
where <version> is the version number of the QConvergeConsole CLI.
The default directory for the QConvergeConsole CLI tool is:
Program Files\QLogic Corporation\QConvergeConsoleCLI
6SN0054667-00 Y
2–Installing and Uninstalling QConvergeConsole CLI
Installing QConvergeConsole CLI in a Linux Environment
If you want to install QConvergeConsole CLI in a different directory, enter it in the
command line. For example:
where <directory> is the full path name of the installation directory.
Quiet or Silent Windows Installation
A quiet or silent installation installs using defaults. This mode requires no user
intervention. Issue the following command for a quiet (silent) installation:
A passive installation installs using default settings and displays a progress
indication only. This is an unattended mode installation. Issue the following
command for a passive installation:
2–Installing and Uninstalling QConvergeConsole CLI
Uninstalling QConvergeConsole CLI in a Linux Environment
Uninstalling QConvergeConsole CLI in a Linux Environment
To uninstall QConvergeConsole CLI on a Red Hat or SUSE Linux operating
system, issue the following command:
# rpm -e QConvergeConsoleCLI
To uninstall QConvergeConsole CLI on an Ubuntu system, issue the following
command:
root@ubuntu:~# dpkg -r qconvergeconsolecli
(Reading database ... 73791 files and directories currently
installed.)
Removing qconvergeconsolecli (2.2.00-xx) ...
Uninstalling QConvergeConsole CLI in a Solaris Environment
If QConvergeConsole CLI was installed using p5p files, refer to “Uninstalling a p5p
Installation (Solaris 11 Only)” on page 14. Otherwise, refer to Uninstalling a
Package Installation (Solaris 10 or 11).
Uninstalling a Package Installation (Solaris 10 or 11)
If package files were used to install QConvergeConsole CLI in a Solaris 10 or 11
SPARC or x86 environment (see “Installation Using Package Files (Solaris 10 or
11)” on page 8), issue the pkgrm QCCLI command to uninstall
/opt/QLogic_Corporation <shared pathname not removed>
/opt <shared pathname not removed>
## Executing postremove script.
## Updating system information.
Removal of <QCCLI> was successful.
Uninstalling a p5p Installation (Solaris 11 Only)
If p5p files were used to install QConvergeConsole CLI in a Solaris 11 SPARC or
x86 environment (see “Installation Using p5p Files (Solaris 11 Only)” on page 10),
issue the pkg uninstall qaucli command to uninstall QConvergeConsole
CLI.
For example:
# pkg uninstall qaucli
Packages to remove: 1
Create boot environment: No
Create backup boot environment: No
Services to change: 1
PHASE ITEMS
Removin
Updating package state data
Updating package cache 1/1
Updating image state Done
Creating fast lookup databa
g old actions70
base
se
9/709
Done
Done
14SN0054667-00 Y
2–Installing and Uninstalling QConvergeConsole CLI
Uninstalling QConvergeConsole CLI in a Solaris Environment
## Executing postremove script.
## Updating system information.
Removal of <QCCLI> was successful.
15SN0054667-00 Y
3Getting Started
QConvergeConsole CLI manages iSCSI, Ethernet, and Fibre Channel functions
on QLogic Fibre Channel Adapters, Intelligent Ethernet Adapters, and Converged
Network Adapters. This chapter describes how to start the QConvergeConsole
CLI using the noninteractive mode (command line interface) and the interactive
mode (menu-driven interface), as well as how to get help.
Using Noninteractive Mode
“Using Interactive Mode” on page 17
“Getting Help” on page 18
Using Noninteractive Mode
Noninteractive mode is a command line interface that executes a command and
its parameters, and then terminates. Use the noninteractive mode to run
QConvergeConsole CLI from a script file or when you want to perform a single
operation. This guide describes the noninteractive mode commands by function in
the following chapters:
Chapter 5 NIC Noninteractive Commands
Chapter 6 Fibre Channel Noninteractive Commands
Chapter 7 iSCSI Noninteractive Commands
Chapter 8 NIC Partitioning (NPAR) Noninteractive Commands
To start the noninteractive QConvergeConsole CLI in Windows
operating system shell, and then type a command with one or more command line
switches. For specific command formats, refer to the chapter for the
corresponding adapter function. For example, to discover iSCSI ports on a
Converged Network Adapter, issue the following command:
qaucli -pr iscsi -i
QConvergeConsole CLI is case-sensitive. In addition, file names in some
operating systems are case-sensitive; in this case, QConvergeConsole CLI is
case-sensitive for that specific file.
1
For Windows 2008 or later, use administrator mode.
16SN0054667-00 Y
1
or Linux, open an
3–Getting Started
Using Interactive Mode
Using Interactive Mode
Interactive mode is a menu-driven interface that manages QLogic Ethernet
Adapters, QLogic Fibre Channel Adapters, and all functions of QLogic Converged
Network Adapters, including NIC, Fibre Channel, iSCSI and NPAR. The interface
for each adapter type is described in its own separate chapter:
"When the following command is executed: qaucli.exe -pr all -h, the help is
printed below
.\qaucli.exe -pr all -h
QConvergeConsole
Version 1.0.1 (Build 28)
Copyright (C) 2012 QLogic Corporation
Build Type: Release
Build Date: Jan 26 2012 17:58:07
20SN0054667-00 Y
3–Getting Started
Getting Help
Usage: qaucli [options]
The following is a simplified help for extension
of non-interactive commands for all protocols (NIC/FC/iSCSI).
Non-interactive mode syntax:
qaucli -pr all -switch [options]
where switch is one of the following command line switches:
-help // Display help info
-h // Same as -help
-? // Same as -help
? // Same as -help
-ei // List errors codes for -pr all switches
-svmtool [svm-options] // SVM FW Update Tool
where [svm-options] are:
mode=[version|ver|inventory|update]
// mode of execution
fwup=fw_file_name
output=[stdout|stderr|output_file_name]
// output in xml format; can be repeated
mac=[11:22:33:44:55:66|11-22-33-44-55-66]
//limit update to device with physical mac
NOTE: mac,wwnn and wwpn switches are exclusive
wwpn=[11-22-33-44-55-66-77-88]
//limit update to device with WWN
NOTE: mac,wwnn and wwpn switches are exclusive
fwdump=fwdump_file_name // NOT implemented yet
comment=[on|true|yes|y|1]
// inserts comments into xml output
// on mac of the device
// and other info if available
discoverall=[on|true|yes|y|1]
21SN0054667-00 Y
3–Getting Started
Getting Help
// discover all adapters; if not set,
// only adapters specified in svmtool.cfg
// will be discovered.
NOTE: discoverall is applicable only for mode=inventory
and mode=update
-all // same as discoverall=[on|true|yes|y|1]
all // same as discoverall=[on|true|yes|y|1]
-suppress_version_match // suppress match check
// for version of flash file
// and version in svmtool.cfg
-supvermatch // same as -suppress_version_match
Example 1 - Display vesion only
qaucli -pr all -svmtool mode=version
Example 2 - Update FW from file and produce xml
output to stdout and to a file;
add comments to xml on mac of the device
qaucli -pr all -svmtool mode=update
fwup=c:/fw/fw1.bin
output=stdout output=c:/xmloutput/1.xml
comment=on
Example 3 - Inventory
qaucli -pr all -svmtool mode=update output=stdout
-updimages_viewver <flash_file> // Displays list of IDs that
// the flash file supports
-updimages_matcher <flash_file> // Displays matches between
// flash file and discovered devices
The following shows a truncated example of noninteractive help output for
FabricCache CLI:
QConvergeConsole
Version 1.1.3 (Build 8)
Copyright (C) 2014 QLogic Corporation
Build Type: Release
Build Date: Apr 22 2014 16:21:19
22SN0054667-00 Y
3–Getting Started
Getting Help
Usage:
? cli
add drive
-drive=<WWULN of a san ssd lun or ssd drive>
[-lun_serial=<LUN Page 0x80 serial number>]
[-lun_wwuln=<WWULN>]
[-lun_any_wwuln=<LUN WWULN, or Page 0x80 serial number designator>]
[-lun_number=<logical unit number>]
[-fc_target=<Fibre Channel target name>]
add member
-clusterid=<cluster ID>
-member=<locally connected device instance>
clear display
clear log
clear lun_statistics
[-lun_serial=<LUN Page 0x80 serial number>]
[-lun_wwuln=<WWULN>]
[-lun_any_wwuln=<LUN WWULN, or Page 0x80 serial number designator>]
[-lun_number=<logical unit number>]
[-fc_target=<Fibre Channel target name>]
.
.
.
For more detail on any of these commands start CLI with
the action and item followed by -help or -?
23SN0054667-00 Y
Part II
NOTE
Noninteractive Commands
Part II of this guide provides details about the noninteractive commands of
QConvergeConsole CLI in the following chapters:
Chapter 4 General Noninteractive Commands
Chapter 5 NIC Noninteractive Commands
Chapter 6 Fibre Channel Noninteractive Commands
Chapter 7 iSCSI Noninteractive Commands
Chapter 8 NIC Partitioning (NPAR) Noninteractive Commands
Noninteractive commands for the 10000 Series Adapter are covered in Part
IV FabricCache Commands, Chapter 15 FabricCache CLI Command
Reference.
24SN0054667-00 Y
4General Noninteractive
Commands
This chapter describes and shows examples of the general noninteractive
commands that apply to all QConvergeConsole CLI supported protocols: NIC,
Fibre Channel, and iSCSI. The general commands include the all switch.
Use the general noninteractive commands for:
Viewing General Help
“Viewing All Inventory” on page 27
“Viewing All Flash Image Versions” on page 28
“Viewing All Matching Flash Image Versions” on page 29
“Viewing All Flash Updates” on page 34
Viewing General Help
To view the general help for all protocols, issue the -pr all -h command as
follows:
qaucli.exe -pr all -h
QConvergeConsole
Version 1.0.1 (Build 28)
Copyright (C) 2012 QLogic Corporation
Build Type: Release
Build Date: Jan 26 2012 17:58:07
Usage: qaucli [options]
The following is a simplified help for extension
of non-interactive commands for all protocols (NIC/FC/iSCSI).
Non-interactive mode syntax:
qaucli -pr all -switch [options]
25SN0054667-00 Y
4–General Noninteractive Commands
Viewing General Help
where switch is one of the following command line switches:
-help // Display help info
-h // Same as -help
-? // Same as -help
? // Same as -help
-ei // List errors codes for -pr all switches
-svmtool [svm-options] // SVM FW Update Tool
where [svm-options] are:
mode=[version|ver|inventory|update]
// mode of execution
fwup=fw_file_name
output=[stdout|stderr|output_file_name]
// output in xml format; can be repeated
mac=[11:22:33:44:55:66|11-22-33-44-55-66]
//limit update to device with physical mac
NOTE: mac,wwnn and wwpn switches are exclusive
wwpn=[11-22-33-44-55-66-77-88]
//limit update to device with WWN
NOTE: mac,wwnn and wwpn switches are exclusive
fwdump=fwdump_file_name // NOT implemented yet
comment=[on|true|yes|y|1]
// inserts comments into xml output
// on mac of the device
// and other info if available
discoverall=[on|true|yes|y|1]
// discover all adapters; if not set,
// only adapters specified in svmtool.cfg
// will be discovered.
NOTE: discoverall is applicable only for mode=inventory
and mode=update
-all // same as discoverall=[on|true|yes|y|1]
26SN0054667-00 Y
4–General Noninteractive Commands
Viewing All Inventory
all // same as discoverall=[on|true|yes|y|1]
-suppress_version_match // suppress match check
// for version of flash file
// and version in svmtool.cfg
-supvermatch // same as -suppress_version_match
Example 1 - Display vesion only
qaucli -pr all -svmtool mode=version
Example 2 - Update FW from file and produce xml
output to stdout and to a file;
add comments to xml on mac of the device
qaucli -pr all -svmtool mode=update
fwup=c:/fw/fw1.bin
output=stdout output=c:/xmloutput/1.xml
comment=on
Example 3 - Inventory
qaucli -pr all -svmtool mode=update output=stdout
-updimages_viewver <flash_file> // Displays list of IDs that
// the flash file supports
-updimages_matcher <flash_file> // Displays matches between
// flash file and discovered devices
Viewing All Inventory
To view the inventory for all protocols, issue the -pr all -svmtool command
as follows:
qaucli.exe -pr all -svmtool mode=inventory output=stdout fwup=.\p3p10929.bin
comment=on
This chapter describes the noninteractive NIC command format and parameters
of QConvergeConsole CLI.
To view the help, issue the -h command.
Command Format
NIC noninteractive commands have the following format:
qaucli -pr nic <command_option> [positional_parameters]
Where <command_option> is one of the command options, and
<positional_parameters> includes all required or optional parameters, as
defined in the Command Summary section of this chapter.
or
qaucli -pr nic -<command> [<cna_port_inst>]
Where <cna_port_inst> is an adapter port instance and <command> is one
of the following, described in detail in the Command Summary section of this
chapter:
-idcbx
-intloopback
-iset (Display Configured Port Settings)
-link
-minidump
-n (Change Port Alias Name [NIC Configuration])
-nh (Adapter Alias [NIC Configuration])
-pinfo (CNA Port Information)
-ping
-rc
-sreset (Reset NIC Statistics)
-sriov (SR-IOV Capability)
-statport (Display NIC Port Statistics)
-sunreset (Undo Reset NIC Statistics)
-team_allowCNAsIn8023adTeam (LACP Override)
-teamdel (Delete Team)
-teaminfo (Display Team Information)
-teamlist (Display Teams List)
-teamnew (Configure New Team)
-teamnew_portspreview
-testflash
-testhw (Hardware Test)
-testinterrupt (Interrupt Test)
-testled (Beacon/LED Test)
-testlink (Link Test)
-testregister (Register Test)
-trans (Transceiver Monitoring Interface [DMI])
-updimages (Flash Update)
-updimages_viewver
-v, -ver (Display Program Version Information)
-vlanadd (Add VLAN to Port or Team)
-vlanadd_preview
-vlandel (Remove VLAN from Port or Team)
-vlandel_preview
-vlaninfo (Display VLAN Information)
-vlanlist (Display VLAN List)
-vpd (CNA VPD Information)
-vtcfgview
-vtrestore (Restore VLAN & Teaming Configuration)
-vtsave (Save VLAN & Teaming Configuration)
-zvt (Display Teams List; Display VLAN List; Display VLAN Information)
37SN0054667-00 Y
5–NIC Noninteractive Commands
NOTE
NOTE
Command Support for NIC Teaming and VLAN Configuration
When you issue a command, QConvergeConsole CLI loads the adapter
information, executes the command, and then returns you to the
command prompt.
When the optional parameter cna_port_inst
action applies to all adapters detected by QConvergeConsole CLI.
Ensure that you issue only one command at a time.
is omitted, the command
Command Support for NIC Teaming and VLAN
Configuration
The following conditions apply to configuring teaming and VLAN using the
QConvergeConsole CLI
Windows Server 2012 and later:
QConvergeConsole CLI
Use the native Windows teaming interface instead of
.
CLI
:
does not support teaming and VLAN configuration.
QConvergeConsole
Windows Server 2008, Windows Server 2008 R2:
QConvergeConsole CLI
QLogic 3200 Series Intelligent Ethernet Adapters and 8100 Series and 8200
Series Converged Network Adapters. For 8300 Series Converged Network
Adapters, use the native Windows teaming interface instead of
QConvergeConsole CLI
Command Summary
This section lists and describes all NIC noninteractive commands in alphabetical
order.
A parenthetical phrase after a command indicates the equivalent interactive
menu option. For example, -c
that the -c command has an equivalent NIC Port Setting Configuration
menu option described in Chapter 9 NIC Interactive Commands.
Not all noninteractive commands have equivalent interactive menu options.
supports teaming and VLAN configuration only for
.
(NIC Port Setting Configuration) indicates
38SN0054667-00 Y
5–NIC Noninteractive Commands
-beacon
-beacon
To toggle on and off the port beacon (LED), issue the -beacon command as
follows:
qaucli -pr nic -beacon <cna_port_inst> on|off
For example:
> qaucli -pr nic -beacon 2 on
Loading: 1. CNA . . .
Loading: 1. CNA Port index : 1 ...
Loading: 1. CNA Port index : 2 ...
Successfully set Beacon to: Enabled
-c (NIC Port Setting Configuration)
To view the adapter port configuration, issue the -c command as follows:
qaucli -pr nic -c <cna_port_inst>
-cardreset
-ch
For example:
> qaucli -pr nic -c 1
=== Displaying CNA Port config info for 1. CNA Port Index ===
Port_Alias : None
Port_Physical_MAC_Alias : john
Port_LLA_MAC_Alias : paul
To activate changes made to the Flash, issue the -cardreset command as
follows:
qaucli -pr nic -cardreset <cna_port_inst>
To view the adapter configuration, issue the -ch command as follows:
qaucli -pr nic -ch <cna_port_inst>
For example:
> qaucli -pr nic -ch 1
=== Displaying CNA config info for 1. CNA Port Index ===
CNA_Alias : CNA X54
39SN0054667-00 Y
5–NIC Noninteractive Commands
NOTE
-d
-d
To generate Extensible Markup Language (XML) discovery output, issue the -d
command as follows:
qaucli -pr nic -d <flash_file> [<xml_output_file>]
Where <flash_file> is the Flash file and <xml_output_file> is the XML
discovery output. If you omit <xml_output_file>, XML discovery output is
written to stdout.xml.
-ei
To view error and exit code information for noninteractive mode, issue the -ei
command as follows:
qaucli -pr nic -ei
Exit codes are also listed in the fcscli-exitcodes.txt file located
here:
To configure external loopback test parameters before you run the test, issue the
-extloopback command as follows:
qaucli -pr nic -extloopback <cna_port_inst> <tests_num> <on_error>
Where <tests_num> specifies the number of tests to run (a value between 1
and 65,535) and <on_error> specifies the action to take if an error is
encountered in the test (0 = ignore the error; 1 = abort the test).
To determine <cna_port_inst>, issue the following command:
qaucli -nic -i
-flashsupport
This command lets you use the Flash Support Tool to manage the Flash memory.
To use the Flash Support Tool, issue the -flashsupport command as follows:
qaucli -pr nic -flashsupport [<option>]
Where <option> is one of the following options:
-d option:
To discover the Converged Network Adapters and generate an XML report,
issue the following command:
40SN0054667-00 Y
5–NIC Noninteractive Commands
-flashsupport
qaucli -pr nic -flashsupport -d <flash_file> <out_xml_file>
Where <flash_file> is the name of the Flash file to use to update the
adapter, and <out_xml_file> is the name of the output XML file.
-u option:
To update the Flash and generate an XML report, issue the following
command:
qaucli -pr nic -flashsupport -u <flash_file> <input_xml_file>
<out_xml_file>
Where <flash_file> is the name of the Flash file to use to update the
adapter, <input_xml_file> is the name of the input XML file, and
<out_xml_file> is the name of the output XML file.
-asn option:
To activate an adapter with a specified serial number, issue the following
command:
qaucli -pr nic -flashsupport -asn --activate <serial_number>
Where <serial_number> is the adapter’s serial number.
-v option:
To display version information, issue the following command:
qaucli -pr nic -flashsupport -v --version
-h
option:
To display help information, issue the following command:
qaucli -pr nic -flashsupport -h --help
-vi
option:
To view all available interfaces, issue the following command:
qaucli -pr nic -flashsupport -vi --view-all-interfaces
-s
option:
To display supported adapters, issue the following command:
qaucli -pr nic -flashsupport -s --supported <flash_file>
Where <flash_file> is the name of the Flash file that will be used to
update the adapter.
41SN0054667-00 Y
5–NIC Noninteractive Commands
NOTE
-flashsupport
-i option:
To set the adapter interface, issue the following command:
qaucli -pr nic -flashsupport -i --interface <interface_id>
Where <interface_id> is an interface ID value displayed by the -vi
switch.
You must use the -i command to specify the adapter interface before
using any of the following options: -a, -info, -w0, -w1, -p0, or -p1.
-a option:
To burn or update all Flash regions for the interface specified by the previous
-i command, issue the following command:
qaucli -pr nic -flashsupport -a --all [<ql_romimage>]
Where <ql_romimage> is the name of the name of the Flash file that will be
used to update the adapter. If the file is not specified, the default file (named
ql_romimage) in the working directory is used.
-info option:
To display information for the interface specified by the previous -i
command (or all discovered adapters when the interface not specified),
issue the following command:
qaucli -pr nic -flashsupport -info --information
-w0
option:
To disable wake on LAN (WoL) for the interface specified by the previous
-i command, issue the following command:
qaucli -pr nic -flashsupport -w0 --wol-off
-w1
option:
To enable WoL for the interface specified by the previous -i command,
issue the following command:
qaucli -pr nic -flashsupport -w1 --wol-on
-p0
option:
To disable pre-eXecution environment (PXE) LAN for the interface specified
by the previous -i command, issue the following command:
qaucli -pr nic -flashsupport -p0 --pxe-off
42SN0054667-00 Y
5–NIC Noninteractive Commands
-g
-p1 option:
To enable PXE LAN for the interface specified by the previous -i
command, issue the following command:
qaucli -pr nic -flashsupport -p1 --pxe-on
-g
To view general system information for the host, issue the -g command as
follows:
qaucli -pr nic -g [<cna_port_inst>]
For example:
> qaucli -pr nic -g
Using config file: G:\Program Files\QLogic Corporation\
QConvergeConsoleCLI\qaucli.cfg
To view adapter information, issue the -icna command as follows:
qaucli -pr nic -icna [<cna_port_inst>]
For example:
> qaucli -pr nic -icna 2
=== CNA Information for 2. CNA Port Index ===
Hostname : WIN-4ZKSPMU5N5L
Adapter Model : QLE8142
Chip Model : 8001
Chip Version : A1
Adapter Alias : None
Serial Number : RFC0916K61116
MAC Address : 00:c0:dd:10:27:60
MAC Address : 00:c0:dd:10:27:62
Driver Information : Ndis 6.x 10GbE driver (X86)
Driver Name : qlge.sys
Driver Version : 1.0.1.0
MPI Firmware Version : 1.35.06
PXE Boot Version : NA
VLAN & Team Driver Name :
VLAN & Team Driver Version :
FCoE Driver Version : 9.1.8.17
FCoE Firmware Version : 5.01.03
FCoE SDMAPI Version : 01.28.00.75
-idcbx
To display port data center bridging exchange protocol (DCBX) information, issue
the -idcbx command as follows:
qaucli -pr nic -idcbx [<cna_port_inst>]
44SN0054667-00 Y
5–NIC Noninteractive Commands
NOTE
NOTE
-intloopback
-intloopback
An external loopback test requires the installation of a loopback plug in the
port SFP.
To configure loopback test parameters before you run the test, issue the
intloopback command as follows:
qaucli -pr nic -intloopback <cna_port_inst> <tests_num> <on_error>
Where <tests_num> specifies the number of tests to run (a value between 1
and 65,535) and <on_error> specifies the action to take if an error is
encountered during the test (0 = ignore the error; 1 = abort the test).
-iset (Display Configured Port Settings)
To view configured port settings, issue the -iset command as follows:
qaucli -pr nic -iset [<cna_port_inst>]
For Linux and Solaris, the configured port settings and their values are
different from what is shown in the following example.
For example:
> qaucli -pr nic -iset 1
=== Configured Port Settings for 1. CNA Port Index ===
For detailed information on support for this command, refer to “Command
Support for NIC Teaming and VLAN Configuration” on page 38.
To configure a new team, issue the -teamnew command as follows:
qaucli -pr nic -teamnew <team_type> <port_insts>|ALL
[<user_assigned_name>]
Where <team_type> specifies a numeric team type value, <port_insts>
specifies a list of comma-separated port indices (such as 1,2), and
<user_assigned_name> is an optional user-specified team name.
59SN0054667-00 Y
5–NIC Noninteractive Commands
NOTE
-teamnew_portspreview
The team_type variable can have the following values:
To test the Flash memory, issue the -testflash command as follows:
qaucli -pr nic -testflash [<cna_port_inst>]
To stop an active diagnostic test, press ENTER. To use an alternate key to
stop tests, modify this line in the sfcli.properties configuration file:
Default: node.app.diag.ascii.abortkey=CR
Custom: node.app.diag.ascii.abortkey=<stop key>
Where <stop key> is a–z or A–Z (press SHIFT for uppercase)Example 1: To set the stop key to S (press SHIFT+S to stop the test):
node.app.diag.ascii.abortkey=S
Example 2: To set the stop key to s (press S to stop the test):
node.app.diag.ascii.abortkey=s
-testhw (Hardware Test)
To test the hardware, issue the -testhw command as follows:
qaucli -pr nic -testhw [<cna_port_inst>]
61SN0054667-00 Y
5–NIC Noninteractive Commands
-testinterrupt (Interrupt Test)
-testinterrupt (Interrupt Test)
To test the interrupt, issue the -testinterrupt command as follows:
qaucli -pr nic -testinterrupt [<cna_port_inst>]
-testled (Beacon/LED Test)
To test the LED, issue the -testled command as follows:
qaucli -pr nic -testled [<cna_port_inst>]
-testlink (Link Test)
To test the link, issue the -testlink command as follows:
qaucli -pr nic -testlink [<cna_port_inst>]
-testregister (Register Test)
To test the register, issue the -testregister command as follows:
qaucli -pr nic -testregister [<cna_port_inst>]
-trans (Transceiver Monitoring Interface [DMI])
To display transceiver diagnostics monitoring interface (DMI) data, issue the
-trans command as follows:
qaucli -pr nic -trans [<cna_port_inst>]
-updimages (Flash Update)
To update the Flash (boot and firmware) images, issue the -updimages
command as follows:
qaucli -pr nic -updimages [<cna_port_inst>] <image_file>
For example:
> qaucli -pr nic -updimages 1 "c:\my dir\valid-image-file"
netscli -updimages c:\temp\temp1
Loading: 1. CNA ...
Loading: 1. CNA Port index : 1 ...
Loading: 1. CNA Port index : 2 ...
=== Updating images for 1. CNA Port Index ===
Loading, please wait ...
Successfully updated Flash (Boot & Firmware images) for 1. Port
Index from file: c:\temp\temp1
62SN0054667-00 Y
5–NIC Noninteractive Commands
NOTE
-updimages_viewver
=== Updating images for 2. CNA Port Index ===
Loading, please wait ...
Successfully updated Flash (Boot & Firmware images) for 2. Port
Index from file: c:\temp\temp1
-updimages_viewver
To view the Flash version, issue the -updimages_viewver command as
follows:
qaucli -pr nic -updimages_viewver <image_file>
-v, -ver (Display Program Version Information)
To view the version number of QConvergeConsole CLI, issue the -v or -ver
command as follows:
qaucli -pr nic -v
qaucli -pr nic -ver
For example:
> qaucli -pr nic -ver
Using config file: G:\Program Files\QLogicCorporation\
QConvergeConsoleCLI\qaucli.cfg