Emulex® CIM Provider Package for LightPulse®
Adapters
Installation Guide
Versions 11.2
May 26, 2017
CIMPP-LPe-IG112-100-31CS
Broadcom, the pulse logo, Connecting everything, Avago Technologies, Avago, the A logo, Emulex, LightPulse, and
OneCommand are among the trademarks of Broadcom and/or its affiliates in the United States, certain other
countries and/or the EU.
Copyright © 2011–2017 Broadcom. All Rights Reserved.
The term "Broadcom" refers to Broadcom Limited and/or its subsidiaries. For more information, please visit
www.broadcom.com.
Broadcom reserves the right to make changes without further notice to any products or data herein to improve
reliability, function, or design.
Information furnished by Broadcom is believed to be accurate and reliable. However, Broadcom does not assume any
liability arising out of the application or use of this information, nor the application or use of any product or circuit
described herein, neither does it convey any license under its patent rights nor the rights of others.
Corporate Headquarters Website
San Jose, CA www.broadcom.com
Emulex CIM Provider Package for LightPulse Adapters Installation Guide
May 26, 2017
Emulex CIM Provider Package for LightPulse Adapters Installation Guide
May 26, 2017
Table of Contents
Broadcom
- 3 -
Table of Contents
Chapter 1: Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.1 Supported Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.2 Supported CIM Provider Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.3 Abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Chapter 2: Installing the Emulex CIM Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.1 In Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.2 In Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.3 In VMware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.3.1 Installing the Offline-bundle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.4 Manually Installing the Emulex CIM Provider with a Lenovo System X Platform Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.4.1 In Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.5 Additional Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.5.1 In VMware ESXi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.5.2 In Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Chapter 3: Using Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3.1 Updating Firmware on Emulex Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3.2 Enabling Logs and Collecting Symptoms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3.3 Generating Provider Logs if Listing Them Fails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3.4 Running Diagnostic Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Chapter 4: Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Broadcom
- 4 -
Emulex CIM Provider Package for LightPulse Adapters Installation Guide
May 26, 2017
Chapter 1: Introduction
Supported Platforms
Chapter 1: Introduction
The Emulex® Common Information Model (CIM) Provider enables comprehensive management of Emulex host bus
adapters (HBAs). It uses an industry-standard application programming interface (API) Common Manageability
Programming Interface (CMPI v2.0) to manage various Emulex adapters.
The CIM provider supports basic inventory and active management of the following LightPulse® Fibre Channel (FC)
adapters:
LPe12000-series adapters
LPe16000-series adapters
LPe31000-series adapters
LPe32000-series adapters
During installation, the Emulex CIM Provider registers with a Web-based Enterprise Management (WBEM) server
running a CIMOM (CIM Object Manager) service. The CIM Provider performs the following functions:
Internally communicates with the Emulex management API.
Internally communicates with the Emulex drivers.
Handles inquiries and requests from various CIM clients.
1.1 Supported Platforms
The following table shows the platforms supported with the Emulex CIM Provider Kits.
Table 1 Emulex CIM Provider Supported Platforms
Operating Systems Emulex CIM Provider Kits
VMware ESXi 6.5 VMW-ESX-6.5.0-emulex-cim-provider-<kit version>-offline_bundle-<vmware_version>.zip
VMware ESXi 6.0 VMW-ESX-6.0.0-emulex-cim-provider-<kit version>-offline_bundle-<vmware_version>.zip
VMware ESXi 5.5 VMW-ESX-5.5.0-emulex-cim-provider-<kit version>-offline_bundle-<vmware_version>.zip
SLES11 emulex_fc_provider_ibm-<kit version>-sles11.i586.rpm
emulex_fc_provider_ibm-<kit version>-sles11.x86_64.rpm
SLES12 emulex_fc_provider_ibm-<kit version>-sles12.i586.rpm
emulex_fc_provider_ibm-<kit version>-sles12.x86_64.rpm
RHEL 7 64-bit KVM emulex_fc_provider_pegasus-<version>-rhel7.x86_64.rpm
NOTE Pegasus rpms are released for RHEL7 64-bit KVM.
RHEL 7 emulex_fc_provider_ibm-<kit version>-rhel7.i686.rpm
emulex_fc_provider_ibm-<kit version>-rhel7.0.x86_64.rpm
RHEL 6 64-bit KVM emulex_fc_provider_pegasus-<kit version>-rhel6.x86_64.rpm
NOTE Pegasus rpms are released for RHEL6 64-bit KVM.
RHEL 6 emulex_fc_provider_ibm-<kit version>-rhel6.i686.rpm
emulex_fc_provider_ibm-<kit version>-rhel6.x86_64.rpm
Windows
Lenovo Provider compatible
emulex_fc_provider_<kit version>.msi
emulex_fc_provider_x64_<version>.msi
Broadcom
- 5 -
Emulex CIM Provider Package for LightPulse Adapters Installation Guide
May 26, 2017
Chapter 1: Introduction
Supported CIM Provider Profiles
1.2 Supported CIM Provider Profiles
Access Points – SNIA SMI-S 1.5 Part 2 Clause 23
Host Discovered Resources – SNIA SMI-S 1.5 Part 6 Clause 7
Indication Profile (partial) – DMTF DSP1054
PCI Device – DMTF DSP1075
Physical Assets Profile – DMTF DSP1011
Physical Package – SNIA SMI-S 1.5 Part 2 Clause 31
Profile Registration – DMTF DSP1033
Record Log – DMTF DSP1010
Software Inventory – DMTF DSP1023
Software Update – DMTF DSP1025
Storage HBA – SNIA SMI-S 1.5 Part 6 Clause 6
FC HBA – SNIA SMI-S 1.5 Part 6 Clause 5
FC HBA Diagnostic profile – DMTF DSP1104
FC Initiator Ports Profile – SNIA SMI-S 1.5 Part 2 Clause 17
1.3 Abbreviations
API Application Programming Interface
CIM Common Information Model
CIMOM CIM Object Manager
CMPI Common Manageability Programming Interface
DMTF
Distributed Management Task Force
FC Fibre Channel
HBA host bus adapter
HTTP Hypertext Transfer Protocol
HTTPS
Hypertext Transfer Protocol over SSL
IP Internet Protocol
KVM kernel-based virtual machine
LAN local area network
PCI
Peripheral Component Interconnect
SFCB Small Footprint CIM Broker
SMI
Storage Management Initiative
SNIA Storage Networking Industry Association
URI Uniform Resource Identifiers
VIB vSphere Installation Bundle
WBEM Web-based Enterprise Management
Broadcom
- 6 -
Emulex CIM Provider Package for LightPulse Adapters Installation Guide
May 26, 2017
Chapter 2: Installing the Emulex CIM Provider
In Linux
Chapter 2: Installing the Emulex CIM Provider
The following must be installed before you can install the Emulex CIM Provider.
One of the following adapters:
— LPe12000-series adapter
— LPe16000-series adapter
— LPe31000-series adapter
— LPe32000-series adapter
The appropriate adapter drivers
NOTE Adapters on an ESXi host running Emulex CIM providers can be
managed by a Windows server using the following applications
(installed on Windows operating systems):
The Emulex OneCommand® Manager application for Windows
The Emulex OneCommand Manager application for VMware
vCenter
Refer to the download page on the Broadcom website at http://www.broadcom.com, or to the vendor website to
verify the driver version or the OneCommand Manager application version that must be installed on your system.
2.1 In Linux
Use the standard RPM install commands.
For example:
rpm -ivh <emulex_fc_provider_ibm-11.2.x.x-rhel7.i686.rpm>
2.2 In Windows
Run the installation msi package which installs the Emulex CIM Provider Kit.
2.3 In VMware
Use one of the standard esxcli commands to install the offline-bundle or the VIB.
2.3.1 Installing the Offline-bundle
To install the signed offline bundle, type:
esxcli software vib install -d <offline-bundle.zip> --maintenance-mode
To install the VIB, type:
esxcli software vib install -v <provider.vib> --maintenance-mode
To install an unzipped file, type:
esxcli software vib install --viburl=<file:/vmware-esx-provider-emulex.vib>
--maintenance-mode
Broadcom
- 7 -
Emulex CIM Provider Package for LightPulse Adapters Installation Guide
May 26, 2017
Chapter 2: Installing the Emulex CIM Provider
Manually Installing the Emulex CIM Provider with a Lenovo System X Platform Agent
2.4 Manually Installing the Emulex CIM Provider with a Lenovo System X Platform
Agent
2.4.1 In Linux
To manually install the Emulex CIM Provider, perform these steps:
1. Extract the Emulex CIM Provider RPM.
2. Place the libraries/binaries in the directory as required by the Open Pegasus CIMOM.
This path is configurable and depends on the customization performed in the CIMOM.
For example:
— In tog-pegasus CIMOM, the path is /usr/lib/Pegasus/providers/
— In the development build of Open Pegasus, the path is $PEGASUS_HOME/bin
Refer to the CIMOM release notes for the exact path.
In Linux, the extracted libraries/binaries are:
libelxhba_cmpi_provider.so/libemulex_fc_provider.so
3. Ensure that there is no ldd dependency for the extracted libraries/binaries.
4. Compile the extracted mof files. Ensure that the $PEGASUS_HOME variable is set in the shell and the
$PEGASUS_HOME/bin is included in the system path ($PATH) variable. Execute the following commands from
the same shell:
cimmofl -aEV -n root/emulex elxhba_schema.mof
This command compiles the Emulex CIM Provider schema file:
cimmofl -aEV -n root/pg_interop elxhba_interop_schema.mof
This command compiles the Emulex CIM Provider schema file for SLP registration:
cimmofl -aEV -n root/pg_interop elxhba_reg.mof
This command compiles the Emulex CIM Provider registration file.
5. Restart the CIMOM.
6. Check the installation using the following command:
cimprovider -ls
The status of elxhba_cmpi_provider_Module/emulex_ucna_provider_Module must be OK.
Broadcom
- 8 -
Emulex CIM Provider Package for LightPulse Adapters Installation Guide
May 26, 2017
Chapter 2: Installing the Emulex CIM Provider
Additional Information
2.5 Additional Information
To repair a faulty CIM Provider installation, contact Broadcom Technical Support with the following additional
information:
2.5.1 In VMware ESXi
Output from the following commands:
esxcfg-scsidevs -a
esxcli software vib list | grep -i elx
esxcli software vib list | grep -i lpfc
esxcli software vib list | grep -i emu
2.5.2 In Linux
1. Output of the following command:
/usr/sbin/ocmanager/hbacmd listhbas
2. Restart the CIMOM and then list the ELXHBA_SoftwareIdentity class in the root/emulex namespace.
For example:
wbemcli -nl -noverify ein 'https://root:<password>@<IP
address>/root/emulex:ELXHBA_SoftwareIdentity'
3. Provide the system logs /var/log/messages for Linux or /var/log/syslog.log for ESXi for the
operation performed in step 2.
4. Output from the following commands:
rpm -qa| grep -i elx
rpm -qa| grep -i lpfc
lspci
Broadcom
- 9 -
Emulex CIM Provider Package for LightPulse Adapters Installation Guide
May 26, 2017
Chapter 3: Using Adapters
Updating Firmware on Emulex Adapters
Chapter 3: Using Adapters
This section describes updating firmware, enabling logs, and using diagnostics.
3.1 Updating Firmware on Emulex Adapters
NOTE If a secure version of firmware (version 11.0 or later) is installed on a
LPe31000-series or LPe32000-series adapter and you want to revert to
an earlier unsecure version of firmware, you must remove the secure
firmware jumper block before performing the update. See the
installation guide for the adapter for additional information.
The Software Update profile is supported on the Emulex FC HBA CIM Provider. You must use this profile to update the
firmware on the Emulex adapters. The following methods are implemented in the Emulex-specific Software Update
profile:
InstallfromByteStream – Requires a custom CIM client, which can read the firmware file and create a ByteStream
that is used for updating the firmware.
InstallfromURI – Supports two different types of URI (Uniform Resource Identifiers).
— The firmware file to be upgraded is available locally on the machine hosting the Emulex adapter.
— The firmware file to be upgraded is available on a remote machine such as an http or an https server. In this
case, the Emulex CIM Provider uses the libcurl library available on the host machine, where the CIM
Provider is running, to download the firmware file.
The Emulex CIM_SoftwareInstallationServiceCapabilities class has the attribute
SupportedURISchemes that indicates the supported URI schemes.
To update the firmware, perform these steps:
1. List the CIM_SoftwareInstallationService in the Emulex namespace. Select the
ELXHBA_SoftwareInstallationService class instance.
wbemcli -noverify ein
'https://root:<password>@<IP>/root/emulex:elxhba_softwareinstallationservic
e' -nl
2. List the CIM_FCPort. Select the desired port from the listed instances.
For example:
wbemcli -noverify ein
'https://root:<password>@<IP>/root/emulex:elxhba_fcport' -nl
3. Select the correct firmware file and choose one of the methods detailed in steps 1and 2 to update the firmware.
For example:
wbemcli -nl -noverify cm
'https://root:<password>@<IP>/root/emulex:<elxhba_softwareinstallationservi
ce instance>' InstallFromURI.URI="<Firmware file
path>",Target=<elxhba_fcport instance>
Broadcom
- 10 -
Emulex CIM Provider Package for LightPulse Adapters Installation Guide
May 26, 2017
Chapter 3: Using Adapters
Enabling Logs and Collecting Symptoms
3.2 Enabling Logs and Collecting Symptoms
To enable logs, perform these steps:
1. List the specific instance of the CIM_RecordLog class. For example, list the ELXHBA_RecordLog instance.
2. Invoke the method SetLogParams with loglevel=5, logmode=2, and tracepath=tracefile path.
3. Invoke the method RequestStateChange with RequestedState=2.
Traces are collected in the file specified in the tracepath attribute in step 2.
Important checkpoints or critical errors are also logged in the /var/log/message file for Linux and the
var/log/syslog.log file for ESXi.
3.3 Generating Provider Logs if Listing Them Fails
To enable provider logs if enumeration fails, perform these steps:
1. Stop the CIMOM.
2. Create a .dmp file.
a. To create a provider log, create the emulex_fc_provider.dmp file in the /etc/cim/emulex
location.
3. Manually enter the following two lines (without spaces):
2,5,2
/tmp/providerlogs.txt
4. Start the CIMOM and list the Emulex classes in the root/emulex namespace.
5. Perform the operation that is not working as expected. The provider logs are available in
</tmp/providerlogs.txt> specified in step 2.
6. Contact Broadcom Technical Support with the provider logs and the system logs (/var/log/syslog.log).
NOTE Dead dump is not supported.
3.4 Running Diagnostic Tests
To run a diagnostic test, perform these steps:
1. Get the instance of the managed element (ELXHBA_PortController). For example:
wbemcli -noverify ein
‘https://root:<password>@<IP>/root/emulex:elxhba_portcontroller’ -nl
2. Get the instance of the ELXHBA_FCHBADiagnostictest class. For example:
wbemcli -noverify ein
‘https://root:<password>@<IP>/root/emulex:elxhba_diagnostictest’ -nl
3. Invoke the method RunDiagnosticservice on the ELXHBA_FCHBADiagnostictest. For example:
wbemcli -noverify cm ‘https://root:<password>@<IP>/root/emulex:<Diagnostic
Test instance from step 2>’
RunDiagnosticservice.ManagedElement=<ManagedElement instance from step 1>’
Broadcom
- 11 -
Emulex CIM Provider Package for LightPulse Adapters Installation Guide
May 26, 2017
Chapter 3: Using Adapters
Running Diagnostic Tests
A CIM_ConcreteJob instance is created for each diagnostic test run. For example:
wbemcli -noverify ein
‘https://root:<password>@<IP>/root/emulex:elxhba_concretejob’ -nl
Results of the diagnostic test runs are available in the attributes RecordData and JobState in
ELXHBA_DiagnosticCompletionRecord class instances. For example:
wbemcli -noverify ei
‘https://root:<password>@<IP>/root/emulex:elxhba_diagnosticcompletionrecord
’ -nl
The diagnostic logs can be cleared using the ClearLog function of ELXHBA_DiagnosticsLog class. For
example:
wbemcli -noverify cm
‘https://root:<password>@<IP>/root/emulex:<Corresponding Diagnostic log
instance>’ ClearLog
Broadcom
- 12 -
Emulex CIM Provider Package for LightPulse Adapters Installation Guide
May 26, 2017
Chapter 4: Troubleshooting
Chapter 4: Troubleshooting
The following error message may appear if the CIM hosts are not properly added to the OneCommand Manager
application:
Unknown or invalid host specified
There could be instances when the drivers, the CIM Provider, and the CIM Client on a Windows machine are all
properly installed, but the CIM hosts are still not added to the OneCommand Manager application.
Table 2 shows the
most common reasons for this.
NOTE If you still experience problems when adding the host, run the
following commands on the ESXi host and send the output to
Broadcom Technical Support:
Svm-support dump
esxcfg-module -l
esxcfg-scsidevs -a
esxcfg-nics -l
lspci
esxcli software vib list | grep -i be2
esxcli software vib list | grep -i lpfc
esxcli software vib list | grep -i emu
esxcli software vib list | grep -i elxnet
Send the /var/log/syslog.log file for all of the above operations.
Table 2 Problems Adding a CIM Host
Situation Resolution
The machine with the specified IP is not
reachable.
Verify whether the machine is reachable from the CIM Client.
The specified protocol (HTTP or HTTPS) is not
supported by the CIMOM.
Most often the CIMOM is configured to use HTTPS. Therefore, if you are trying to
connect with HTTP, you might get an error. Try using HTTPS instead.
The namespace is invalid. Ensure that the namespace for the Emulex provider is root/emulex.
The username or password is invalid. Verify that the username is correct, and retype the password.
The CIMOM is not running on the ESXi host. You can check whether the CIMOM (SFCB) is running by typing one of these
commands.
/etc/init.d/sfcbd-watchdog status
Or
ps -ef | grep sfcb
If the CIMOM is listening to a port other than 5988 or 5989, the connection might
not take place. You can configure the SFCB CIMOM settings by editing
/etc/sfcb/sfcb.cfg.
The CIM Provider is running, but enumerations
are not occurring properly.
Ensure that the correct CIM Provider for the ESXi host is installed.
/