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.
I
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
ChangesSections Affected
Modified note explaining requirement for tape
devices and backup software
Added “all” parameter to command line definition
for -z option
Added footnote explaining requirement for tape
devices and backup software
Changed command name from “FC Adapter Information” to “All Information”
“Hardware Requirements” on page 1-1
“Host Configuration (Command Line Option -z)” on
page 6-2
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 Is 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, and operating
system requirements needed for the successful operation of the
QConvergeConsole CLI.
Chapter 2 Installing and Uninstalling QConvergeConsole CLI describes how
to download, install, and uninstall the utility.
Chapter 3 Getting Started describes how to start QConvergeConsole CLI on
Windows
to view detailed information about command parameters and options.
Chapter 4 General Noninteractive Commands describes and shows
examples of the general noninteractive commands that apply to all
QConvergeConsole CLI supported protocols: NIC, Fibre Channel, and
iSCSI.
Chapter 5 NIC Noninteractive Commands describes the noninteractive NIC
command syntax and parameters.
Chapter 6 Fibre Channel Noninteractive Commands describes the
noninteractive Fibre Channel command syntax and parameters.
Chapter 7 iSCSI Noninteractive Commands describes the noninteractive
iSCSI command syntax and parameters.
Chapter 8 NIC Partitioning (NPAR) Noninteractive Commands describes the
noninteractive NIC Partitioning (NPAR) command syntax and parameters.
®
, Linux®, and Solaris® platforms. This chapter also describes how
SN0054667-00 Gxix
Page 20
Preface
What Is in the Help System
Chapter 9 NIC Interactive Commands contains a description of the
QConvergeConsole CLI NIC interactive mode menus.
Chapter 10 Fibre Channel Interactive Commands contains a description of
the QConvergeConsole CLI Fibre Channel interactive mode menus.
Chapter 11 Converged Network Adapter Interactive Commands contains a
description of the QConvergeConsole CLI Converged Network Adapter
interactive mode menus for the NIC, iSCSI, Fibre Channel, and NPAR
functions.
Chapter 12 Setting Up NIC Partitioning (NPAR) Using Interactive
Commands contains steps for setting up NIC Partitioning (NPAR) using the
interactive mode menus of QConvergeConsole CLI.
Appendix A NIC Partitioning (NPAR) Overview provides an overview of NIC
partitioning.
Following these chapters is a glossary of terms and an index to help you quickly
locate the information you need.
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
described in Chapters 5 through 8.
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 (part number SN0054669-00)
:
xxSN0054667-00 G
Page 21
Documentation Conventions
NOTE
CAUTION
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.
Tex 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
Tex t i n bold font indicates user interface elements such as a menu items,
buttons, check boxes, or column headings. For example:
Preface
Documentation Conventions
. For
.
Click the Start button, point to Programs, point to Accessories, and
then click Command Prompt.
Under Notification Options, select the Warning Alarms check box.
Tex 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:
cd /root and press ENTER.
Type
Enter the following command: sh ./install.bin
Key names and key strokes are indicated with UPPERCASE:
Press CTRL+P.
Press the UP ARROW key.
Tex 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.
SN0054667-00 Gxxi
Page 22
Preface
NOTE
Documentation Conventions
What are shortcut keys?
To enter the date type mm/dd/yyyy (where mm is the month, dd is the
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 (CLI) command syntax conventions include the
following:
Plain text indicates items that you must type as shown. For example:
< > (angle brackets) indicate a variable whose value you must specify.
day, and yyyy is the year).
qaucli -pr nic -ei
For example:
<serial_number>
For CLI commands only, variable names are always indicated
using angle brackets instead of italics.
[ ] (square brackets) indicate an optional parameter. For example:
[<file_name>] means specify a file name, or omit it to select
the default file name.
| (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:
When used together, ( ) (parentheses) and { } (braces) indicate
grouping of parameters 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 b c
xxiiSN0054667-00 G
Page 23
License Agreements
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 at
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.Under QLogic Products, type the QLogic model name in the search box.
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 the
Read Me and Release Notes icons 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 Readme file.
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.
SN0054667-00 Gxxiii
Page 24
Preface
Technical Support
3.Click an item in each selection column to define the search, and then click
Go.
4.Locate the firmware, software, or document you need, and then click the
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 customers with
extended service, consult your plan for available hours. For Support phone
numbers, see the Contact Support link at support.qlogic.com.
Support Headquarters
QLogic Web Site
Technical Support Web Site
QLogic Corporation
4601 Dean Lakes Blvd.
Shakopee, MN 55379 USA
www.qlogic.com
http://support.qlogic.com
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:
http://support.qlogic.com
support@qlogic.com
training@qlogic.com
.
xxivSN0054667-00 G
Page 25
1System Requirements
NOTE
QConvergeConsole CLI is a 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
For the latest information on supported hardware, refer to the
QConvergeConsole CLI Readme and Release Notes.
QConvergeConsole CLI requires the following minimum hardware for the
workstation server:
Server.
“Operating System Requirements” on page 1-2
systems.
Processor. Pentium® II processor, 300MHz.
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-4.
SN0054667-00 G1-1
Single-processor or multiprocessor server or workstation. See
for a list of operating
Page 26
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 QLogic Storage Networking Interoperability Guide, 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 Readme and Release Notes.
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
Refer to the QLogic Web site for QLogic adapter drivers and agents:
http://driverdownloads.qlogic.com
.
Operating System Requirements
QConvergeConsole CLI runs on the following platforms:
Microsoft
Red Hat
Novell
Oracle
Solaris
®
Windows Server®
®
Linux® Advance Server/Enterprise Server
®
SUSE
®
Linux Unbreakable Enterprise Kernel (UEK) R2 (2.6.39-400 kernel)
®
®
Linux Enterprise Server (SLES®)
SPARC® and Solaris x86
1-2SN0054667-00 G
Page 27
NOTE
1–System Requirements
Operating System Requirements
For an up-to-date list of supported operating system versions, refer to
the QConvergeConsole CLI Readme, which can be downloaded where
QConvergeConsole CLI is posted on the QLogic Web site:
http://driverdownloads.qlogic.com
.
SN0054667-00 G1-3
Page 28
1–System Requirements
NOTE
Supported QLogic Adapters
Supported QLogic Adapters
QConvergeConsole CLI supports the following QLogic-branded adapters:
2400/2500/2600 Series Fibre Channel Adapters
3200 Series Intelligent Ethernet Adapters
8100/8200/8300 Series Converged Network Adapters
For information about QLogic adapters, refer to the QLogic Web site at
http://www.qlogic.com/Products/adapters
To determine support for OEM-branded adapters, please contact your OEM.
.
1-4SN0054667-00 G
Page 29
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 2-2
“Uninstalling QConvergeConsole CLI” on page 2-6
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
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.Under QLogic Products, type the QLogic model name in the search box.
Alternatively, you can click Guided Search to obtain assistance in locating
the QConvergeConsole CLI version to download.
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.
Click the Read Me and Release Notes icons under Support Files for
additional information.
5.Click Download Now.
6.Save the file to your computer.
SN0054667-00 G2-1
Page 30
2–Installing and Uninstalling QConvergeConsole CLI
NOTE
Installing QConvergeConsole CLI
Installing QConvergeConsole CLI
The installation procedures differ depending on the operating system:
“Installing QConvergeConsole CLI in a Windows Environment” on page 2-2
“Installing QConvergeConsole CLI in a Linux Environment” on page 2-3
“Installing QConvergeConsole CLI in a Solaris Environment” on page 2-3
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
Installing QConvergeConsole CLI in a Linux Environment
®
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 6 of
“Downloading QConvergeConsole CLI” on page 2-1. 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 utility is:
Program Files\QLogic Corporation\QConvergeConsoleCLI
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.
2-2SN0054667-00 G
Page 31
2–Installing and Uninstalling QConvergeConsole CLI
Installing QConvergeConsole CLI in a Linux Environment
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:
PHASE ITEMS
Installing new actions 503/503
Updating package state database Done
Updating image state Done
Creating fast lookup database Done
SN0054667-00 G2-5
Page 34
2–Installing and Uninstalling QConvergeConsole CLI
Uninstalling QConvergeConsole CLI
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 Solaris Environment
Uninstalling QConvergeConsole CLI in a Windows Environment
The Windows operating system (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, point to 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.
3.Select QConvergeConsole CLI.
4.Click Change/Remove.
Command Line Uninstall
You can uninstall QConvergeConsole CLI from the command line in interactive,
passive, or silent (quiet) mode.
To uninstall interactively from the command line:
Issue one of the following commands from a command prompt:
QConvergeConsoleCLI-<version>-win_x64.msi
or
QConvergeConsoleCLI-<version>-win.msi
2-6SN0054667-00 G
Page 35
2–Installing and Uninstalling QConvergeConsole CLI
Uninstalling QConvergeConsole CLI in a Linux Environment
To uninstall in unattended mode from the command line:
Issue the following command from a command prompt:
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
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 2-8. 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
SPARC/x86 environment or a Solaris 11 SPARC/x86 environment, follow the
steps in the following sample output to uninstall QConvergeConsole CLI:
G13457-T9x6275M2N1# pkgrm QCCLI
The following package is currently installed:
QCCLI QLogic QConvergeConsole CLI (CNA Configuration Utility)
(i386) 1.00.03 Build 23 (Solaris 8-11)
Do you want to remove this package? [y,n,?,q] y
## Removing installed package instance <QCCLI>
This package contains scripts which will be executed with super-user
permission during the process of removing this package.
SN0054667-00 G2-7
Page 36
2–Installing and Uninstalling QConvergeConsole CLI
Uninstalling QConvergeConsole CLI in a Solaris Environment
Do you want to continue with the removal of this package [y,n,?,q] y
## Verifying package <QCCLI> dependencies in global zone
## Processing package information.
## Executing preremove script.
## Removing pathnames in class <none>
/opt/QLogic_Corporation/QConvergeConsoleCLI/ucli.sig
/opt/QLogic_Corporation/QConvergeConsoleCLI/sfcli.properties
/opt/QLogic_Corporation/QConvergeConsoleCLI/scli
/opt/QLogic_Corporation/QConvergeConsoleCLI/qaucli_contents.dat
/opt/QLogic_Corporation/QConvergeConsoleCLI/qaucli.cfg
/opt/QLogic_Corporation/QConvergeConsoleCLI/qaucli
/opt/QLogic_Corporation/QConvergeConsoleCLI/nvramdefs/x8086x34ba/nvram23.dat
/opt/QLogic_Corporation/QConvergeConsoleCLI/nvramdefs/x8086x34ba
/opt/QLogic_Corporation/QConvergeConsoleCLI/nvramdefs/x8086x34a0/nvram23.dat
.
/opt/QLogic_Corporation/QConvergeConsoleCLI/adapters.properties
/opt/QLogic_Corporation/QConvergeConsoleCLI
/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/x86
environment, use the pkg uninstall command to uninstall QConvergeConsole
CLI, as shown in the following sample output:
solaris-13609# pkg uninstall qaucli
Packages to remove: 1
Create boot environment: No
Create backup boot environment: No
Services to change: 1
PHASE ITEMS
Removing old actions 709/709
Updating package state database Done
Updating package cache 1/1
Updating image state Done
Creating fast lookup database Done
2-8SN0054667-00 G
Page 37
## Executing postremove script.
## Updating system information.
Removal of <QCCLI> was successful.
2–Installing and Uninstalling QConvergeConsole CLI
Uninstalling QConvergeConsole CLI in a Solaris Environment
SN0054667-00 G2-9
Page 38
2–Installing and Uninstalling QConvergeConsole CLI
Uninstalling QConvergeConsole CLI in a Solaris Environment
2-10SN0054667-00 G
Page 39
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 3-2
“Getting Help” on page 3-4
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.
SN0054667-00 G3-1
1
or Linux, open an
Page 40
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
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
3-6SN0054667-00 G
Page 45
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
3–Getting Started
Getting Help
-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
SN0054667-00 G3-7
Page 46
3–Getting Started
Getting Help
3-8SN0054667-00 G
Page 47
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 interactive commands for:
Viewing General Help
“Viewing All Inventory” on page 4-3
“Viewing All Flash Image Versions” on page 4-4
“Viewing All Matching Flash Image Versions” on page 4-5
“Viewing All Flash Updates” on page 4-10
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]
SN0054667-00 G4-1
Page 48
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]
4-2SN0054667-00 G
Page 49
4–General Noninteractive Commands
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
Viewing All Inventory
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
-n (Change Port Alias Name [NIC Configuration])
-nh (Adapter Alias [NIC Configuration])
-pinfo (CNA Port Information)
-ping
-rc
-sreset (Reset NIC Statistics)
-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)
When you issue a command, QConvergeConsole CLI loads the adapter,
executes the command, and then returns you to the command prompt.
When the optional parameter
[cna_port_inst]
is omitted, 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.
5-2SN0054667-00 G
Page 61
Command Summary
NOTE
This section lists each command line option in alphabetic order, and provides a
description of each and example of most.
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 Chapter9 NIC Interactive Commands.
Not all noninteractive commands have equivalent interactive menu options.
-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:
5–NIC Noninteractive Commands
Command Summary
(NIC Port Setting Configuration) indicates
> 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]
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
-cardreset
To activate changes made to the Flash, issue the -cardreset command as
follows:
> qaucli -pr nic -cardreset [cna_port_inst]
SN0054667-00 G5-3
Page 62
5–NIC Noninteractive Commands
-ch
-ch
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
-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
-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, 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>]
5-4SN0054667-00 G
Page 63
5–NIC Noninteractive Commands
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:
> 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 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 that will be used 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.
-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
-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>
SN0054667-00 G5-5
Page 64
5–NIC Noninteractive Commands
NOTE
-flashsupport
Where <flash_file> is the name of the Flash file that will be used to
update the adapter.
-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
5-6SN0054667-00 G
Page 65
-g
5–NIC Noninteractive Commands
-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
-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
To view general system information for the host, issue the -g command as
follows:
> qaucli -pr nic -g [cna_port_inst]
For example:
-g
-h (Help)
-i
> qaucli -pr nic -g
Using config file: G:\Program Files\QLogic
Corporation\QConvergeConsoleCLI
Working dir: G:\Documents and Settings\user1
Using config file: G:\Program Files\QLogic
Corporation\QConvergeConsoleCLI\netscli.cfg
Host Name : APPCRUSHER
Host Version: Service Pack 2 (Build 3790)
Host Type : Microsoft Windows Server 2003 R2 x64
User Type : Privileged; CNA setup allowed
To view the help file, issue the -h command as follows:
> qaucli -pr nic -h
The QConvergeConsole CLI help file contains a condensed version of the
contents of this chapter.
To view a list of all QLogic adapter ports detected, issue the -i command as
follows:
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]
5-8SN0054667-00 G
Page 67
-intloopback
NOTE
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>
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:
5–NIC Noninteractive Commands
-intloopback
> 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 ===
Header_Data_Split_Enable : off
IPv4_Large_Send_Offload_v1_Enable : on
IPv4_Large_Send_Offload_v2_Enable : on
IPv6_Large_Send_Offload_v2_Enable : on
IPv4_TCP_Checksum_Offload_Enable : RxTx
IPv6_TCP_Checksum_Offload_Enable : RxTx
IPv4_UDP_Checksum_Offload_Enable : RxTx
IPv6_UDP_Checksum_Offload_Enable : RxTx
Jumbo_Frames_MTU_9000_Enable_Rx : off
Jumbo_Frames_MTU_9000_Enable_Tx : off
LOCAL_Administered_Address_MAC : 00:c0:dd:12:0f:f4
MAC_Address_Alias : paul
Receive_Side_Scaling_Enable : on
Receive_Ring_Size : 0
Transmit_Ring_Size : 0
PromiscuousModeEnabled : off
SN0054667-00 G5-9
Page 68
5–NIC Noninteractive Commands
NOTE
-link
Linux does not support the Receive_Side_Scaling_Enable option.
-link
To view the status of the physical link, including the port speed, issue the -link
command as follows:
> qaucli -pr nic -link [cna_port_inst]
For example:
> qaucli -pr nic -link 1
=== Physical Link Status for 1. CNA Port Index ===
Link Status : Up
Port Speed : 10 Gbps
-minidump
To dump a firmware core dump into a file for a specific cna_port_inst, issue
the -minidump command as follows:
> qaucli -pr nic -minidump <cna_port_inst> <minidump_file>
[force | noforce]
Where minidump_file specifies the name of the dump file, and force and
noforce specify how the core dump is created:
If force is specified, then a new core dump is created and dumped into
the specified file.
If
noforce is specified, then if a core dump is available, it is dumped into
the specified file.
-n (Change Port Alias Name [NIC Configuration])
To change a port alias name, issue the -n command as follows:
> qaucli -pr nic -n [cna_port_inst] <config_name|config_alias>
<value> [<config_name|config_alias> <value>]
For this release of QConvergeConsole CLI, you can set the following properties:
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 any alphabetic character a–z or A–Z (uppercase
characters require pressing SHIFT+<stop key>).
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]
-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]
5-18SN0054667-00 G
Page 77
-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)
5–NIC Noninteractive Commands
-testlink (Link Test)
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
=== 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
SN0054667-00 G5-19
Page 78
5–NIC Noninteractive Commands
NOTE
-v, -ver (Display Program Version Information)
-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\QLogic
Corporation\QConvergeConsoleCLI\qaucli.cfg
To display vital product data (VPD) information, issue the -vpd command as
follows:
> qaucli -pr nic -vpd [cna_port_inst]
-vtcfgview
To view the contents of the previously saved VLAN and teaming configuration
settings file (see -vtsave (Save VLAN & Teaming Configuration)), issue the
-vtcfgview command as follows:
> qaucli -pr nic -vtcfgview [state_cfg_file]
If you do not specify a file name, QConvergeConsole CLI reads the default
file (vtstate.cfg) in the installation directory.
For example:
>qaucli -pr nic -vtcfgview c:/system_1.cfg
Using config file: E:\Program Files\QLogic\Corporation
\QConvergeConsoleCLI\netscli.cfg
5-22SN0054667-00 G
Page 81
5–NIC Noninteractive Commands
Accessing file: c:/system_1.cfg
Number of Teams: 1
----------------
type=Fail Over MAC: 00:c0:dd:0a:b4:61 00:c0:dd:0a:b4:60 (VLAN IDs: 555)
Number of Ports: 3
----------------
MAC :00:c0:dd:0a:b4:34 (VLAN IDs: 35)
MAC :00:c0:dd:0a:b4:35 (VLAN IDs: 777)
MAC :None (VLAN IDs:)
Number of VLANS: 3
----------------
............................
VLAN ID : 35
............................
IPv4Address : 169.254.132.7
IPv4SubnetMask : 0.0.0.0
IPv4GatewayAddr : 0.0.0.0
DHCPServerCount : 0
IPv6GatewayAddr :
IPv6AddressCount : 1
pDHCPServers[ 0] : fe80::e9ba:1d3e:8584:8407
DNSServerCount : 3
pDNSServers[ 0] : fec0:0:0:ffff::1
pDNSServers[ 1] : fec0:0:0:ffff::2
pDNSServers[ 2] : fec0:0:0:ffff::3
............................
VLAN ID : 777
............................
IPv4Address : 169.254.202.39
IPv4SubnetMask : 0.0.0.0
IPv4GatewayAddr : 0.0.0.0
DHCPServerCount : 0
IPv6GatewayAddr :
IPv6AddressCount : 1
pDHCPServers[ 0] : fe80::d079:f594:8e03:ca27
DNSServerCount : 3
pDNSServers[ 0] : fec0:0:0:ffff::1
pDNSServers[ 1] : fec0:0:0:ffff::2
-vtcfgview
SN0054667-00 G5-23
Page 82
5–NIC Noninteractive Commands
NOTE
-vtrestore (Restore VLAN & Teaming Configuration)
pDNSServers[ 2] : fec0:0:0:ffff::3
............................
VLAN ID : 555
............................
IPv4Address :
IPv4SubnetMask :
IPv4GatewayAddr :
DHCPServerCount : 0
IPv6GatewayAddr :
IPv6AddressCount : 0
DNSServerCount : 0
-vtrestore (Restore VLAN & Teaming Configuration)
To reinstate previously saved VLAN and team settings from a file, issue the
-vtrestore command as follows:
> qaucli -pr nic -vtrestore [file_name]
The default file configuration file name for VLAN and teaming is
vtstate-user.cfg, which is saved in the QConvergeConsole CLI installation
directory. You may have saved your configuration with a different file name or
location.
The -vtrestore command can restore a configuration file produced only
by the -vtsave command. Similarly, a configuration that is saved using
the QLogic Windows Teaming property pages can be restored only with the
Windows Teaming property pages.
For example:
>qaucli -pr nic -vtrestore 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 ...
5-24SN0054667-00 G
Page 83
5–NIC Noninteractive Commands
-vtrestore (Restore VLAN & Teaming Configuration)
Attempting to restore TEAMs and VLANs if configured prior to vtdriver updaate.
*** Teams:
*** Ports:
00:c0:dd:0a:b4:34
VLAN IDs:
55
00:c0:dd:0a:b4:35
VLAN IDs:
55
Refreshing interfaces ... Please wait ...
Updating IP properties for all ports ... Please wait ...
Updating IP properties for all ports ... Please wait ...
Successfully restored TEAMs/VLANs
-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]
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 ...
5-26SN0054667-00 G
Page 85
5–NIC Noninteractive Commands
-zvt (Display Teams List; Display VLAN List; Display VLAN Information)
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
This chapter describes the noninteractive Fibre Channel command format and
parameters of QConvergeConsole CLI. For a quick reference to informative
commands, see Displaying System Information (Command Line Options -g, -z,
and -tp) on this page.
To view help, issue the -h command.
Displaying 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 6-1).
# qaucli -pr fc -z shows the host configuration (see “Host
Configuration (Command Line Option -z)” on page 6-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 device management (SDM) API version
SN0054667-00 G6-1
Page 88
6–Fibre Channel Noninteractive Commands
NOTE
Host Configuration (Command Line Option -z)
List of adapters: adapter model, port number, worldwide port name
(WWPN), serial number (SN), adapter number (adapter 0–n), and status
(online or offline)
Total number of QLogic Fibre Channel Adapters detected
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 6-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 and LUN information
Selective LUNs information
Boot device settings
To show the information for a single adapter, issue the following command:
To show the information for all adapters, issue the following command:
# qaucli -pr fc -z all
6-2SN0054667-00 G
Page 89
Host Port 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 6-1. The commands are listed in alphabetical order.
CLIDescriptionSee User Guide Section
-cShow adapter settings “-c (Display HBA Parameters)” on page 6-8
-eConfigure boot device“-e (Boot Devices Configuration)” on
-fgView driver settings“-fg” on page 6-13
-gsShow adapter statistics“-gs (Configure Parameters [FC Port Statis-
-iShow adapter information“-i (FC Adapter Information; FC VPD Informa-
6–Fibre Channel Noninteractive Commands
Host Port Configuration
.
Table 6-1. Options Shown by -z
page 6-10
tics])” on page 6-15
tion)” on page 6-17
-lShow LUN list“-l (FC Target/LUN Information)” on page 6-23
-mConfigure selective LUNs“-m (Selective LUNs)” on page 6-25
-pConfigure target persistent
binding
-tShow target list“-t (FC Target/LUN Information)” on page 6-37
hba instance = Adapter port instance (use the -g command to find)
hba wwpn = Adapter world wide port name
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” on page 6-29). For example:
“-p (Target Persistent Bindings)” on page 6-30
# qaucli -pr fc -l -o
SN0054667-00 G6-3
Page 90
6–Fibre Channel Noninteractive Commands
Command Format
-s = Silent mode (see “-s” on page 6-36). For example:
# qaucli -pr fc -i all -s -o output.txt
-x = Outputs the results in XML format (see “-x” on page 6-40). 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” on page 6-13). 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 6-2 defines the command variables.
.
Table 6-2. Command Variables
VariableDefinitionFormat
<hba instance>
Adapter number
<hba wwpn> Adapter world wide port
name
<alias>Adapter alias
<target wwnn>Target world wide node
name
<target wwpn>Target world wide port
name
<target port id>Target port ID xx-xx-xx or xxxxxx
<target id> Target ID—
<lun id> Logical unit number (0–255)
<address>IP addressxxx.xxx.xxx.xxx
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
xx-xx-xx-xx-xx-xx-xx-xx or
xxxxxxxxxxxxxx
<iidma 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.
6-4SN0054667-00 G
Page 91
Command Summary
NOTE
This section lists the command line options in alphabetic order, and provides a
description of each.
A parenthetical phrase after a command indicates the equivalent interactive
menu option. For example, -c
that the -addchap command has an equivalent Add a CHAP menu option
described in Chapter11 Converged Network Adapter Interactive
Commands.
Not all noninteractive commands have equivalent interactive menu options.
The Fibre Channel noninteractive commands include the following:
To update the message passing interface (MPI) configuration table on the
Converged Network Adapter (81xx only) from a file, issue the following command:
The output displays the TLV of the link layer discovery protocol (LLDP) frames
meant for exchanging the parameters and their values.
To view data center Ethernet (Cisco
®
data communications equipment, DCE™)
network activity information sent and received over the Converged Network
Adapter port connection, issue the following command:
The -dm option allows you to show general or detailed digital diagnostic
monitoring interface for optical transceivers.
This option is supported only for QLogic QLA/QLE/QEM24xx (4Gb)
Adapters. Under Solaris, this option is disabled if you are using Linux inbox
drivers (SLES 10.0 or RHEL 5.0 or later).
To show transceiver monitoring general information, issue the following command:
# qaucli -pr fc -dm (<hba instance> | <hba wwpn> | <all>) general |
gen
To show transceiver monitoring detailed information, issue the following
command:
# qaucli -pr fc -dm (<hba instance> | <hba wwpn> | all) details |
det
Where:
hba instance = Adapter number (use the -g command to find)
hba wwpn = World wide port name of the adapter
all = All adapters in the system
-e (Boot Devices Configuration)
Use the -e command to:
Show the current boot device selection for all adapters.
Show the current boot device selection for a specific adapter.
Set a target device as the boot device for an adapter.
Selectable boot; the OS boots from the first target the BIOS finds.
Delete the boot device from an adapter.
In these commands:
hba instance = Adapter number (use the -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
target id = ID to which the target is bound
lun id = ID of the LUN
6-10SN0054667-00 G
Page 97
6–Fibre Channel Noninteractive Commands
-e (Boot Devices Configuration)
To view the current boot device selection on all adapters:
# qaucli -pr fc -e all (view | info)
To view the current boot device selection for a specific adapter:
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.
SN0054667-00 G6-11
Page 98
6–Fibre Channel Noninteractive Commands
NOTE
NOTE
-e (Boot Devices Configuration)
To set a specific target as the boot device for a specific adapter, issue the
following command:
Because x86 Solaris does not require the target ID, the Solaris command is:
# qaucli -pr fc -e (
wwnn> <target wwpn> <lun id>
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.
<hba instance> | <hba wwpn>) <target
If you select an adapter with no target or a target with no LUN,
QConvergeConsole CLI shows an error message and aborts.
In Solaris SPARC, setting the target ID to the target of the boot-selected LUN is
equivalent to persistently binding the target (see “-p (Target Persistent Bindings)”
on page 6-30). Therefore, if the target is persistently bound, its boot device entry
must have the same target ID.
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?
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:
Issue the -ei command to view a list of the Fibre Channel error codes.
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.
-fg
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.
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 the file.
The -fg option is valid only in noninteractive mode.
The -fg option is not supported for Linux and Solaris.
SN0054667-00 G6-13
Page 100
6–Fibre Channel Noninteractive Commands
-fs (Driver Parameters)
To show the driver settings, issue the following command: