User’s Guide—QConvergeConsole CLI
2400, 2500, 3200, 8100, 8200 Series
Information furnished in this manual is believed to be accurate and reliable. However, QLogic Corporation assumes no
responsibility for its use, nor for any infringements of patents or other rights of third parties which may result from its
use. QLogic Corporation reserves the right to change product specifications at any time without notice. Applications
described in this document for any of these products are for illustrative purposes only. QLogic Corporation makes no
representation nor warranty that such applications are suitable for the specified use without further testing or
modification. QLogic Corporation assumes no responsibility for any errors that may appear in this document.
Document Revision History
Revision A, December 13, 2010
Revision B, March 31, 2011
Revision C, October 18, 2011
ChangesSections Affected
Deleted Windows Server 2003 from the list of sup-
“Operating System Requirements” on page 1-2
ported operating systems.
Updating procedure for downloading QCC CLI“Downloading QConvergeConsole CLI” on
page 2-1
Added a note explaining that configuration port
settings and values differ for Linux/Solaris.
“-iset (Display Configured Port Settings)” on
page 4-9
Deleted reference to -svmtool.“Command Format” on page 4-1
Removed section for -svmtool.Former section “-svmtool” in chapter 4
Updated supported adapters to QLE81xx and
QLE82xx.
Removed example of -cna command saving MPI
configuration table to a file.
Added “all” to -e (view | info) command to view the
current boot device selection.
Added a note explaining that the -fg option is not
“-cna (FCoE Utilities Menu for QLE81xx and
QLE82xx Adapters)” on page 5-7
“-cna (FCoE Utilities Menu for QLE81xx and
QLE82xx Adapters)” on page 5-7
User’s Guide—QConvergeConsole CLI
2400, 2500, 3200, 8100, 8200 Series
xxSN0054667-00 C
Preface
This guide describes QConvergeConsole® CLI, which is used to configure and
manage QLogic Fibre Channel adapters, Intelligent Ethernet adapters, and
Converged Network Adapters within SANs.
What’s in this Guide
This guide contains the basic information you need to get started with
QConvergeConsole CLI.
This preface explains the QConvergeConsole CLI help system, describes the
typographic conventions used in this guide, lists related documents, specifies the
intended audience, 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 chapters:
Chapter 1 System Requirements lists the hardware, software requirements,
and operating system requirements needed for the successful operation of
the QConvergeConsole CLI.
Chapter 2 Installing and Uninstalling QConvergeConsole CLI describes how
to install and uninstall the utility.
Chapter 3 Getting Started describes how to start QConvergeConsole CLI on
Windows and Linux platforms. This chapter also describes how to view
detailed information about command parameters and options.
Chapter 4 NIC Noninteractive Commands describes the noninteractive NIC
command syntax and parameters.
Chapter 5 Fibre Channel Noninteractive Commands describes the
noninteractive Fibre Channel command syntax and parameters.
Chapter 6 iSCSI Noninteractive Commands describes the noninteractive
iSCSI command syntax and parameters.
Chapter 7 NIC Partitioning (NPAR) Noninteractive Commands describes the
noninteractive NIC Partitioning (NPAR) command syntax and parameters.
Chapter 8 NIC Interactive Commands contains a description of the
QConvergeConsole CLI NIC interactive mode menus.
Chapter 9 Fibre Channel Interactive Commands contains a description of
the QConvergeConsole CLI Fibre Channel interactive mode menus.
SN0054667-00 Cxxi
Preface
What’s in the Help System
Chapter 10 Converged Network Adapter Interactive Commands contains a
description of the QConvergeConsole CLI Converged Network Adapter
interactive mode menus for the NIC, iSCSI, and Fibre Channel functions.
Chapter 11 NIC Partitioning (NPAR) Interactive Commands contains
information on setting up NIC Partitioning (NPAR) using the interactive mode
menus of the QConvergeConsole CLI.
Appendix A NIC Partitioning (NPAR) Overview provides an overview of NIC
partitioning.
Following these chapters is a glossary of terms.
What’s 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
described in chapters 4 through 7.
Intended Audience
This guide is for system administrators who are responsible for installing,
configuring, and managing QLogic adapters using QConvergeConsole CLI.
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 Readme
For information about the QConvergeConsole GUI utility, refer to the following
document:
QConvergeConsole User’s Guide
:
Documentation Conventions
This guide uses the following documentation conventions:
NOTE: provides additional information.
CAUTION!
causing damage to data or equipment.
indicates the presence of a hazard that has the potential of
WARNING
causing personal injury.
xxiiSN0054667-00 C
!! indicates the presence of a hazard that has the potential of
Preface
License Agreements
Te x t i n 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 3-6.
For more information, visit www.qlogic.com
Te x t i n 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
then click Command Prompt.
Under Notification Options, select the Warning Alarms check box.
Te x t i n 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:
Type
cd /root and press ENTER.
.
. For
Enter the following command: sh ./install.bin
Key names and key strokes are indicated with UPPERCASE:
Press CTRL+P.
Press the UP ARROW key.
Te x t i n 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.
License Agreements
Refer to the QLogic Software End User License Agreement for a complete listing
of all license agreements affecting this product.
SN0054667-00 Cxxiii
Preface
Technical Support
Technical Support
Customers should contact their authorized maintenance provider for technical
support of their QLogic switch products. QLogic-direct customers may contact QLogic
Technical Support; others will be redirected to their authorized maintenance provider.
For details about available service plans, or for information about renewing and
extending your service, visit the Service Program Web page at
http://www.qlogic.com/services
Training
QLogic offers training for technical professionals for all iSCSI, InfiniBand, and
Fibre Channel products. From the main QLogic web page at www.qlogic.com
click the Support tab at the top, and then click Training and Certification on the
left. The QLogic Global Training portal offers online courses, certification exams,
and scheduling of in-person training.
Technical Certification courses include installation, maintenance, and
troubleshooting QLogic products. Upon demonstrating knowledge using live
equipment, QLogic awards a certificate identifying the student as a certified
professional. You can reach the training professionals at QLogic by e-mail at
training@qlogic.com
.
,
.
Contact Information
QLogic Technical Support for products under warranty is available during local
standard working hours excluding QLogic Observed Holidays. For customers with
extended service, consult your plan for available hours. For Support phone
numbers, see the Contact Support link at http://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. We are constantly adding to
the collection of information in our database to provide answers to your most
urgent questions. Access the database from the QLogic Support Center:
http://support.qlogic.com
QLogic Corporation
4601 Dean Lakes Blvd.
Shakopee, MN 55379 USA
www.qlogic.com
http://support.qlogic.com
support@qlogic.com
training@qlogic.com
.
xxivSN0054667-00 C
1System Requirements
QConvergeConsole CLI is an management utility 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
Operating System Requirements
Supported QLogic Adapters
Hardware Requirements
The minimum hardware requirements for the workstation server are as follows:
Server.
“Operating System Requirements” on page 1-2
systems.
Processor. Pentium® II processor, 300 MHz
Memory. 64MB of physical RAM to run QConvergeConsole CLI
Hard disk space. About 26MB 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 1-2.
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. See the QLogic Storage Networking Interoperability Guide,
which you can download from the following QLogic Web page:
http://connect.qlogic.com/interopguide/info.asp
Single-processor or multiprocessor server or workstation. See
for a list of operating
SN0054667-00 C1-1
1–System Requirements
Software Requirements
NOTE:
Tape devices are shown as part of the configuration, but are not fully
supported. Only persistent binding is supported.
Software Requirements
The software requirements for the server on which your adapter is physically
installed are as follows:
QLogic adapter drivers for your operating system
NOTE:
Refer to the QLogic Web site for QLogic adapter drivers and agents:
http://driverdownloads.qlogic.com
Administrative privileges to perform management functions
.
Operating System Requirements
QConvergeConsole CLI runs on the following platforms:
Windows Server 2008
®
Red Hat
Novell
NOTE:
For the supported operating system versions, refer to the Readme where
QConvergeConsole CLI is posted on the QLogic Web site:
http://driverdownloads.qlogic.com
Linux® Advance Server/Enterprise Server
SUSE
®
Linux Enterprise Server (SLES)
.
Supported QLogic Adapters
The supported QLogic-branded adapters are as follows. For support of
OEM-branded adapters, please contact your OEM.
2400 and 2500 Series Fibre Channel Adapters
3200 Series Intelligent Ethernet Adapters
8100 and 8200 Series Converged Network Adapters
1-2SN0054667-00 C
1–System Requirements
Supported QLogic Adapters
NOTE:
For information about QLogic adapters, refer to the QLogic Web site at
http://www.qlogic.com/Products/adapters
.
SN0054667-00 C1-3
1–System Requirements
Supported QLogic Adapters
1-4SN0054667-00 C
2Installing and Uninstalling
QConvergeConsole CLI
This chapter describes how to download, install, and uninstall QConvergeConsole
CLI.
Downloading QConvergeConsole CLI
“Installing QConvergeConsole CLI” on page 2-2
“Uninstalling QConvergeConsole CLI” on page 2-4
NOTE:
QConvergeConsole CLI is designed to configure QLogic adapters on the
local machine (where it is installed). It cannot configure adapters on remote
machines.
Downloading QConvergeConsole CLI
To download QConvergeConsole CLI from the QLogic Web site:
1.Go to the QLogic Driver Downloads/Documentation page at
http://driverdownloads.qlogic.com
2.Click QLogic Products.
3.Click Guided Search.
A window opens prompting you to Enter your search criteria.
4.Provide the information necessary:
a.In the Select a Product Type menu, select Adapters.
b.In the Select by Model or by OS, select by Model.
c.In the Select the Product Technology menu, select either
Converged Network Adapters, Fibre Channel Adapters, or
Intelligent Ethernet Adapters, as appropriate.
d.In the Select the Model menu, select your QLogic Adapter.
e.In the Select the Desired Item menu, select Management Tools.
SN0054667-00 C2-1
.
2–Installing and Uninstalling QConvergeConsole CLI
Installing QConvergeConsole CLI
f.Click Search.
5.Scroll through the list that appears and select the QConvergeConsole
version for your operating system.
6.Click Download Now.
7.On the File Download dialog box, click Save.
8.On the Save As dialog box. specify a folder or directory on the system, and
then click Save to download the file to that location. The package file has
one of the following formats, depending on the operating system:
9.In the Support Tools table, select and download the Readme file for the
appropriate version of QConvergeConsole CLI.
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 Windows Environment
You can install QConvergeConsole CLI from the command prompt using the
Microsoft
Standard Windows Interactive (CLI) Installation
Quiet or Unattended Windows Installation
Passive Windows Installation
Overwrite Previous Windows Installations
NOTE:
®
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, at the command prompt, issue the msiexec
command.
To obtain more information about MSI, visit the Microsoft Web site.
2-2SN0054667-00 C
2–Installing and Uninstalling QConvergeConsole CLI
Installing QConvergeConsole CLI in a Windows Environment
Standard Windows Interactive (CLI) Installation
To begin a standard installation of QConvergeConsole CLI on a Microsoft
Windows operating system, at a command line, issue one of the following
commands:
QConvergeConsoleCLI-<version>_win.msi
or
QConvergeConsoleCLI-<version>_win_x64.msi
Where <version> is the version number.
The default directory for QConvergeConsole CLI utility is:
Program files\QLogic Corporation\QConvergeConsoleCLI
If you want to install the 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 Unattended Windows Installation
Issue the following command for a quiet (silent) installation using default values.
For example, the following command installs silently using defaults and does not
show any errors:
QCCCLI.msi /q
Passive Windows Installation
Issue the following command for a passive installation using default values. For
example:
QCCCLI.msi /passive
The preceding command installs with minimum interaction, showing only the
progress bar and any errors.
Overwrite Previous Windows Installations
Issue the following for an installation that overwrites any previous installations
without asking for confirmation:
QCCCLI.msi /i forceinstall=true
SN0054667-00 C2-3
2–Installing and Uninstalling QConvergeConsole CLI
Installing QConvergeConsole CLI in a Linux Environment
Installing QConvergeConsole CLI in a Linux Environment
To install QConvergeConsole CLI on a Linux platform, issue the following from the
command form:
Red Hat Linux also creates a soft link from the /usr/local/bin directory to the
executable, qaucli. By default, the /usr/local/bin directory is in the
execution path; you need not add it.
SUSE Linux and PowerPC
the execution path by default. You must add it.
®
(PPC) do not put the /usr/local/bin directory in
Uninstalling QConvergeConsole CLI
To remove QConvergeConsole CLI from your system, follow the instructions for
your operating system.
Uninstalling QConvergeConsole CLI in a Windows Environment
Uninstalling QConvergeConsole CLI in a Linux Environment
Uninstalling QConvergeConsole CLI in a Windows
Environment
The Windows OS offers the following methods of uninstalling QConvergeConsole
CLI:
Start Menu Uninstall
Control Panel Uninstall
Command Line Uninstall
Start Menu Uninstall
To uninstall from the Windows Start menu:
1.Go to Start.
2.Point to All Programs, QLogic Management Suite, and then click
Uninstall QConvergeConsole CLI.
Control Panel Uninstall
To uninstall from the Control Panel:
1.Go to Start, and then click Control Panel.
2.Double-click Add/Remove Programs.
2-4SN0054667-00 C
3.Select QConvergeConsole CLI.
4.Click Change/Remove.
Command Line Uninstall
You can uninstall QConvergeConsole CLI from the command line. Select
interactive, passive, or silent (quietly) uninstall:
To uninstall interactively from the command line:
Issue the following command from a command prompt:
qcccli.msi
To uninstall passively from the command line:
Issue the following command from a command prompt:
msiexec /x qcccli.msi
To uninstall quietly from the command line:
Issue the following command from a command prompt:
2–Installing and Uninstalling QConvergeConsole CLI
Uninstalling QConvergeConsole CLI in a Linux Environment
msiexec /q /x qcccli.msi
Uninstalling QConvergeConsole CLI in a Linux Environment
To uninstall QConvergeConsole CLI on a Red Hat and SUSE Linux and PPC
operating systems, issue the following from a command prompt:
rpm -e QConvergeConsoleCLI-AA.BB.CC-DD
SN0054667-00 C2-5
2–Installing and Uninstalling QConvergeConsole CLI
Uninstalling QConvergeConsole CLI in a Linux Environment
2-6SN0054667-00 C
3Getting Started
The 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).
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 4 NIC Noninteractive Commands
Chapter 5 Fibre Channel Noninteractive Commands
Chapter 6 iSCSI Noninteractive Commands
To start the noninteractive QConvergeConsole CLI in Windows
operating system shell, and then type commands with 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:
1
or Linux, open an
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.
SN0054667-00 C3-1
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, and iSCSI. Although the
QConvergeConsole CLI contains menus for all of these adapter types, for clarity,
this guide describes the interface for each adapter type separately in the following
chapters:
To start QConvergeConsole CLI in interactive mode in Linux, issue the following
command:
qaucli
3-2SN0054667-00 C
Main Menu
When you start QConvergeConsole CLI in interactive mode, the Main Menu
appears as follows:
Main Menu
1: Adapter Information
2: Adapter Configuration
3: Adapter Updates
4: Adapter Diagnostics
5: Adapter Statistics
6: Refresh
7: Help
8: Exit
Please Enter Selection:
Selecting an option from the Main Menu prompts you to choose an adapter type.
3–Getting Started
Main Menu
To manage an Intelligent Ethernet Adapter or a Converged Network Adapter,
select the Converged Network Adapter option to open additional menus.
To manage a Fibre Channel Adapter, select the Fibre Channel Adapter
option to open additional menus.
For example:
Adapter Type Selection
1: Converged Network Adapter
2: Fibre Channel Adapter
(p or 0: Previous Menu; m or 98: Main Menu; ex or 99: Quit)
Please Enter Selection:
Menu Navigation
From any menu, type:
p or 0 (zero) to return to the previous menu
m or 98 to return to the Main Menu
ex or 99 to end the QConvergeConsole CLI session
SN0054667-00 C3-3
3–Getting Started
Getting Help
Getting Help
Help is available in interactive mode using option 7. Help. Noninteractive mode
provides help using the -h switch. For example, to list all of the available
command line parameters, issue the following command:
qaucli -h
To list available online switches, issue the following commands for their respective
adapter types:
qaucli -pr iscsi -h
qaucli -pr nic -h
qaucli -pr fc -h
To list available legacy switches, issue the following commands for their
respective adapter types:
qaucli -pr -iscsi -h
qaucli -pr -nic -h
qaucli -pr -fc -h
3-4SN0054667-00 C
4NIC Noninteractive
Commands
This chapter describes the noninteractive NIC command format and parameters
of QConvergeConsole CLI.
NOTE:
To view the help, issue the -h command.
Command Format
Noninteractive mode format includes the following command:
qaucli -pr nic [optional parameters] <command option> [positional
parameters]
or
qaucli -pr nic -switch [optional cna_port_instance]
Whereswitchis one of the following:
-beacon (Enable/Disable Port Beacon)
-c
-cardreset
-ch
-d
-ei
-extloopback
-flashsupport
-g (Display General System Information)
-h (Help), -?, ?
-i (List All QLogic CNA Ports Detected)
-icna (CNA Information)
-idcbx (Display Port DCBX Information)
-intloopback (Configure Test Parameters)
-iset (Display Configured Port Settings)
-link (Display Physical Link Status)
SN0054667-00 C4-1
4–NIC Noninteractive Commands
Command Format
-minidump (Firmware Mini Dump)
-n (Change Port Alias Name)
-nh (Change CNA Alias Name)
-pinfo (Port Information)
-ping (Ping Target)
-rc
-sreset (Reset Ethernet Statistics Counters)
-statport (Display Ethernet Port Statistics)
-sunreset (Undo Reset Ethernet Statistics Counters)
-teamdel (Delete Team)
-teaminfo (Display Team Information)
-teamlist (Display Teams List)
-teamnew (Configure New Team)
-teamnew_portspreview
-testflash
-testhw
-testinterrupt
-testled
-testlink
-testregister
-trans (Display Transceiver DMI Data)
-updimages (Update Flash (Boot & Firmware Images))
-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 (Display VPD Information)
-vtcfgview
-vtrestore (Restore VLAN & Teaming Configuration)
-vtsave (Save VLAN & Teaming Configuration)
-zvt (Display Teams List; Display VLANs List; Display VLAN Information)
NOTE:
When you issue a command, QConvergeConsole CLI loads the adapter,
executes the command, and then returns you to the command prompt.
When optional parameter
[cna_port_inst]
is not present, the command
action applies to all adapters detected by QConvergeConsole CLI.
Not all switches are functional in this release.
Ensure that you issue only one command at a time.
4-2SN0054667-00 C
Command Summary
This section lists and describes each command line option in alphabetic order,
followed by a command description.
-beacon
(Enable/Disable Port Beacon)
To toggle on and off the port beacon (LED), issue the -beacon command as
follows:
> -switch -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
4–NIC Noninteractive Commands
Command Summary
-c
-cardreset
-ch
To view the adapter port configuration, issue the -c command as follows:
> qaucli -pr nic -c [cna_port_inst]
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 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]
SN0054667-00 C4-3
4–NIC Noninteractive Commands
-d
For example:
> qaucli -pr nic -ch 1
=== Displaying CNA config info for 1. CNA Port Index ===
CNA_Alias : CNA X54
-d
To generate 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 get error and exit code information for noninteractive mode, issue the -ei
command as follows:
> qaucli -pr nic -ei
-extloopback
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, run 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:
4-4SN0054667-00 C
4–NIC Noninteractive Commands
-d option:
To discover the Converged Network Adapters and generate an xml report,
issue the following command:
> qaucli -pr nic -flashsupport -d <flash_file> [out_xml_file]
Where <flash_file> is the name of the flash file that will be used to
update the adapter and
-u option:
out_xml_file is the name of the output xml file.
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 that will be used to
update the adapter,
out_xml_file is the name of the output xml file.
input_xml_file is the name of the input xml file, and
-flashsupport
-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
option:
-vi
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.
SN0054667-00 C4-5
4–NIC Noninteractive Commands
-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.
NOTE:
The
-i command must be used to specify the adapter interface before using
any of the following options: -a, -info, -w0, -w1, -p0, -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 will be 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
option:
-w0
To disable Wake on LAN for the interface specified by the previous -i
command, issue the following command:
> qaucli -pr nic -flashsupport -w0 --wol-off
-w1
option:
To enable Wake on LAN for the interface specified by the previous -i
command, issue the following command:
> qaucli -pr nic -flashsupport -w1 --wol-on
option:
-p0
To disable PXE LAN for the interface specified by the previous -i
command, issue the following command:
> qaucli -pr nic -flashsupport -p0 --pxe-off
4-6SN0054667-00 C
-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
(Display General System Information)
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
4-8SN0054667-00 C
-idcbx
(Display Port DCBX Information)
To display port DCBX information, issue the -idcbx command as follows:
> qaucli -pr nic -idcbx [cna_port_inst]
-intloopback
(Configure Test Parameters)
NOTE:
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>
4–NIC Noninteractive Commands
-idcbx (Display Port DCBX Information)
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).
-iset
(Display Configured Port Settings)
To view configured port settings, issue the -iset command as follows:
> qaucli -pr nic -iset [cna_port_inst]
NOTE:
For Linux/Solaris, the configured port settings and their values are different
from what is shown in the following example.
SN0054667-00 C4-9
4–NIC Noninteractive Commands
-link (Display Physical Link Status)
For example:
> qaucli -pr nic -iset 1
=== Configured Port Settings for 1. CNA Port Index ===
Team Description: QLogic VT-IM Miniport Driver #2
Team Type : Fail Over
Driver Name : qlvtid.sys
Driver Version : 1.0.0.2
Driver Date : 05/26/2009
VLAN Enabled : Disabled
VLAN ID : None
MAC Address : 00:c0:dd:0a:b1:a9
MTU : 1500
IPv4 Address : 169.254.27.115
Subnet Mask : 255.255.0.0
IPv6 Address : fe80::2c0:ddff:fe0a:b1a9
Link Status : Unknown
4-16SN0054667-00 C
4–NIC Noninteractive Commands
-teamlist (Display Teams List)
-teamlist
(Display Teams List)
To view a list of all previously configured teams (if any), issue the -teamlist
command as follows:
> qaucli -pr nic -teamlist
For example:
> qaucli -pr nic -teamlist
Using config file: .\netscli.cfg
Loading: 1. CNA ...
Loading: 1. CNA Port index : 1 ...
Loading: 1. CNA Port index : 2 ...
Team: 1 Team Description: QLogic VT-IM Miniport Driver #2 VLAN ID: None
Team Type: Fail Over
Updating IP properties for all ports ... Please wait ...
Successfully restored TEAMs/VLANs
SN0054667-00 C4-27
4–NIC Noninteractive Commands
-vtsave (Save VLAN & Teaming Configuration)
-vtsave
(Save VLAN & Teaming Configuration)
To save the currently configured VLAN and team settings to a file, issue the
-vtsave command as follows:
> qaucli -pr nic -vtsave [file_name]
NOTE:
If you do not specify a configuration file name, the VLAN and teaming
settings are saved in the default file, vtstate-user.cfg, which is
saved in the QConvergeConsole CLI installation directory. Saved
settings can be later reinstated using the -vtrestore option.
A configuration that is saved with the -vtsave command can be
restored only with the -vtrestore command. Similarly, a configuration
that is saved using the QLogic Windows Teaming property pages can be
restored only with the Windows Teaming property pages.
>qaucli -pr nic -vtsave c:/system_1.cfg
Using config file: E:\Program Files\QLogic Corporation
\QConvergeConsoleCLI\netscli.cfg
Loading CNA Data ...
Loading: 1. CNA ...
Loading: 1. CNA Port index : 1 ...
Loading: 1. CNA Port index : 2 ...
Loading: 2. CNA ...
Loading: 2. CNA Port index : 1 ...
Loading: 2. CNA Port index : 2 ...
Refreshing interfaces ... Please wait ...
Attempting to save TEAMs and VLANs Configuration.
Team: 1 Team Description: QLogic VT-IM Miniport Driver VLAN ID: 555 Team Type:
Fail Over
-zvt (Display Teams List; Display VLANs List; Display VLAN Information)
VLAN Enabled : Enabled
VLAN ID : 555
MAC Address : 00:c0:dd:0a:b4:60
MTU : 1514
IPv4 Address :
Subnet Mask :
IPv6 Address :
Link Status : Down
4-30SN0054667-00 C
5Fibre Channel
Noninteractive Commands
This chapter describes the noninteractive Fibre Channel command format and
parameters of QConvergeConsole CLI. For a quick reference to informative
commands, see Display System Information (Command Line Options -g, -z, and
-tp).
NOTE:
To view help, issue the command -h.
Display System Information
(Command Line Options -g, -z, and -tp)
When you select one of these options, general information appears in various
formats. For example:
# qaucli -pr fc -g shows the host information (see “Host Information
(Command Line Option -g)” on page 5-1).
# qaucli -pr fc -z shows the host configuration (see “Host Configuration
(Command Line Option -z)” on page 5-2).
Host Information
(Command Line Option -g)
The command format to show host information is:
# qaucli -pr fc -g
Issue this command to view the following information about the local machine:
Host name
OS type
OS version (patches where applicable)
SAN target management (SDM) API version
SN0054667-00 C5-1
5–Fibre Channel Noninteractive Commands
Host Configuration (Command Line Option -z)
List of adapters: adapter model, port number, WWPN, serial number (SN),
adapter number (adapter 0–n), and status (online or offline)
Total number of QLogic Fibre Channel adapters detected
NOTE:
The failover and SAN device management APIs are QLogic-specific libraries
required for QConvergeConsole CLI. The versions of these libraries are
useful for debugging purposes.
Host Configuration
(Command Line Option -z)
The command line option -z provides a summary for the selected adapter in a
single command. The command format is:
# qaucli -pr fc -z
QConvergeConsole CLI shows the information in “Host Information (Command
Line Option -g)” on page 5-1, as well as the following additional information:
Adapter general information
Adapter vital product data (VPD)
Adapter parameter settings
Driver settings information:
Group: persistent
Group: binding
Device/LUN Information
Selective LUNs Information
Boot device settings
To show the information for a single adapter, issue the following command:
# qaucli -pr fc -z (<hba instance> | <hba wwpn>)
Where:
hba instance
hba wwpn
= Adapter number (use -g command to find)
= World wide port name of the adapter
To show the information for all adapters, issue the following command:
# qaucli -pr fc -z all
5-2SN0054667-00 C
Host Configuration
Use these options to show the information for one or all of the adapter ports in the
system. The -z option shows the combination of the commands listed in
Table 5-1. The commands are listed in alphabetical order.
-tShow target list“-t (Display Target Information)” on
Show adapter settings
Show adapter information
“-c (Show Parameter Settings)” on
page 5-7
able)” on page 5-9
page 5-12
page 5-13
“-i (Display HBA General Information or
VPD Information for One or All HBAs)”
on page 5-16
page 5-24
Info)” on page 5-28
page 5-33
Command Format
The command format for noninteractive mode is:
# qaucli -pr fc -(Cmd) (<hba instance> | <hba wwpn>)
(view | info)
Where:
hba instance = Adapter port instance (use -g command to find)
hba wwpn = Adapter world wide port name
SN0054667-00 C5-3
5–Fibre Channel Noninteractive Commands
Command Format
You can combine the commands -o, -s and -x with other options. However, they
must be at the beginning or at the end of the command line. Use these commands
as follows:
-o = Output the results to a file (see “-o (Output to a File)” on page 5-28).
For example:
# qaucli -pr fc -l -o
-s = Silent mode (see “-s (Silent Mode)” on page 5-33). For example:
# qaucli -pr fc -i all -s -o output.txt
-x = Outputs the results in XML format (see “-x (Output in XML Format 1)”
on page 5-37). For example:
# qaucli -pr fc -i all -x -o output.xml
You cannotcombine the command -f with any other options:
-f = Input Parameter Options from a Text File (see “-f (Input Parameter
Options from a Text File)” on page 5-11). For example:
# qaucli -pr fc -f command.txt
In addition, the following general rules for commands apply:
Only one command line option per input file is valid.
You can use either the hyphen (-) character or the forward slash (/)
character. For example, both of these commands are valid:
qaucli -pr fc -g
qaucli -pr fc /g
Table 5-2 defines the command variables.
.
Table 5-2. Command Variables
VariableDefinitionFormat
<hba instance>
<hba wwpn> Adapter world wide port
<alias>Adapter alias
<target wwnn>Target world wide node
Adapter number
name
name
a
xx-xx-xx-xx-xx-xx-xx-xx or
xxxxxxxxxxxxxx
Symbolic adapter b name
xx-xx-xx-xx-xx-xx-xx-xx or
xxxxxxxxxxxxxx
<target wwpn>Target world wide port
name
<target port id>Target port ID xx-xx-xxor xxxxxx
5-4SN0054667-00 C
xx-xx-xx-xx-xx-xx-xx-xx or
xxxxxxxxxxxxxx
Table 5-2. Command Variables (Continued)
VariableDefinitionFormat
<target id> Target ID
<lun id> Logical unit number (0–255)
<address>IP addressxxx.xxx.xxx.xxx
(speed)Target link speed1.2, 4, or 8GHz
a
You can use the -g command to find adapter numbers.
b
You assign the symbolic name. It is limited to 100 characters in length.
Command Summary
This section lists and describes each command line option in alphabetic order,
followed by a command description.
5–Fibre Channel Noninteractive Commands
Command Summary
-a
(View or Toggle Beacon Status)
Use the -a command to either view (1) or change (2) the status of a beacon.
NOTE:
Adapter must not be in silent mode. See “-s (Silent Mode)” on page 5-33
to issue a response to this command.
The -a feature is not supported on QLA22xx adapters or QLE8042
adapter.
To view the adapter port’s LED beacon state, issue the following command:
# qaucli -pr fc -a (<hba instance> | <hba wwpn>)(view | info)
When the adapter’s LED is flashing, the following message appears:
HBA Port x - LED Flashing is ON.
When the adapter’s LED is not flashing, the following message appears:
HBA Port x - LED Flashing is OFF.
To start or stop flashing the adapter’s LED beacon, issue the following command:
# qaucli -pr fc -a (<hba instance> | <hba wwpn>)
QConvergeConsole CLI toggles the LED’s state. If the LED is flashing, the
flashing stops. If the LED is not flashing, the flashing begins.
SN0054667-00 C5-5
5–Fibre Channel Noninteractive Commands
-b (Save or Update the Flash BIOS or FCode)
If QConvergeConsole CLI is not in silent mode (see
page 5-33
), one of the following messages appears to indicate the LED’s current
state:
The LED Flashing for <hba instance> <hba wwpn> has been turned ON
The LED Flashing for <hba instance> <hba wwpn> has been turned OFF
The hba instance and hba wwpn variables must match the command input
parameter.
-b
(Save or Update the Flash BIOS or FCode)
Use the -b command to:
Update the BIOS or FCode from a file (1).
Save the BIOS or FCode to a file (2).
To update the Flash of one or all adapters with new BIOS or FCode, issue the
following command:
If the system does not have an adapter with a boot device selected, the following
message appears:
There is no boot device selected for any HBA in the system.
Following is an example of the boot device option when viewing the boot device
for a single adapter. In this example, no boot device is configured (selectable boot
is disabled; the boot port name is all zeroes).
To cause the OS to boot from the first target it finds with a LUN, select a boot port
name of 00-00-…00 (selectable boot); this applies only if the boot BIOS is
enabled.
To set a specific target as the boot device for a specific adapter, issue the
following command:
The boot device setting option is not supported on Macintosh
PowerPC.
QConvergeConsole CLI checks all parameters to verify that the adapter, targets,
and LUNs are valid.
If you select an adapter with no target or a target with no LUN,
QConvergeConsole CLI shows an error message and aborts.
For all operating systems, if the adapter already has boot devices defined and
they are different from the ones in the command parameter or menu selection,
you are prompted to confirm the boot device selection:
The HBA already has a boot device(s) selected. Do you want to
replace it with the new one?
5-10SN0054667-00 C
For all operating systems, if the adapter already has boot devices selected and
they are the same as the ones in the command parameter or menu selection, the
following message appears:
The HBA already has that device selected as boot device.
To use selectable boot (the OS boots from the first target the BIOS finds) set the
<target wwpn>, <target wwnn> and <lun id> inputs to all zeroes. For example
issue the following command:
The -f option is valid only in noninteractive mode, and cannot be combined
with any other options. Only one command line parameter per file is valid.
This option is used when it is run as a script file.
To input parameter options to QConvergeConsole CLI through a text file, type -f,
followed by the file name. For example:
# qaucli -pr fc -f command.txt
The text file must be formatted as follows:
The file must contain a single line.
The file must contain only parameters.
The file cannot contain another -f option.
The following example shows how to set the connection option of an adapter to
default (loop preferred, otherwise point-to-point) and the data rate to auto through
a command file that is invoked by the -f option:
1.Create a text file (for example, setadapter0.txt) and issue the following
command in the text file:
-n 0 co 2 dr 2
2.Save and close the file.
SN0054667-00 C5-11
5–Fibre Channel Noninteractive Commands
-fg (Show Driver Settings)
3.Issue the qaucli -pr fc command with the -f option (input from
command file):
# qaucli -pr fc -f setadapter0.txt
# qaucli -pr fc -f <file name>
QConvergeConsole CLI specifies command line input from file.
-fg
(Show Driver Settings)
NOTE:
The -fg option is valid only in noninteractive mode.
The -fg option is not supported for Linux/Solaris.
To show the driver settings, issue the following command:
PersistentPlusNewPN0, 1
get(s) plus any new target(s) with
driver default
Present targets with driver default
NewOnly
b
NO0, 1
Bind devices by WWPNBindWWPNBW0, 1
Bind devices by port IDBindPortIDBP0, 1
a
0 = Disabled, 1 = Enabled
b
Driver parameter NewOnly (NO) is supported only with the failover driver. If you select a QLA22xx
adapter, all QLA22xx adapters on the host will use the same settings. If you select a 23xx adapter,
all 2G/4G adapters on the host will also use the same settings.
The following restrictions apply:
Under Linux, this feature is disabled if you are using the IOCTL or sysfs
(inbox) driver.
®
Under Mac OS
, the BindWWPN and BindPortID parameters are not
changeable; Mac OS supports only the BindWWPN parameter.
a
-gs
(Show HBA Statistics)
To view the adapter statistics, issue the following command:
hba instance = Adapter number (use -g command to find)
hba wwpn = World wide port name of the adapter
-ex or -exclude = World wide port name of the target device that is
excluded from the read/write test
param name = One of the following:
param alias = One of the following:
param value = Value for selected parameter (see Tabl e 5- 6)
“Run a Read/Write Buffer Test” on page 5-18 contains command line examples
and test results for a read/write buffer test.
Run a Read/Write Buffer Test
This test runs on all devices or on the devices you select on the adapter you
select. This test sends the SCSI Write Buffer command to the target devices and
uses the SCSI Read Buffer command to read the returned data and do a data
comparison.
DataPattern
DataSize
TestCount
TestIncrement
OnError
DP
DS
TC
TI
OE
5-18SN0054667-00 C
5–Fibre Channel Noninteractive Commands
-kr (Run Read/Write Buffer Test)
NOTE:
All devices attached to the adapter must support SCSI Read/Write Buffer
commands.
To do a read/write buffer test using the current parameters, issue the following
command:
# qaucli -pr fc -kr (<hba instance> | <hba wwpn>)
To exclude a device or devices on the selected adapter port, issue the following
command:
The following examples do 500 read/write buffer tests with a test increment of 10,
a data pattern of FFh, and a data size of 8 bytes. The test stops if an error occurs.
# qaucli -pr fc -kr <hba instance> DP FF DS 8 TC 500 TI 10 OE 1
# qaucli -pr fc -kr <hba wwpn> DP FF DS 8 TC 500 TI 10 OE 1
You do not have to set each parameter for the read/write buffer test. If you do not
specify a parameter in the command line, the current parameter value is used. For
example, the following command sets the data pattern to FFh and uses the
current values for the other parameters:
# qaucli -pr fc -kr <hba instance> DP FF
The following example sets the data size to 16 bytes and has the test loop if an
error occurs. The other parameters use the current values.
# qaucli -pr fc -kr <hba wwpn> DS 16 OE 2
An example of a successful read/write buffer test follows:
HBA 1: QEM2462 Port 1 WWPN xx-xx-xx-xx-xx-xx-xx-xx Port ID 02-0E-00
Save link status to CVS log fileLogToFileLFLog file name
a
When the AutoPoll parameter is 0, the link status is retrieved automatically until the user aborts the
operation. When the AutoPoll parameter is in the range of 1–256, the link status is retrieved for the
number of cycles specified by this value.
0–256 a cycles
SN0054667-00 C5-23
5–Fibre Channel Noninteractive Commands
-m (View, Enable, or Disable LUNs)
-m
(View, Enable, or Disable LUNs)
NOTE:
If the current driver setting is Bind by Port ID, this option is not available.
Under Linux, if you use the IOCTL or sysfs (inbox) driver, this feature is
disabled.
You must persistently bind the targets before configuring selective LUNs,
(link).
Use the -m command to:
View all selective LUNs for all adapter ports
View an adapter’s selective LUN list
View the current selective state of a LUN on a specific target
Enable (select) a LUN on a specific target on a specific adapter
Disable (deselect) a LUN on a specific target on a specific adapter
Enable all LUNs on a specific target on a specific adapter
Disable (deselect) all LUNs on a specific target on a specific adapter
Enable (select) all LUNs of all targets on a specific adapter
Disable (deselect) all LUNs of all targets on a specific adapter
For these commands:
hba instance = Adapter number (use -g command to find)
hba wwpn = World wide port name of the adapter
target wwnn = World wide node name of the target
target wwpn = World wide port name of the target
lun id = ID of the LUN
To view all selective LUNs for all adapter ports, issue the following command:
# qaucli -pr fc -m all (view | info)
To view an adapter’s selective LUN list, issue the following command:
Data Rate (QLA23xx/QLA24xx/QLE23xx/QLE24xx and QLE2562):
0 = 1 Gb
1 = 2Gbs
2 = Auto
3 = 4 Gbs
4 = 8 Gbs
c
EnableBIOS option not available on 4Gb adapter.
d
EnableExtendedLogging option not available on PPC64 or SPARC.
e
Operation mode (QLA/QLE23xx, QLA/QLE24xx, and QLE2562):
0 = interrupt for every I/O completion
5 = interrupt when interrupt delay timer expires
6 = interrupt when interrupt delay timer expires or no active I/O
e
NOTE:
QLA200/210 adapters have a limited set of parameters that can be
changed.
SN0054667-00 C5-27
5–Fibre Channel Noninteractive Commands
-o (Output to a File)
-o
(Output to a File)
NOTE:
The -o option is valid only in noninteractive mode.
This option can be used with all noninteractive mode options that have a
corresponding interactive mode option (see Tabl e 5 -1 ). The option must
be the first or last command in the command line.
If the file already exists, new data are appended to the current file.
To output result and status messages into a file, type -o, followed by the file
name. For example, to save LUN information to a file named systemLUNinfo:
# qaucli -pr fc -l -o systemLUNinfo
Where the file name is systemLUNinfo, all messages are located in the
directory indicated for the system platform:
Windows:
Linux:
Mac OS:
syslog.log in the current directory
/var/log/messages
/var/log/system.log
-p
(Display Persistent Target Binding Info)
With this command you can:
Show binding information for one or on all adapters.
Bind a specific target to a selected adapter.
Bind all targets on a specific adapter or on all adapter.
Unbind a specific target.
Unbind all targets on a specific adapter or on all adapters.
NOTE:
Under Linux, if you use the IOCTL or sysfs (inbox) driver these features are
disabled.
To show target persistent binding information for a specific adapter port, issue the
following command:
hba instance = Adapter number (use -g command to find)
hba wwpn = World wide port name of the adapter
target wwnn = World wide node name of the target
To unbind all targets on a specific adapter port or on all adapter ports, issue the
following command:
# qaucli -pr fc -p (<hba instance> | <hba wwpn> | all) (remove all
| unbind all)
Where:
hba instance = Adapter number (use -g command to find)
hba wwpn = World wide port name of the adapter
-pa
(Define Port Alias)
With this command you can:
Define the port alias for a specific adapter port (1)
Delete the port alias from a specific adapter port (2)
View the port alias for a specific adapter port (3)
To define a port alias for the specified adapter, issue the following command: