Chapter 2: Installing and Uninstalling the Emulex HBA Manager Application Components
This chapter describes installing and uninstalling the Emulex HBA Manager application.
2.1 Installing the Emulex HBA Manager Application
This section describes how to install the application in Windows, Linux, and VMware operating systems.
The Emulex HBA Manager application can be installed two ways:
n An attended installation using the GUI.
n An unattended installation using the command line.
2.1.1.1 Attended Installation in Windows
To use the attended installation method in Windows, perform the following steps:
1. Download the Emulex HBA Manager application enterprise kit installation file from the Support Documents and Downloads area of www.broadcom.com.
2. Navigate to the directory to which you downloaded the file.
3. Double-click the elxocm-windows-x64-<version>.exe file. The Emulex HBA Manager Enterprise window appears. Click Next. The Installation Options window appears.
4. Select the components that you want to install and click Install. After installing the Emulex HBA Manager application files, the Emulex HBA Manager Management Mode dialog appears (Figure 1).
Figure 1: Emulex HBA Manager Management Mode Dialog
The Emulex HBA Manager Management Mode dialog enables you to select Secure Management to assign the desired user privileges, or you can choose one of the other management modes. See Section 4.2, Using Emulex HBA Manager Application Secure Management, or Section 4.3, Changing Management and Read-Only Mode, for more information. Choose the management type that you want.
5. Select or clear the Enable TCP/IP Management check box to enable or disable remote management over TCP/IP. You can also change the TCP/IP port used (23333 is the IANA registered port for Broadcom).
6. Click OK. The Installation Completed window appears when the installation is finished.
7. Click Finish. A shortcut is added to the Start menu. You do not need to reboot the system.
2.1.1.2 Unattended Installation in Windows
To use the unattended installation method in Windows, perform the following steps:
1. Download the Emulex HBA Manager application enterprise kit installation file to your system from the Support Documents and Downloads area of www.broadcom.com.
2. Activate the kit with the /q or /q2 switch.
– The /q switch displays progress reports.
– The /q2 switch does not display progress reports.
3. You can enable Secure Management mode, or you can select a management mode:
Enable Secure Management mode by adding the sec=1 argument, or disable it by adding the sec=0 argument. If the sec argument is not entered, Secure Management mode is disabled by default. See Section 4.2, Using Emulex HBA Manager Application Secure Management, for more information.
To enable Secure Management mode, type the following command at the command prompt:
elxocm-windows-x64-<version>.exe sec=1 /q2
To disable Secure Management mode, type the following command at the command prompt:
elxocm-windows-x64-<version>.exe sec=0 /q2
The following are management mode defaults for an unattended installation:
– mmode = 2 (Local Management Plus mode)
– achange = 1(Allow the management mode to change)
NOTE: If you enable Secure Management mode and select another management mode, a conflicting parameters error occurs.
Select a management mode by adding the mmode argument, and select the ability to change that management mode by adding the achange parameter with selected values as in the following example. See Section 4.3, Changing Management and Read-Only Mode, for more information.
For example, type the following command at the command prompt:
elxocm-windows-x64-<version>.exe mmode=3 achange=1 /q2
The following are the possible mmode values:
1 – Local Only Management mode
2 – Local Management Plus mode
4 – Local Management Plus mode and read only
5 – Full Management mode and read only
The following are the possible achange values:
0 – Do not allow the management mode to change.
1 – Allow the management mode to change.
You can also set the following optional parameters:
– MHost – This optional switch allows a non-management-host user to select a management host with which to register. If this switch is not specified, the default value of 0 is used, and the capability is disabled. If the switch is specified, the value can be a host name or an IP address that is validated by the installer. An error message appears if /mmode is set as Local Only or Management Host.
– mExcl – This optional switch allows a non-management-host user to select whether the Emulex HBA Manager application processes requests exclusively from the Management Host specified by the MHost parameter. This option is accepted only if accompanied by a valid MHost value; otherwise, an error message appears. If this switch is not specified, the default value of 0 is used. If the parameter is specified, the following are valid values:
l 0 – Remotely managed by other hosts.
l 1 – Remotely managed by the management host only.
– Mtcp – This optional parameter allows you to enable or disable remote management and to specify the TCP/IP port over which management occurs. If this parameter is not specified, the default TCP/IP port number 23333 is used.
If the management host option is selected, you must either select the default port number or enter a valid TCP/IP port number on the command line. A value of 0 is not accepted.
If one of the nonmanagement host options is selected, you can enter the TCP/IP port number on the command line.
You must install the appropriate driver version for your operating system before you can install the Emulex HBA Manager application. Go to the Support Documents and Downloads area at www.broadcom.com for the latest drivers.
Previous versions of the Linux driver must be uninstalled. You must run the uninstall script that shipped with the version of the Linux driver that you want to remove.
NOTE: SELinux (Security Enhanced Linux) must be enabled after installing the Emulex HBA Manager application; otherwise, the installed files will have incorrect SELinux context settings.
NOTE: To ensure that the Emulex HBA Manager application installation files have the correct context settings, perform the following steps:
1. Install the Emulex HBA Manager application.
Broadcom releases binary HBA Manager files for Linux in RPM format that are digitally signed using the GnuPG standard. This allows certification of the contents of the RPM files and verification that the contents have not been modified since they were created. The RPMs have been digitally signed by Broadcom with a GnuPG private key that is held only by Broadcom. Instructions for creating the GnuPG public key file are located at:
https://docs.broadcom.com/docs/1334566
NOTE: The public key is not required for installation, but installing the application without it might result in a NOKEY warning message.
2.1.2.1 Attended Installation in Linux
To install the Emulex HBA Manager application or to update an existing installation, perform the following steps:
2. Download the utilities from the Support Documents and Downloads area of www.broadcom.com.
3. Copy the Emulex HBA Manager application elxocm-<platform>-<version>.tgz file to a directory on the installation machine.
4. Change to the directory to which you copied the tar file.
– For RHEL 7.x and RHEL 8.x, type the following command:
tar zxvf elxocm-rhel7-rhel8-<version>-<rel>.tgz
– For SLES 12 SPx and SLES 15 SPx, type the following command:
tar zxvf elxocm-sles12-sles15-<version>-<rel>.tgz
6. Change to the elxocm directory used in Step 3.
– For RHEL 7.x and RHEL 8.x, type the following command:
cd elxocm-rhel7-rhel8-<version>-<rel>
– For SLES 12 SPx and SLES 15 SPx, type the following command:
cd elxocm-sles12-sles15-<version>-<rel>
NOTE: Prior to installation, you must configure the Emulex HBA Manager application groups on the LDAP network or the local host machine for Secure Management operation. See Section 4.2.1, Configuration Requirements for Emulex HBA Manager Application Secure Management, for configuration instructions.
7. Run the install script. Type the following command:
8. When prompted, choose whether to enable Secure Management for OneCommand.
Do you want to enable Secure Management feature for OneCommand? (s/u)
Enter 's' to select secure management. (LDAP/NIS OCM group configuration required)
Enter 'u' to run without secure management (default).
If you select Secure Management by entering s, proceed to Step 11. You cannot choose a management mode as described in Step 9.
9. When prompted, enter the type of management mode that you want to use.
Enter the type of management you want to use:
1 Local Mode : HBA's on this Platform can be managed by OneCommand clients on this Platform Only.
2 Managed Mode: HBA's on this Platform can be managed by local or remote OneCommand clients.
3 Remote Mode : Same as '2' plus OneCommand clients on this Platform can manage local and remote HBA's.
4 Management Host : Same as '1' plus OneCommand clients on this Platform can manage remote HBA's.
5 Strictly Local Management with Daemons Disabled : Only manage the adapters on this host. Management of adapters on this host from other hosts is not allowed. Emulex HBA Manager daemons are disabled, which limits some application features.
NOTE: If you enabled Secure Management in Step 8, you cannot configure a management mode.
– If you select option 2, you are asked if you want to enable TCP/IP management from remote hosts.
– If you select option 3, you are asked if you want to enable TCP/IP management of remote hosts and enable TCP/IP management from remote hosts. You are prompted to enter the TCP/IP port number to use. (Leaving the field blank defaults to 23333.)
– If you select option 2 or 3, you are prompted for the management host address. (Leaving the field blanks means none.)
– You can enter an IP address or host name. If you enter a management host address, you are prompted to exclude management of this host from any other host.
– If you select option 4, management of remote hosts is automatically selected, and you are prompted to enter the TCP/IP port number to use. (Leaving the field blank defaults to 23333.)
– If you select option 5, you are not prompted to enter anything.
NOTE: Management hosts cannot be managed by remote hosts.
10. If you answered 2, 3, or 4 in Step 9, you must decide whether you want the Emulex HBA Manager application to operate in read-only mode. Read-only mode prevents users from performing some operations, such as resetting adapters, updating an adapter's firmware, or changing adapter driver properties and bindings. It affects only the local Emulex HBA Manager application interface. These operations can still be performed using remote management. Enter either y for yes to allow users to perform these operations or n for no if read-only mode is desired.
ATTENTION: The Emulex HBA Manager application cannot retrieve data from an offline adapter or port and will display incorrect information for that adapter or port. Adapters and ports must be online for the application to display accurate information.
If you answered 5 in Step 9, the following conditions apply:
– The elxhbamgrd daemon is disabled from starting during boot.
Normally, the daemon determines whether a firmware dump is available on each adapter during the boot process and automatically captures all available dumps. In addition, an Emulex driver for Linux can signal the daemon to capture a firmware dump (driver-initiated dump).
If the daemon is disabled, a new systemd unit (ehm-auto-dump.service) is enabled and is used to capture automatic firmware dumps during boot. However, driver-initiated dumps cannot be performed.
– The elxdiscoveryd daemon, which is required by the Emulex HBA Manager GUI to discover adapters, is started when the GUI is started. However, the GUI prevents the discovery settings from being changed.
NOTE: If you have root privileges, you can reenable the daemons using the systemctl command.
11. You are prompted whether to allow users to change the management mode after installation. Enter either y for yes or n for no.
2.1.2.2 Unattended Installation in Linux
For unattended or silent installation of the Emulex HBA Manager application for Linux, installation settings are defined using the installation script command line.
NOTE: Prior to installation, the Emulex HBA Manager application groups must be configured on the LDAP network or the local host machine for Secure Management operation. See Section 4.2.1, Configuration Requirements for Emulex HBA Manager Application Secure Management, for configuration instructions.
To view the options for unattended installation, type the following command:
To perform an unattended, silent installation, type the following command:
NOTE: The default management mode for unattended installation is Local Management Plus.
2.1.2.3 Updating an Installation in Linux
The Emulex HBA Manager application supports the following update paths:
n You can update from an earlier core kit to a later enterprise kit.
n You can update from an earlier enterprise kit to a later enterprise kit.
See Section 2.1.2.1, Attended Installation in Linux, or Section 2.1.2.2, Unattended Installation in Linux, for instructions.
2.1.3 In VMware
For VMware hosts, you can manage adapters using the Emulex HBA Manager application on Windows, but you must install and use the appropriate Emulex CIM Provider.
NOTE: The Emulex CIM Provider is not supported on ESXi 7.0 U3 and later operating systems. Refer to the Emulex CIM Provider Package Installation Guide, release 14.0, for more information.
The Emulex CIM Provider is available as an offline bundle in ESXi platforms. Use the offline bundle to update software on VMware platforms. For more information about the ESXi patch management activities, refer to the VMware website.
For the best real-time management of Emulex adapters in VMware ESXi environments, use the Emulex HBA Manager application for VMware vCenter. For more information, refer to the Emulex HBA Manager Application for VMware vCenter User Guide.
To install the Emulex CIM Provider in a VMware ESXi hypervisor environment, use the esxcli command line utility and perform these steps:
1. Copy the CIM Provider zip file to the /var/log/vmware directory.
2. Log on to the VMware hypervisor host, and execute one of the following commands:
esxcli software vib install -d vmware-esx-provider-emulex-cim-provider-<version>.zip
esxcli software component apply -d Broadcom-ELX-CIMProvider_<kit_version>-OEM.700.<component_version>-signed_component-<vmware_version>.zip
2.2 Uninstalling the Emulex HBA Manager Application
To uninstall the Emulex HBA Manager application, perform the following steps:
a. Select Start > Control Panel > Programs > Uninstall a Program.
b. Select Emulex OCManager Enterprise <version>, and click either Remove or Uninstall.
b. Change to the elxocm-<platform>-<version> installation directory.
c. Type the following command:
a. Type the following command: