Users Guide

ManualsBrandsDell ManualsConverged InfrastructureQLogic Family of Adapters

Table Of Contents

Third party information brought to

you courtesy of Dell.

Doc. No. TD-000947 Rev. 1

Janurary 29, 2021

2500, 2600, 2700 Series Fibre Channel Adapters

User’s Guide

QConvergeConsole

CLI

Cover

Summary of content (230 pages)

PAGE 1
QConvergeConsole® CLI 2500, 2600, 2700 Series Fibre Channel Adapters User’s Guide Third party information brought to you courtesy of Dell. Doc. No. TD-000947 Rev.
PAGE 2
Marvell QConvergeConsole® CLI User’s Guide THIS DOCUMENT AND THE INFORMATION FURNISHED IN THIS DOCUMENT ARE PROVIDED “AS IS” WITHOUT ANY WARRANTY. MARVELL AND ITS AFFILIATES EXPRESSLY DISCLAIM AND MAKE NO WARRANTIES OR GUARANTEES, WHETHER EXPRESS, ORAL, IMPLIED, STATUTORY, ARISING BY OPERATION OF LAW, OR AS A RESULT OF USAGE OF TRADE, COURSE OF DEALING, OR COURSE OF PERFORMANCE, INCLUDING THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
PAGE 3
Table of Contents Preface Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . What Is in This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . What Is in the Help System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Related Materials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Documentation Conventions . . . . . . . . . . . . . . . . . . . .
PAGE 4
User’s Guide—QConvergeConsole CLI 2500, 2600, 2700 Series Fibre Channel Adapters 3 Getting Started Using Noninteractive Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using Interactive Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Starting QConvergeConsole CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Starting QConvergeConsole CLI in Windows. . . . . . . . . . . . . . . Starting QConvergeConsole CLI in Linux. . . . . .
PAGE 5
User’s Guide—QConvergeConsole CLI 2500, 2600, 2700 Series Fibre Channel Adapters -fs (Driver Parameters) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -fwdump (Firmware Dump). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -g . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . -gs (Configure Parameters [Monitoring]) . . . . . . . . . . . . . . . . . . . . . . -h (Help). . . . . . . . . . . . . . . . . . . . . .
PAGE 6
User’s Guide—QConvergeConsole CLI 2500, 2600, 2700 Series Fibre Channel Adapters -z (All Information) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Part III Interactive Commands 6 Fibre Channel Interactive Commands Adapter Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . FC Adapter Information (-i) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . FC Port Information . . . . . . . . . . . . . . . . . . . .
PAGE 7
User’s Guide—QConvergeConsole CLI 2500, 2600, 2700 Series Fibre Channel Adapters Save Flash (-b) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Save HBA Parameters (-r) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Generate Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Personality (-pc) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . FEC (-fec) . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 8
User’s Guide—QConvergeConsole CLI 2500, 2600, 2700 Series Fibre Channel Adapters Start Diagnostics Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CT FTR Test (-ftr) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Display Test Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reset Test Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configure Test Parameters . . . . . . . . . . . . . . . . . . . . . . .
PAGE 9
User’s Guide—QConvergeConsole CLI 2500, 2600, 2700 Series Fibre Channel Adapters Refresh. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Help (-h) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A 202 203 203 Revision History Glossary Doc. No. TD-000947 Rev.
PAGE 10
User’s Guide—QConvergeConsole CLI 2500, 2600, 2700 Series Fibre Channel Adapters List of Figures 2-1 2-2 2-3 Installer—Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Update Package—No Previous Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Update Package—Success . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 6 7 Doc. No. TD-000947 Rev.
PAGE 11
User’s Guide—QConvergeConsole CLI 2500, 2600, 2700 Series Fibre Channel Adapters List of Tables Table 5-1 5-2 5-3 5-4 5-5 5-6 5-7 5-8 5-9 5-10 6-1 Options Shown by -z . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Command Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ping Diagnostics Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 12
Preface This guide describes QConvergeConsole ® (QCC) CLI, a management tool that is used to configure and manage Marvell® QLogic® Fibre Channel Adapters within SANs. Intended Audience This guide is for system administrators who are responsible for installing, configuring, and managing Marvell adapters using QConvergeConsole CLI. What Is in This Guide This guide contains the basic information you need to get started with the QConvergeConsole CLI tool.
PAGE 13
Preface What Is in the Help System Part III Interactive Commands  Chapter 6 Fibre Channel Interactive Commands contains a description of the QCC CLI Fibre Channel interactive mode menus. Appendices  Appendix A Revision History contains a list of changes made to this guide since the last revision. At the end of this guide is a glossary of terms and an index to help you quickly locate the information you need.
PAGE 14
Preface Command Line Interface Documentation Conventions      Text in bold font indicates user interface elements such as a menu items, buttons, check boxes, or column headings. For example:  Click the Start button, point to Programs, point to Accessories, and then click Command Prompt.  Under Notification Options, select the Warning Alarms check box. Text in Courier font indicates a file name, directory path, or command line text.
PAGE 15
Preface Conventions for Interactive Commands  [ ] (square brackets) indicate an optional parameter. For example:   | (vertical bar) indicates mutually exclusive options; select one option only. For example:    [] means specify a file name, or omit it to select the default file name. 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.
PAGE 16
Part I General CLI Information Part I of this guide provides general information about QConvergeConsole CLI in the following chapters:  Chapter 1 System Requirements  Chapter 2 Installing and Uninstalling QConvergeConsole CLI  Chapter 3 Getting Started Doc. No. TD-000947 Rev.
PAGE 17
1 System Requirements QConvergeConsole CLI is a management tool that centralizes management and configuration of QLogic adapters within the entire network (LAN and SAN).
PAGE 18
1–System Requirements Software Requirements The minimum requirements for a SAN environment are as follows:  Storage. Fibre Channel devices, such as disks and RAID subsystems. QConvergeConsole CLI supports most Fibre Channel devices. NOTE Tape devices and backup protection software must support persistent binding. Software Requirements NOTE For the latest information on supported software, refer to the QConvergeConsole CLI Read Me and Release Notes documents.
PAGE 19
1–System Requirements Supported Marvell Adapters Supported Marvell Adapters QConvergeConsole CLI supports the 2500, 2600, and 2700 Series Fibre Channel Adapters. NOTE For information about Marvell adapters, refer to the Marvell Web site, Products page: https://www.marvell.com/products/ Doc. No. TD-000947 Rev.
PAGE 20
2 Installing and Uninstalling QConvergeConsole CLI This chapter describes how to download, install, and uninstall QConvergeConsole CLI.  Downloading QConvergeConsole CLI  “Installing QConvergeConsole CLI” on page 6  “Uninstalling QConvergeConsole CLI” on page 8 NOTE QConvergeConsole CLI configures Marvell adapters on the local system (where it is installed) only. It cannot configure adapters on remote systems.
PAGE 21
2–Installing and Uninstalling QConvergeConsole CLI Installing QConvergeConsole CLI 7. Locate the management utility, software, or document you need, and then click the item’s name or icon to download or open the item.
PAGE 22
2–Installing and Uninstalling QConvergeConsole CLI Installing QConvergeConsole CLI in a Linux Environment 4. A message appears when the package has been installed successfully (Figure 2-3). Figure 2-3. Update Package—Success Installing QConvergeConsole CLI in a Linux Environment To install QConvergeConsole CLI on a Linux platform, issue the following commands from the command line: Linux 32-bit (i386/i686): # rpm -ivh QConvergeConsoleCLI-.i386.
PAGE 23
2–Installing and Uninstalling QConvergeConsole CLI Uninstalling QConvergeConsole CLI NOTE  QConvergeConsole CLI is available for PowerPC ® (PPC), both PPC64 and PPC64le. Only FC protocol is supported with PPC64le.  qaucli is already installed on Citrix 6.5 and later. To update QConvergeConsole CLI to the latest version, issue the following command: # rpm -Uhv QConvergeConsoleCLI-Citrix-.rpm Ubuntu (aarch64): root@ubuntu:~# dpkg -i qconvergeconsolecli_2.2.00-xx_arm64.
PAGE 24
2–Installing and Uninstalling QConvergeConsole CLI Uninstalling QConvergeConsole CLI in a Windows Environment 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 Windows Control Panel: 1. Go to Start, and then click Control Panel. 2. Double-click Add/Remove Programs. 3. Select QConvergeConsole CLI. 4.
PAGE 25
2–Installing and Uninstalling QConvergeConsole CLI Uninstalling QConvergeConsole CLI in a Linux Environment Uninstalling QConvergeConsole CLI in a Linux Environment To uninstall QConvergeConsole CLI on a Red Hat or SUSE Linux operating system, issue the following command: # rpm -e QConvergeConsoleCLI To uninstall QConvergeConsole CLI on an Ubuntu system, issue the following command: root@ubuntu:~# dpkg -r qconvergeconsolecli (Reading database ... 73791 files and directories currently installed.
PAGE 26
3 Getting Started QConvergeConsole CLI manages Fibre Channel functions on Marvell Fibre Channel 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.
PAGE 27
3–Getting Started Using Interactive Mode Using Interactive Mode Interactive mode is a menu-driven interface that manages MarvellFibre Channel Adapters, and all functions of Fibre Channel. The interface for the Fibre Channel Adapters is described in Chapter 6. Starting QConvergeConsole CLI Start the CLI using the method specified for your operating system: Windows, Linux, or Solaris.
PAGE 28
3–Getting Started Main Menu 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: Monitoring 6: Refresh 7: Help 8: Exit 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 Getting Help To view help i
PAGE 29
3–Getting Started Getting Help The following shows an example of noninteractive help output for iSCSI, NIC, and Fibre Channel adapters: Using config file: /opt/QLogic_Corporation/QConvergeConsoleCLI/qaucli.cfg Installation directory: /opt/QLogic_Corporation/QConvergeConsoleCLI Working dir: /root QConvergeConsole Version x.y.z (Build xx) Copyright (C) 2020 Marvell Semiconductor, Inc.
PAGE 30
3–Getting Started Getting Help qaucli -nic [options] - Use NIC legacy command line qaucli -iscsi [options] - Use iSCSI legacy command line qaucli -fc [options] - Use FC legacy command line qaucli -fca [options] - Use FabricCache legacy command line Additional options: -h - Display built-in command line syntax Help about commands, and command options available for each specific protocol are available by specifying "-h" to the protocol of interest: qaucli -pr nic | -nic -h - Display NIC protocol u
PAGE 31
3–Getting Started Getting Help Usage: qaucli [options] The following is a simplified help for extension of non-interactive commands for all protocols (NIC/FC/iSCSI).
PAGE 32
3–Getting Started Getting Help //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.
PAGE 33
3–Getting Started Getting Help Example 3 - Inventory qaucli -pr all -svmtool mode=update output=stdout -updimages_viewver // Displays list of IDs that // the flash file supports -ffv supported file // verifies if input is FFV // Returns 0 upon support and non-zero otherwise // Input same as for -updimages_viewver -updimages_matcher
PAGE 34
Part II Noninteractive Commands Part II of this guide provides details about the noninteractive commands of QConvergeConsole CLI in the following chapters:  Chapter 4 General Noninteractive Commands  Chapter 5 Fibre Channel Noninteractive Commands Doc. No. TD-000947 Rev.
PAGE 35
4 General Noninteractive Commands This chapter describes and shows examples of the general noninteractive commands that apply to the Fibre Channel QConvergeConsole CLI supported protocol. The general commands include the all switch. To view the general help, issue the -pr fc -h command as follows: localhost:~ # qaucli -pr fc -h QConvergeConsole Version x.y.z (Build xx) Copyright (C) 2020 Marvell Semiconductor, Inc.
PAGE 36
4–General Noninteractive Commands - Logical Unit Number of a LUN. - The udev persistent device name to be assigned to a designated LUN (Linux only). Options: [int] - Interactive mode (Menu driven). -i [] [vpd] - Views the general or vpd information of all HBAs. -i | [vpd] - Displays general/VPD information of an HBA port. -c [] - Displays current HBA Parameter settings of all HBAs.
PAGE 37
4–General Noninteractive Commands - Displays information of devices (Disks or Tapes) attached to an HBA port. -l | - Displays LUNs information of devices attached to an HBA port. -l | | - Displays LUNs information of devices attached to an HBA port. -l | | - Displays specific LUN information of a device attached to an HBA port.
PAGE 38
4–General Noninteractive Commands all HBAs. -p || remove all|unbind all - Unbinds all attached device(s) to an HBA port or all HBAs. -p | remove|unbind - Unbinds the specified device of an HBA port. -m | view|info Doc. No. TD-000947 Rev.
PAGE 39
5 Fibre 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 Displaying System Information (Command Line Options -g, -z) on this page. NOTE To view help, issue the -h command. Displaying System Information (Command Line Options -g, -z) When you select one of these options, general information appears in various formats.
PAGE 40
5–Fibre Channel Noninteractive Commands 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). Depending on the model, adapter information may also include the instance number, link status (up or down), diagnostic mode (D_Port), and SFP detection (installed or not).
PAGE 41
5–Fibre Channel Noninteractive Commands Host Port Configuration To show the information for all adapters, issue the following command: qaucli -pr fc -z all 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 5-1. The commands are listed in alphabetical order. . Table 5-1.
PAGE 42
5–Fibre Channel Noninteractive Commands Command Format You cannot combine the -f, -o, and -s commands with any other options:  -f = Input parameter options from a text file (see “-f” on page 43). For example: qaucli -pr fc -f command.txt  -o = Output the results to a file (see “-o (Redirect Standard Output To a File)” on page 73). For example: qaucli -pr fc -l all -o output.txt  -s = Silent mode (see “-s (Suppress Output [Silent Mode])” on page 87).
PAGE 43
5–Fibre Channel Noninteractive Commands Command Summary Table 5-2. Command Variables (Continued) Variable Definition Format
IP address xxx.xxx.xxx.xxx Target link speed 1.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 all Fibre Channel noninteractive commands in alphabetical order.
PAGE 44
5–Fibre Channel Noninteractive Commands -a                                    -g -gs (Configure Parameters [Monitoring]) -h (Help) -ha (Adapter Alias [FCoE Configuration]) -i (FC Adapter Information; FC VPD Information; FC VFC Information) -kl (Loopback Test) -kr (Read Write Buffer Test) -l (FC Target/LUN Information) -ls (Display Parameters [HBA Statistics]; Link Status) -m (Selective LUNs) -mbiv (Flash/MBI Information) -n (Configure HBA Parameters) -o (Redirect Standar
PAGE 45
5–Fibre Channel Noninteractive Commands -b (Flash Update; Save Flash) To view the adapter port’s LED beacon state, issue the following command: qaucli -pr fc -a | view|info The following message appears: HBA Port x - LED Flashing is . Where is ON if the LED is flashing, or OFF if the LED is not flashing. In Solaris SPARC, include double quotes around the question mark (?) if the system is running with a csh or tcsh shell.
PAGE 46
5–Fibre Channel Noninteractive Commands -b (Flash Update; Save Flash) Where: all = All adapters of the same type in the system are updated with the new BIOS or FCode = Adapter number (use the -g command to find) = World wide port name all = Update all regions (BIOS, FCode, or extensible firmware interface (EFI) depending on the Flash image = Name or path of file containing update BIOS or FCode a = Optional.
PAGE 47
5–Fibre Channel Noninteractive Commands -b (Flash Update; Save Flash) -src = Specifies a different template file than the default file.