Equallogic Multipathing Extension Module: Installation and User Guide
Equallogic Multipathing Extension Module: Installation and User Guide
Equallogic Multipathing Extension Module: Installation and User Guide
Copyright 2010 Dell, Inc. All rights reserved. EqualLogic is a registered trademark of Dell, Inc. Dell is a trademark of Dell, Inc. All trademarks and registered trademarks mentioned herein are the property of their respective owners. Information in this document is subject to change without notice. Reproduction in any manner whatsoever without written permission is strictly forbidden. July 2010
Table of Contents
Chapter 1 Overview of the EqualLogic Multipathing Extension Module ....................................................... 1-1 EqualLogic MEM Configuration Model .......................................................................................................... 1-1 Chapter 2 Installing the EqualLogic Multipathing Extension Module............................................................ 2-1 Prerequisites...................................................................................................................................................... 2-1 Obtaining the EqualLogic Multipathing Extension Module............................................................................. 2-1 Using the EqualLogic Plugin with HBAs......................................................................................................... 2-1 Unsupported VMware Environments ............................................................................................................... 2-2 Installation Considerations................................................................................................................................ 2-2 Software iSCSI Configuration Requirements................................................................................................... 2-2 Installing Or Upgrading the EqualLogic MEM On Your VMware ESX Or ESXi Server............................... 2-3 Installation Procedure with vCenter Update Manager...................................................................................... 2-3 Installation Procedure with setup.pl.................................................................................................................. 2-4 Tasks Performed During the Installation Process............................................................................................. 2-5 Verifying the Installation .................................................................................................................................. 2-5 Configuring Your Network for the EqualLogic MEM Plugin.......................................................................... 2-6 Chapter 3 Configuring the EqualLogic Multipathing Extension Module ....................................................... 3-1 Setting Configuration Values............................................................................................................................ 3-1 Viewing Configuration Values .................................................................................................................. 3-1 EHCM Configuration File ................................................................................................................................ 3-2 Diagnostics........................................................................................................................................................ 3-2 Chapter 4 Known Issues and Limitations........................................................................................................... 4-1 Failure On One Physical Network Port Can Prevent iSCSI Session Rebalancing ........................................... 4-1 Installation Not Possible From VM Running on the ESX Server .................................................................... 4-1 iSCSI HBA Limitations .................................................................................................................................... 4-1
iii
Preface
This manual describes how to install, configure, and use the EqualLogic Multipathing Extension Module for VMware vSphere (hereafter referred to as the EqualLogic MEM). The EqualLogic MEM enables you to use enhanced multipathing on supported VMware environments connected to PS Series groups.
Audience
Dell intends this manual for administrators responsible for managing VMware vSphere environments attached to a PS Series group. It is expected that you understand: Administration of PS Series groups VMware ESX administration
Organization
The organization of this guide is as follows: Chapter 1, Overview of the EqualLogic Multipathing Extension Module Describes the functions of the EqualLogic MEM. Chapter 2, Installing the EqualLogic Multipathing Extension Module Describes the installation procedures, including prerequisites, configuring the VMware ESX environment, installing the kit, and verifying the installation. Chapter 3, Configuring the EqualLogic Multipathing Extension Module Describes configuration tasks. Chapter 4, Known Issues and Limitations Describes known issues and limitations for this release. Appendix A, Sample Configuration Commands Shows examples of the setup.pl script.
Conventions
Documentation conventions are shown in the following table.
Convention fixed width group_ip_address Convention Command, parameter, output, file name, link, button, field, URL address, or e-mail address. Variable. Replace the text in italics with the actual object name or identifier.
PS Series Software
Firmware Installed on each array, PS Series firmware software allows you to manage your storage environment and provides capabilities such as volume snapshots, cloning, and replication to ensure data hosted on the arrays is protected in the event of an error or disaster.
Preface Group Manager GUI: Provides a graphical user interface for managing a group. Group Manager CLI: Provides a command line interface for managing a group.
Manual Transfer Utility (MTU) Runs on Windows and Linux systems and enables you to use physical media to securely transfer large amounts of data to a replication partner, facilitating replication and preventing network congestion.
SAN HeadQuarters (SANHQ): Provides centralized monitoring, historical performance trending, and event reporting for multiple PS Series groups.
Current Customers Please Note: You may not be running the latest versions of the tools and software listed above. If you are under a valid warranty or support agreement for your PS Series array, you are entitled to obtain the latest updates and new releases as they become available.
vi
Preface
Related Documentation
For detailed information about PS Series arrays, groups, volumes, array software, and host software, see the following documentation:
To configure the EqualLogic MEM, you must also use VMware commands and procedures. See the VMware vSphere 4.x documentation at:
http://www.vmware.com/support/pubs
Contacting Dell
Dell provides several online and telephone-based support and service options. Availability varies by country and product, and some services might not be available in your area. For customers in the United States, call 800-945-3355. Note: If you do not have access to an Internet connection, contact information is printed on your invoice, packing slip, bill, or Dell product catalog.
vii
Preface Use the following procedure to contact Dell for sales, technical support, or customer service issues: 1. Visit support.dell.com or the Dell support URL specified in information provided with the Dell product. 2. Select your locale. Use the locale menu or click on the link that specifies your country or region. 3. Select the required service. Click the "Contact Us" link, or select the Dell support service from the list of services provided. 4. Choose your preferred method of contacting Dell support, such as e-mail or telephone.
Online Services
You can learn about Dell products and services using the following procedure: 1. Visit www.dell.com (or the URL specified in any Dell product information). 2. Use the locale menu or click on the link that specifies your country or region.
viii
The PSP provides load balancing capabilities that enable you to maximize I/O throughput. The PSP uses its knowledge of the distributed nature of volumes on the PS Series group to route each I/O packet on the optimal path to the volume. EHCM simplifies management by creating the appropriate number of sessions to an EqualLogic volume. The number of paths created by EHCM depends on the topology of your SAN and the MPIO settings on the VMware ESX server. Every volume is distributed across one or more members in the PS Series group. The portion of a volume that is located on a single member is referred to as a volume slice. The default EHCM behavior is to create two sessions per volume slice, with a maximum of six sessions per volume. However, you can alter this behavior (see EHCM Configuration File). When you use the EqualLogic MEM, EHCM distributes iSCSI sessions across all configured adapters and PS Series group Ethernet ports. EHCM does not establish entirely redundant paths (iSCSI sessions that have identical server and array endpoints). Therefore, in configurations that have limited numbers of VMware ESX and array Ethernet ports, the actual number of sessions created may be less than you specify for the configuration. EHCM monitors the topology of the SAN. If you change the configuration by modifying the number of Ethernet interfaces, or by moving a PS Series volume, or if there is a network outage that affects some of the iSCSI sessions, EHCM automatically reconfigures the iSCSI sessions.
1-1
Table 1-1 describes the components shown in this figure. Table 1-1: EqualLogic MEM Logical Path Configuration Details
Callout
1 2 3 4 5 6 7 8 9 10 11
Description
VMware virtual machines with guest operating system Virtual machine disk format (VMDK) Raw device mapping (RDM) disk VMware file system (VMFS) CIM provider, which hosts EqualLogic Host Connection Management. EqualLogic Routed PSP VMware native multipathing, hosting the PSP driver VMkernel, the ESX hypervisor, including network and storage stacks Host Bus Adapter (HBA) or software initiator Network PS Series group members
1-2
Prerequisites
Table 2-1 lists the minimum revisions of software and firmware required for supporting the installation of the EqualLogic MEM. Table 2-1: Minimum Software and Firmware Revisions
Product PS Series firmware VMware ESX or ESXi vSphere Client vSphere vMA or CLI Revision Version 4.0.7 or later. Check the Dell technical support website for the latest firmware updates. Version 4.1 Enterprise Version 4.1 Version 4.1
not be unzipped, as the installation tools expect it in .zip format. This bundle can be installed through vCenter Update Manager or from a vMA with the provided setup.pl script.
2-1
Note: If using the EqualLogic MEM with an iSCSI HBA that does not support iSCSI session management, there are no other configuration requirements. You can proceed to Installing Or Upgrading the EqualLogic MEM On Your VMware ESX Or ESXi Server. You can use the Broadcom iSCSI offload initiator in conjunction with the VMware software initiator. However, the two initiators must not be sharing physical NICs or VMkernel ports. Each dependent HBA may have different scaling limits and may have different MTU support for jumbo frames. See the latest VMware Compatibility Guide or check with your hardware vendor for details for specific devices. Chapter 4 lists limitations for HBAs known at the time of publication. As the total number of iSCSI sessions approaches the adapter limit, the EHCM will reduce the number of sessions it creates to each iSCSI target in order to distribute the available sessions equitably. The EHCM will reserve a limited number of iSCSI sessions for discovering and logging in to new iSCSI targets. If the number of new iSCSI targets presented to the ESX server exceeds the number of reserved sessions, an additional rescan will need to be performed for the iSCSI initiator to discover and connect to all the new targets.
Installation Considerations
Installation of the EqualLogic MEM requires you to put the ESX server in maintenance mode using VMware management tools. You must reboot the VMware ESX host after installation or uninstallation for the changes to take effect. Notes: Installation and configuration through the setup.pl script requires connecting directly to the ESX server. For ESXi servers this requires you to disable lockdown mode. Because installation requires putting the ESX server in maintenance mode, it is not possible to perform the installation from a vCenter Server, vCenter Update Manager, or VMware Management Assistant that is running as a VM on the ESX server. The VMs must first be migrated to another ESX server so they can continue running during the installation.
Unlike the initial ESX 4.0 release, with ESX 4.1, you no longer need to create multiple VMkernel ports for each physical NIC uplink. The networking should now be configured with a single VMkernel port for each physical NIC uplink. Table 2-2: Software iSCSI Configuration Requirements
Task 1 2 Action Create a vSwitch Enable jumbo frames Description Create a vSwitch to use for iSCSI traffic. Assign physical NICs that will be used for iSCSI traffic to this vSwitch. If you intend to use jumbo frames, you must enable them for each vSwitch and each VMkernel port (virtual network interface that is used by the VMkernel) interface. You must use the command line to create a VMkernel port with jumbo frames enabled. You can verify that jumbo frames are enabled on the vSwitch and VMkernel ports by using the commands esxcfg-vswitch -l and esxcfg-vmknic -l. Before enabling Jumbo Frames, check with your hardware vendors to ensure your physical network adapter and other network equipment support Jumbo Frames. For MPIO, the iSCSI daemon uses the VMkernel ports. You can have ports on multiple vSwitches, but each port must be mapped to a single uplink. Create VMkernel ports for the iSCSI daemon to use. You should create one VMkernel port per physical NIC that will be used for iSCSI multipathing. If you have multiple VMkernel ports sharing the same uplink, only one of them will be used by EHCM, and the excess VMkernel ports will be ignored. You can use NIC teaming, but each VMkernel port must be mapped to a single uplink (physical NIC). You can verify this by using the command esxcfg -vswitch -l, and you can remove extra uplinks with the esxcfg-vswitch -N command. Enable VMware iSCSI Initiator. You must add the PS Series group address to the iSCSI Initiator discovery list. You must bind the VMkernel ports to the iSCSI daemon with the esxcli swisci nic add command. It is necessary to rescan for storage devices after you bind VMkernel ports to the iSCSI daemon.
3 4
6 7
The configuration of software iSCSI has changed significantly from VMware ESX 3.5 to ESX 4.0. Be sure that you are familiar with the differences. See the Setting Up Software iSCSI Initiators section in the iSCSI SAN Configuration Guide. The VMware vSphere ESX 4.1 documentation is available at this website: http://www.vmware.com/support/pubs Note: See the PS Series documentation for group limits on total iSCSI sessions. It may be necessary to reduce the number of sessions created per volume in large configuration.
Installing Or Upgrading the EqualLogic MEM On Your VMware ESX Or ESXi Server
Note: You are required to put the VMware ESX server in maintenance mode when installing, removing, or upgrading the EqualLogic MEM. vCenter Update Manager automatically puts the ESX server in maintenance mode as part of the installation process.
documentation on setup.pl in Chapter 3, Configuring the EqualLogic Multipathing Extension Module. For instructions on uninstallation, see Removing the EqualLogic Plugin Installation. For instructions on installing and configuring vCenter Update Manager see the VMware vCenter Update Manager Administration Guide. Once Update Manager is configured, you must load the EqualLogic MEM offline bundle into the patch repository by selecting the "Import Patches" option and browsing to the dell-eql-mem-<version>.zip file. After uploading the offline bundle into the patch repository, you can then use the normal Update Manager process to scan and apply it to the desired ESX servers. Update Manager puts the ESX server into maintenance mode and reboot it as part of the installation process.
Query the Installed EqualLogic Plugin Use the following syntax to query the EqualLogic MEM plugin:
setup.pl --query --server="hostname" [--username=username] [--password=password]
2-4
Installing EqualLogic Plugin Use the following syntax to install the EqualLogic MEM plugin:
setup.pl --install --server="hostname" [--username=username] [--password=password] [--bundle=bundle]
The --bundle parameter specifies the path to the offline bundle file containing multipathing plugin (dell-eqlmem-<version>.zip). If not specified, the script will default to the offline bundle in the same directory as the setup.pl script. Removing the EqualLogic Plugin Installation Use the following syntax to remove the EqualLogic MEM plugin:
setup.pl --remove --server="hostname" [--username=username] [--password=password]
Enabling the EqualLogic Plugin Enabling the plugin sets the PSP as the active PSP for all existing EqualLogic disk devices, and sets it as the default PSP for all new EqualLogic disk devices. Use the following syntax to enable the EqualLogic MEM plugin:
setup.pl --enable --server="hostname" [--username=username] [--password=password]
The plugin is automatically enabled when it is installed. Disabling the EqualLogic Plugin Disabling the plugin sets the VMW_PSP_FIXED as the active PSP for all existing EqualLogic disk devices, and sets it as the default PSP for all new EqualLogic disk devices. Use the following syntax to disable the EqualLogic MEM plugin:
setup.pl --disable --server="hostname" [--username=username] [--password=password]
2-5
For example:
$ ./setup.pl --server=10.127.88.180 --query Found Dell EqualLogic multipathing package installed: DELL-eql-mem-1.0.0.111844 Default PSP for EqualLogic devices is DELL_PSP_EQL_ROUTED No supported iSCSI adapters found.
Table 2-4 describes the configuration parameters. Table 2-4: Parameters for Configuration
Parameter --nics --ips --vswitch --mtu --vmkernel --netmask --enableswiscsi --nohwiscsi Description Comma separated list of vmnics to use for multipathing. Default none
Comma separated list of IP addresses to assign to VMkernel ports used none for multipathing. Name of vSwitch to create. Will use existing vSwitch if one is found. MTU to use for VMkernel ports and vSwitch used for multipathing. Prefix to use for VMkernel ports created for multipathing. Subnet mask used for VMkernel ports created for multipathing. Enable the VMware software iSCSI initiator if not already enabled. Ignore any supported hardware adapters, and use only the VMware software iSCSI initiator. If the configuration script detects both software and hardware initiators, it will use the hardware initiator by default unless this flag is set. vSwitchISCSI 1500 iSCSI 255.255.255.0 not set not set
Sets the specified IP address as a Send Targets discovery address for all none iSCSI initiators that were used to bind vmknics. Use a vNetwork Distributed Switch instead of a standard vSwitch. Specify a file to use ro record a log of network configuration actions. not set setup.log
Note: The --configure operation can be run in an interactive mode by specifying only the server name parameter. The script then interactively asks the user a series of questions to gather the necessary information for network configuration. For example:
setup.pl --configure --server=10.127.129.160
2-6
volumesessions
12
membersessions
When determining how many sessions to create to a volume, EHCM chooses a value that meets all constraints specified by the totalsessions, volumesessions and membersessions values. See the PS Series documentation for group limits on total iSCSI sessions. It may be necessary to reduce the number of sessions created per volume in large configurations.
For example:
$ setup.pl --setparam --name=totalsessions --value=256 --server=10.127.88.180 Setting parameter totalsessions = 256 Parameter Name Value Max Min Description -------------- ----- --------------reconfig 240 600 60 Period in seconds between iSCSI session reconfigurations. upload 120 600 60 Period in seconds between routing table upload. totalsessions 256 1024 64 Max number of sessions per host. volumesessions 6 12 3 Max number of sessions per volume. membersessions 2 4 1 Max number of sessions per member per volume.
3-1
For example:
$ setup.pl --listparam --server=10.127.88.180 Parameter Name Value Max Min Description -------------- ----- --------------reconfig 240 600 60 Period in seconds between iSCSI session reconfigurations. upload 120 600 60 Period in seconds between routing table upload. totalsessions 512 1024 64 Max number of sessions per host. volumesessions 6 12 3 Max number of sessions per volume. membersessions 2 4 1 Max number of sessions per member per volume.
Diagnostics
The EqualLogic MEM component generates debug logging at run time. The log file locations are shown in Table 3-2. Table 3-2: Log Files
Log File Name /var/log/ehcmd.log /var/log/vmkernel.log /var/log/messages Description Contains EHCMD log messages for ESX and ESXi Includes PSP log messages (ESX) Includes PSP log messages (ESXi)
To produce a dump of the details of the current MPIO configuration to a file, use the following command from the ESX CLI service console:
/usr/sbin/ehcmcli -d -o <filename>
3-2
Failure On One Physical Network Port Can Prevent iSCSI Session Rebalancing
In some cases, a network failure on a single physical NIC can affect kernel traffic on other NICs. This occurs if the physical NIC with the network failure is the only uplink for the VMKernel port that is used as the default route for the subnet. This affects several types of kernel network traffic, including ICMP pings which the EqualLogic MEM uses to test for connectivity on the SAN. The result is that the iSCSI session management functionality in the plugin will fail to rebuild the iSCSI sessions to respond to failures of SAN changes.
For the latest capabilities, see the VMware Compatibility Guide. It is available at:
http://www.vmware.com/support/pubs
4-1
Appendix A
This appendix provides examples of using the setup.pl script to configure networking for multipathing.
Example 1: Configuring a 4-Port Nic Using the VMware Software iSCSI Initiator
$./setup.pl --server=10.127.129.130 --configure --ips=10.127.129.131,10.127.129.132,10.127.129.133,10.127.129.134 --nics=vmnic2,vmnic3,vmnic4,vmnic5 --enableswiscsi Configuring networking for iSCSI multipathing: vSwitch = vSwitchISCSI mtu = 1500 nics = vmnic2 vmnic3 vmnic4 vmnic5 ips = 10.127.129.131 10.127.129.132 10.127.129.133 10.127.129.134 netmask = 255.255.255.0 vmkernel = iSCSI enableswiscsi = 1 Creating vSwitch vSwitchISCSI. Setting vSwitch MTU to 1500. Creating portgroup iSCSI0 on vSwitch vSwitchISCSI. Assigning IP address 10.127.129.131 to iSCSI0. Creating portgroup iSCSI1 on vSwitch vSwitchISCSI. Assigning IP address 10.127.129.132 to iSCSI1. Creating portgroup iSCSI2 on vSwitch vSwitchISCSI. Assigning IP address 10.127.129.133 to iSCSI2. Creating portgroup iSCSI3 on vSwitch vSwitchISCSI. Assigning IP address 10.127.129.134 to iSCSI3. Creating new bridge. Adding uplink vmnic2 to vSwitchISCSI. Adding uplink vmnic3 to vSwitchISCSI. Adding uplink vmnic4 to vSwitchISCSI. Adding uplink vmnic5 to vSwitchISCSI. Setting new uplinks for vSwitchISCSI. Setting uplink for iSCSI0 to vmnic2. Setting uplink for iSCSI1 to vmnic3. Setting uplink for iSCSI2 to vmnic4. Setting uplink for iSCSI3 to vmnic5. Enabling SW initiator. Enabled SW initiator. Bound vmk0 to vmhba35. Bound vmk1 to vmhba35. Bound vmk3 to vmhba35. Bound vmk4 to vmhba35. Configuration finished.
Resulting configuration:
$ esxcfg-vswitch -l --server 10.127.129.130 --username root --password <secret> Switch Name Num Ports Used Ports Configured Ports MTU Uplinks vSwitch0 128 3 128 1500 vmnic0 PortGroup Name VM Network Service Console Switch Name vSwitchISCSI Num Ports 128 VLAN ID 0 0 Used Ports 9 VLAN ID 0 0 0 0 Used Ports 0 1 Uplinks vmnic0 vmnic0 MTU 1500 Uplinks vmnic2,vmnic3,vmnic4,vmnic5
Configured Ports 128 Used Ports 1 1 1 1 Uplinks vmnic5 vmnic4 vmnic3 vmnic2
A-1
Resulting configuration:
$ esxcfg-vswitch -l --server 10.127.129.160 --username root --password <secret> Switch Name Num Ports Used Ports Configured Ports MTU Uplinks vSwitch0 128 3 128 1500 vmnic0 PortGroup Name VM Network Service Console Switch Name vSwitchISCSI Num Ports 128 VLAN ID 0 0 Used Ports 5 VLAN ID 0 0 Used Ports 0 1 Uplinks vmnic0 vmnic0 MTU 1500 Uplinks vmnic4,vmnic5
A-2
Index
B
Broadcom iSCS limitations 4-1
M
Multipathing Extension Module 1-1
C
configuration file 3-2 configuring the EqualLogic MEM 3-1
N
NIC teaming 2-3
P
Pluggable Storage Architecture 1-1 PSP 1-1
E
EHCM 1-1 ehcmd 3-2 EqualLogic Host Connection Manager 1-1
U
uplinks 2-3
I
installation EqualLogic MEM 2-3 tasks performed 2-5 iSCSI sessions 3-1
V
VMkernel 2-3 VMkernel port 2-3 binding 2-3 VMware ESX configuration 2-2 VMware iSCSI Initiator 2-3 vSwitch 2-3
J
jumbo frames 2-3, 4-1
K
known issues 4-1
Index-1