SANsurfer FC HBA Command Line Interface (CLI)

This software license applies only to QLogic customers. QLogic Corporation. All rights reserved.

1. Package Contents

The following table identifies the SANsurfer FC HBA Command Line Interface (CLI) installation packages available for the supported OS platforms.

NOTE: The bb in the file names shown above represents the build number of the current software release.

2. Requirements

This section defines the minimum hardware and software requirements.

2.1 Hardware Requirements

SANsurfer FC HBA CLI requires the following minimum hardware requirements:

• QLogic QLx2xxx / QLx2xx FC HBAs
• Single-processor or multiprocessor server or workstation:
  • Pentium III with 450 MHz or greater for Windows XP Professional, Windows 2000, Windows Server 2003, Red Hat/SLES Linux, Solaris x86, or NetWare.
  • Pentium III with 450 MHz or greater for Windows XP Professional, Windows 2000, Windows Server 2003, Red Hat/SLES Linux, Solaris x86, or NetWare.
  • Power Mac G5 1.8 Mhz or greater with 512 Mb of memory.
• Fibre channel devices, such as disks and RAID subsystems. SANsurfer FC HBA CLI supports most FC devices. For a complete list of devices that support failover, see the QLogic SAN Interoperability Guide, which you can down load from the QLogic Web site, http://www.qlogic.com/interopguide/info.asp#inter.
  NOTE: Tape devices are displayed as part of the configuration, but are not fully supported by SANsurfer FC HBA CLI (only Persistent binding and LUN masking are available).
• 256 Mb physical RAM is required to run SANsurfer FC HBA CLI; Running with less memory can cause disk swapping, which severely effects performance.
• Video card capable of 256 colors and a screen resolution of 800 - 600 pixels are required.
• About 7 Mb of disk space.

2.2 Software Requirements

SANsurfer FC HBA CLI requires the following minimum software requirements:

• QLogic QLA2xxx drivers for your OS platform.
• Administrative privileges to perform management functions.
• One of the operating systems identified in the OS Support section.

3. OS Support

The SANsurfer FC HBA CLI runs on the OS platforms shown in the following table.

NOTE: For specific OS service packs (SP) and updates, refer to the descriptions where this software version is posted on the QLogic website (http://support.qlogic.com/support/drivers_software.asp).

4. Supported Features

The SANsurfer FC HBA CLI provides a command line interface (CLI) that lets you easily install, configure, and deploy QLogic Fibre Channel HBAs. It also provides robust diagnostic and troubleshooting capabilities and useful statistical information to optimize SAN performance. This application can only configure HBAs on the local machine upon which the application is installed.

The SANsurfer FC HBA CLI can be operated in two modes:

• Interactive mode (Menu driven interface): This mode requires user intervention.
• Non-interactive mode (Command line interface): Use this mode for scripting or when you just want to perform a single operation.

5. Using SANsurfer FC HBA CLI

This section provides procedures that help the user get started using the application. For details, see the following topics:

• 5.1 Installing SANsurfer FC HBA CLI
• 5.2 Starting SANsurfer FC HBA CLI
• 5.3 Removing SANsurfer FC HBA CLI

5.1 Installing SANsurfer FC HBA CLI

For detailed procedures, please refer to the SANsurfer FC HBA CLI Application User’s Guide.

NOTE: On Linux, add the verify option with --nodeps to skip the dependency check when installing the distribution rpm package on a Novell SLES 8/9/10 IA64 system. For example:

#rpm -iv scli-x.xx.xx-xx.IA64.rpm --nodeps

5.2 Starting SANsurfer FC HBA CLI

For detailed procedures, please refer to the SANsurfer FC HBA CLI Application User’s Guide.

5.2 Removing SANsurfer FC HBA CLI

For detailed procedures, please refer to the SANsurfer FC HBA CLI Application User’s Guide.

NOTE: During the uninstall process, certain files and directories might be left behind. Be sure to manually delete these files.

6. Application Notes

The application notes provide additional information in the following subsections:

• 6.1 General [Applies to All Operating Systems (OSs)]
• 6.2 Windows Operating System
• 6.3 Solaris Operating System

6.1 General [Applies to All Operating Systems (OSs)]

Understanding the Displayed Hard Drive Size Under LUN Information

Two different measurement formats are used when displaying the hard drive size: decimal (GB) and binary (GiB). Binary is used by Windows, and decimal is used by Linux. Both Linux and Windows display the "correct" number.

Binary numbers are numbers that are a power of 2.

Decimal numbers are numbers that are a power of 10.

2^10 is 1,024. The closest decimal number is 10^3 or 1,000.

2^20 is 1,048,576. The closest decimal number is 10^6 or 1,000,000.

2^30 is 1,073,741,824. The closest decimal number is 10^9 or 1,000,000,000.

6.2 Windows Operating System

ConfigRequired Parameter

Under Windows, the ConfigRequired parameter in the registry dictates how devices are seen by the OS.

When ConfigRequired=0, both persistently bound and new devices display as enabled. This includes devices that might have been previously unconfigured using the SANsurfer FC HBA CLI. This parameter can be set in the Driver Setting of SANsurfer FC HBA CLI called: "Present targets that are persistently bound plus any new target(s) found".

When ConfigRequired=1, only persistently bound devices display as configured. New devices or devices that were previously unconfigured using the SANsurfer FC HBA CLI display as unconfigured. This parameter can be set in the Driver Setting of SANsurfer FC HBA CLI called: "Present target that are persistently bound only".

NOTE: With the new Windows driver (version 8.2.0.10 and later), the ConfigRequired parameter must be set to 1 to prevent unconfigured entries from being seen by the OS.

6.3 Solaris Operating System

Target Persistent Binding

On Solaris, the qla_mp_config_required parameter in the configuration file dictates how devices are seen by the OS.

The qla_mp_config_required flag in the QLogic configuration file (qla2x00.conf) controls persistent binding of targets. The default configuration file that comes with the QLogic driver does not have an entry for this flag. An entry for this flag appears in the configuration file only when target configuration data is saved using SANsurfer FC HBA CLI.

SANsurfer FC HBA CLI sets the qla_mp_config_required flag to 1 by default. When this flag is set to 1, the driver reports only target devices that are persistently bound in the configuration file to the OS. The driver does not report any new or unconfigured targets to the OS. In other words, the default behavior for this flag is Persistent Targets Only.

When the qla_mp_config_required flag is set to 0, the driver reports both persistently bound and new targets to the OS. This is equivalent to Persistent Plus New.

NOTEs:

• SANsurfer FC HBA CLI does not read in the value of the persistent-binding-configuration parameter from the configuration file.
• The QLC driver does not support persistent binding/failover configuration.
• The QLC driver does not support selective LUN configuration.

7. Known Issues and Workarounds

This section identifies known issues that apply to specific operating systems. Each issue provides a workaround only if one exists.

7.1 Windows Operating System

7.2 Linux Operating System

7.3 Solaris Operating System

7.4 Mac OS X Operating System

8. Contacting Support

Please feel free to contact your QLogic approved reseller or QLogic Technical Support at any phase of integration for assistance. QLogic Technical Support can be reached by the following methods:

Web: http://support.qlogic.com

North America Contact Information
Email: support@qlogic.com
Phone: (952) 932-4040

Support contact information for other regions of the world is available at the QLogic website:
http://support.qlogic.com

Go to Top

© Copyright 2007. All rights reserved worldwide. QLogic, the QLogic logo, and the Powered by QLogic logo are registered trademarks of QLogic Corporation. All other brand and product names are trademarks or registered trademarks of their respective owners.