QLogic Linux SuperInstaller Readme QLogic Corporation All rights reserved Table of Contents 1. Package Contents 2. Supported Adapters/Controllers 3. Supported Operating Systems 4. Installing the Driver 5. Additional Notes 6. Contacting Support 1. Package Contents The QLogic Linux SuperInstaller package contains the following drivers and management tools for QLogic 10000/2400/2500/2600/8100/8200/3200/8300 Series Adapters: * FC-FCoE, iSCSI, and Ethernet Networking drivers * QConvergeConsole command line interface (CLI) Management Tool and SNIA HBA APIs for 2400/2500/2600/8100/8200/8300 (FC-FCoE functions) * FC-FCoE, iSCSI, and Ethernet Networking Management Agents to enable remote access using QConvergeConsole (GUI) Management Tool * Linux Tools (scripts) for commonly performed storage networking tasks The Linux SuperInstaller package contains the following files: * qlinstall - Script to install FC-FCoE, iSCSI, and Ethernet Networking Drivers for 2400/2500/2600/8100/3200/8200/8300 Series Adapters * ql-pci.ids - Vendor device mapping file * agents/ - RPC command and FC-FCoE, iSCSI, and Networking Management Agents * qaucli/ - QConvergeConsole Command Line (CLI) Management tool * iscli/ - SANsurfer iSCSI CLI tool for 4000 Series iSCSI Adapters * Linux-Tools/ql-dynamic-tgt-lun-disc-x.y.tgz - Scans for newly added LUNs * Linux-Tools/ql-set-cmd-timeout-x.y.tgz - Allows you to set the timeout on the devices connected to the QLogic Fibre Channel-FCoE Adapters * Linux-Tools/ql-lun-state-online-x.y.tgz - Allows you to change the state of the LUNs connected to the QLogic adapter from offline to online/running * Linux-Tools/ql-hba-snapshot-x.yy.tgz - Works on sysfs to display details about the QLogic adapter attached to the system * Linux-Tools/ql-hba-collect-x.yy.tgz - Collects all the system information and configuration * Readme.txt - This readme file 2. Supported Adapters/Controllers * 10000/2400/2500/2600/8100/8200/3200/8300 Series Adapters 3. Supported Operating Systems The adapter driver installation script supports following Linux operating system (OS) platforms: * Red Hat RHEL 6.6/6.7 (32-bit, 64-bit), RHEL7.1/7.2 ( 64-bit) ,Intel x86, Intel64, AMD64 * Novell SLES 11 SP3/SP4 (32-bit, 64-bit) , SLES12/12.1 (64-bit), Intel x86, Intel64, AMD6 NOTE: For specific service packs (SP) and OS updates, refer to the descriptions where this software version is posted on the QLogic Web site: http://driverdownloads.qlogic.com 4. Installing the Linux SuperInstaller The following sections provide script options and examples: * 4.1 Command Line Options * 4.2 Running Linux SuperInstaller (qlinstall) Commands 4.1 Command Line Options The following options are available: -i | --install [-ia|--install_agent] This option checks for the pre-built binaries for the running OS arch combination and installs it. If a pre-built binary is not found, the binary is generated from the source RPM for the running kernel. To install the qlremote/iqlremote/netlqlremote/qlremote_fca agent (which is used with SANsurfer HBA Manager and QConvergeConsole Management Tool (GUI)), use -ia or --install_agent. -ifc | --install_fc [-a]" This option checks for and installs the pre-build binaries for the running OS arch for the Fiber Channel/FCoE driver. If a pre-built binary is not found, the binary is generated from the source RPM for the running kernel. To install the qlremote, use the -ifc -a option. To install the qlremote_fca, use the -ifc -a option. -inic | --install_nic [-a]" This option checks for and installs the pre-build binaries for the running OS arch for the Ethernet Networking driver. If a pre-built binary is not found, the binary is generated from the source RPM for the running kernel. To install the netqlremote, use the -inic -a option -iiscsi | --install_iscsi [-a]" This option checks for and installs the pre-build binaries for the running OS arch for the iSCSI driver. If a pre-built binary is not found, the binary is generated from the source RPM for the running kernel. To install the iqlremote, use the -iiscsi -a option -up | --upgrade This option installs the driver source, builds the driver, and loads the driver on the next OS boot. It creates the RAMdisk to load the QLogic adapter driver at boot time. NOTE: Do not use this option with the -i option. dl | --device_list This option displays the devices connected on all the adapters. -u | --uninstall [ -l|--loaded] This option uninstalls the driver. To keep the current drivers loaded during the uninstall process, specify -l or --loaded. -ufc | --uninstall_fc [ -a ] This option uninstalls the Fibre Channel/FCoE driver with agent, if the -a option is specified. -unic | --uninstall_nic [ -a ] This option uninstalls the Ethernet Networking driver with agent, if the -a option is specified. -uiscsi | --uninstall_iscsi [ -a ] This option uninstalls the iSCSI driver with agent, if the -a option is specified. -l | --load [module-name] This option detects the installed adapters in the system and loads the driver for each installed adapter. It unloads any older driver versions before loading the latest drivers. If this option includes a module name, it loads only that module. -ul | --unload [module-name] This option unloads all drivers for the installed adapters. iq | --install_qaucli This option installs QConvergeConsole CLI (qaucli). -nq | --no_qaucli This option skips the qaucli installation. -iis | --install_iscli This option installs SANsurfer iSCSI HBA CLI. nis | --no_iscli This option skips the iscli installation. -h | --help | -? This option displays the help message. 4.2 Running Linux SuperInstaller (qlinstall) Commands This section describes how to perform tasks using the qlinstall command options at the command line with a root or superuser account. To start the installation script, type: # ./qlinstall To display help for the command line options, type: # ./qlinstall -h To run the installation script, type one of the following: # ./qlinstall # ./qlinstall -i # ./qlinstall -install To install the driver without an existing QLogic adapter, type: # ./qlinstall -force To install the driver without unloading and loading the current drivers, type: # ./qlinstall -up To install driver and agent, type one of the following: # ./qlinstall -i -ia # ./qlinstall -i -a # ./qlinstall -ifc -a # ./qlinstall -inic -a # ./qlinstall -iiscsi -a To display the device list, type: # ./qlinstall -dl To uninstall driver and agent, type one of the following: # ./qlinstall -u # ./qlinstall -uninstall # ./qlinstall -u -a # ./qlinstall -ufc -a # ./qlinstall -unic -a # ./qlinstall -uiscsi -a To load the driver, type one of the following: # ./qlinstall -l # ./qlinstall -load To load a specific module, for example, qla2xxx, type: # ./qlinstall -l qla2xxx To unload the driver, type one of the following: # ./qlinstall -ul # ./qlinstall -unload To unload a specific module, for example, qla2xxx, type: # ./qlinstall -ul qla2xxx To run CLI tools, type one of the following: # ./qlinstall -iq # ./qlinstall -iis 5. Additional Notes This section contains: * 5.1 Prerequisite * 5.2 Supported Features * 5.3 Linux Tools * 5.4 Known Issues 5.1 Prerequisite * In order to make sure that the source RPM's get compiled on the systems which doesn't have excatly matching binary rpm's, make sure the kernel ksyms & kernel source rpm's are installed on your machine. * The Linux SuperInstaller (qlinstall script) requires following packages to build binary rpms in RedHat RHEL 6: - redhat-rpm-config-.el6.noarch rpm - rpm-build-.el6. rpm Ex: redhat-rpm-config-9.0.3-25.el6.noarch rpm rpm-build-4.8.0-12.el6.i686 rpm 5.2 Supported Features The Linux SuperInstaller (qlinstall script) supports the following features: * Supports Fibre Channel, iSCSI, Intelligent Ethernet Adapters, and Converged Network Adapters. * Builds, installs, and loads the driver with the configuration module for Fibre Channel/iSCSI/Converged Network Adapters on the 2.6.x kernel, based on the QLogic adapter model installed in the system. * Installs the driver before installing the Fibre Channel/ iSCSI/Intelligent Ethernet Adapters/Converged Network Adapters. * Installs and updates the driver in the RAMdisk. * Performs a device discovery and displays devices found. * Provides the following command line options: - Invokes the device discovery at a later stage. - Rebuilds the RAMdisk to exclude or include the QLogic adapter driver. - Unload or load the driver. 5.3 Linux Tools The installer package also provides Linux tools in the Linux-Tools directory. To use these tools, change to the Linux-Tools directory, and then run the following command to uncompress all Linux tools: # ./uncompress_all.sh 5.4 Known Issues * Cannot uninstall agents (qlinstall -u -a) without drivers installed. * qlcnic driver get reloaded automatically after an unload. * SuperInstaller needs to be uninstalled first before installing any new driver via a different mechanism like installing drivers using the install scripts provided in the driver source tgz files. 6. Contacting Support For further assisance, contact QLogic Technical Support at: http://support.qlogic.com (c) Copyright 2016. All rights reserved worldwide. QLogic and the QLogic logo are registered trademarks of QLogic Corporation. All other brand and product names are trademarks or registered trademarks of their respective owners.