CIM Provider and vCenter Plug-in Cavium Corporation All rights reserved Table of Contents 1. Package Contents 2. Supported Adapters/Controllers 3. Supported Operating Systems 4. QLogic CIM Provider 5. vSphere Plug-ins 6. Additional Notes 7. Contacting Support 1. Package Contents The QLogic CIM Provider and vCenter Plug-in package, version 1.2.47-2, contains the following files: * QLogic_Adapter_VI_Plugin_x_x_x.exe - The QLogic Adapter vCenter Plug-in installation package, where x_x_x is the version of the vCenter Plug-in. * QLogic_Adapter_Web_Client_Plugin_x_x_xx_x.exe - The QLogic Adapter vCenter Web Plug-in installation package for Windows, where x_x_xx_x is the version of the vCenter Web Plug-in. * QLogic_Adapter_Web_Client_Plugin_Linux_i386_x_x_xx_x.bin - The QLogic Adapter vCenter Web Plug-in installation package for Linux i386, where x_x_xx_x is the version of the vCenter Web Plug-in. * QLogic_Adapter_Web_Client_Plugin_Linux_x64_x_x_xx_x.bin - The QLogic Adapter vCenter Web Plug-in installation package for Linux x64, where x_x_xx_x is the version of the vCenter Web Plug-in. * qlogic_adapter_provider_vmware_esx55_60-x.x.x - Contains the QLogic Adapter CIM Provider installation package for ESXi 5.5/6.0, where x.x.x is the version of the CIM Provider. * qlogic_viplugin_provider_vmware_esx50x-x.x.x - Contains the QLogic FastLinq CIM Provider installation package for ESXi 5.0.x/5.1.x, where x.x.x is the version of the CIM Provider. * qlogic_viplugin_provider_vmware_esx55_60-x.x.x - Contains the QLogic FastLinq CIM Provider installation package for ESXi 5.5/6.0, where x.x.x is the version of the CIM Provider. * qlogic_viplugin_provider_vmware_esx65-x.x.x - Contains the QLogic FastLinq CIM Provider installation package for ESXi 6.5, where x.x.x is the version of the CIM Provider. * readme.txt - This document. * release_notes.txt - The Release Notes document that lists changes, fixes, known issues, and release details. 2. Supported Adapters The following series of adapters are supported by QLogic Adapter CIM Provider and vCenter Plug-in for VMware ESX/ESXi. 2400/2500/2600/2700/8100/8200/8300/3200 Series Adapters The following series of adapters are supported by QLogic FastLinq CIM Provider and vCenter Plug-in for VMware ESX/ESXi. 3400/8400/45000 Series Adapters 3. Supported Operating Systems This section defines the supported operating systems. The QLogic Adapter CIM Provider runs on the following operating systems: * VMware ESX 5.x.x, 6.x (64-bit) Intel 64, AMD64 The QLogic FastLinq CIM Provider runs on the following operating systems: * VMware ESX 5.x.x, 6.x (64-bit) Intel 64, AMD64 The QLogic Adapter vCenter Plug-in and QLogic Adapter Web Client Plug-in are supported on Windows operating systems. The QLogic Adapter Web Client Plug-in is supported on 32 and 64 bit Linux operating systems. 4. QLogic CIM Provider 4.1 Supported Features The QLogic Adapter CIM Provider supports the following: * Adapter inventory * Flash update * Adapter configuration The following namespaces are supported on VMware ESX: * qlogic/cimv2 * root/interop * qlogic/viplugin No command line options are available for the QLogic Adapter CIM Provider. 4.2 Installing the QLogic CIM Provider The QLogic Adapter CIM Provider for VMware ESX was generated as a VIB (vSphere Installation Bundle) file. A VIB contains the complete set of files and binaries required to install the provider on VMware ESX/ESXi. The offline-bundle.zip file contains the VIB and the necessary metadata to install the provider on VMware ESX/ESXi. To install the QLogic Adapter CIM Provider using esxcli command on ESXi5.x and ESXi6.x systems only: 1. Copy the QLGC_ESX-xxx-provider-xxx-offline_bundle.zip file in to a directory (for example /var/tmp) of the ESXi system. 2. Execute the "esxcli" commands as follows: # esxcli software vib install --maintenance-mode -d file://// Note: is the directory (for example /var/tmp/) where the CIM Provider zip file was stored. # reboot Note: reboot ESXi upon successful installation when prompted. To install the QLogic Adapter CIM Provider from a remote host using the vSphere CLI vihostupdate command (ESXi systems only): NOTE: To update the provider from a remote host using the vihostupdate command, make sure that the ESXi system is in Maintenance Mode. 1. Copy the QLGC_ESX-xxx-provider-xxx-offline_bundle.zip file to any location on the host where either the vSphere CLI package is installed or vSphere Management Assistant (vMA) is hosted. 2. Navigate to the location of the QLGC_ESX-xxx-provider-xxx-offline_bundle.zip file. 3. Execute the vihostupdate command to install the offline bundle as follows: # vihostupdate.pl --install --bundle QLGC_ESX-xxx-provider-xxx-offline_bundle.zip 4. Follow the on-screen instructions to complete the installation. You may need to reboot the ESX system. NOTE: For more details on vihostupdate, refer to the documents on the VMware vSphere Command-Line Interface Documentation page, located here: http://www.vmware.com/support/developer/vcli/ 4.2.1 Subsequent Update Installation To update the QLogic Adapter CIM Provider after a prior installation: 1. Follow the instructions in section 4.4 to remove the existing package. 2. Follow the instructions in section 4.2 to install the new package. 4.3 Starting the QLogic Adapter CIM Provider After a system startup, the Small Footprint CIM Broker (SFCB) CIM object manager(CIMOM) in the ESX system should start automatically and load the QLogic Adapter CIM Provider when necessary. For ESX systems, you can also manually stop, start, or restart the SFCB CIMOM using the following commands. To stop the SFCB CIMOM and the QLogic Adapter CIM Provider: # /etc/init.d/sfcbd-watchdog stop To start the SFCB CIMOM and the QLogic Adapter CIM Provider: # /etc/init.d/sfcbd-watchdog start To restart the SFCB CIMOM and the QLogic Adapter CIM Provider: # /etc/init.d/sfcbd-watchdog restart After starting the SFCB CIMOM, use a CIM client utility to query the QLogic Adapter CIM Provider for information. Note: On ESXi 6.5, the CIM MOM may not be enabled. To see if the CIM MOM is enabled, execute the following command: # esxcli system wbem get If the CIM MOM is not enabled, execute the following command: # esxcli system wbem set -e true 4.4 Removing the QLogic Adapter CIM Provider To remove the QLogic Adapter CIM Provider, use either the esxupdate or vihostupdate or esxcli command. To uninstall the QLogic Adapter CIM PRovider using esxcli command on ESXi5.x and ESXi6.x systems: 1. To view VIB list: # esxcli software vib list 2. To remove the QLogic Adapter provider: # esxcli software vib remove --vibname qlogic-adapter-provider --maintenance-mode –f 3. To remove the QLogic FCA provider: # esxcli software vib remove --vibname provider-fca --maintenance-mode –f 3. To remove the QLogic FastLinQ provider: # esxcli software vib remove --vibname viplugin-cimprovider --maintenance-mode –f To uninstall from a remote host using the vihostupdate command: NOTE: To uninstall the provider from a remote host using the vihostupdate command, make sure that the ESX/ESXi system is in Maintenance Mode. To put the ESX/ESXi host in Maintenance Mode using vSphere Client, select Inventory -> Host -> Enter Maintenance Mode. 1. From a console on the host where the vSphere CLI package is installed or vMA is hosted, query and find the Bulletin ID of the existing provider: # vihostupdate.pl --query 2. Remove the existing VIB as follows: # vihostupdate.pl --remove --bulletin NOTE: For more details on vihostupdate, refer to the documents on the VMware vSphere Command-Line Interface Documentation page, located here: http://www.vmware.com/support/developer/vcli/ 5. vSphere Plug-ins 5.1 Supported Features The QLogic Adapter vSphere Plug-ins support the following: * Adapter inventory * Flash update * Adapter configuration 5.2 Installing the QLogic Adapter vCenter Plug-in To install the QLogic Adapter vCenter Plug-in: 1. Run the QLogic_Adapter_VI_Plugin_x_x_x.exe by either: * Double-clicking the file name. * Typing the name of the EXE on a command prompt. 2. Follow the instruction in the installer to complete the installation. 3. After the installation completes Tomcat service needs to be restarted. If Plug-in is installed on the VMware Vcenter server restart "VMware VirtualCenter Management WebServices". If the vCenter Plug-in is installed on server other than VCenter Server, restart the "Apache Tomcat Service" to start using the vCenter Plug-in. To install the QLogic Adapter vSphere Web Client Plug-in: 1. Gather all information necessary for the installation a. IP address of the vCenter Server b. vCenter Server credentials (user name and password) c. Determine where to host the QLogic Adapter vSphere Web Client Plug-in(on vCenter Server or other server) i. If hosting the QLogic Adapter Plug-in on a different server, then make sure the server has Tomcat running as a service and have the IP address of the Tomcat instance ready. The Tomcat server must be configured for HTTPS. Also, make sure the Tomcat environment variable “CATALINA_HOME” is set to the appropriate directory. 2. Run the installer on the server providing the Tomcat service. Provide the information requested by the installer. a. On Windows, double click on the installer and follow the instructions on the GUI provided. b. On Linux: i. Make sure the user is the root user (or has root privileges). ii. Make the installer executable (if not already) by using the command “chmod +x ” where “” is the file name of the installer. iii. Run the installer by issuing the command “./” where “” is the filename of the installer. iv. Follow the instructions provided by the installer. 3. Restart the Tomcat service. If the QLogic Adapter Plug-in is being hosted on the vCenter Server, you must restart the vCenter Server service. On Windows, use “Administrative Tools” -> “Services” and restart the service “VMware VirtualCenter Server”. On the vCenter Server Appliance (Linux) you will need to issue the command “/etc/init.d/vmware-vpxd tomcat-restart”. 4. Restart any vSphere Web Client sessions. If updating a previous version of the QLogic Adapter Plug-in, then restart the vSphere Web Client services. On Windows, use “Administrative Tools” -> “Services” and restart the service “VMware vSphere Web Client”. On the vCenter Server Appliance (Linux) you will need to issue the command “/etc/init.d/vsphere-client restart”. 5.3 Starting the QLogic Adapter vCenter Plug-in To start the QLogic Adapter vCenter Plug-in: 1. Start the VMware vSphere Client and connect to the vCenter Server by entering the IP address or name, user name, and password, and then clicking the "Login" button. 2. If the Security Warning dialog box appears, click "Ignore" to use the current SSL certificate. * If you start and connect the vSphere Client directly to an ESX/ESXi server, the vCenter Plug-in does not show up. * If you have not done so, create a data center and add the ESX/ESXi server. 3. In the left pane, select the IP Address of the VMware ESX/ESXi server. 4. In the right pane, click the Qlogic "QConvergeConsole" tab to view the Web page. The vCenter Plug-in retrieves the adapter information from the server. NOTE: If the server does not have the QLogic Adapter CIM Provider and adapters installed, or if the vCenter Plug-in installation and registration was not successful, the QLogic "QConvergeConsole" tab is not shown. To start the QLogic Adapter vSphere Web Client Plug-in: 1. Start a vSphere Web Client session by using a web browser and connect to the vSphere Web Client using the appropriate user name and password. 3. In the left pane, "vCenter" -> "Hosts" -> the IP Address of the VMware ESX/ESXi server. 4. In the right pane, click the "Manage" tab. The "QConvergeConsole" tab should be available. Click on "QConvergeConsole". The vCenter Plug-in retrieves the adapter information from the server. NOTE: If the server does not have the QLogic Adapter CIM Provider and adapters installed, or if the vSphere Web Client Plug-in installation and registration was not successful, the QLogic "QConvergeConsole" tab is not shown. 5.4 Removing the QLogic Adapter vCenter Plug-in To remove the QLogic Adapter vCenter Plug-in: 1. In the Windows Control Panel, select "Add or Remove Programs." 2. In the Add or Remove Programs dialog box, select the QLogic Adapter vCenter Plug-in, and then click "Change/Remove." 3. Follow the instruction in the QLogic Adapter vCenter Plug-in installer to remove the Plug-in. To remove the QLogic Adapter vSphere Web Client Plug-in: * Uninstalling the vSphere Web Client Plug-in on Windows is initiated through the Windows “Uninstall Programs” control panel. Follow the uninstaller UI to uninstall the plug-in. * Uninstalling the vSphere Web Client Plug-in on Linux is initiated by a command line command “/opt/qlogic/QLogic\ Adapter\ Web\ Client\ Plugin/Uninstall_QLogic\ Adapter\ Web\ Client\ Plugin/Uninstall\ QLogic\ Adapter\ Web\ Client\ Plugin”. Follow the prompts (UI or console commands) to uninstall the plug-in by the root user. 5.5 Updating the Flash To update the Flash from the QLogic Adapter vCenter Plug-in: 1. Follow the instructions in "5.3 Starting the QLogic Adapter vCenter Plug-in" to start the vCenter Plug-in. 2. In the left pane of the QLogic Adapter page, select the adapter, and then click the "Update Adapter Flash Image" link. 3. In the Select Flash File for Update dialog box, click "Browse". 4. In the Choose File to Upload dialog box, select the .bin Flash file from the extracted Flash kit package that is compatible with your adapter, and then click "Open". 5. In the Select Flash File for Update dialog box, click "Send". 6. Verify the current Flash version and file version, and then click "OK" to continue the update. 7. When asked “Do you want to reset the adapter to activate the firmware immediately after successful update?”, click "OK" if you want the new firmware to take effect immediately. Or, click "Cancel" to have the new firmware take effect after the next system reboot. 8. Wait for the Flash update process to complete. Processing time depends on the network connection and the system configuration. Do not interrupt the update process. CAUTION: The Flash update may take up to ten minutes to complete. Do not cancel the task or reboot the server during this time. Doing so may corrupt the firmware on the adapter. If the flash update has failed after waiting 10 minutes, there may be a timeout issue, in this case, follow the instructions in section 6.4.e. 9. In the Flash update successful completion message box, click "OK." 10. If you clicked "OK" in step 7, you can click "Refresh" to verify the new flash firmware version. Otherwise, you must reboot the system for the new flash firmware to take effect. 6. Additional Notes 6.1 Hardware Requirements This section defines the minimum hardware requirements for the two components. QLogic Adapter CIM Provider --------------------------- The QLogic Adapter CIM Provider requires the following minimum hardware: * One or more QLogic Adapters. * Single-processor or multi-processor server or workstation. The server and workstation hardware must be compatible and capable of running the VMware ESXi 5.x.x platform. Refer to the latest online "VMware Compatibility Guide" for your OS on the VMware Web site: http://www.vmware.com * Video card capable of 256 colors, and a screen resolution of 800x600 pixels * About 5MB disk space QLogic Adapter vCenter Plug-in ---------------------------- The QLogic Adapter vCenter Plug-in requires the following minimum hardware to operate: * Single-processor or multi-processor server or workstation. The server and workstation hardware must be compatible and capable of running the VMware vCenter Server or Tomcat server. Refer to the latest online "VMware Compatibility Guide" for your OS on the VMware Web site: http://www.vmware.com * Video card capable of 256 colors, and a screen resolution of 800x600 pixels 6.2 Software Requirements This section defines the minimum software requirements for the two components. QLogic Adapter CIM Provider --------------------------- The QLogic Adapter/FCA CIM Provider requires the following minimum software: * QLogic ESX/ESXi (qlcnic/qla2xxx/qla4xxx/qlnativefc) driver for your QLogic Adapter. * Administrative privileges to perform management functions * One of the operating systems identified in the "3. OS Support" section. The QLogic FastLinQ CIM Provider requires the following minimum software: * QLogic ESX/ESXi (net-cnic/misc-cnic-register/net-bnx2x/scsi-bnx2fc/scsi-bnx2i/ qedentv/qedf/qedil) driver for your QLogic Adapter. * Administrative privileges to perform management functions * One of the operating systems identified in the "3. OS Support" section. QLogic Adapter vCenter Plug-in ----------------------------- The QLogic vCenter Plug-in requires the following minimum software: * Tomcat 6 or 7. The installer dynamically detects the Tomcat version and installs accordingly. http://tomcat.apache.org/ NOTE: VMware requires that all vCenter Plug-ins are Web-based applications hosted on a Tomcat Server, which can be downloaded and installed on Linux and Windows systems. * VMware vCenter Server 5.x.x or 6.x.x For information on how to set up vCenter Server, please visit VMware's website and search for "vSphere installation" to get the latest vSphere installation instructions and guides. 6.3 Recommended or Best Practices a. For 25G/40G/100G adapters, if DCBX/ETS are used, setting of bandwidth to 0 on storage functions is the best practice. 6.4 Known Issues and Workarounds a. The QLogic Adapter CIM provider may take longer than 50 seconds to initialize, depending on the number of adapters on the system. No workaround; QLogic is currently investigating this known issue in the lower level API. b. If you have problems downloading the firmware/minidump files from the vCenter Plug-in, please check your internet explorer settings. For additional information on internet explorer settings, please follow http://support.microsoft.com/kb/2549423 or http://support.microsoft.com/kb/815313 c. If you have problems updating the flash on 81xx series of adapters, please try unloading the NIC driver and then attempt flash update operation using the FCoE interface only. d. To manage hosts with ESX/ESXi 5.0 or earlier releases using the vCenter Server 5.1, please install the following patches provided by VMware. ESXi 5.0 U1 https://my.vmware.com/web/vmware/info/slug/datacenter_cloud_infrastructure /vmware_vsphere_hypervisor_esxi/5_0?cmd=displayKC&externalId=2019107 e. The flash update operation for some adapters could take 15-20 minutes to complete. Due to SFCB CIMOM settings on the ESX/ESXi host, QLogic Adapter VI Plugin could time out during the operation. To work around this issue, modify the sfcb CIMOM configuration file as mentioned below, vi /etc/sfcb/sfcb.cfg Change the "intSockTimeout" value from 600 to 1500. Stop the CIMOM - /etc/init.d/sfcbd-watchdog stop & Start the CIMOM - /etc/init.d/sfcbd-watchdog start f. If you happen to install QCC GUI or other applications(which installs its own tomcat server) in the same server as the vCenter server, please make sure to pick a different port as the listening port for the tomcat installation. g. If you encounter the error message, "A script on this page is causing web browser to run slowly", please follow the instructions provided in the link - http://support.microsoft.com/kb/175500#LetMeFixItMyselfAlways to fix the issue. h. If NPAR is enabled, enabling/disabling "Enable RX checksumming" NIC driver Parameter might have no effect. i. If installing the plug-ins on a separate Tomcat server, make sure that the server where Tomcat is running has enough resources (such as memory). For example, if the server is a virtual machine without sufficient memory, operations such as updating firmware may fail. To determine resource issues checking the Tomcat log may show the issues as exceptions such as "OutOfMemory" exceptions. Recommended to allocate at least 1GB of memory to the virtual machine running the Tomcat server. j. When conducting a Read/Write Buffer test and the status returned is "R/W buffer not supported", the test may continue to show "R/W buffer not supported" unless the plug-in is refreshed using the "Refresh" button (upper right corner of the vCenter Plug-in or web client refresh button) k. When installing web client plug-in on the same Windows machine as the vCenter Server and the web client plug-in does not seem to be installed. Please make sure the plug-in is installed on the drive as the vCenter Server. 7. Contacting Support Please feel free to contact QLogic Support at http://support.qlogic.com for further assistance. (c) Copyright 2009-2017. All rights reserved worldwide. QLogic, the QLogic logo, and the Powered by QLogic logo are registered trademarks of Cavium Corporation. All other brand and product names are trademarks or registered trademarks of their respective owners.