FC ESX Command Line Interface (CLI) Plug-in Marvell Semiconductor Inc All rights reserved Table of Contents 1. Package Contents 2. Supported Adapters/Controllers 3. Supported Operating Systems 4. Installing the ESXCLI Plug-in 5. Additional Notes 6. Contacting Support 1. Package Contents The QLogic FC ESXCLI plug-in package, version 1.5.5, contains the following files: * MRVL-QLogic-FC-Esxcli-Plugin_1.5.5-1OEM.800.1.0.20613240_22630835.zip - The QLogic FC ESX command line interface plug-in installation package for ESXi 8.0. * readme-fcesxcli_plugin-ESXi8.x.txt - This document. * release_notes-fcesxcli_plugin-ESXi8.x.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 ESXCLI Plug-in for VMware ESX/ESXi. 25xx/26xx/27xx/28xx FC Family of Adapters 3. Supported Operating Systems This section defines the supported operating systems for the three components. The FC ESXCLI runs on the following operating systems: * VMware ESX 7.0 Intel 64, AMD64 4. Installing the FC ESXCLI Plug-in 4.1 Installing the FC ESXCLI Plug-in The FC ESXCLI Plug-in 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 plug-in on VMware ESX/ESXi. The offline-bundle.zip file contains the VIB and the necessary metadata to install the plug-in on VMware ESX/ESXi. 4.1.1 Initial Installation To install the FC ESXCLI plug-in using esxcli command on ESXi systems: 1. Copy the zip file into 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:////.zip OR # esxcli software component apply -d file:////.zip Note: is the directory (for example /var/tmp/) where the plug-in zip file was stored. 3. Reboot the system. 4.1.2 Subsequent Update Installation To update the FC ESXCLI plug-in after a prior installation: 1. Follow the instructions in section 5.3 to remove the existing plug-in. 2. Follow the instructions in section 4.1.1 to install the new plug-in. 5. Additional Notes 5.1 Operating the ESXCLI plug-in After installing the plug-in, you will need to reboot the system. 5.1.1 Operating the ESXCLI plug-in directly on the host To verify the plug-in is installed, execute the esxcli command without any parameters to view the list of namespaces available and check to see if the "qlfc" namespace is listed. 5.1.1.1 To view the list of QLogic adapters: # esxcli qlfc qcc adapter list The adapter Id will be in the form of "Adapter__". For example, "Adapter_QLE2784_QFD1829Y06078". Use this adapter Id for all other commands requiring an adapter Id. 5.1.1.2 To flash update a QLogic adapters: # esxcli qlfc qcc adapter update -i -m -f - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Parameter | Value | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Adapter-Id | One of the Adapter Id from adapter list command (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Image-Type | Type of image to be updated (required) | | | | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Image-file-with-path | Image Filename with complete path (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - String values are case-sensitive. 5.1.1.3 To view information regarding a specific adapter: # esxcli qlfc qcc adapter info get -i The is one of the adapter Ids displayed in the "list" command. 5.1.1.4 To view personality information regarding a specific adapter: # esxcli qlfc qcc adapter personality get -i The is one of the adapter Ids displayed in the "list" command. 5.1.1.5 To set personality information of a specific adapter: # esxcli qlfc qcc adapter personality set -i -p The is one of the adapter Ids displayed in the "list" command. Note: Personality Change is supported only for ISP2031/ISP8031 based adapters. 5.1.1.6 To view flash information of a specific adapter: # esxcli qlfc qcc adapter flashinfo get -i The is one of the adapter Ids displayed in the "list" command. 5.1.1.7 To view the list of QLogic Ports: # esxcli qlfc qcc port list The Port-Identifier will be in the form of "FC_". For example, "FC_21:00:00:24:ff:7d:3c:47". Use this Port-Identifier for all other commands requiring a Port-Identifier. 5.1.1.8 To update NVRAM information of a specific port using NVRAM file: # esxcli qlfc qcc port updatenvram -i -f The is one of the Port-Identifiers displayed in the "list" command. 5.1.1.9 To view information of a specific port: # esxcli qlfc qcc port info get -i The is one of the Port-Identifiers displayed in the "list" command. 5.1.1.10 To view SFP DMI data of a specific port: # esxcli qlfc qcc port dmi get -i The is one of the port Ids displayed in the "list" command. 5.1.1.11 To view SFP DMI data of a specific port as Hex values: # esxcli qlfc qcc port dmi getraw -i The is one of the port Ids displayed in the "list" command. 5.1.1.12 To save SFP data of the SFP connected to a specific port: # esxcli qlfc qcc port dmi save -i -f -m - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Parameter | Value | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Port-Identifier | One of the Port Id from port list command (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | sfp-file-with-path | Filename with complete path to save SFP data (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Mode | Type of image to be saved (required) | | | | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - String values are case-sensitive. Note: This command is not supported for NPIV Virtual Port. 5.1.1.13 To view FC Statistics of a specific port: # esxcli qlfc qcc port stats get -i -m - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Parameter | Value | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Port-Identifier | One of the Port Id from port list command (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Mode | Statistics Mode (required) | | | | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - String values are case-sensitive. 5.1.1.14 To reset FC Statistics of a specific port: # esxcli qlfc qcc port stats reset -i -m - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Parameter | Value | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Port-Identifier | One of the Port Id from port list command (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Mode | Statistics Mode (required) | | | | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - String values are case-sensitive. 5.1.1.15 To view FC VPD of a specific port: # esxcli qlfc qcc port vpd get -i The is one of the port Ids displayed in the "list" command. 5.1.1.16 To view HBA Parameters of a specific port: # esxcli qlfc qcc port hbaparams get -i Note: This command is not supported for NPIV Virtual Port. The is one of the port Ids displayed in the "list" command. 5.1.1.17 To set HBA Parameters of a specific port in cache file: This command sets user provided data in temporary cache file. This cache file will be used by "set" command to save settings in flash. # esxcli qlfc qcc port hbaparams setFile -i -c -d -b -n -f -p -g -k -a -x -z -l -e -o -u -r -m -w -y -q -j Note: This command is not supported for NPIV Virtual Port. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Parameter | Value | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Port-Identifier | One of the Port Id from port list command (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Connection-Options | Port Connection Options (Optional) | | | | | | | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Data-Rate | Speed to set (Optional) | | | | | | <32_Gbps, 64_Gbps> See Note 1 below | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Enable-BIOS | Enable BIOS (Optional) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Enable-Fabric-Assigned-WWN | Enable Fabric Assigned WWPN (Optional) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Enable-FC-Tape | Enable FC Tape support (Optional) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Enable-Hard-Loop-ID | Enable Hard Loop ID (Optional) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Enable-Lip-Full-Login | Enable LIP Full Login (Optional) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Enable-LR | Enable Long Range (Optional) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Enable-Target-Reset | Enable Target Reset (Optional) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Execution-Throttle | Execution Throttle (Optional) <0 - 65535> | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Frame-Size | FC Frame Sixze (Optional) <512, 1024, 2048> | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Hard-Loop-ID | Hard Loop ID (Optional) <0 - 125> | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Interrupt-Delay-Timer | Interrupt Delay Timer in Seconds (Optional) <0 - 255> | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Link-Down-Timeout | Link Down Timeout in Seconds (Optional) <0 - 240> | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Login-Retry-Count | Login Retry Count (Optional) <0 - 255> | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Loop-Reset-Delay | Loop Reset Delay (Optional) <0 -255> | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Operation-Mode | Opearting Mode (Optional) | | | | | | | | | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Port-Down-Retry-Count | Port Down Retry Count (Optional) <0 - 255> | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | LUNs-Per-Target | Luns Per Target (Optional) | | | <0, 8, 16, 32, 64, 128, 256> | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Enable-SCM | Enable SAN Congestion Mgmt (Optional) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Virtual-Lane | Enable Virtual Lane support (Optional) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - String values are case-sensitive. Note: 1. The Data Rate values are highest 3 speed values supported for the adapter. The maximum speed value is displyed in Port Info command. e.g: If maximum speed value is "32 Gbps", then Data Rate values supported are "Auto, 32_Gbps, 16_Gbps, 8_Gbps". 2. Enable BIOS paramter is also used for Boot From SAN settings. 3. "Loop_Only" connection options is not supported for data rate >= 16 Gbps. 5.1.1.18 To set HBA Parameters of a specific port in the flash: This command sets user provided data from temporary cache file to flash. This command will fail if cache file is not present. On successful completion of "set" command cache file will be deleted. # esxcli qlfc qcc port hbaparams set -i Note: This command is not supported for NPIV Virtual Port. The is one of the port Ids displayed in the "list" command. 5.1.1.19 To Restore Default values of HBA Parameters of a specific port in the flash: # esxcli qlfc qcc port hbaparams restoreDefaults -i Note: This command is not supported for NPIV Virtual Port. This command also clears Boot Config settings. The is one of the port Ids displayed in the "list" command. 5.1.1.20 To save HBA Parameters of a specific port in the user provided file: This command saves HBA Parameters data from flash to user provided file. # esxcli qlfc qcc port hbaparams save -i -f Note: 1. This command is not supported for NPIV Virtual Port. 2. If filename is provided without absolute path, then file is saved in "/var/log/vmware" folder. The is one of the port Ids displayed in the "list" command. 5.1.1.21 To view Forward-Error-Correction (FEC) info of a specific port: # esxcli qlfc qcc port fec get -i Notes: 1. This command is not supported for NPIV Virtual Port. 2. FEC is enabled by default on MEZZ cards. 3. FEC is disabled on all cards when PortSpeed is < 16Gbps. 4. FEC is enabled on all cards when PortSpeed is >= 32Gbps. The is one of the port Ids displayed in the "list" command. 5.1.1.22 To set Forward-Error-Correction (FEC) info of a specific port: # esxcli qlfc qcc port fec set -i -f -r Notes: 1. This command is not supported for NPIV Virtual Port. 2. FEC is read-only for MEZZ cards. 3. FEC is read-only for all cards when PortSpeed is < 16Gbps. 4. FEC is read-only for all cards when PortSpeed is >= 32Gbps. The is one of the port Ids displayed in the "list" command. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Parameter | Value | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Port-Identifier | One of the Port Id from port list command (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | FEC-Status | FEC Status (Optional) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Reset | Reset FEC Counters (Optional) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - String values are case-sensitive. 5.1.1.23 To view Buffer-to-Buffer Credits (BBCR) info of a specific port: # esxcli qlfc qcc port bbcr get -i Note: This command is not supported for NPIV Virtual Port. The is one of the port Ids displayed in the "list" command. 5.1.1.24 To set Buffer-to-Buffer Credits (BBCR) info of a specific port in local cache file: This command sets user provided data in temporary cache file. This cache file will be used by "set" command to save settings in flash. # esxcli qlfc qcc port bbcr setFile -i -b -c Note: This command is not supported for NPIV Virtual Port. The is one of the port Ids displayed in the "list" command. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Parameter | Value | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Port-Identifier | One of the Port Id from port list command (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | BBCR-Status | BBCR Status (Optional) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | BBCR-Configured | BBCR Configured value (Optional) <0 - 15> | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - String values are case-sensitive. 5.1.1.25 To set Buffer-to-Buffer Credits (BBCR) info of a specific port in the flash: # esxcli qlfc qcc port bbcr set -i Note: This command is not supported for NPIV Virtual Port. The is one of the port Ids displayed in the "list" command. 5.1.1.26 To view Boot Configuration info of a specific port: # esxcli qlfc qcc port bootconfig get -i -b Notes: 1. This command is not supported for NPIV Virtual Port. 2. If Boot-Mode is not specified, BIOS Boot-Mode is selected. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Parameter | Value | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Port-Identifier | One of the Port Id from port list command (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Boot-Mode | Boot Mode to display BIOS/UEFI parameters (Optional) | | | | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 5.1.1.27 To set Boot Configuration info of a specific port in local cache file: This command sets user provided data in temporary cache file. This cache file will be used by "set" command to save settings in flash. Based on Boot-Mode (BIOS or UEFI) different command options are supported. For BIOS Boot Mode # esxcli qlfc qcc port bootconfig setFile -i -b -d -a -f -j -k -l -m For UEFI Boot Mode # esxcli qlfc qcc port bootconfig setFile -i -b -a -e -c -g -f -j -k -l -m -n -o -p -q Notes: 1. This command is not supported for NPIV Virtual Port. 2. If Boot-Mode is not specified, BIOS Boot-Mode is selected. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Parameter | Value | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Port-Identifier | One of the Port Id from port list command (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Boot-Mode | Boot Mode to configure BIOS/UEFI parameters (Optional) | | | | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Enable-BFS | Enable Boot-From-SAN config (Optional) | | | Displayed as Adapter BIOS in BIOS Boot-Mode | | | Displayed as Adapter Driver in UEFI Boot-Mode | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Selectable-Boot | Enable Boot From Selected Device (Optional) | | | Applicable only in BIOS Boot-Mode | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Fabric-Assigned-Boot-LUN | Enable Fabric Assigned Boot LUN (Optional) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Selective-Login | Enable Selective Login (Optional) | | | Applicable only in UEFI Boot-Mode | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Selective-LUN-Login | Enable Selective LUN Login (Optional) | | | Applicable only in UEFI Boot-Mode | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | World-Login | Enable World Login (Optional) | | | Applicable only in UEFI Boot-Mode | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Drive-0 | Boot Target 0 and LUN (Optional) | | | ":" separated Target WWPN and "-" separated LUN | | | e.g.: "20:01:00:00:0e:14:45:2f-5" | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Drive-1 | Boot Target 1 and LUN (Optional) | | | ":" separated Target WWPN and "-" separated LUN | | | e.g.: "20:01:00:00:0e:14:45:2f-4" | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Drive-2 | Boot Target 2 and LUN (Optional) | | | ":" separated Target WWPN and "-" separated LUN | | | e.g.: "20:01:00:00:0e:14:45:2f-3" | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Drive-3 | Boot Target 3 and LUN (Optional) | | | ":" separated Target WWPN and "-" separated LUN | | | e.g.: "20:01:00:00:0e:14:45:2f-2" | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Drive-4 | Boot Target 4 and LUN (Optional) | | | ":" separated Target WWPN and "-" separated LUN | | | e.g.: "20:01:00:00:0e:14:45:2f-9" | | | Applicable only in UEFI Boot-Mode | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Drive-5 | Boot Target 5 and LUN (Optional) | | | ":" separated Target WWPN and "-" separated LUN | | | e.g.: "20:01:00:00:0e:14:45:2f-8" | | | Applicable only in UEFI Boot-Mode | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Drive-6 | Boot Target 6 and LUN (Optional) | | | ":" separated Target WWPN and "-" separated LUN | | | e.g.: "20:01:00:00:0e:14:45:2f-7" | | | Applicable only in UEFI Boot-Mode | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Drive-7 | Boot Target 7 and LUN (Optional) | | | ":" separated Target WWPN and "-" separated LUN | | | e.g.: "20:01:00:00:0e:14:45:2f-6" | | | Applicable only in UEFI Boot-Mode | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - String values are case-sensitive. 5.1.1.28 To set Boot Configuration info of a specific port in the flash: # esxcli qlfc qcc port bootconfig set -i Note: 1. This command is not supported for NPIV Virtual Port. 2. Enable Host HBA BIOS in HBA Params must be set for Boot From SAN. 3. Alternate-Boot-Target-2 and Alternate-Boot-Target-3 boot are not supported for Dell branded adapters. The is one of the port Ids displayed in the "list" command. 5.1.1.29 To view Boot Configuration info of a specific port: # esxcli qlfc qcc port bootconfigext get -i -b Notes: 1. This command is not supported for NPIV Virtual Port. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Parameter | Value | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Port-Identifier | One of the Port Id from port list command (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Boot-Mode | Boot Mode to display BIOS/UEFI/NVME parameters (required) | | | | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 5.1.1.30 To set Boot Configuration info of a specific port in local cache file: This command sets user provided data in temporary cache file. This cache file will be used by "set" command to save settings in flash. Based on Boot-Mode (BIOS or UEFI) different command options are supported. For BIOS Boot Mode # esxcli qlfc qcc port bootconfigext setFile -i -b -d -a -f -n -p -o For UEFI Boot Mode # esxcli qlfc qcc port bootconfigext setFile -i -b -a -e -c -g -f -n -p -o For NVME Boot Mode # esxcli qlfc qcc port bootconfigext setFile -i -b -a -e -c -g -f -m -n -p -o -l Notes: 1. This command is not supported for NPIV Virtual Port. 2. For BIOS/UEFI boot mode, Boot Target Num, Target WWPN and Disk Num are required together. 2. For NVME boot mode, Boot Target Num, Target WWPN, Disk Num and Target Enable are required together. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Parameter | Value | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Port-Identifier | One of the Port Id from port list command (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Boot-Mode | Boot Mode to configure BIOS/UEFI parameters (required) | | | | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Enable-BFS | Enable Boot-From-SAN config (Optional) | | | Displayed as Adapter BIOS in BIOS Boot-Mode | | | Displayed as Adapter Driver in UEFI/NVME Boot-Mode | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Selectable-Boot | Enable Boot From Selected Device (Optional) | | | Applicable only in BIOS Boot-Mode | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Fabric-Assigned-Boot-LUN | Enable Fabric Assigned Boot LUN (Optional) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Selective-Login | Enable Selective Login (Optional) | | | Applicable only in UEFI/NVME Boot-Mode | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Selective-LUN-Login | Enable Selective LUN Login (Optional) | | | Applicable only in UEFI/NVME Boot-Mode | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | World-Login | Enable World Login (Optional) | | | Applicable only in UEFI/NVME Boot-Mode | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | FC-NVMe | Enable FC NVMe (Optional) | | | Applicable only in NVME Boot-Mode | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Boot-Target-Number | Boot Target Number (Optional) <0 - 7> | | | <0 - 3> in BIOS boot mode | | | <0 - 7> in UEFI/NVME boot mode | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Boot-Target-WWPN | Boot Target WWPN (Optional) | | | ":" separated Target WWPN | | | e.g.: "20:01:00:00:0e:14:45:2f" | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Boot-Disk-Num | Boot Disk (LUN/NamespaceID) Number (Optional) <0 - 65535> | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Boot-Target-Enable | Boot Target Enable (Optional) | | | Applicable only in NVME Boot-Mode | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - String values are case-sensitive. 5.1.1.31 To set Boot Configuration info of a specific port in the flash: # esxcli qlfc qcc port bootconfigext set -i Note: 1. This command is not supported for NPIV Virtual Port. 2. Enable Host HBA BIOS in HBA Params must be set for Boot From SAN. 3. Alternate-Boot-Target-2 and Alternate-Boot-Target-3 boot are not supported for Dell branded adapters. The is one of the port Ids displayed in the "list" command. 5.1.1.32 To get Firmware Dump info of a specific port in a binary file: # esxcli qlfc qcc port fwdump get -i -f Note: This command is not supported for NPIV Virtual Port. The is one of the port Ids displayed in the "list" command. 5.1.1.33 To get Beacon info of a specific port: # esxcli qlfc qcc port beacon get -i Note: This command is not supported for NPIV Virtual Port. The is one of the port Ids displayed in the "list" command. 5.1.1.34 To set Beacon info of a specific port: # esxcli qlfc qcc port beacon set -i -b Note: This command is not supported for NPIV Virtual Port. The is one of the port Ids displayed in the "list" command. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Parameter | Value | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Port-Identifier | One of the Port Id from port list command (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Beacon-State | Beacon state to be set (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - String values are case-sensitive. 5.1.1.35 To view Universal SAN Congestion Mitigation (USCM) Statistics of a specific port: # esxcli qlfc qcc port scmstats get -i The is one of the port Ids displayed in the "list" command. 5.1.1.36 To clear Universal SAN Congestion Mitigation (USCM) Statistics of all the targets connected to a specific port: # esxcli qlfc qcc port scmstats clear -i The is one of the port Ids displayed in the "list" command. 5.1.1.37 To check Universal SAN Congestion Mitigation (USCM) Status of a specific port: # esxcli qlfc qcc port scmchk get -i The is one of the port Ids displayed in the "list" command. 5.1.1.38 To check Universal SAN Congestion Mitigation (USCM) Profile of a specific port: # esxcli qlfc qcc port scmprofile get -i The is one of the port Ids displayed in the "list" command. Note: This command is not supported for NPIV Virtual Port. 5.1.1.39 To set Universal SAN Congestion Mitigation (USCM) Profile of a specific port: # esxcli qlfc qcc port scmprofile set -i -r or # esxcli qlfc qcc port scmprofile set -i -a Note: This command is not supported for NPIV Virtual Port. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Parameter | Value | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Port-Identifier | One of the Port Id from port list command (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Restore | Restores Congestion Profile default driver setting (optional) | | | | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Activation | Congestion Profile Activation value (optional) | | | | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - String values are case-sensitive. Restore and Activation options are mutually exclusive. 5.1.1.40 To get Diagnostics Port (DPort) Status of a specific port: # esxcli qlfc qcc port dportdiag get -i Note: This command is not supported for NPIV Virtual Port. The is one of the port Ids displayed in the "list" command. 5.1.1.41 To set Diagnostics Port (DPort) Status of a specific port: # esxcli qlfc qcc port dportdiag set -i -m Note: This command is not supported for NPIV Virtual Port. The is one of the port Ids displayed in the "list" command. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Parameter | Value | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Port-Identifier | One of the Port Id from port list command (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | DPort-Mode | DPort Mode to be set (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 5.1.1.42 To run Diagnostics Port (DPort) test on a specific port: # esxcli qlfc qcc port dportdiag run -i Note: This command is not supported for NPIV Virtual Port. The is one of the port Ids displayed in the "list" command. 5.1.1.43 To run CT Diagnostics test on a specific port: # esxcli qlfc qcc port ctdiag run -i -p -n -e -t Note: This command is not supported for NPIV Virtual Port. The is one of the port Ids displayed in the "list" command. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Parameter | Value | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Port-Identifier | One of the Port Id from port list command (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Test-Type | CTDiag Test Type (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Number-of-Tests | Number of tests (required) <1 - 65535> | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Stop-On-Error | Stop on error flag (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Target | Target WWPN to send CT Diag command (required) | | | ":" separated Target WWPN | | | e.g.: "20:01:00:00:0e:14:45:2f" | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 5.1.1.44 To run FC Ping Diagnostics test on a specific port: # esxcli qlfc qcc port fcping run -i -n -e -t Note: This command is not supported for NPIV Virtual Port. The is one of the port Ids displayed in the "list" command. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Parameter | Value | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Port-Identifier | One of the Port Id from port list command (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Number-of-Tests | Number of tests (required) <1 - 65535> | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Stop-On-Error | Stop on error flag (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Target | Target WWPN to send FC Ping command (required) | | | ":" separated Target WWPN | | | e.g.: "20:01:00:00:0e:14:45:2f" | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 5.1.1.45 To run FC Echo ELS Diagnostics test on a specific port: # esxcli qlfc qcc port fcecho run -i -n -e -t Note: This command is not supported for NPIV Virtual Port. The is one of the port Ids displayed in the "list" command. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Parameter | Value | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Port-Identifier | One of the Port Id from port list command (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Number-of-Tests | Number of tests (required) <1 - 65535> | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Stop-On-Error | Stop on error flag (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Target | Target WWPN to send FC Ping command (required) | | | ":" separated Target WWPN | | | e.g.: "20:01:00:00:0e:14:45:2f" | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 5.1.1.46 To Read Diagnostics Parameter (RDP) test on a specific port: # esxcli qlfc qcc port rdp get -i Note: This command is not supported for NPIV Virtual Port. The is one of the port Ids displayed in the "list" command. 5.1.1.47 To run Loopback test on a specific port: # esxcli qlfc qcc port loopback run -i -p -z -n -e -t -l -d Note: This command is not supported for NPIV Virtual Port. The is one of the port Ids displayed in the "list" command. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Parameter | Value | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Port-Identifier | One of the Port Id from port list command (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Data-Pattern-Type | Loopback Data Pattern Type (required) | | | | | | <01011010, 10100101, 10101010, 11111111, Custom> | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Data-Size | Data Size (required) | | | <8, 16, 32, 64, 128, 256, 512, 1024, 2048> | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Number-of-Tests | Number of tests (required) <1 - 65535> | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Stop-On-Error | Stop on error flag (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Test-Increment | Test Increment (required) <1 - 65535> | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Loopback-Type | Loopback Test Type (required) | | | | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Data-Pattern | Data pattern for Custom type (Optional) | | | e.g.: "2-1-0-0-E-4-5-F" | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 5.1.1.48 To run Read/Write Buffer test on a specific port: # esxcli qlfc qcc port rwbuffer run -i -p -z -n -e -t -d Note: This command is not supported for NPIV Virtual Port. The is one of the port Ids displayed in the "list" command. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Parameter | Value | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Port-Identifier | One of the Port Id from port list command (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Data-Pattern-Type | Loopback Data Pattern Type (required) | | | | | | <01011010, 10100101, 10101010, 11111111, Custom> | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Data-Size | Data Size (required) <8, 16, 32, 64, 128> | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Number-of-Tests | Number of tests (required) <1 - 10000> | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Stop-On-Error | Stop on error flag (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Test-Increment | Test Increment (required) <1 - 10000> | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Data-Pattern | Data pattern for Custom type (Optional) | | | e.g.: "2-1-0-0-E-4-5-F" | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 5.1.1.49 To view the list of FC Targets detected through QLogic Ports: # esxcli qlfc qcc target list The Target-Id will be in the form of "FC__Target_". For example, "FC_21:00:00:24:ff:7d:3c:47_Target_51:00:00:42:3c:ab:67:5d". Use this Target-Id for all other commands requiring a Target-Id. 5.1.1.50 To view information regarding a specific target: # esxcli qlfc qcc target info get -i The is one of the Target-Ids displayed in the "list" command. 5.1.1.51 To view SAN Congestion Management (SCM) Statistics of a specific target: # esxcli qlfc qcc target scmstats get -i The is one of the Target-Ids displayed in the "list" command. 5.1.1.52 To check SAN Congestion Management (SCM) Status of a specific target: # esxcli qlfc qcc target scmchk get -i The is one of the Target-Ids displayed in the "list" command. 5.1.1.53 To view iiDMA speed of a specific target: # esxcli qlfc qcc target iidma get -i The is one of the Target-Ids displayed in the "list" command. 5.1.1.54 To set iiDMA speed of a specific target: # esxcli qlfc qcc target iidma set -i -s - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Parameter | Value | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Target-Id | One of the Target Id from target list command (required) | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | Link-Speed | Speed to set (required) | | | <1_Gbps, 2_Gbps, 4_Gbps, 8_Gbps, 16_Gbps, > | | | <32_Gbps, 64_Gbps> See Note 1 below | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Note: 1. The Link Speed values are upto max speed supported for the adapter port. The maximum speed value is displyed in Port Info command. e.g: If maximum speed value is "32 Gbps", then Link Speed values supported are "1_Gbps, 2_Gbps, 4_Gbps, 8_Gbps, 16_Gbps, 32_Gbps". 5.1.1.55 To view FC link statistics of a specific target: # esxcli qlfc qcc target stats get -i The is one of the Target-Ids displayed in the "list" command. 5.1.1.56 To view the list of FC LUNs detected through QLogic Ports: # esxcli qlfc qcc lun list The LUN-Id will be in the form of For FCP Targets: "FC__Target__LUN_". For example, "FC_21:00:00:24:ff:7d:3c:47_Target_51:00:00:42:3c:ab:67:5d_LUN_11". For NVMe Targets: "FC__Target__NSID_". For example, "FC_21:00:00:24:ff:7d:3c:47_Target_51:00:00:42:3c:ab:67:5d_NSID_11". Use this LUN-Id for all other commands requiring a LUN-Id. 5.1.1.57 To view information regarding a specific LUN: # esxcli qlfc qcc lun info get -i The is one of the LUN-Ids displayed in the "list" command. 5.1.2 Operating the ESXCLI plug-in remotely To operate the ESXCLI plug-in remotely, the vSphere Command Line Interface (CLI) from VMware must be installed on your local workstation. The local workstation must also be able to connect to the ESXi host. Once the vSphere CLI software is installed on the local workstation, esxcli commands may be executed through this software. The commands to view and configure the QLogic adapters are the same as the commands listed in section 5.2.1 with the exception that login information will be required to execute the command. For example, to view the list of QLogic adapters: # \esxcli -s -u -p qlfc qcc adapter list The is the path to the directory where the vSphere CLI was installed. The is the IP address of the ESXi host. The is the user name to use to log in to the ESXi host. The is the password to use to log in to the ESXi host. On Windows, for example, the command would look like: C:\> "C:\Program Files (x86)\VMware\VMware vSphere CLI\bin\esxcli" -s 192.168.1.27 -u root -p password qlfc qcc adapter list To update the firmware on an adapter remotely requires some additional steps in order to upload the firmware file to the ESXi host. Step 1: Find the name of the datastore to store the firmware file C:\> "C:\Program Files (x86)\VMware\VMware vSphere CLI\bin\esxcli" -s 192.168.1.27 -u root -p password storage vmfs extent list Step 2: Create a temporary directory to store the fimrware file using the "Volume Name" found in Step 1. C:\> "C:\Program Files (x86)\VMware\VMware vSphere CLI\bin\vifs.pl" --server 192.168.1.27 --username root --password password --mkdir "[datastore1 (3)] tmp" This will create a directory called "tmp" on the datastore "datastore1 (3)". Step 3: Upload the file to the ESXi host C:\> "C:\Program Files (x86)\VMware\VMware vSphere CLI\bin\vifs.pl" --server 192.168.1.27 --username root --password password --put "[datastore1 (3)] tmp/" This will upload the firmware file named on the ESXi host in the directory "tmp". Step 4: Execute the update command C:\> "C:\Program Files (x86)\VMware\VMware vSphere CLI\bin\esxcli" -s 192.168.1.27 -u root -p password qlfc qcc adapter update -i -f This will execute the firmware update command on the named adapter () using the file specified by the . The must be the file name specified following the following format: /vmfs/volumes/// The is the VMFS UUID that is listed in the table shown in Step 1 for the datastore that was used to store the firmware file. The is the directory that was created in Step 2 on the datastore. The is the name of the firmware file specified in Step 3. 5.2 Enabling/Disabling Debug in FC ESXCLI plug-in 5.2.1 Enabling Debug in FC ESXCLI plug-in 1. Enable ESXCLI-Plugin debugging # export QLFC_DEBUG_LEVEL=65535 2. Restart hostd # /etc/init.d/hostd restart 3. Run FC ESXCLI Plugin command # esxcli qlfc qcc adapter list # esxcli qlfc qcc adapter update -i -f Logs will get generated in following files: * /var/tmp/qfcesxcli.log * /var/tmp/quapi-output.log * /var/tmp/quapi.log 5.2.2 Disabling Debug in FC ESXCLI plug-in 1. Disable ESXCLI-Plugin debugging export QLFC_DEBUG_LEVEL=0 2. Restart hostd # /etc/init.d/hostd restart 5.3 Removing the FC ESXCLI plug-in To remove the FC ESXCLI plug-in, use esxcli command. 1. To view VIB list: # esxcli software vib list OR # esxcli software component list 2. To remove the ESXCLI plug-in: # esxcli software vib remove --vibname mrvlfcesxcliplugin --maintenance-mode -f OR # esxcli software component remove -n MRVL-QLogic-FC-Esxcli-Plugin 5.4 Hardware Requirements This section defines the minimum hardware requirements. FC ESXCLI plug-in ------------------------------ The FC ESXCLI plug-in 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.5/6.0 platform. Refer to the latest online "VMware Compatibility Guide" for your OS on the VMware Web site: http://www.vmware.com * About 5MB disk space 5.5 Software Requirements This section defines the minimum software requirements. FC ESXCLI plug-in ------------------------------ The FC ESXCLI plug-in requires the following minimum software: * Administrative privileges to perform management functions * One of the operating systems identified in the "3. OS Support" section. * (Optional) VMware vSphere CLI (Command Line Interface) for remote operation 5.6 Known Issues * For ISP28xx series 64 Gbps adapters when port is set to 16 Gbps speed with Virtual Lane feature enabled and connected to Brocade switch or when PLOGI timeouts are seen, port is not seen in port list command output. * CT FC Trace Route command failure is seen when garbage value of paths is provided by switch. 6. Contacting Support Please feel free to contact Marvell QLogic Support at https://www.marvell.com/support.html for further assistance. For more information, please refer to "Marvell ESXCLI plug-in for VMware vSphere" UserGuide document available on www.marvell.com. Some features in the doc on marvell.com may or may not apply to the OEM SW release, please refer to the vCenter Plugin UG for the set of supported features for the respective OEM SW release. (c) Copyright 2016-2023. All rights reserved worldwide. QLogic, the QLogic logo, and the Powered by QLogic logo are registered trademarks of Marvell Semiconductor Inc. All other brand and product names are trademarks or registered trademarks of their respective owners.