              QConvergeConsole CLI Readme
               Marvell Semiconductor, Inc
                  All rights reserved 

Table of Contents
 
1. Package Contents 
2. Supported Adapters/Controllers 
3. Supported Operating Systems
4. Installing the Application 
5. Additional Notes    
   5.1 Warning Messages on Startup 
   5.2 Actions prior to the installation/upgrade of drivers
   5.3 Issue with the BSG on Oracle UEK
   5.4 OS Hot fix for performance issues on Windows Server 2008 R2  
   5.5 RHEL 6.x Installation of 32-bit compatibility libs
   5.6 Features not supported in Windows PE
   5.7 Action prior to the installation/upgrade of QCC CLI  
   5.8 Features not available when running Windows Server 2008
       Inbox driver   
   5.9 FC Loopback data patterns
   5.10 Hyper-V Virtual Port new FC driver required
   5.11 Linux PowerPC Dependency on libstdc++.so.5  
   5.12 Loading SCSI Generic (SG) driver requirement for RH7.1
   5.13 Flash Update early termination issue   
   5.14 CT Ping and FTR tests fail when connected to Cisco switch
   5.15 Minimum switch firmware requirements for Diagnostics Port, Read Diagnostics
        Parameters and FC Ping features
   5.16 Features not supported with NVME Targets/LUNs
   5.17 Flash update failed with misleading error message when running inbox driver and
        firmware lockdown mode is turned on
   5.18 FC Ping and CT Ping fail on HPE Alletra9K target
   5.19 Limitations with SFP Firmware update
   5.20 Application fails to start after Emulex tools installed (Linux)
  
6. Open Source License
   6.1 SNIA HBA API   

7. Contacting Support
 

1. Package Contents 

The QConvergeConsole Command Line Utility (QCC CLI) package 
contains the following files:

Windows x64:
   * qaucli.exe 
   * UpdateDriverAMD64.exe 
   * adapters.properties
   * agent.properties
   * scli.properties 
   * dup_contents.dat
   * fc_contents.dat
   * fcscli-exitcodes.txt
   * flashcfg.properties
   * menu.properties
   * npiv.bat
   * npiv.mof 
   * qlwmi.mof
   * scli.bat    
   * qaucli.cfg      
   * hbaapi2_x64.dll
   * ql2xhai2.dll
   * qlcoutil.dll
   * qlsdm.dll
   * dqltrace.dll
   * nvramdefs directory

Linux:	
   * qaucli 
   * scli
   * qaucli.cfg
   * adapters.properties
   * agent.properties
   * scli.properties 
   * dup_contents.dat
   * fc_contents.dat
   * fcscli-exitcodes.txt
   * flashcfg.properties
   * menu.properties
   * libqlsdm.so
   * libHBAAPI.so
   * hba.conf
   * nvramdefs directory

2. Supported Adapters/Controllers

   * 2500, 2600, 2700 and 2800 Series Fibre Channel Adapters
   
3. Supported Operating Systems

The QCC CLI runs on the following operating system (OS) platforms:

   OS Name                         OS Type            Hardware Platform
   ---------------             ------------         -------------------------------
   * Windows Server 2022           64-bit            Intel 64, AMD64   
   * Windows Server 2019	   64-bit            Intel 64, AMD64   
   * Windows PE 10/11              64-bit            Intel 64, AMD64   
 
   * Red Hat RHEL AS/ES 9.x        64-bit            Intel 64, AMD64, PPC64, ARM 64
   * Red Hat RHEL AS/ES 8.x        64-bit            Intel 64, AMD64, PPC64, ARM 64     
  
   * SUSE SLES 12 SP1/SP2          64-bit            Intel 64, AMD64, PPC64, ARM 64
                  SP3/SP4          64-bit            Intel 64, AMD64, PPC64, ARM 64
                  SP5              64-bit            Intel 64, AMD64, PPC64, ARM 64
   * SUSE SLES 15 SP1/SP2/SP3      64-bit            Intel 64, AMD64, PPC64, ARM 64
                  SP4/SP5

   * Ubuntu 22.04                  64-bit            Intel 64, AMD64, PPC64, ARM 64
   * Ubuntu 20.04                  64-bit            Intel 64, AMD64, PPC64, ARM 64
  
   * Citrix XenServer 8.2          64-bit            Intel 64, AMD64

   * OpenEuler 22.03 LTS SP1       64-bit            ARM 64
   * Kylin Linux Advanced Server   64-bit            Intel 64, AMD64, ARM64
     v10 SP1/SP2/SP3
   * UOS Server 20.1060            64-bit            Intel 64, AMD64, ARM64
   * UOS Server 20.1050e           64-bit            Intel 64, AMD64, ARM64
   * Oracle UEK R5,R6, UEK R7      64-bit            AMD64 

NOTE: 

For specific service packs (SP) and OS updates, refer to the
descriptions where this software version is posted on Marvell 
Web site https://www.marvell.com or on your OEM website.

   
4. Installing the Application  

The QConvergeConsole Command Line Utility User's Guide provides 
procedures for installing, starting, and removing the QCC CLI. It 
also provides detailed explanations of command line options. You can 
download a copy of this document from the driver download page for 
your adapter at Marvell Web site.

  https://www.marvell.com

5. Additional Notes 

The following sections provide additional information according to
operating system:

5.1 Warning Messages on Startup

When launching QCC CLI, the following warning messages may appear on 
the console: 

   * qla2xxx 0000:01:02.0: Unable to read SFP data (102/a0/0)
   * qla2xxx 0000:01:02.0: Unable to read SFP data (102/a0/0)
   * qla2xxx 0000:01:02.1: Unable to read SFP data (102/a0/0)
   * qla2xxx 0000:01:02.1: Unable to read SFP data (102/a0/0)
   * qla2xxx 0000:01:02.0: Unable to read SFP data (102/a0/0)
   * qla2xxx 0000:01:02.1: Unable to read SFP data (102/a0/0)
   * qla2xxx 0000:01:02.0: Unable to read SFP data (102/a0/0)

The FC driver displays these messages when it is unable to read  
SFP data. You can safely ignore them.  

5.2 Actions prior to the installation/upgrade of drivers

The QConvergeConsole Command Line Utility (QCC CLI)  
should be closed prior to installing or upgrading 
the FC driver.

5.3 Issue with the BSG on Oracle UEK

An operating system patch to Oracle UEK is required 
to allow QCC CLI to run properly.
Without this patch the application can lock up.
The patch fixes an operating system issue with BSG support. 
The patch is available at the following web link location 
(all three lines below need to be concatenated into one line 
in your web browser):

http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;
a=commitdiff;h=84eb8fb42c120ff32b201c1cdd910033c888f699;
hp=0f19bc681ed0849a2b95778460a0a8132e3700e2

5.4 OS Hot fix for performance issues on Windows Server 2008 R2

Poor performance has been observed on some computers that have
NUMA-based processors and are running Windows Server 2008 R2.
This issue occurs for applications with threads that request a
large amount of memory. A correction to this problem is available
in Windows Server 2008 R2 SP1, but if the user cannot upgrade to 
SP1, then a hot fix is available at:

http://support.microsoft.com/default.aspx?scid=kb;en-US;2155311

5.5  RHEL 6.x Installation of 32-bit compatibility libs

Installation Sequence:

   1. Select RHEL 6.0-20100805.0-Server-x86_64-DVD1.iso to mount with 
      Raritan to install system Kernel version 2.6.32-59.el6.x86_64
   2. Choose installation with Basic Video driver.
   3. Select Basic storage device.
   4. Install the software for "software development work machines" 
      and extra install compatibility libraries.
 
      Compatibility library rpms list:
      Compat-db-4.6.21-15.el6,x86_64
      Compat-expat1-1.95.8-8.el6.x86_64
      Comapt-glibc-2.5.46.2.x86_64
      Compat-libgfortran-41-4.1.2-39.el6.x86_64
      Compat-libstdc++-296-2.96-144.el6.x86_64
      Compat-libstdc++-33-3.2.3-69.el6.x86_64
      Compat-libtermcap-2.0.8.49.el6.x86_64
      Compat-openldap-2.4.19_2.3.43-15.el6.x86_64
      Openssl098e-0.9.8e-17.el6.x86_64
 
   5. Configure the network , make sure iptables/firewall is 
      disabled.
   6. Install QCC CLI application.
   7. Install below library RPMs in sequence.
              libXau-1.0.5.1.el6.i686.rpm
              libxcb-1.5.1el6.i686.rpm
              libX11-1.3.2.el6.i686.rpm
              libXext.1.1.3.2.el6.i686.rpm
              libXp.1.0.0.15.1.el6.i686.rpm
   8. Run QCC CLI application.


5.6 Features not supported in Windows PE

At this time the following features are not supported on Windows PE:
   * Virtual port 
   * FCoE Information
   * DCBX Parameters (TLV)
   * Persistent binding
   * Selective LUN

5.7 Action prior to the installation/upgrade of QCC CLI

The QCC GUI agents should be stopped prior to 
installing or upgrading the QConvergeConsole CLI.  Make sure to 
restart all the QCC GUI agents once the QCC CLI installation is 
complete.

5.8 Features not available when running Windows Server 2008 Inbox 
     driver

FC NVRAM parameters and Flash updates on 8Gb adapters are 
disabled when running Windows Server 2008 Inbox Driver Version 
9.1.4.5 or 9.1.4.6. User must update the host to the latest Marvell 
driver.

5.9 FC Loopback data patterns

Data patterns (CRPAT, CJPAT, CSPAT) for Loopback are not supported with 
QLE83xx/QLE26xx Series Adapters.

5.10 Hyper-V Virtual Port new FC driver required

System that is configured with virtual port created from Hyper-V Server
must run driver with minimum version as shown below:

For FC driver: v9.1.11.24
For FCoE driver: v9.1.11.12

5.11 Linux PowerPC Dependency on libstdc++.so.5

Installation of libstdc++.so.5 library is required , 
if the following error is displayed: 
“qaucli: error while loading shared libraries:
libstdc++.so.5: cannot open shared object file: No such file or directory?.

5.12 Loading SCSI Generic (SG) driver requirement for RH7.1

In RH7.1, loading SG driver is required to display the LUNs.  
To load SG driver: # modprobe sg

5.13 Flash Update early termination issue

On Linux, during flash update,  if the running process is interrupted by pressing Ctrl-C 
or by issuing command  "kill -9 <process id>" . A stale  shared file may be left behind
as the cleanup process may not be done thoroughly.  Any attempt of running flash
update again by QCC GUI or by QCC CLI  will fail subsequently.  

Workaround: Manually delete the following file in /tmp directory

 /tmp/ql_shared.dat   

5.14 CT Ping and FTR tests fail when connected to Cisco switch

    Work Around: 
     Certain Cisco switches are pre-configured not to response to CT commands and this will prevent
     storage explorer from reporting any information about the FC fabric. If your switch supports
     CT passthrough commands, the default settings may be off.  
     Please contact your switch vendor on how to enable CT support (Close mode vs. Open mode).

5.15 Minimum switch firmware requirements for Diagnostics Port, Read Diagnostics
     Parameters and FC Ping features.

     Brocade: 
       Fabric OS: v8.1.0.b

     Cisco:
       Kickstart:  version 8.2(0)SK(1) [build 8.2(0)SK(0.148)] 
       System: version 8.2(0)SK(1) [build 8.2(0)SK(0.148)] 

5.16 Limitations with NVME Target/LUN support.
   
     * Sg3 Utils version 1.44 or above is required to discover/inquiry NVME target/LUN info.
     * Target Vendor, Product ID and Product Revision fields of size 8 bytes, 16 bytes and 4
      bytes are supported as per SCSI Inquiry command. NVME targets may have bigger size
      strings which will get truncated.
     * Target PortID is 00-00-00.
     * WWULN (World-Wide-Unique-LUN-Number) in LUN info is not supported.
     * IIDMA settings are not supported.
     * LUN Persistent Name feature is not supported (Linux).
     * CT ping and CT FTR diagnostics test are not supported.
     * Boot-From-SAN is not supported.
     * NVME target is detected only when at least one namespace is present.
   
     Work Around: None

5.17 Flash update failed with misleading error message when running inbox driver and
     firmware lockdown mode is turned on.
	
     Work Around: Update to the latest driver.

5.18 FC Ping and CT Ping fail on HPE Alletra9K target
     As per HPE, the Alletra9K storage array does not support Read Link Status (RLS) command.
     so it rejects as unsupported ELS command.

     Work Around: None

5.19 Limitations with SFP Firmware update
     Boot from SAN (BFS) with single path configured is not supported.
     Support only with Accelink WTD sfp module.
     All I/Os must be suspended before updating the sfp module firmware.

     Work Around: None

5.20 Application fails to start after Emulex tools installed (Linux)
     Marvell application uses the SNIA common HBA API version 2 but Emulex tools overrides the 
     existing SNIA common HBA API with version 1 during installation.
     This causes the application stop working due to missing function calls.
     i.e: HBA_SendCTPassThruV2

     Work Around: 
        1. Reinstall QConvergeConsole CLI.
        2. Replace the Emulex libHBAAPI.so with the Marvell libHBAAPI.so by running this command
           #/opt/QLogic_Corporation/QConverconsoleCLI/lib64/libinstall --force

        
6. Open Source License

6.1 SNIA HBA API

Version: 2.0

http://hbaapi.sourceforge.net/

License: Storage Networking Industry Association Public License

http://hbaapi.sourceforge.net/faq.htm

The SNIA Common HBA API is an industry standard "C" language Application Programming
Interface for management of Fibre Channel Host Bus Adapters and discovery of SAN
resources. Developed through the Storage Networking Industry Association (SNIA),
the HBA API has been overwhelmingly adopted by Storage Area Network vendors to help manage,
monitor, and deploy storage area networks. It defines a scope within which application
software can be written without attention to vendor-specific infrastructure behavior.

7. Contacting Support

   For further assistance, contact Marvell Technical Support at:
   
   https://www.marvell.com/support/

Copyright (c) 2018-2023 Marvell.
All rights reserved.

This file is subject to the limited use license agreement by and between Marvell and you,
your employer or other entity on behalf of whom you act. In the absence of such license
agreement the following file is subject to Marvell’s standard Limited Use License Agreement.

