Emulex HBAnyware User Manual
HBAnyware
Last Updated January 25, 2008
®
Version 3.4
User Manual
Utility
Copyright© 2008 Emulex Corporation. All rights reserved worldwide. No part of this document may be reproduced
by any means nor translated to any electronic medium without the written consent of Emulex Corporation.
Information furnished by Emulex Corporation is believed to be accurate and reliable. However, no responsibility is
assumed by Emulex Corporation for its use; or for any infringements of patents or other rights of third parties which
may result from its use. No license is granted by implication or otherwise under any patent or patent rights of Emulex
Corporation.
Emulex, AutoPilot Installer, BlockGuard, cLAN, FabricStream, FibreSpy , Giganet, HBAnyware, InSpeed, IntraLink,
LightPulse, MultiPulse, SAN Insite, SBOD and Vixel are registered trademarks, and AutoPilot Manager, EZPilot,
SLI and VMPilot are trademarks of Emulex Corporation. All other brand or product names referenced herein are
trademarks or registered trademarks of their respective companies or organizations.
Emulex provides this manual "as is" without any warranty of any kind, either expressed or implied, including but not
limited to the implied warranties of merchantability or fitness for a particular purpose. Emulex Corporatio n may
make improvements and changes to the product described in this manual at any time and without any notice. Emulex
Corporation assumes no responsibility for its use, nor for any infringements of patents or other rights of third parties
that may result. Periodic changes are made to information contained herein; although these changes will be
incorporated into new editions of this manual, Emulex Corporation disclaims any undertaking to give notice of such
changes.
The HBAnyware Utility User Manual Page ii
Introduction.............................................................................................................. 1
Known Issues.................................................................................................... 3
Installing HBAnyware Components..........................................................................4
Installing the HBAnyware Utility.........................................................................4
Installing the HBAnyware Utility with Web Launch.............................................6
Installing the HBAnyware Utility Security Configurator......................................7
Uninstalling the HBAnyware Security Configurator............................................ 8
Uninstalling HBAnyware Web Launch Only....................................................... 9
Uninstalling the Utility Package.........................................................................9
Using the HBAnyware Components....................................................................... 11
Starting the HBAnyware Utility......................................................................... 11
Starting HBAnyware with Web Launch............................................................ 11
Starting the HBAnyware Security Configurator................................................ 11
Starting HBAnyware from the Command Line................................................. 12
Examples of Modifications ..................................................................12
The HBAnyware Utility Window Element Definitions ....................................... 13
The Menu Bar ...........................................................................................14
The Toolbar............................................................................................... 14
The Toolbar Buttons.................................................................................. 14
Sort Toolbar Buttons........................................................................... 14
The Discovery-Tree................................................................................... 15
Discovery-Tree Icons..........................................................................15
Property Tabs............................................................................................16
Status Bar................................................................................................. 16
Changing Management Mode ......................................................................... 17
Resetting HBAs...............................................................................................18
Changing HBA Names .................................................................................... 19
Discovering HBAs ........................................................................................... 20
Automatic Fibre Channel Discovery.......................................................... 20
Remote SAN Management Using TCP/IP Access Protocol....................... 20
Adding a Single Host ..........................................................................21
Adding a Range of Hosts.................................................................... 21
Removing Hosts..................................................................................23
Configuring Discovery Settings................................................................. 23
Sorting HBA Information .................................................................................. 24
Viewing Remote and Local HBAs..............................................................24
Viewing HBA Information.................................................................................25
Viewing Discovery Information..................................................................25
Viewing Host Information ..........................................................................26
The Host Information Tab....................................................................26
The Driver Parameters Tab................................................................. 27
Viewing General HBA Attributes ............................................................... 28
Viewing Detailed HBA Information ............................................................29
Viewing Fabric Information........................................................................ 31
Viewing Target Information........................................................................ 32
Viewing LUN Information...........................................................................33
Masking and Unmasking LUNs (Windows, Solaris LPFC and
Solaris emlxs (SFS))........................................................................... 34
Viewing Port Statistics............................................................................... 35
Viewing Firmware Information...................................................................37
Viewing Target Mapping (Windows, Solaris LPFC and
Solaris emlxs (SFS))................................................................................. 38
The HBAnyware Utility User Manual Page iii
Viewing Target Mapping (Linux)................................................................ 39
Viewing and Setting Up Authentication (Windows, Linux 8.2,
Solaris LPFC and Solaris emlxs (SFS)).............................................. 40
Viewing or Changing Authentication Configuration............................. 42
Changing Your Password.................................................................... 42
Updating Firmware..........................................................................................43
Updating Firmware (Batch Mode)..............................................................44
Enabling or Disabling an HBA’s BIOS .......................................................47
Configuring the Driver ..................................................................................... 48
Setting Driver Parameters......................................................................... 48
Restoring All Parameters to Their Earlier Values................................ 49
Resetting All Default Values ................................................................ 49
Setting an HBA Parameter Value to the Host Parameter Value.......... 50
Saving HBA Driver Parameters to a File.............................................50
Setting Driver Parameters for All HBAs in a Host ...............................50
Changing Non-dynamic Parameter Values (Linux)..............................51
Creating and Assigning a Batch Mode Driver Parameters File.................. 52
Storport Miniport Driver Parameters................................................................ 54
Driver for Solaris LPFC – Configuration File Reference ................................. 60
Driver For Solaris emlxs (SFS) Driver Parameters.......................................... 74
Solaris emlxs (SFS) and Solaris LPFC Driver Parameter Cross-Reference.... 79
Driver for Linux Parameter Tables...................................................................85
Version 8.0 LPFC and LPFCDFC Parameter............................................ 85
Version 8.2 LPFC and LPFCDFC Parameter........................................... 88
DH-CHAP Authentication and Configuration....................................... 88
Enabling Authentication...................................................................... 88
The lpfc_enable_auth Module Parameter........................................... 88
The fcauthd Daemon .......................................................................... 88
fcauth Daemon Parameters................................................................ 89
Setting Remote and Local Passwords ................................................ 89
Driver for VMware ESX Configuration Parameters..........................................92
Server Performance (Windows).......................................................................95
I/O Coalescing .......................................................................................... 95
Performance Testing................................................................................. 95
Mapping and Masking ..................................................................................... 96
Automapping SCSI Devices (Windows) .................................................... 96
Mapping and Masking Defaults (Windows) ............................................... 97
Setting Up Persistent Binding (Windows, Solaris LPFC and
Solaris emlxs (SFS))................................................................................. 97
Adding New Targets Using sd.conf for Solaris 8................................. 99
HBAnyware Security............................................................................................100
Introduction ................................................................................................... 100
Creating the Access Control Group............................................................... 100
Designating a Master Security Client.............................................................101
Access Control Groups..................................................................................101
Introduction............................................................................................. 101
Access Control Group Tab on the MSC................................................... 102
Access Control Group Tab on a Non-MSC.............................................. 103
ACG Icons............................................................................................... 103
Adding a Server to the ACG .................................................................... 104
Deleting a Server from the ACG.............................................................. 104
Removing Security from all Servers in the ACG...................................... 104
Generating New Security Keys ............................................................... 104
The HBAnyware Utility User Manual Page iv
Restoring the ACG to Its Last Saved Configuration ................................ 105
Accessing a Switch................................................................................. 105
Access Sub-Groups.......................................................................................105
Introduction............................................................................................. 105
ASG Icons............................................................................................... 106
Creating an ASG..................................................................................... 106
Reserved Indices - Examples.................................................................. 107
Adding a Server to an ASG..................................................................... 108
Deleting an ASG ..................................................................................... 108
Restoring an ASG to Its Last Saved Configuration.................................. 108
Editing an ASG .......................................................................................108
About Offline ASGs................................................................................. 110
Backup Masters..............................................................................................111
Introduction..............................................................................................111
Backup Master Eligible Systems..............................................................111
Backup Master Tab and Controls ............................................................ 112
Creating a Backup Master ....................................................................... 112
Reassigning a Backup Master as the New MSC from the Old MSC........ 113
Reassigning a Backup Master as the New MSC from the
Backup Master........................................................................................ 113
Diagnostics.......................................................................................................... 115
Performing Diagnostic Tests ......................................................................... 115
Running a Quick Test.............................................................................. 116
Running a Power On Self Test (POST)................................................... 116
Using Beaconing..................................................................................... 116
Creating Diagnostic Dumps..................................................................... 117
Displaying PCI Registers and Wakeup Information................................. 118
Running Advanced Diagnostic Tests............................................................. 118
Running Loopback Tests......................................................................... 119
Running End-to-End (ECHO) Tests ......................................................... 121
Saving the Log File........................................................................................ 122
Using the HBAnyware Utility Command-Line Interface........................................ 123
Using the CLI Client ...................................................................................... 123
Syntax Rules........................................................................................... 123
Troubleshooting...................................................................................................136
General Situations.........................................................................................136
Emulex Driver for Windows and HBAnyware Situations................................ 138
Emulex Driver for Solaris LPFC and HBAnyware Situations ......................... 138
Emulex Driver for Linux and HBAnyware Situations ..................................138
Security Configurator Situations - Access Control Groups (ACG) ................. 143
Security Configuration Situations - Access Sub-Groups (ASG).....................143
HBAnyware Security Configurator Situations - Backup Masters.................... 145
Error Message Situations.............................................................................. 146
Master Security Client Situations................................................................... 147
Non-Hierarchical and Hierarchical ASG ........................................................ 148
The HBAnyware Utility User Manual Page v
Introduction
Emulex® drivers have many properties that you can modify using the HBAnyware® configuration utility.
The utility is client/server based and provides 'remote' configuration capability to other host platforms
running the utility. This remote configuration capability can be provided by either Fibre Channel (FC)
access (host systems on the same FC Storage Area Network (SAN) or by Transmission Control
Protocol/Internet Protocol (TCP/IP) access (from IP addresses of remote machines). The HBAnyware
utility also enables local discovery of Emulex and OEM branded Emulex host bus adapters (HBAs).
This manual supports the following versions of the HBAnyware application.
• Windows
• Solaris LPFC
• Solaris emlxs (SFS)
• Linux
• VMware ESX Server
• Use the HBAnyware utility to do any of the following (see Table 1 to determine if a sp ecific
feature or task is supported by your operating system):
• Discover local and remote hosts, HBAs, targets and Logical Unit Numbers (LUNs)
• Enable local and FC discovery of Emulex and OEM branded Emulex HBAs
• Reset HBAs
• Set up persistent binding
• Set HBA driver parameters simultaneously to multiple HBAs using Batch Update
• Set global driver parameters to HBAs
• Update firmware and FC boot code (x86 BootBIOS, OpenBoot or EFIBoot) on a single
HBA or multiple HBAs using Batch Update
• Enable or disable the x86 BootBIOS
• Run diagnostic tests on HBAs
• Manage local, FC remote and TCP/IP accessed HBAs
• Locate HBAs using beaconing
• Mask and unmask LUNS
• Perform authentication using the Fibre Channel Security Protocol Diffie-Hellman Challenge Handshake Authentication Protocol (FC-SP DH-CHAP)
The HBAnyware Utility User Manual Page 1
Table 1: HBAnyware Features and Tasks Cross-Reference
Feature/Task Windows
HBAnyware Graphical User
Interface (GUI)
HBAnyware Command Line
Interface (CLI)
HBAnyware with Web Launch
utility
HBAnyware Security
Configurator
Discover local hosts, HBAs,
targets and LUNs
Discover remote hosts, HBAs,
targets and LUNs
Enable local discovery of
Emulex and OEM branded
Emulex HBAs
Enable FC discovery of
Emulex and OEM branded
Emulex HBAs
Reset HBAs
Set up persistent binding
Set HBA driver parameters
simultaneously to multiple
HBAs using Batch Update
Set global driver parameters to
HBAs
Update firmware and FC boot
code on a single HBA or
multiple HBAs using Batch
Update
Enable or disable the x86
BootBIOS
Run diagnostic tests on HBAs
Manage local HBAs
Manage FC remote and
TCP/IP accessed HBAs
Locate HBAs using beaconing
Mask and unmask LUNS
Perform authentication using
FC-SP DH-CHAP
XXXX
XXXXX
XXXX
XXXX
XXXXX*
XXXXX*
XXXXX*
XXXXX*
XXXXX*
XXX
XXXX
XXXXX**
XXXXX*
XXXXX*
XXXX
XXXXX*
XXXXX*
XXXXX
XXX
XXXX
Solaris
LPFC
Solaris
(emlxs) SFS
Linux
VMware ESX
Server
* Supported by only hbacmd on VMware ESX Server. Remote management clients can perform these func-
tions on ESX Server HBAs using the HBAnyware GUI.
** Temporary (not persistent) driver parameters are supported only by hbacmd on VMware ESX Server.
The HBAnyware Utility User Manual Page 2
Known Issues
The following issues have been reported at the time of publication. These issue s may not have been
verified or confirmed and may apply to another product, such as hardware.
• Emulex provides support for LightPulse
Names (WWPNs) outside the typical Emulex range, such as Hewlett-Packard’s upcoming Virtual
Connect for FC on the BladeSystem c-Class platform. In these environments, HBAnyware utility
version 3.2 or later must be deployed across all servers on the SAN, and on any o ther
management console used for TCP/IP access management.
• If there are multiple versions of the Java Runtime Environment (JRE) installed on your Internet
Explorer client, then you may see the following text in the browser's main display window when
you attempt to launch the HBAnyware utility via the browser:
Emulex Corporation HBAnyware Demo of HBAnyware WebStart web
n.n.n.n.....
If you verified that the HBAnyware Web Launch Services package is installed and is running on
the target server, try one of these two workarounds:
• Exit the browser, then restart it. The HBAnyware utility launches successfully.
• Uninstall all non-essential versions of the JRE. HBAnyware Web Launch services
require only a single version of the JRE be installed on the Windows browser client.
• On the VMware ESX Server, there is a known issue with the discovery-threads parameter. The
range for this parameter should be 30 - 64 (decimal). The default is erroneously set to 1. Set this
driver parameter to a valid value. If you do not, when you change any driver parameter value,
the following error message may be displayed: “Driver Parameter ‘discovery-threads’ is not
within the allowed range”.
• Centraliz ed management of HBAs acros s VMware ESX servers must be limi ted to, at most, one
HBAnyware client. This limitation applies to HBAnyware remote con nectivity for both FC (inband) and TCP/IP (out-of-band) management. The remote HBAnyware client configuration must
be modified to disable automatic periodic polling of remote servers.
To disable automatic periodic polling of remote servers:
®
HBAs that are reprogrammed with World Wide Port
1. Start the HBAnyware utility.
2. From the Menu bar, click Discovery>Modify Settings. The HBA Discovery Properties dialog box appears.
3. Define the discovery properties as follows:
• Discovery Server Startup area: This setting defaults to When the utility starts.
Keep this default or if necessary select it.
• Refresh Rate, Fibre Channel area: Select the Manual Refresh (requires click-
ing the discovery refresh button) checkbox.
• Refresh Rate, TCP/IP area: Select the Manual Refresh (requires clicking the
discovery refresh button) checkbox.
• Expire Undiscovered HBA area: Select the Never Remove checkbox.
4. Click OK.
Emulex recommends that remote management of other Windows, Linux and Solaris servers
take place in an environment separate from management of ESX servers. For example, other
servers should exist in a separate zone so that the HBAnyware client that manage them does
not automatically discover ESX servers.
The HBAnyware Utility User Manual Page 3
Installing HBAnyware Components
Installing the HBAnyware Utility
In Windows:
The AutoPilot Installer
the Quick Installation Manual for more information. This ma nual is available on the Emulex Web site for
your driver version.
In Solaris LPFC, Solaris emlxs (SFS) and Linux:
The following must be installed before you can install the utilities:
• The appropriate driver for your operating system:
• Solaris LPFC driver version 6.20i or later.
• Solaris emlxs (SFS) driver version 2.21 or later
• Linux driver version 8.0.16.34 or later.
• Emulex Driver for VMware ESX, version 7.4 or later . See the Emulex Driver for VMware ESX
User Manual for specific information on driver support in ESX Releases.
• For Solaris LPFC and Solaris emlxs (SFS), JRE 5.0; HBAnyware utilities will not run under
earlier versions of the JRE. The JRE and instructions for installation are available at
http://java.sun.com/downloads/index.html.
Caution: The utilities require java runtime binaries and libraries, their path must be included at
®
software streamlines the Emulex driver and HBAnyware utility installation. See
the beginning of the PATH environment variable to avoid conflict s with earlier versions
of java that may still be installed on the system. For example, if the java runtime
binaries are in /usr/java/bin, then include this path in the PATH environment variable.
For example: (bash> export PATH="/usr/java/bin:$PATH")
• For Solaris emlxs (SFS), the Emulex Fibre Channel Adapter (FCA) utilities; See the FCA Utilities
User Manual for instructions on unpacking and installing the FCA Utilities.
• In Linux, previous versions of the application helper module must be uninstalled. You must run
the uninstall script that shipped with the version of the application helper module you want to
remove.
To install the HBAnyware utilities in Solaris LPFC and Solaris emlxs (SFS):
1. Uncompress and untar the EmlxApps file included in the driver package. For Solaris emlxs
(SFS), proceed to step 3.
2. For Solaris LPFC, run the unpack script to obtain the correct package version. Type:
./unpack_apps
3. Unzip the file. Type:
gunzip HBAnyware-<version>-<platform>.tar.gz
4. Untar the file. Type:
tar -xvf HBAnyware-<version>-<platform>.tar
5. Run the pkgadd utility. Type:
pkgadd -d .
6. When prompted by pkadd, choose to install HBAnyware.
7. When prompted by pkadd, answer the HBAnyware installation option questions.
The HBAnyware Utility User Manual Page 4
To install the HBAnyware utilities in Linux:
Note: This procedure also installs the application helper module on your system.The
application helper module allows HBAnyware to communicate with the Emulex driver
for Linux. The 'elxlpfc' init script is also installed and configured to start and stop the
'lpfcdfc' driver during system startup and shutdown.
1. Log on as ‘root’.
2. Download the utilities from the Emulex web site or copy them to the system from the installation
CD.
3. Copy the ElxLinuxApps-<AppsRev><DriverRev>.tar file to a directory on the install machine.
4. Change (use cd command) to the directory to which you copied the tar file.
5. Untar the file. Type:
tar xvf ElxLinuxApps-<AppsRev><DriverRev>.tar
6. Uninstall any previously installed versions. Type:
./uninstall
7. Run the install script. Type:
./install
8. Enter the type of management you want to use:
1 Local Mode : HBA's on this Platform can be managed by
HBAnyware clients on this Platform Only.
2 Managed Mode: HBA's on this Platform can be managed by local
or remote HBAnyware clients.
3 Remote Mode : Same as '2' plus HBAnyware clients on this
Platform can manage local and remote HBA's.
9. You are prompted as to whether or not to allow users to change management mode after
installation. Enter 'y' for yes, or 'n' for no.
You can also install the applications kit on an upgraded kernel. The lpfc driver must be part of the target
kernel distribution and the utilities package must have been installed on the current kernel.
To install the applications kit on an upgraded kernel :
1. Boot to the new kernel.
2. Log on as ‘root’.
3. Change (use the cd command) to the directory containing the unpacked Applications Kit.
4. Run the install upgrade kernel script. Type:
./install upgradekernel
To install the HBAnyware Agent in VMware ESX Server:
The LPFC driver must be loaded before you can install the HBAnyware Agent.
1. Log in as ‘root’.
2. Copy the <AppsRev><DriverRev>.rpm file to a directory on the install machine.
3. CD to the directory to which you copied the rpm file.
4. Install the rpm. Type:
rpm -i <AppsRev><DriverRev>.rpm
The rpm contents are installed in /opt/hbanyware. The hbacmd utility is also located in this directory.
The HBAnyware Utility User Manual Page 5
Installing the HBAnyware Utility with Web Launch
In addition to the driver and HBAnyware utilities, the following must be installed before you can install
the Web Launch feature:
Note: The HBAnyware utility with Web Launch is not supported on the VMWare ESX
Server.
• In Windows:
• Microsoft Internet Information Services (IIS) Server must be installed. See the Microsoft
Web site for information on downloads and installation.
• JRE must be installed. See the www.java.com Web site for information on downloads and
installation.
• In Solaris LPFC, Solaris emlxs (SFS) and Linux:
• Apache must be installed and running on the server that is hosting the Web Launch Services
software.
• The Java Web Start application must be installed and running on the browser host.
The system on which you are installing the Web Launch services package (the server) requires:
• The HTTP server must be configured to handle the JNLP MIME file type. The followin g
MIME file type/file extension must be added to your server configuration:
MIME type: application/x-java-jnlp-file
File Extension: jnlp
• The HTTP server must be configured and running.
The system on which you are running the browser (the client) requires:
• JRE 5.0 or later must be installed. The HBAnyware-installed JRE must match the
HBAnyware code base. Specific requirements:
• Sun 32-bit JRE 5.0 or later for Intel based systems (x86 and IA64)
• Sun 32-bit JRE 5.0 or later x86-64
• 64-bit JRE 5.0 or later for RH4 and SL9 (ppc64)
• 32-bit JRE 5.0 or later for RH5 and SL10 (ppc64)
See the appropriate vendor documentation for detailed instructions about configuring MIME
types, configuring and starting the HTTP server and installing the JRE.
To install the HBAnyware utility with Web Launch:
In Windows:
Click Programs>Emulex >HBAnyware WebLaunch Install. Web Launch installation begins.
In Solaris LPFC, Solaris emlxs (SFS) and Linux:
1. Log on as ‘root’.
2. Navigate to the HBAnyware directory.
• Solaris LPFC and Solaris emlxs (SFS):
cd /opt/hbanyware
• Linux:
cd /usr/sbin/hbanyware
The HBAnyware Utility User Manual Page 6
3. Run the install script. Type:
./wsinstall
4. When prompted, enter the Web server's document root directory. For example:
/srv/www/htdocs
5. You are provided with the IP address of the host and asked if that is the IP address that is being
used by your Web server. Answer Y or N as appropriate. If you answer N, you are prompted for
the IP address you wish to use.
6. You are asked if your Web server is listening on the normal default HTTP port (80)? Answer Y or
N as appropriate. If you answer N, you are prompted for the port you wish to use.
You are notified when the installation of the HBAnyware Web Launch package is complete.
Once the necessary information is entered, you are notified when the installation of the HBAny-
ware Web Launch package is complete. The Web Launch configuration files are created and
Web Launch Services automatically starts.
7. To verify installation, locate another client, open a Web browser window and enter this URL
according to this format:
http://IP_ADDR:PORT_NUM/hbanyware.jnlp
where IP_ADDR is the IP address of host on which you installed the HBAnyware Web Launch
service, and PORT_NUM is the TCP port number of the listening hosts' Web server. The standard HBAnyware user interface is displayed.
Installing the HBAnyware Utility Security Configurator
The Emulex driver and the HBAnyware utilities must be installed before you can install the HBAnyware
Security Configurator.
Note: The HBAnyware utility Security Configurator is not supported on the VMWare ESX
Server.
To install the HBAnyware utility Security Configurator:
In Windows:
1. Locate the SSCsetup.exe file. The default path for this file is:
C:\Program Files\HBAnyware
2. Double-click the SSCsetup.exe file. A welcome window appears.
3. Click Next. The Setup Status window is displayed. After setup completes, the Emulex
HBAnyware Security Setup Completed window appears.
4. Click Finish.
In Solaris LPFC and Solaris emlxs (SFS):
1. Copy the <HBAnywareSSC_version>.tar.gz file to a directory on the install machine.
2. cd to the directory to which you copied the .gz file.
3. Untar the file. Type:
gzcat <HBAnywareSSC_version>.tar.gz | tar xvf-
4. Log on as ‘root’.
5. At the shell prompt, type:
pkgadd -d `pwd`
The HBAnyware Utility User Manual Page 7
6. When prompted by pkadd, choose to install HBAnywareSSC.
7. When prompted by pkadd, answer the HBAnyware installation option questions.
In Linux:
1. Log on as ‘root’.
2. Change (use the cd command) to the directory to which you copied the tar file. (See “Installing
the Utilities and the application helper module” on page 7 step 2 for reference.)
3. Run the install script with the ssc parameter specified. Type:
./install ssc
Uninstalling the HBAnyware Security Configurator
To uninstall the HBAnyware Security Configurator:
In Windows:
1. Select Start>Settings>Control Panel. The Control Panel appears.
2. Click Add/Remove Programs. The Add or Remove Programs window appears.
3. Select Emulex HBAnyware Security Configurator>Change/Remove.
4. Click Next. The Security Configurator is removed from the system.
5. Click Finish. Uninstallation is complete.
In Solaris LPFC and Solaris emlxs (SFS):
1. Log on as ‘root’.
Note: If the HBAnyware Security Configurator is installed, it must be uninstalled before
uninstalling the HBAnyware and driver utilities.
2. Type:
pkgrm HBAnywareSSC
In Linux:
Note: You must run the uninst all script that shipped with the ve rsion of HBAnyware Security
Configurator you want to remove. If the uninstall script resides in the usr/src directory,
be sure to copy it to a temporary directory before you run it.
1. Log on as ‘root’.
2. Change (use the cd command) to the directory to which you copied the tar file during installation.
3. Run the uninstall script with the ssc parameter specified. Type:
./uninstall ssc
The HBAnyware Utility User Manual Page 8
Uninstalling HBAnyware Web Launch Only
To uninstall HBAnyware Web Launch, but leave the HBAnyware utility installed:
In Windows:
1. Select Start> Programs>Emulex>HBAnyware WebLaunch Uninstall. The following screen
appears:
Figure 2: HBAnyware Web Launch, Uninstallation screen
2. HBAnyware Web Launch is removed. Press any key to continue.
In Solaris LPFC, Solaris emlxs (SFS) and Linux:
1. Log on as ‘root’.
Note: If you inst alled HBAnyware with We b Launch, you must uninst all it before uni nstallin g
HBAnyware.
2. Execute the uninstallation script.
• Solaris LPFC and Solaris emlxs (SFS):
/opt/hbanyware/wsuninstall
• Linux:
/usr/sbin/hbanyware/wsuninstall
This script stops the HBAnyware Web Launch Service daemons (if they are running) and removes all
Web Launch related files from the host.
Uninstalling the Utility Package
To uninstall the HBAnyware utility and HBAnyware Web Launch:
In Windows:
1. Select St art>Settings>Control Panel. The Add/Remove Programs window appears. Select the
Install/Uninstall tab.
2. Select Emulex Fibre Channel and click Change/Remove. Click Next. The utilities are removed
from the system.
3. Click Finish. Uninstallation is complete.
In Solaris LPFC and Solaris emlxs (SFS):
1. Log on as ‘root’.
2. Type:
pkgrm HBAnyware
The HBAnyware Utility User Manual Page 9
In Linux (also uninstalls the application helper module):
1. Log on as ‘root’.
2. Change (use the cd command) to the directory to which you copied the tar file during installation.
3. Uninstall any previously installed versions. Type:
./uninstall
In VMware ESX Server (uninstalls the HBAnyware Agent):
1. Log in as ‘root’.
2. Type:
rpm -qa | grep elx
3. Locate the <AppsRev><DriverRev>.rpm file. The .rpm contents are installed in
/usr/sbin/hbanyware. The hbacmd utility is also located in this directory.
4. Type:
rpm -e <AppsRev><DriverRev>.rpm
The HBAnyware Utility User Manual Page 10
Using the HBAnyware Components
Note: To properly view the HBAnyware utility, ensure your system meets the following
display requirements:
For Windows systems the display resolution must be set to 800 by 600 or better.
For UNIX systems the display resolution must be set to 1024 by 768 or better.
The display must run in 256-color mode or higher. HBAnyware icons use 256 colors.
If the display is set for 16 color mode, HBAnyware icons will not be displayed.
Starting the HBAnyware Utility
To start the HBAnyware utility:
In Windows:
On the Windows desktop, select Start>All Programs>Emulex>HBAnyware. If you have a Vista
system, right-click and select Run As Administrator.
In Solaris LPFC, Solaris emlxs (SFS) and Linux:
1. Log on as ‘root’.
2. Run the script to start the HBAnyware utility.
• Solaris LPFC and Solaris emlxs (SFS):
cd /opt/hbanyware/hbanyware
• Linux:
cd /usr/sbin/hbanyware/hbanyware
Starting HBAnyware with Web Launch
After the HBAnyware Web Launch software is installed and the Web Launch server is initialized, you can
launch the HBAnyware utility directly with your Web browser.
Note: Only the HBAnyware Web Launch graphic GUI is being exported to the requesting
client. All HBA discovery and remote management operations are performed by
resources running on the remote host that served up the GUI component. Therefore,
the SAN view displayed by the GUI is not from the client running the GUI, but rather
from the host from which this GUI was retrieved.
To launch the HBAnyware utility with your Web browser:
1. Open your Web browser.
2. Enter the URL of an HBAnyware.jnlp file. Make sure that the URL specifies a remote server
which has the HBAnyware Web Launch software installed and running. For example:
http://138.239.20.30/hbanyware.jnlp
Starting the HBAnyware Security Configurator
Before starting the HBAnyware Security Configurator:
• Ensure that all of the systems that are part of, or will be part of, the security configuration are
online on the network so that they receive updates or changes made to the security
configuration.
The HBAnyware Utility User Manual Page 11
• If you are running the HBAnyware Security Configurator with TCP/IP access, TCP/IP hosts must
be added to the discovery-tree or they will not be seen by the Security Configurator.
Note: When you install the HBAnyware utility security software on a system and run the
HBAnyware utility Security Configurator for the first time, that system becomes the
Master Security Client (MSC). For more information, see “Creating the Access
Control Group” on page 100.
To start the HBAnyware Security Configurator:
In Windows:
On the desktop, click Start>All Programs>Emulex>HBAnyware Security Configurator. The
HBAnyware Security Configurator Discovery window appears. After discovery is completed, the
HBAnyware Security Configurator appears.
In Solaris LPFC, Solaris emlxs (SFS) and Linux:
• Log on as ‘root’.
• Solaris LPFC and Solaris emlxs (SFS):
cd /opt/hbanyware/ssc
• Linux:
cd /usr/sbin/hbanyware/ssc
Starting HBAnyware from the Command Line
Not all HBAs for a specific host can run FC. Therefore, if you run with TCP/IP access, that host may
display HBAs that do not appear when running FC.
To start HBAnyware from the command line:
From the directory in which the HBAnyware utility is installed, type hbanyware and press <Enter>. This
starts the HBAnyware utility with FC access.
Note: In Solaris LPFC, Solaris emlxs (SFS) and Linux: This command is case sensitive
and must be entered in all lowercase.
• Start the HBAnyware utility with TCP/IP access by adding an argument in the form “h=<host>”.
The <host> argument may be either the IP address of the host or its system name. The call will
use a default IP port of 23333, but you can override this by optionally appending a colon (:) and
entering the IP port number.
Examples of Modifications
• ./hbanyware h=138.239.82.2
The HBAnyware utility will show HBAs in the host with the IP address 138.239.82.2.
• ./hbanyware h=Util01
The HBAnyware utility will show HBAs in the host named Util01.
• ./hbanyware h=Util01
The HBAnyware utility will show HBAs in the host named Util01.
Run this modified command line to launch the HBAnyware utility for a single, remote host in
local mode.
The HBAnyware Utility User Manual Page 12
The HBAnyware Utility Window Element Definitions
The HBAnyware utility window contains five basic components: the menu bar, the toolbar, the discoverytree, the property tabs and the status bar.
Figure 3: HBAnyware Utility window
Note: The element you select in the discovery-tree determines whether a menu item or
toolbar icon is active. For example, if you select the local host or other system host,
the Reset Adapter item on the Adapter menu is unavailable. The Reset Adapter
toolbar button is unavailable as well.
Note: Screenshots in this manual are for illustrative purposes only . Your syste m information
may vary slightly.
Note: If you are using this version of the HBAnyware utility to access a remote server on
which an older version of HBAnyware is installed, features that are not available
through the server’s version of HBAnyware are grayed out.
The HBAnyware Utility User Manual Page 13
The Menu Bar
The menu bar contains command menus that enable you to perform a variety of tasks such as exiting
the HBAnyware utility, resetting HBAs and sorting items in the discovery-tree view. Many of the menu
bar commands are also available from the toolbar.
The Toolbar
Many of the toolbar functions are also available from the menu bar. The toolbar is visible by default. Use
the Toolbar item in the View menu to hide the toolbar. If the item is checked, the toolbar is visible.
Figure 4: Toolbar
The Toolbar Buttons
The toolbar buttons perform the following tasks:
Click the Rediscover button to refresh the discovery-tree display.
Click the Reset button to reset the selected HBA.
Sort Toolbar Buttons
You can sort discovered HBAs by host name or fabric addresses. You can also choose to display only
local or remote HBAs. See page 24 for details on sort buttons.
Sort by Host Name button (default)
Sort by Fabric ID button
Local HBAs Only button
Help button
The HBAnyware Utility User Manual Page 14
The Discovery-Tree
The discovery-tree (left pane) has icons that represent discovered network (SAN) elements (local host
name, system host names and all HBAs active on each host). Targets and LUNs are also displayed.
Figure 5: Discovery-tree
Discovery-Tree Icons
Discovery-tree icons represent the following:
This icon represents the local host.
This icon represents other hosts connected to the system.
A green HBA icon with black descriptive text represents an online HBA.
A gray HBA icon with a red X and red text represents an offline or otherwise temporarily inacces-
sible HBA. Several situations could cause the HBA to be offline or inaccessible:
• The HBA on a local host is not connected to the network, but is available for local access.
• The HBA on a local host is malfunctioning and inaccessible to the local host and the
network.
• The HBA on a local host is busy performing a local download and is temporarily inaccessible
to the local host and the network.
The Target icon represents connections to individual storage devices.
The LUN icon represents connections to individual LUNs.
The HBAnyware Utility User Manual Page 15
The Tape LUN icon represents LUNs that are tape devices.
The Target Controller LUN icon represents LUNs that are storage controllers.
The Switch icon represents connections to the switch.
Property Tabs
The property tabs display configuration, statistical and status information for network elements. The set
of available tabs is context-sensitive, depending on the type of network element or HBA currently
selected in the discovery-tree.
Status Bar
The status bar is located near the bottom of the HBAnyware utility window. The status bar displays
messages about certain HBAnyware utility functions, such as “Discovery in process”.
The status bar is visible by default. Use the Status Bar item in the View menu to hide the status bar. If
checked, the status bar is visible.
The HBAnyware Utility User Manual Page 16
Changing Management Mode
During installation you selected a management mode, however you can chang e it if you enab led that
option during installation. The HBAnyware utility enables you to choose three types of host/HBA
management:
• Strictly Local Management - This setting only allows management of HBAs on this host.
Management of HBAs on this host from other hosts is not allowed.
• Local Management Plus - This setting only allows management of HBAs on this host, but
management of HBAs on this host from another host is possible.
• Full Management - This setting enables you to manage HBAs on this host and other hosts that
allow it.
To change HBAnyware management mode using the Management Mode dialog box:
In Windows:
1. From the File menu, select Management Mode. Th e Manage ment Mod e dialog box appears.
Figure 6: Management Mode dialog box
2. Choose the management type you want.
3. Click OK.
Note: The HBAnyware utility must be restarted to see the new management mode.
In Solaris LPFC, Solaris emlxs (SFS) and Linux:
1. Run the script to change the management mode.
• Solaris LPFC and Solaris emlxs (SFS):
cd /opt/hbanyware/set_operating_mode
• Linux:
cd /usr/sbin/hbanyware/set_operating_mode
2. Choose the management type you want.
The HBAnyware Utility User Manual Page 17
Resetting HBAs
You can reset remote and local HBAs.
Caution: Do not reset your HBA while copying or writing files. This could result in data loss or
corruption.
To reset the HBA:
1. In the discovery-tree, select the HBA you want to reset.
2. Do one of the following:
• From the menu bar, click Adapter, and then click Reset Adapter.
• Click the Reset HBA button: .
The following warning appears:
Figure 7: Reset Warning
3. Click Yes. The HBA resets.
The reset may require several seconds to complete. While the HBA is resetting, the status bar
shows “Reset in progress.” When the reset is finished, the status bar shows “Ready”.
The HBAnyware Utility User Manual Page 18
Changing HBA Names
The HBAnyware utility enables you to change HBA names. For example, you may want to identify a
particular HBA with the function it supports, such as a tape drive, scanner, or some other device.
Use any characters you want for names, and names can be up to 255 characters in length. You may
also revert to the HBA's default name if you wish.
Note: Although you can change the HBA's displayed name from the default WWPN, the
change occurs in the discovery-tree only. The WWPN is still active, it is simply
replaced for display purposes with the name you enter . For example, the Port WWPN
field of the General tab is not changed. Also, any change you make to the HBA
names in your discovery-tree will be seen only by you; people running the
HBAnyware utility on another host will not see your name changes
Figure 8: General tab
To change the name of an HBA:
1. From the discovery-tree, select the HBA whose name you wish to change.
2. Do one of the following:
• Select Edit Name from the Adapter menu.
• From the discovery-tree, right-click the HBA whose name you wish to change and select
Edit Name (or Change Name).
3. Edit the HBA name in the discovery-tree.
To use the HBA's default name:
1. From the discovery-tree, select the HBA whose name you wish to change.
2. Do one of the following:
• Select Use Default Name from the Adapter menu.
• From the discovery-tree, right-click the HBA whose name you wish to change and select
Use Default Name (or Restore Default Name).
The HBAnyware Utility User Manual Page 19
Discovering HBAs
Automatic Fibre Channel Discovery
HBAs that have a physical FC connection to the same SAN are discovered automatically when
HBAnyware is launched. HBAs that don't have a physical FC conne ctio n to the SAN whe re HBAnywar e
is launched can be discovered by sending management requests to a remote host using TCP/IP.
Note: The HBAnyware utility can only discover and manage remote HBAs on hosts running
the HBAnyware utility’s remote management server. Remote FC capabilities of the
HBAnyware utility are subject to fabric zoning and whether HBAnyware security is
being utilized. Hosts you want to discover and manage using the HBAnyware utility
must be in the same zone or discovered and managed through TCP/IP access.
Note: After adding an HBA to a running system (commonly called a hot plug), click
Discovery Refresh ( ) or restart the HBAnyware utility to display the new HBA in
the discovery-tree.
Figure 9: Discovery Information
Remote SAN Management Using TCP/IP Access Protocol
You can discover HBAs on TCP/IP hosts. Remote SAN management over TCP/IP sends remote
management requests on another LAN using TCP/IP access protocol to remote hosts. TCP/IP access
enables you to access HBAs via their host IP-address or by the name of the host on which they reside.
Since HBAs may exist on a host but not be a part of a FC network, they will not appear during normal FC
discovery. Thus, TCP/IP access enlarges the number of HBAs that can be querie d or modifie d.
Note: In Windows, if yo u are running a firewall you may need to add the HBAnyware remote
server to the firewall’s exception list. This remote server’s path is:
\Program Files\Emulex\Util\Common\rmserver.exe
The HBAnyware Utility User Manual Page 20
The principle differences between FC and TCP/IP access are:
• A TCP/IP host with an HBA inst alled does not need to connect to a fabric to manage other hosts.
• A TCP/IP management host can manage all of the HBAs in a remote host, not just the ones
connected to the same fabric. FC can only manage HBAs connected to the same fabric.
• You can manage many more hosts since TCP/IP access is not constrained by the boundaries of
a fabric or zoning.
• True board status (e.g. link down) is available since the FC path is not necessary to send a
status request to the remote host.
• HBA security in a TCP/IP environment is much more important since many more hosts are
available for management and TCP/IP access is not affected by fabrics or zoning.
• Discovery of hosts in a TCP/IP environment is not automatic like FC discovery.
Adding a Single Host
The HBAnyware utility enables you to specify a single TCP/IP host to manage. If the host is successfully
discovered, it is added to the static list of hosts. If it has not been discovered over FC, the host and its
HBAs are added to the discovery-tree.
To add a single host:
1. From the Discovery menu, select TCP/IP>Add Host. The Add Remote Host dialog box appears.
Figure 10: Add Remote Host dialog box
2. Enter the name or the IP address of the host to be added. Entering the IP address is the best
way to add a new host.
Note: Using the IP address to identify the host avoids name resolution issues.
3. Click OK. You will receive a message indicating if the new host was successfully added.
Adding a Range of Hosts
You can find the TCP/IP accessed manageable hosts by searching a range of IP addresses using the
Add Range of IP Hosts dialog box. The Add Range of IP Hosts dialog box enables you to build the initial
list of TCP/IP accessed manageable hosts.
The HBAnyware Utility User Manual Page 21
Figure 11: Add Range of IP Hosts dialog box
To add a range of hosts:
1. From the Discovery menu, select TCP/IP>Add Range of Hosts. The Add Range of IP Hosts
dialog box appears.
2. Enter the complete start and end address range and click Add. The added address range
appears in the dialog box. Add any additional ranges you wish to search.
3. Click Start Discovery. The utility checks each address in the range to determine if the host is
available and remotely manageable. The number of addr esses discovered (of m anagea ble
hosts) is periodically updated on the dialog box.
Note: The number of addresses doe s not correspond directly to the number of hosts added
to the discovery-tree. For example, some of the addresses discovered may be for
hosts that have already been discovered over FC. However, new HBAs may be
discovered on those hosts that were not discovered over FC. Also, a host may have
more than one HBA installed and both IP addresses for that host are discovered
during the search, but only one host will possibly be added to the discovery-tree.
4. Save the IP ranges:
• In Windows: A dialog box appears asking you to save the IP ranges you searched. Click Yes
to save the address ranges. If you save the address ranges, these address ranges will
appear the next time you use the Add Range of IP Hosts dialog box. Click No if you do not
want to save the address ranges.
• In Solaris LPFC, Solaris emlxs (SFS) and Linux: Click Save Ranges to File to save the
specified range(s) to a file so that these address ranges will appear the next time you use
the Add Range of IP Hosts dialog box.
The HBAnyware Utility User Manual Page 22
Removing Hosts
Removing hosts that can no longer be discovered improves the operation of the discovery server. For
example, you may want to remove a host when it is removed from the network or detect hosts that are
no longer being discovered.
To remove hosts:
1. From the Discovery menu, select TCP/IP>Remove Host(s). The Remove TCP/IP Hosts dialog
box shows a list of discovered hosts. Any host not currently discovered appears in red. Click
Show Undiscovered Hosts Only to only display currently undiscovered hosts.
2. From the Remove TCP/IP Hosts dialog box, select the hosts you wish to remove. You can select
all the displayed hosts by clicking Select All.
3. Click OK (or Remove) to remove the selected hosts.
Configuring Discovery Settings
Use the HBAnyware Discovery Settings dialog box to configure several discovery server parameters.
You can define when to start the discovery server, when to refresh FC and TCP/IP accessed discoveries
and when to remove previously discovered HBAs that are no longer being d iscovered.
Figure 12: HBA Discovery Properties dialog box
To configure discovery settings:
1. From the Menu bar, select Discovery/Modify Settings. The HBA Discovery Properties dialog
box appears.
2. Define the discovery properties you wish and click OK. Click Defaults to return the discovery
properties to their default settings.
The HBAnyware Utility User Manual Page 23
Sorting HBA Information
Y ou can so rt discovered HBAs by host name, fabric ID, HBA name, t arget name and LUN n umber . You can
also view local or remote HBAs. By default, both local and remote HBAs are sorted by host name.
To sort HBAs, switch between host name or fabric ID in one of two ways:
• From the menu bar: click View, then click Sort by Host Name or Sort by Fabric ID.
• From the toolbar, click one of the following button s:
• Sort HBAs by Host Name (default) .
• Sort HBAs by Fabric ID .
The HBAnyware utility sorts in ascending order. The sort recognizes letters, numbers, spaces
and punctuation marks.
Sort by Host Name
• Initially sorts by host name. Y ou cannot change host names using the HBAnyware utility;
names must be changed locally on that system.
• Within each host system, sorts by HBA model.
• If multiple HBAs have the same model number, sorts models by World Wide Node Name
(WWNN).
• If targets are present, sorts by WWPN. Multiple HBAs may refer to the same target.
• If LUNs are present, sorts by LUN number.
Sort by Fabric ID
• Initially sorts by fabric ID.
• Within each fabric ID, sorts by HBA model.
• If multiple HBAs have the same model number, sorts models by WWNN.
• If targets are present, sorts by WWPN. Multiple HBAs may refer to the same target.
• If LUNs are present, sorts by LUN number.
• If the fabric ID is all zeros, no fabric is attached.
Viewing Remote and Local HBAs
The Local HBAs Only menu item and button both work with the Sort by Host Name and Sort by Fabric ID
buttons. The first time you select this menu item or click this button, only local HBAs are displayed. To
change the view back to remote HBAs, select the menu item or click the Local HBAs Only button again.
Toggle between remote and local HBA views in one of two ways:
• From the menu bar: click View, then click Local HBAs Only.
• From the toolbar, click the Local HBAs Only button: .
The HBAnyware Utility User Manual Page 24
Viewing HBA Information
Viewing Discovery Information
Discovery Information contains a general summary of the discovered elements. The Host or Fabric icon,
depending upon which view you select, is the root of the discovery-tree, but it does not repres ent a
specific network element. Expanding it reveals all hosts, LUNs, targets and HBAs that are visible on the
SAN.
To view the discovery inform ation:
1. Click the Host or Fabric icon at the root of the discovery-tree. Discovered SAN elements appear
in the discovery-tree.
2. Select an element from the discovery-tree to learn more about it.
Figure 13: Discovery Information
Discovery Information Field Definitions
• Number of Hosts - The total number of discovered host computers. This includes servers,
workstations, personal computers, multiprocessors and clustered computer complexes.
• Number of Fabrics - The total number of discovered fabrics.
• Number of Adapters - The total number of discovered HBAs.
• Number of Target Ports - The total number of unique discovered targets on the SAN. In the
discovery-tree, the same target can appear under more than one HBA.
The HBAnyware Utility User Manual Page 25
Loading...