**************************************** README **************************************** Chelsio NVMe-oF offload Initiator for VMware ESXi 6.7 Version : 4.0.0.1 (Alpha) Date : 02/07/2019 Overview ================================================================================ The Chelsio NVMe-oF offload Initiator driver package installs various drivers and utilities for Chelsio's Unified Wire adapters. NOTE: Drivers are not VMware certified. ================================================================================ CONTENTS ================================================================================ - 1. Supported Operating Systems - 2. Supported Cards - 3. How to Use - 4. Support Documentation - 5. Customer Support 1. Supported Operating Systems ================================================================================ - ESXi 6.7 - ESXi 6.7 U1 2. Supported Cards ================================================================================ - T62100-LP-CR - T6225-CR 3. How to Use ================================================================================ Driver Installation =================== a) Download the driver package from https://service.chelsio.com. b) Unzip the driver package. [root@host:~] unzip .zip c) Put the host in maintenance mode using the vSphere Client (Inventory->Host->Enter Maintenance Mode). d) Install the drivers. [root@host:~] cp *.vib /productLocker/ [root@host:~] cp *.vib /var/log/vmware/ [root@host:~] esxcli software vib install -v /productLocker/cxl-*.vib --no-sig-check [root@host:~] esxcli software vib install -v /productLocker/cheiscsi-*.vib --no-sig-check [root@host:~] esxcli software vib install -v /productLocker/chelsio-esx-libcheiscsi_ima.so-*.vib --no-sig-check e) After installation/update completes successfully, exit from maintenance mode and reboot the system. Driver Loading ============== After rebooting the ESXi Host, the driver will load automatically. However, it is possible to manually load the driver by using the command below: [root@host:~] vmkload_mod cheiscsi Execute the below command so that device manager performs a rescan: [root@host:~] kill -SIGHUP $(cat /var/run/vmware/vmkdevmgr.pid) Firmware Update =============== Native Network Driver (cxl) will auto-load the firmware (v1.23.0.0) if an update is required. The version can be verified using: [root@host:~] /opt/chelsio/bin/cxgbtool -c version cxgbtool ======== cxgbtool will be installed by default on installing the driver VIB. Usage: ------ To use cxgbtool, use the syntax: [root@host:~] /opt/chelsio/bin/cxgbtool NOTE: For information on available parameters and their usage, refer to cxgbtool help by running the "/opt/chelsio/bin/cxgbtool -h" command. Driver Configuration ==================== Configure the NVMe target machine with the IP Address, Target name, disks etc. For information on how to configure the NVMe Target, please refer Chelsio Unified Wire for Linux User's Guide. IMPORTANT: Disable iwpmd service on the target machine. On RHEL7.X machines, use the below command. [root@host~]# systemctl stop iwpmd Connecting to NVMe target ------------------------- Follow the below procedure on NVMe Initiator machine to connect to the target. a) Log in to vCenter Server through vSphere Web Client using a web browser. b) If you have already created and configured the host intended to be used as initiator, skip to step (c) i. Under Hosts and Clusters, right-click and click New Datacenter… Provide a name and Click OK. ii. Right-click on the newly created datacenter and click Add Host... Follow onscreen instructions and provide information to add the host. Click Finish. c) Select the host and under the Configure tab, select Storage Adapters. This will display the list of available Chelsio storage adapters. d) In the Adapter Details section, click Network Settings tab and then Edit. e) Configure IP for the adapter and click OK. You can configure either IPv4 or IPv6 or both. f) Discover the target. [root@host:~] /opt/chelsio/bin/cxgbtool -c nvmf -tport -ipaddr g) Login to the target. [root@host:~] /opt/chelsio/bin/cxgbtool -c nvmf -tport -ipaddr -L -subnqn h) Rescan the storage adapter and the target LUNs will be visible. [root@host:~] esxcfg-rescan -A i) All the available LUNs will be displayed in the Devices tab. These LUNs can now be attached to VMs or can be used to store VMs. Disconnecting from NVMe target ------------------------------ To logout or disconnect from the target, [root@host:~] /opt/chelsio/bin/cxgbtool -c nvmf -tport -ipaddr -LT -tgtid Driver Unloading ================ Logout of all the existing NVMe-oF sessions. Execute the command below to unload the driver: [root@host:~] vmkload_mod -u cheiscsi Driver Uninstallation ===================== NOTE: Before proceeding, please ensure that no NVMe-oF session or connection is active and running. Follow the steps mentioned below to uninstall the drivers: a) Put the host in maintenance mode using the vSphere Client (Inventory->Host->Enter Maintenance Mode). b) Uninstall the drivers. [root@host:~] esxcli software vib remove -n cxl [root@host:~] esxcli software vib remove -n cheiscsi [root@host:~] esxcli software vib remove -n chelsio-esx-libcheiscsi_ima.so c) Reboot the host. [root@host:~] reboot 4. Support Documentation ================================================================================ The documentation for this release can be found inside the /doc folder. It contains: - README - Release Notes - User's Guide 5. Customer Support ================================================================================ Please contact Chelsio support at support@chelsio.com for any issues regarding the product. ******************************************************************************** Copyright (C) 2019 Chelsio Communications. All Rights Reserved. The information in this document is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Chelsio Communications. Chelsio Communications assumes no responsibility or liability for any errors or inaccuracies that may appear in this document or any software that may be provided in association with this document. Except as permitted by such license, no part of this document may be reproduced, stored in a retrieval system,or transmitted in any form or by any means without the express written consent of Chelsio Communications.