1–Product Overview
Installing the QLogic Adapter vCenter Plug-in for ESX/ESXi
Installing the QLogic Adapter vCenter Plug-in for
ESX/ESXi
This section on installing the QLogic Adapter vCenter Plug-in contains the following:
“Introduction” on page 1-11
“Requirements” on page 1-12
“Installing the QLogic Adapter CIM Provider” on page 1-13
“Starting the QLogic Adapter CIM Provider” on page 1-14
“Removing the QLogic Adapter CIM Provider” on page 1-15
“Starting the QLogic Adapter vCenter Plug-in” on page 1-16
“Removing the QLogic Adapter vCenter Plug-in” on page 1-16
“Installing the Flash Utility” on page 1-17
“Updating the Flash” on page 1-17
“Using the vCenter Plug-in on a Tomcat Server” on page 1-18
“Plug-in Unregistration from a Manual Installation” on page 1-21
“Launching the Plug-in from vSphere Client” on page 1-21
Introduction
The QLogic Adapter vCenter Plug-in is a user-interface extension to the vSphere™ Client that allows you to manage and configure QLogic adapters, including the NIC partitioning feature, on ESX and ESXi servers. When the you select an ESX or ESXi host that has QLogic adapters installed, the extension appears in the client as an additional tab named QLogic Adapter, as shown in
Figure 1-1
.
Figure 1-1. vSphere Client Showing QLogic Adapter Tab
SN0054671-00 D 1-11
1–Product Overview
Installing the QLogic Adapter vCenter Plug-in for ESX/ESXi
Requirements
The QLogic Adapter vCenter Plug-in requires the components in Figure 1-2
to be installed and running.
Figure 1-2. vCenter Plug-in Requirements
QLogic provides the following components that must be installed on the ESX or
ESXi Server, vCenter Server, and Tomcat Web Server.
ESX/ESXi Server
QLogic Adapter with firmware and driver
QLogic Adapter CIM Provider
vCenter Server
QLogic XML configuration file to register the plug-in to the vCenter Server
Tomcat Web Server
QLogic Web-based extension to the vSphere Client
1-12 SN0054671-00 D
1–Product Overview
Installing the QLogic Adapter vCenter Plug-in for ESX/ESXi
Installing the QLogic Adapter CIM Provider
The QLogic Adapter CIM Provider for VMware ESX was generated as a vSphere
Installation Bundle (VIB) file. A VIB contains the complete set of files and binaries required to install the provider on VMware ESX/ESXi. The offline-bundle.zip
file contains the VIB and the necessary metadata to install the provider on VMware ESX/ESXi.
This section provides the following installation procedures for the CIM Provider:
Initial Installation
Subsequent Update Installation
Initial Installation
To install the QLogic Adapter CIM Provider using the esxupdate command
(ESX systems only):
1.
Copy the offline-bundle.zip file into the root directory (/) of the ESX system.
2.
Issue the esxupdate command as follows:
# cd /
# esxupdate --bundle offline-bundle.zip --nodeps –nosigcheck
--maintenancemode update
To install the QLogic Adapter CIM Provider from a remote host using the vSphere CLI vihostupdate
command (ESXi systems only):
NOTE
To update the provider from a remote host using the vihostupdate command, make sure that the ESXi system is in maintenance mode. To put the ESXi host in maintenance mode using vSphere Client, select Inventory, select Host, and then select Enter Maintenance Mode.
1.
Copy the offline-bundle.zip file to any location on the host where either the vSphere CLI package is installed or the vSphere Management
Assistant (vMA) is hosted.
2.
Navigate to the location of the offline-bundle.zip file.
3.
Issue the vihostupdate command to install the offline bundle as follows:
# vihostupdate.pl <conn_options> --install --bundle offline-bundle.zip --nosigcheck
For available options, refer to the vihostupdate page.
SN0054671-00 D 1-13
1–Product Overview
Installing the QLogic Adapter vCenter Plug-in for ESX/ESXi
4.
Follow the on-screen instructions to complete the installation. You may need to reboot the ESXi system.
NOTE
For more details on vihostupdate, refer to the documents on the VMware vSphere Command-Line Interface Documentation page, located here: http://www.vmware.com/support/developer/vcli/ .
Subsequent Update Installation
To update the QLogic Adapter CIM Provider after a prior VIB installation:
1.
Follow the instructions in
“Removing the QLogic Adapter CIM Provider” on page 1-15
to remove the existing VIB.
2.
Follow the instructions in
“Initial Installation” on page 1-13 to install the
new VIB.
Starting the QLogic Adapter CIM Provider
After a system startup, the Small Footprint CIM Broker (SFCB) CIM object manager (CIMOM) in the ESX system should start automatically and load the
QLogic Adapter CIM Provider when necessary.
For ESX systems, you can also manually stop, start, or restart the SFCB CIMOM by issuing the following commands.
To stop the SFCB CIMOM and the QLogic Adapter CIM Provider:
# /etc/init.d/sfcbd-watchdog stop
To start the SFCB CIMOM and the QLogic Adapter CIM Provider:
# /etc/init.d/sfcbd-watchdog start
To restart the SFCB CIMOM and the QLogic Adapter CIM Provider:
# /etc/init.d/sfcbd-watchdog restart
After starting the SFCB CIMOM, use a CIM client utility to query the QLogic
Adapter CIM Provider for information.
1-14 SN0054671-00 D
1–Product Overview
Installing the QLogic Adapter vCenter Plug-in for ESX/ESXi
Removing the QLogic Adapter CIM Provider
To remove the QLogic Adapter CIM Provider, use either the esxupdate or vihostupdate
command.
To uninstall the QLogic Adapter CIM Provider using the esxupdate command:
1.
Query and find the existing VIB you are updating as follows:
# esxupdate query --vib-view | grep qlogic
For example, the VIB ID may have a format similar to the following:
ESX/ESXi 4.0: cross_qlogic-nic-provider_400.x.x.x-000000
ESX/ESXi 4.1: cross_qlogic-nic-provider_410.x.x.x-000000 where x.x.x is the version number of the existing provider.
2.
Remove the existing VIB as follows:
# esxupdate remove -b <vibID>
To uninstall from a remote host using the vihostupdate command:
NOTE
To uninstall the provider from a remote host using the vihostupdate command, make sure that the ESX/ESXi system is in maintenance mode.
To put the ESX/ESXi host in maintenance mode using vSphere Client, select
Inventory, select Host, and then select Enter Maintenance Mode.
1.
From a console on the host where the vSphere CLI package is installed or vMA is hosted, query to find the Bulletin ID of the existing provider:
# vihostupdate.pl <conn_options> --query\
For example, the Bulletin ID may have a format similar to the following:
ESX/ESXi 4.0: QLGC_NIC_PROVIDER-ESX-4.0.0-qlogic-nic-provider-x.x.x
ESX/ESXi 4.1: QLGC_NIC_PROVIDER-ESX-4.1.0-qlogic-nic-provider-x.x.x where x.x.x is the version number of the existing provider.
2.
Remove the existing VIB as follows:
# vihostupdate.pl <conn_options> --remove --bulletin
<bulletinID>
SN0054671-00 D 1-15
1–Product Overview
Installing the QLogic Adapter vCenter Plug-in for ESX/ESXi
NOTE
For more details on vihostupdate, refer to the documents on the
VMware vSphere Command-Line Interface Documentation page, located here: http://www.vmware.com/support/developer/vcli/
Starting the QLogic Adapter vCenter Plug-in
To start the QLogic Adapter vCenter Plug-in:
1.
Start the VMware vSphere Client and connect to the vCenter Server by entering the IP address or name, user name, and password.
2.
Click Login.
3.
If the Security Warning dialog box appears, click Ignore to use the current
SSL certificate.
If you start and connect the vSphere Client directly to an ESX/ESXi server, the vCenter plug-in does not open.
If you have not already done so, create a data center and add the ESX server.
4.
In the left pane, select the IP address of the VMware server.
5.
In the right pane, click the QLogic Adapter tab to view the Web page.
The vCenter plug-in retrieves the adapter information from the server.
NOTE
If the server does not have the QLogic Adapter CIM Provider and adapters installed, or if the vCenter Plug-in installation and registration was not successful, the QLogic Adapter tab is not shown.
Removing the QLogic Adapter vCenter Plug-in
To remove the QLogic Adapter vCenter Plug-in:
1.
In the Windows Control Panel, select Add or Remove Programs.
2.
In the Add or Remove Programs dialog box, select the QLogic Adapter
vCenter Plug-in, and then click Change/Remove.
3.
Follow the instructions in the QLogic Adapter vCenter Plug-in installer to remove the plug-in.
1-16 SN0054671-00 D
1–Product Overview
Installing the QLogic Adapter vCenter Plug-in for ESX/ESXi
Installing the Flash Utility
For ESX, before you perform a Flash update on QLogic Adapters using the
QLogic Adapter vCenter Plug-in, ensure that the QLflash utility is also installed on the ESX system.
To install the QLflash utility on ESX:
1.
Unzip the esx_qlflash.zip file, which contains the qlflash userworld executable.
2.
Copy the QLflash binary file to the /usr/lib/vmware/bin/ directory.
3.
Add executable permission for QLflash by issuing the following command:
# chmod +x qlflash
4.
If it does not already exist, edit and append the
/usr/lib/vmware/bin/qlflash
entry in the
/etc/vmware/UserWorldBinaries.txt file.
For ESXi, the QLflash utility is not required, so no additional steps are necessary.
Updating the Flash
NOTE
For ESX systems, before you perform a Flash update on a QLogic Adapter using the vCenter Plug-in, ensure that the QLflash utility is also installed.
Follow the instructions in the
Installing the Flash Utility section.
To update the Flash from the QLogic Adapter vCenter Plug-in:
1.
Follow the instructions in
“Starting the QLogic Adapter vCenter Plug-in” on page 1-16
to start the vCenter plug-in.
2.
In the left pane of the QLogic Adapter page, select the adapter, and then click the Update Adapter Flash Image link.
3.
In the Select Flash File for Update dialog box, click Browse.
4.
In the Choose File to Upload dialog box, select the .bin Flash file from the extracted Flash kit package that is compatible with your adapter, and then click Open.
5.
In the Select Flash File for Update dialog box, click Send.
6.
Verify the current Flash version and file version, and then click OK to continue the update.
SN0054671-00 D 1-17
1–Product Overview
Installing the QLogic Adapter vCenter Plug-in for ESX/ESXi
7.
When asked “Do you want to reset the adapter to activate the firmware immediately after successful update?,” click OK if you want the new firmware to take effect immediately. Or, click Cancel to have the new firmware take effect after the next system reboot.
8.
Wait for the Flash update process to complete. Processing time depends on the network connection and the system configuration. Do not interrupt the update process.
CAUTION
The Flash update may take up to 10 minutes to complete. Do not cancel the task or reboot the server during this time. Doing so may corrupt the firmware on the adapter.
9.
In the Flash update successful completion message box, click OK.
10.
If you clicked OK in
Step 7 , you can click Refresh to verify the new firmware
version. Otherwise, you must reboot the system for the new firmware to take effect.
Using the vCenter Plug-in on a Tomcat Server
VMware requires that all vCenter plug-ins are web-based applications hosted on a
Tomcat Server, which can be downloaded and installed on Linux and Windows systems. Here is a link to Tomcat: http://tomcat.apache.org
The QLogic vCenter Plug-in supports Tomcat 5, 6, and 7. The installer dynamically detects the Tomcat version and installs accordingly.
This section provides the following procedures for using the vCenter Plug-in on a
Tomcat Server:
“Installing Tomcat on Linux” on page 1-19
“Starting and Stopping Tomcat on Linux” on page 1-19
“Installing Tomcat on Windows” on page 1-19
“Starting and Stopping Tomcat on Windows” on page 1-20
1-18 SN0054671-00 D
1–Product Overview
Installing the QLogic Adapter vCenter Plug-in for ESX/ESXi
Installing Tomcat on Linux
To install Tomcat on a Linux OS:
1.
Go to the following URL: http://tomcat.apache.org/download-55.cgi
2.
Locate the following directory and file:
Binary Distribution > Core > tar.gz
(apache-tomcat-5.5.28.tar.gz)
3.
Unzip the tar.gz file by issuing the following command:
root # tar zxf file.tar.gz
4.
Create a symbolic link to a Tomcat directory by issuing the following command:
# ln -s apache-tomcat-5.5.28 tomcat
where setting variables include the following:
export JAVA_HOME=/root/gwt/jdk1.6.0_17/ export CATALINA_HOME=/root/gwt/tomcat/
Starting and Stopping Tomcat on Linux
To start Tomcat, issue the following command:
# $CATALINA_HOME/bin/startup.sh
To stop Tomcat, issue the following command:
# $CATALINA_HOME/bin/shutdown.sh
Installing Tomcat on Windows
To install Tomcat on a Windows OS:
1.
Go to either of the following URLs: http://tomcat.apache.org/download-60.cgi
http://tomcat.apache.org/download-70.cgi
2.
Locate the following directory and file:
Binary Distribution > Core > 32-bit/64-bit Windows Service
Installer
3.
To install the Tomcat service, get the 32-bit/64-bit Windows Service Installer, save it, and run it.
SN0054671-00 D 1-19
1–Product Overview
Installing the QLogic Adapter vCenter Plug-in for ESX/ESXi
Starting and Stopping Tomcat on Windows
To start and stop Tomcat on a Windows OS:
1.
Go to Computer Management > Services and Application > Services >
Apache Tomcat <version number>.
2.
Right-click, and then select Start /Stop to initiate Tomcat service, or select
Stop to halt the Tomcat service.
Installing the vCenter Plug-in on Tomcat
To install the vCenter Plus-in on a Tomcat Server:
1.
Download the QLogic Adapter vCenter Plug-in installer EXE; for example,
QLogic Adapter VI Plugin 1.0.4.exe
.
2.
Run the installer by double-clicking the EXE file or by typing the name of the
EXE
on a command prompt.
The InstallAnywhere installer prepares to install the QLogic Adapter vCenter
Plug-in.
3.
On the Introduction window, click Next.
4.
On the Please Wait window, wait while the QLogic Adapter vCenter Plug-in is configured for your system.
5.
On the Choose Install Folder window, either accept the default installation directory, or click Choose to specify a different folder.
6.
Click Install to install files to the installation directory specified in the previous step.
A progress window shows the status of the installation.
7.
On the User Input window, type your vCenter Server IP address, username, and password, as well as the IP address of your local Tomcat Server. Then click Next to continue.
8.
On the Please Wait window, wait while the QLogic Adapter vCenter Plug-in is configured for your system and registers the plug-in with the vCenter
Server.
9.
On the Registration Result window, click Finish to complete the plug-in installation.
1-20 SN0054671-00 D
1–Product Overview
Installing the QLogic Adapter vCenter Plug-in for ESX/ESXi
Plug-in Unregistration from a Manual Installation
If you have performed a manual installation of the vCenter plug-in, you must perform a manual uninstall before running the vCenter installation wizard.
VMware provides two type of scripts for vCenter plug-in registration:
For Windows PowerShell
®
scripting: http://communities.vmware.com/docs/DOC-4521
For Perl: http://communities.vmware.com/docs/DOC-4530
1.
Before you can use the script, download the appropriate VI SDK from
VMware.
For PowerShell, download vSphere PowerCLI: http://communities.vmware.com/community/vmtn/vsphere/automationtools/ powercli
For Perl VI SDK, download vSphere SDK for Perl: http://www.vmware.com/support/developer/viperltoolkit/
2.
After you download and install the SDK and the registration script, follow the
VMware instructions to register the vCenter Plug-in.
For example, the Perl unregister command is: perl registerPlugin.pl --server="127.0.0.1"
-username="administrator" --password="password"
--key="com.qlogic.QLogicAdapterVIPlugIn" --action="remove"
3.
Replace the username and password with the correct information to log into the vCenter Server.
Launching the Plug-in from vSphere Client
To launch the plug-in from vSphere client:
1.
Start the vSphere Client and connect to the vCenter Server. (If you start and connect the vSphere Client directly to an ESX or ESXi server, the vCenter plug-in does not appear.)
2.
If you have not done so, create a data center and add the ESX server.
3.
In the left pane, select the server.
A row of tabs appear in the right pane. If the server has QLogic Adapter CIM
Provider and adapters installed, and if the vCenter plug-in installation and registration were successful, the QLogic Adapter tab appears in the tab row.
4.
Click the QLogic Adapter tab to view a web page.
SN0054671-00 D 1-21
1–Product Overview
Installing the QLogic Adapter vCenter Plug-in for ESX/ESXi
1-22 SN0054671-00 D
