Brocade, the B-wing symbol, BigIron, DCX, Fabric OS, FastIron, IronPoint, IronShield, IronView, IronWare, JetCore, NetIron,
SecureIron, ServerIron, StorageX, and TurboIron are registered trademarks, and DCFM, Extraordinary Networks, and SAN Health
are trademarks of Brocade Communications Systems, Inc., in the United States and/or in other countries. All other brands,
products, or service names are or may be trademarks or service marks of, and are used to identify, products or services of their
respective owners.
Notice: This document is for informational purposes only and does not set forth any warranty, expressed or implied, concerning
any equipment, equipment feature, or service offered or to be offered by Brocade. Brocade reserves the right to make changes to
this document at any time, without notice, and assumes no responsibility for its use. This informational document describes
features that may not be currently available. Contact a Brocade sales office for information on feature and product availability.
Export of technical data contained in this document may require an export license from the United States government.
The authors and Brocade Communications Systems, Inc. shall have no liability or responsibility to any person or entity with
respect to any loss, cost, liability, or damages arising from the information contained in this book or the computer programs that
accompany it.
The product described by this document may contain “open source” software covered by the GNU General Public License or other
open source license agreements. To find out which open source software is included in Brocade products, view the licensing
terms applicable to the open source software, and obtain a copy of the programming source code, please visit
http://www.brocade.com/support/oscd.
Brocade Communications Systems, Incorporated
Corporate and Latin American Headquarters
Brocade Communications Systems, Inc.
1745 Technology Drive
San Jose, CA 95110
Tel: 1-408-333-8000
Fax: 1-408-333-8101
E-mail: info@brocade.com
European Headquarters
Brocade Communications Switzerland Sàrl
Centre Swissair
Tour B - 4ème étage
29, Route de l'Aéroport
Case Postale 105
CH-1215 Genève 15
Switzerland
Tel: +41 22 799 5640
Fax: +41 22 799 5641
E-mail: emea-info@brocade.com
Asia-Pacific Headquarters
Brocade Communications Systems China HK, Ltd.
No. 1 Guanghua Road
Chao Yang District
Units 2718 and 2818
Beijing 100020, China
Tel: +8610 6588 8888
Fax: +8610 6588 9999
E-mail: china-info@brocade.com
Asia-Pacific Headquarters
Brocade Communications Systems Co., Ltd. (Shenzhen WFOE)
Citic Plaza
No. 233 Tian He Road North
Unit 1308 – 13th Floor
Guangzhou, China
Tel: +8620 3891 2000
Fax: +8620 3891 2111
E-mail: china-info@brocade.com
This section describes text formatting conventions and important notice formats used in this
document.
Text formatting
The narrative-text formatting conventions that are used are as follows:
bold textIdentifies command names
italic textProvides emphasis
code textIdentifies CLI output
For readability, command names in the narrative portions of this guide are presented in mixed
lettercase: for example, switchShow. In actual examples, command lettercase is often all
lowercase. Otherwise, this manual specifically notes those cases in which a command is case
sensitive.
Identifies the names of user-manipulated GUI elements
Identifies keywords and operands
Identifies text to enter at the GUI or CLI
Identifies variables
Identifies paths and Internet addresses
Identifies document titles
Identifies command syntax examples
Notes, cautions, and warnings
The following notices and statements are used in this manual. They are listed below in order of
increasing severity of potential hazards.
A note provides a tip, guidance or advice, emphasizes important information, or provides a reference
to related information.
An Attention statement indicates potential damage to hardware or data.
A Caution statement alerts you to situations that can be potentially hazardous to you or cause
damage to hardware, firmware, software, or data.
A Danger statement indicates conditions or situations that can be potentially lethal or extremely
hazardous to you. Safety labels are also attached directly to products to warn of these conditions
or situations.
xBrocade Adapters Administrator’s Guide
53-1001583-01
Key terms
For definitions specific to Brocade and Fibre Channel, see the Brocade Glossary.
For definitions specific to this document, see “Glossary and Acronyms” on page 165.
For definitions of SAN-specific terms, visit the Storage Networking Industry Association online
dictionary at:
http://www.snia.org/education/dictionary
Notice to the reader
This document may contain references to the trademarks of the following corporations. These
trademarks are the properties of their respective companies and corporations.
These references are made for informational purposes only.
.
CorporationReferenced Trademarks and Products
Microsoft CorporationWindows Server, Windows XP, Windows Vista
Sun Microsystems, Inc.Sun, Solaris
Red Hat, Inc.Red Hat, Red Hat Network, Maximum RPM, Linux Undercover
Novell, Inc.SuSE Enterprise Server (SLES), Linux
VMwareVMware, ESX Server
Additional information
This section lists additional Brocade and industry-specific documentation that you might find
helpful.
Brocade resources
To get up-to-the-minute information, go to http://my.brocade.com to register at no cost for a user ID
and password.
For practical discussions about SAN design, implementation, and maintenance, you can obtain
Building SANs with Brocade Fabric Switches through:
http://www.amazon.com
White papers, online demos, and data sheets are available through the Brocade Web site at:
Release notes are available on the MyBrocade website and are also bundled with the Fabric OS
firmware.
Other industry resources
For additional resource information, visit the Technical Committee T11 Web site. This Web site
provides interface standards for high-performance and mass storage applications for Fibre
Channel, storage management, and other applications:
http://www.t11.org
For information about the Fibre Channel industry, visit the Fibre Channel Industry Association Web
site:
http://www.fibrechannel.org
Getting technical help
Contact your adapter support supplier for hardware, firmware, and software support, including
product repairs and part ordering. To expedite your call, have the following information available:
• Adapter model and serial number
• Adapter operating system version
• Error numbers and messages received
• supportSave command output (see “debug” on page 135 for details)
• Detailed description of the problem, including the switch or fabric behavior immediately
following the problem, and specific questions
• Description of any troubleshooting steps already performed and the results
• Serial console and Telnet session logs
• syslog message logs
Related documentation
• Brocade Adapters Installation and Reference Manual
• Brocade Adapters Troubleshooting Guide
• Fabric OS Administrator’s Guide supporting Fabric OS v6.4.0
• Fabric OS Troubleshooting and Diagnostics Guide supporting Fabric OS v6.4.0
• Data Center Fabric Manager User Manual
xiiBrocade Adapters Administrator’s Guide
53-1001583-01
Document feedback
Quality is our first concern at Brocade and we have made every effort to ensure the accuracy and
completeness of this document. However, if you find an error or an omission, or you think that a
topic needs further development, we want to hear from you. Forward your feedback to:
documentation@brocade.com
Provide the title and version number of the document and as much detail as possible about your
comment, including the topic heading and page number and your suggestions for improvement.
Brocade offers five models of Fibre Channel Host Bus Adapters (HBAs). These models provide
reliable, high-performance host connectivity for mission-critical SAN environments. The Brocade
HBAs are listed in Table 1.
TABLE 1Brocade Fibre Channel HBA models
Model NumberPort SpeedNumber of Ports
4154 Gbps m axi mum
425 4 Gbps maximum
8048 Gbps maximum2
8158 Gbps maximum
8258 Gbps maximum
1
A 4 Gbps SFP installed in Brocade 815 or 825 HBAs allows 4, 2, or 1 Gbps speed only.
2
An 8 Gbps SFP installed in Brocade 425 or 415 HBAs allows 2 or 4 Gbps speed only.
1
2
2
1
1
1
2
1
2
Using Brocade HBAs, you can connect your server (host system) to devices on the Fibre Channel
SAN. The combined high performance and proven reliability of a single-ASIC design makes these
HBAs ideal for connecting hosts to SAN fabrics based on Brocade Fabric or M-Enterprise operating
systems.
Brocade 804 mezzanine cards connect to the embedded switch modules or embedded interconnect
modules on the Blade System chassis by way of an internal backplane and therefore, no optical
modules (SFPs) are involved. With the exception of no SFPs, the Brocade 804 mezzanine FC HBA
card functions the same as the other Brocade HBAs.
The Host Connectivity Manager (HCM) is a management software application for configuring,
monitoring, and troubleshooting Brocade HBAs, converged network adapters (CNAs) and FC
mezzanine cards in a storage area network (SAN) environment.
The management software has two components:
• The agent, which runs on the host.
• The management console, which is the graphical user interface client used to manage the
The information in this guide is intended for OEMs, field service personnel, and customers who are
installing Brocade hardware and HCM software. HCM can be installed in standalone and HP
servers. For instructions about how to install the HCM software, refer to the Brocade Adapters
Installation and Reference Manual.
You can manage the software on the host or remotely from another host. The communication
between the management console and the agent is managed using JSON-RPC over HTTPS.
All HCM, utility, SMI-S Provider, boot software, and driver installation packages, as well as the Driver
Update Disk (DUD), are described in the Brocade Adapters Installation and Reference Manual.
adapter.
HCM features
Common HBA management software features include the following:
• Discovery using the agent software running on the servers attached to the SAN, which enables
• Configuration management , which enables you to configure local and remote systems. With
• Diagnostics, which enables you to test the adapters and the devices to which they are
• Monitoring, which provides statistics for the SAN components.
• Security, which enables you to specify a CHAP secret and configure authentication parameters.
• Event notifications, which provide asynchronous notification of various conditions and
you to contact the devices in your SAN.
HCM you can configure the following items:
-Brocade 4 Gbps and 8 Gbps HBAs
-HBA ports (including logical ports, base ports, remote ports, and virtual ports) associated
with the local host
connected:
-Link status of each adapter and its attached devices
-Loopback test, which is external to the adapter, to evaluate the ports (transmit and receive
transceivers) and the error rate on the adapter
-Read/write buffer test, which tests the link between the adapter and its devices
-FC protocol tests, including echo, ping, and traceroute
problems through a user-defined event filter.
2Brocade Adapters Administrator’s Guide
53-1001583-01
Tree node pop-up menus
You can use the HCM GUI main menu or the Brocade Command Line Utility (BCU) to configure,
monitor, and troubleshoot your SAN components. The instructions for using each feature are
detailed in subsequent chapters of this document. For each SAN component, you can optionally
right-click its icon and a pop-up menu displays (see Table 2).
TABLE 2HCM tree pop-up menus
SAN componentPop-up menu feature
HostRefresh All
Tree node pop-up menus
Start Polling
Update Boot Image
Change Agent Password
Configure Names
Basic Port Configuration
Persistent Binding
Statistics > Port Statistics
Authentication
Support Save
Tree > Copy | Search | Collapse All | Expand All
1
Brocade HBA
4 Gbps or 8 Gbps
PortRefresh
Base PortRefresh
DeviceRefresh
Refresh
Define Name
Update Boot Image
Basic Port Configuration
Persistent Binding
Port Statistics
Diagnostics
Authentication
Enable Adapter
Tree > Copy | Search | Collapse All | Expand All
Define Name
Port Configuration > Basic | Advanced
Virtual Port > Create | Delete
Diagnostics
FC-SP
Enable Port
Persistent Binding
Statistics > Port | FCP IM Module | Fabric | IOC | QoS
Tree > Copy | Search | Collapse All | Expand All
Logical Port Statistics
Tree > Copy | Search | Collapse All | Expand All
Define Name
Statistics > Target | FCP IM
Tree > Copy | Search | Collapse All | Expand All
The following procedures describe how to launch the HCM application in Windows and Linux.
• “Launching the application on Windows platforms”
• “Launching the application on Linux platforms”
2
Launching the application on Windows platforms
After installing the HCM software, locate Brocade HCM on the Windows platform by selecting
Start > Programs > Brocade Adapter Software > Host Connectivity Manager.
OR
Click the desktop icon to launch the application.
Figure 1 shows the screen that appears when HCM software is first launched.
FIGURE 1HCM Login dialog box
The factory default user ID and password are Administrator and password. After you log in for the
first time, you should change the default password to a new one using the HCM GUI.
After installing the HCM software, locate Brocade HCM on the Linux platform.
• If using a GNOME shell, double-click the Host_Connectivity_Manager icon to launch the
application.
• If using a KDE shell, click the Host_Connectivity_Manager icon to launch the application.
OR
Start the application from the command prompt using the following commands:
suse116208:~ # cd /opt/brocade/adapter/client
suse116208:<installed directory>/adapter/client #
./Host_Connectivity_Manager
Remember password
The Login dialog has a check box to remember the password. If you check the Remember password
check box, you do not need to enter the password the next time you launch the application.
Skip login
Take one of the following actions to manage the Skip Login feature.
• Enable Skip Login by checking the Skip Login Dialog check box.
If the Skip Login check box is checked, it automatically disables the Remember password
option.
• Disable Skip Login by setting hba-application.skip-login=false in the
/data/HBAApplication.properties file.
• Select the Skip Login check box if you do not want the Login dialog box to appear the next time
the application is started.
Changing an HCM application password
You can change the default password of the application to a different password using the Change
HCM Password dialog box.
Note the following when you change a password:
• You must validate your user identity by supplying your old password before you can change to a
new password. The new password must be different than the old password.
• The password can begin with an alphabetic, numeric, or special character.
• The default minimum and maximum length of the password is 8 and 64 characters. You can
configure the password length in the HBAApplication.properties file:
# min chars for the application password
password_min=8
#max chars for the application password
password_max=64
• The password is encrypted and stored in the noitacitnehtua.properties file.
6Brocade Adapters Administrator’s Guide
53-1001583-01
HCM software launch
NOTE
1. From the Host Connectivity Manager, select Configure > Change Password > Change Password
for HCM User.
The Change HCM Password dialog box, shown in Figure 2, displays.
2
FIGURE 2Change HCM Password dialog box
2. Type the current password for the account. The default user name and password are
Administrator and password.
3. Type the new password of the account.
The new password must have at least one character different from the old password.
4. Retype the new password in the Confirm New password field.
5. Click OK.
Both the user name and passwords are case-sensitive.
Changing an HCM agent password
You can change the default password of the agent to a different password using the Change HCM
Agent Password dialog box.
Note the following when you change a password:
• You must validate your user identity by supplying your old password before you can change to a
new password. The new password must be different than the old password.
• The password can begin with an alphabetic, numeric, or special character.
• The default minimum and maximum length of the password is 8 and 64 characters. You can
configure the password length in the HBAApplication.properties file:
# min chars for the application password
password_min=8
#max chars for the application password
password_max=64
• The password is encrypted and stored in the noitacitnehtua.properties file.
1. From the Host Connectivity Manager, click Configure > Change Password > Change Agent
Password.
The Change HCM Agent Password dialog box, shown in Figure 3, displays.
FIGURE 3Change HCM Agent Password dialog box
2. Type the current password for the account. The default user name and password are admin
and password.
3. Type the new password of the account.
The new password must have at least one character different from the old password.
4. Retype the new password in the Confirm New password field.
5. Click OK.
Both the user name and passwords are case-sensitive.
8Brocade Adapters Administrator’s Guide
53-1001583-01
Software downgrade using Adapter Software Installer
Software downgrade using Adapter Software Installer
Although driver and HCM downgrades are not supported, the following procedures are
recommended for downgrading between versions 2.1, 2.0, and 1.1 of the Brocade adapter
software. If you are not downgrading previous software versions, proceed to HCM software launch.
Downgrading HCM and driver or HCM only
To downgrade HCM and adapter drivers or HCM only, follow these steps, which are detailed in the
following designated sections of the Brocade Adapters Installation and Reference Manual.
1. Uninstall HCM and drivers or HCM only using procedures detailed under "Software removal
using Adapter Software Uninstaller."
2. When a message box displays asking to back up the HCM configuration, click Yes and proceed
with the software removal. Refer to "HCM configuration data."
3. Install the desired version of the software using "Using the Adapter Software Installer."
When the "Found Backed up data" message displays prompting you to restore old
configurations, select restore the data and continue with the installation.
2
Downgrading driver only
Uninstall existing drivers using procedures under "Software removal using Adapter Software
Uninstaller" in the Brocade Adapters Installation and Reference Manual.
Install new drivers using procedures under "Using the Adapter Software Installer" in the Brocade Adapters Installation and Reference Manual.
HCM configuration data
HCM configuration data is compatible between version 2.1, 2.0, 1.1, and 1.0 of the Brocade
adapter software. Configuration data that is backed up when prompted during software removal
with the Adapter Software Uninstaller and when using the HCM Backup dialog box includes the
following:
The following application configuration files are backed up in the data directory:
Software downgrade using Adapter Software Installer
NOTE
2
Backing up data after an uninstall
If you uninstall the Brocade HCM software, you are prompted to back up the application
configuration data that was created during installation. Be sure to back up configuration data when
the backup message displays during uninstallation. You can perform a backup on an as-needed
basis.
Following are default locations for HCM configuration data.
• Versions 1.1.0.8 and above - <user home>\HCM\data
• Versions 1.1.0.6 and below - <installation location>\FC HBA\data
To restore the backed-up configuration data when you re-install the HCM, you must manually
overwrite the new data directory contents with the backed-up data. This restores your previous
settings.
Data restoration
You can use the Restore Data dialog box to restore data that has been previously backed up. The
Host Connectivity Manager (HCM) stores the location and version details of the most recently-taken
backed up data and automatically points to the location of the data.
Use HCM 2.1 or later to restore backed up data. HCM 2.0 and earlier versions do not support the
Restore Data feature.
The following data is restored:
• HBA application configuration data (HBAApplication.properties)
• HCM user authentication data (noitacitnehtua.properties)
• Alias Configuration data (HbaAliasdb.properties)
• Setup Discovery data (SetupDiscovery.properties)
• Syslog data (Syslog.properties)
• HCM Logging data (logging.properties and log4j.xml)
• SupportSave
Restoring backed up data
You must use HCM 2.1 or later to restore backed-up data.
1. Select the host, an HBA, or a port from the device tree.
2. Select Tool > Restore Data from the main menu.
The Restore Data dialog box, shown in Figure 4, displays.
10Brocade Adapters Administrator’s Guide
53-1001583-01
Software downgrade using Adapter Software Installer
2
FIGURE 4Restore Data dialog box
3. Click the Restore from previous backup data at button, and then click Browse and navigate to
where the last backed up file resides.
OR
Click the Restore default data button. If you click this button, the Browse field is grayed out and
the last restored data file is automatically retrieved.
4. Click Start Restore.
5. Restart the HCM application for the restoration to take effect.
From the Host Connectivity Manager main window, shown in Figure 5, you can manage all the
adapters installed in this computer. Alternatively you can manage adapters installed in remote
computers, if the computers are networked. Only one host can be managed at a time; multiple host
management is not supported.
Refer to the Brocade Adapters Installation and Reference Manual for instructions on how to install
both the driver and GUI, the driver only, or the GUI only.
FIGURE 5Host Connectivity Manager main window
12Brocade Adapters Administrator’s Guide
53-1001583-01
Legend Help menu
To display the HCM product icons and the event severity icons, select Help > Legends from the
Host Connectivity Manager.
HCM product icons
On the left side of the Host Connectivity Manager, there is a navigation tree for representing the
managed host with adapters and ports. Each tree node has an icon to represent the type of node.
If the operational status is offline, link-down, or error, a small red diamond appears on the upper
right corner of the icon.
Tab le 4 shows the product icons that represent the components that HCM manages.
Tab le 5 describes the icons that represent the four event types. Event filtering enables you to block
events based on user-defined criteria (severity or type of log). Events that have been filtered out do
not appear in the Master Log, For information about how to filter events, see “Filtering event log
entries” on page 64.
TABLE 5HCM Master Log icons
IconDescription
Critical-level messages indicate that the software has detected serious problems that will
eventually cause a partial or complete failure of a subsystem if not corrected immediately; for
example, a power supply failure or rise in temperature must receive immediate attention.
Major messages represent conditions that do not impact overall system functionality significantly.
For example, timeouts on certain operations, failures of certain operations after retries, invalid
parameters, or failure to perform a requested operation.
Minor messages highlight a current operating condition that should be checked or it might lead to
a failure in the future. For example, a power supply failure in a redundant system relays a warning
that the system is no longer operating in redundant mode and that the failed power supply needs
to be replaced or fixed.
Discovery
Information-level messages report the current non-error status of the system components; for
example, the online and offline status of a fabric port.
Discovery enables you to contact the adapters present in a specified host in your SAN. The setup
discovery profile is saved in the SetupDiscovery.properties file to remember the history of
each host and related attributes of discovered hosts.
When you log in to HCM, the specified host is automatically contacted (discovered) and displayed
on the navigation tree. By default, the local host is automatically contacted (discovered) and
displayed on the navigation tree. When you configure and turn on discovery, the application
discovers Brocade adapters in that host, connected to the SAN.
The HCM application enables you to discover Brocade adapters, ports, virtual ports, remote ports,
and LUNs using out-of-band discovery only.
14Brocade Adapters Administrator’s Guide
53-1001583-01
Discovery
NOTE
NOTE
2
Setting up out-of-band discovery for an adapter
When performing out-of-band discovery, you are managing the adapter remotely. The application
connects to the agent running on the host server over the IP network and product information is
copied back from the Brocade adapter to the server. If you do not configure the application to
directly discover the devices, the connections and attached devices may not display correctly.
1. From the Host Connectivity Manager, click Discovery > Setup.
The Setup for Discovery dialog box, shown in Figure 6, displays.
FIGURE 6Setup for Discovery dialog box
2. From the Host Name list, select the host name from where you will discover the adapter.
For the first time, the Host Name list will contain only the Local host. You must specify the host
name or the IP address for discovering the remote servers. Only previously-discovered servers
are available in the Host Name list.
3. Type the port number in the Port Number text box. The default is 34568.
4. Type in the user ID and password that will authenticate the SAN product with the agent. The
default user ID and password are admin/password.
It is recommended you change the agent password on the host for security reasons.
Click the Remember Host check box if you do not want to type it in each time you set up
discovery.
5. In the Polling Frequency (seconds) text box, specify the value for how frequently the application
has to poll for newly discovered devices.
All parameters related to the adapters that are installed in that server are refreshed each time
the poll occurs.
If the Keep Polling check box is checked, polling occurs after the specified polling interval. If
the check box is not checked, polling stops.