SANbox 5000 Series Fibre Channel Switch
Command Line Interface Guide
Information furnished in this manual is believed to be accurate and reliable. However, QLogic Corporation assumes no
responsibility for its use, nor for any infringements of patents or other rights of third parties which may result from its
use. QLogic Corporation reserves the right to change product specifications at any time without notice. Applications
described in this document for any of these products are for illustrative purposes only. QLogic Corporation makes no
representation nor warranty that such applications are suitable for the specified use without further testing or
modification. QLogic Corporation assumes no responsibility for any errors that may appear in this document.
This SANbox switch is covered by one or more of the following patents: 6697359; other patents pending.
QLogic and SANbox are trademarks or registered trademarks of QLogic Corporation.
Microsoft, Windows NT, and Windows 2000/2003, and Internet Explorer are registered trademarks of Microsoft
Corporation.
All other brand and product names are trademarks or registered trademarks of their respective owners.
S
Document Revision History
Release, Revision A, July 25, 2007Firmware Version 6.7
This guide describes the features and use of the command line interface for
SANbox 5000 Series switches running firmware version 6.7. This guide is
organized as follows:
Section 1 describes switch models and features, the intended audience,
related materials, new items in this release, and technical support.
Section 2 describes logging on and off of a switch, opening and closing an
Admin session, entering commands, getting help, paging a switch, setting
page breaks, and loading and retrieving files.
Section 3 describes the management of user accounts and passwords.
Section 4 describes configuring the switch network connection.
Section 5 describes managing the switch configuration, setting the date and
time, backing up and restoring the switch configuration, resetting the switch,
installing firmware, and installing feature licenses.
Section 6 describes port configurations, resetting a port, initializing a port
loop, configuring port threshold alarms, and testing ports.
Section 7 describes managing the zoning database and configuring
Section 11 describes events and event logging.
Section 12 describes managing the Simple Network Management Protocol
(SNMP) configuration.
Section 13 lists the commands in alphabetical order, including the command
syntax, keywords, notes, and examples.
59183-01 A1-1
An index and a glossary are also provided.
1 – Introduction
Switch Models and Examples
1.1
Switch Models and Examples
The commands and displays of the command line interface vary depending on the
switch model. All examples in this guide are taken from a SANbox 5600 switch
unless stated otherwise.
1.2
Intended Audience
This guide is intended for individuals who are responsible for installing and
servicing Fibre Channel equipment using the command line interface.
1.3
Related Materials
The following manuals and materials are referenced in the text and/or provide
additional information.
SANbox 5000 Series Fibre Channel Switch Installation Guide, 59096-04
SANbox 5000 Series QuickTools Switch Management User Guide,
59235-01
SANbox 5000 Series Enterprise Fabric Suite 2007 User Guide, 59097-04
SANbox Simple Network Management Protocol Reference Guide,
publication number 59047-07
CIM Agent Reference Guide, 59223-01
S
SANbox CLI Quick Reference Guide, 59261-00
QLogic Switch Interoperability Guide v3.0. This PDF document can be
downloaded at http://www.qlogic.com/interopguide/info.asp#inter.
Fibre Channel-Arbitrated Loop (FC-AL-2) Rev. 7.0.
Fibre Channel-10-bit Interface Rev. 2.3.
Definitions of Managed Objects for the Fabric Element in Fibre Channel
St a ndard (draft-ietf-ipfc-fabric-element-mib-04.txt).
The Fibre Channel Standards are available from:
Global Engineering Documents, 15 Inverness Way East, Englewood, CO
80112-5776 Phone: (800) 854-7179 or (303) 397-7956
Fax: (303) 397-2740.
1-259183-01 A
A
1.4
New in This Release
The following features are new in this release:
The switch is equipped with the QuickTools embedded graphical user
interface. QuickTools is a web applet that provides basic fabric management
tools.
The following optional features are available with the purchase and
installation of a license key:
Enterprise Fabric Suite 2007 is a workstation-based Java® application
that provides a graphical user interface for fabric management. This
includes Performance View which graphs port performance. Enterprise
Fabric Suite 2007 comes with a free 30-day trial license.
Fabric Security provides for Secure Socket Layer (SSL) and Secure
Shell (SSH) connection security, device security using Challenge
Handshake Authentication Protocol (CHAP), and remote
authentication using a Remote Authentication Dial-In User Service
(RADIUS) server.
SANdoctor provides tools for Fibre Channel connection verification
(Fcping command), Fibre Channel route tracing (Fctrace command),
and transceiver diagnostic information (Show Media command).
Port Activation enables additional Fibre Channel ports up to the
20-port maximum.
You can download firmware image files using Trivial File Transfer Protocol
(TFTP) using the Firmware Install, Image Install, and Image TFTP
commands.
1 – Introduction
New in This Release
The Zoning Delete Orphans command removes inactive zone sets and all
zones and aliases not in the active zone set.
Implicit hard zoning enforces soft zone boundaries effectively converting
them to hard zones.
Port binding establishes a list of port/devices that are permitted to log in to a
switch port. Port binding is configured using the
59183-01 A1-3
Set Config Security Portbinding command.
1 – Introduction
Technical Support
1.5
Technical Support
Customers should contact their authorized maintenance provider for technical
support of their QLogic switch products. QLogic-direct customers may contact
QLogic Technical Support; others will be redirected to their authorized
maintenance provider.
Visit the QLogic support Web site listed in Contact Information for the latest
firmware and software updates.
1.5.1
Availability
QLogic Technical Support for products under warranty is available during local
standard working hours excluding QLogic Observed Holidays.
1.5.2
Training
QLogic offers certification training for the technical professional for both the
SANblade™ HBAs and the SANbox switches. From the training link at
www.qlogic.com, you may choose Electronic-Based Training or schedule an
intensive "hands-on" Certification course.
S
Technical Certification courses include installation, maintenance and
troubleshooting QLogic SAN products. Upon demonstrating knowledge using live
equipment, QLogic awards a certificate identifying the student as a Certified
Professional. The training professionals at QLogic may be reached by email at
tech.training@qlogic.com.
1-459183-01 A
A
1.5.3
Contact Information
Support HeadquartersQLogic Corporation
QLogic Web Sitewww.qlogic.com
Technical Support Web Sitesupport.qlogic.com
Technical Support Emailsupport@qlogic.com
Technical Training Emailtech.training@qlogic.com
North American Region
Emailsupport@qlogic.com
Phone+1-952-932-4040
1 – Introduction
Technical Support
12984 Valley View Road
Eden Prairie, MN 55344-3657
USA
Fax+1 952-974-4910
Europe, Middle East, and Africa Region
Emailemeasupport@qlogic.com
Phone Numbers by Language+353 1 6924960 - English
+353 1 6924961 - Français
+353 1 6924962 - Deutsch
+353 1 6924963 - Español
+353 1 6924964 - Português
+353 1 6924965 - Italiano
Asia Pacific Region
Emailapacsupport@qlogic.com
Phone Numbers by Language+63-2-885-6712 - English
Logging In to the Switch
Opening and Closing an Admin Session
Entering Commands
Getting Help
Setting Page Breaks
Creating a Support File
Downloading and Uploading Files
NOTE:Throughout this document, references in text to commands and
keywords use initial capitalization for clarity. Actual command and
keyword entries are case insensitive
59183-01 A2-1
2 – Command Line Interface Usage
Logging In to the Switch
2.1
Logging In to the Switch
To log in to a switch through Telnet, open a command line window on the
workstation and enter the Telnet command followed by the switch IP address:
# telnet ip_address
The Telnet window opens prompting you for a login. Enter an account name and
password. The default account name is admin, and its password is password.
switch login:admin
password: xxxxxxxx
Warning: Your user account password has not been changed
It is strongly recommended that you do so before
proceeding
To log off, enter the Exit command:
SANbox #> exit
S
To log in to a switch through the serial port, config ure the workst ation port with the
following settings:
9600 baud
8-bit character
1 stop bit
No parity
Enter an account name and password when prompted.
NOTE:A switch supports a combined maximum of 19 logins or sessions
reserved as follows:
4 logins or sessions for internal applications such as management
server and SNMP
9 high priority Telnet sessions
6 logins or sessions for Enterprise Fabric Suite 2007 inband and
out-of-band logins, Application Programming Interface (API)
inband and out-of-band logins, and Telnet logins. Additional logins
will be refused.
2-259183-01 A
A
2.2
Opening and Closing an Admin Session
The command line interface performs monitoring and configuration tasks.
Commands that perform monitoring tasks are available to all user accounts.
Commands that perform configuration tasks are available only after entering the
Admin Start command to open an Admin session. A user account must have
Admin authority to enter the Admin Start command.
The following is an example of how to open and close an Admin session:
The command-line completion feature makes entering and repeating commands
easier. Table 2-1 describes the command-line completion keystrokes.
KeystrokeEffect
TabCompletes the command line. Enter at least one character and press
Up ArrowScrolls backward through the list of previously entered commands.
Down ArrowScrolls forward through the list of previously entered commands.
Control-AMoves the cursor to the beginning of the command line
Control-EMoves the cursor to the end of the command line.
Control-UClears the command line.
Table 2-1. Command-Line Completion
the tab key to complete the command line. If more than one possibility
exists, press the Tab key again to display all possibilities.
59183-01 A2-3
2 – Command Line Interface Usage
Getting Help
2.4
Getting Help
To display help for a command, enter the Help command followed by the
command. The following is an example of the help that is available for the
Config Edit command.
SANbox #> help config edit
config edit [CONFIG_NAME]
This command initiates a configuration session and places the current session
into config edit mode.
If CONFIG_NAME is given and it exists, it gets edited; otherwise, it gets
created. If it is not given, the currently active configuration is edited.
Admin mode is required for this command.
Usage: config edit [CONFIG_NAME]
2.5
Setting Page Breaks
S
Some display commands deliver so much information to the screen that it scrolls
off too quickly to read it. You can limit the display to 20 lines by turning on page
breaks. By default, page breaks are turned of f.The followin g is an example of ho w
to turn page breaks on and how it affects the display.
SANbox #> set pagebreak on
SANbox #> zone list
Zone ZoneSet
---- ------ Zone1
alpha
beta
Zone2
delta
echo
Zone3
sierra
tango
Zone4
gamma
delta
Press any key to continue, 'q' to quit ...
2-459183-01 A
A
2.6
Creating a Support File
If you contact technical support about a problem with your switch, they may
request that you create and send a support file. This support file cont ains all of the
switch configuration information which can be helpful in diagnosing the problem.
The Create Support command creates the support file (dump_support.tgz) on the
switch. If your workstation has an FTP server, you can proceed with the command
prompts to send the file from the switch to a remote host. Otherwise, you can use
FTP to download the support file from the switch to your workstation.
NOTE:Support files are deleted from the switch during a power cycle or
switch reset.
The following example creates a support file and sends it to a remote host.
SANbox #> create support
Log Msg:[Creating the support file - this will take several seconds]
FTP the dump support file to another machine? (y/n): y
Enter IP Address of remote computer: 10.20.33.130
Login name: johndoe
Enter remote directory name: bin/support
Would you like to continue downloading support file? (y/n) [n]: y
Connected to 10.20.33.130 (10.20.33.130).
220 localhost.localdomain FTP server (Version wu-2.6.1-18) ready.
331 Password required for johndoe.
Password: xxxxxxx
2 – Command Line Interface Usage
Creating a Support File
230 User johndoe logged in.
cd bin/support
250 CWD command successful.
lcd /itasca/conf/images
Local directory now /itasca/conf/images
bin
200 Type set to I.
put dump_support.tgz
local: dump_support.tgz remote: dump_support.tgz
227 Entering Passive Mode (10,20,33,130,232,133)
150 Opening BINARY mode data connection for dump_support.tgz.
226 Transfer complete.
43430 bytes sent in 0.292 secs (1.5e+02 Kbytes/sec)
Remote system type is UNIX.
Using binary mode to transfer files.
221-You have transferred 43430 bytes in 1 files.
221-Total traffic for this session was 43888 bytes in 1 transfers.
221 Thank you for using the FTP service on localhost.localdomain.
59183-01 A2-5
2 – Command Line Interface Usage
Creating a Support File
If your workstation does not have an FTP server, enter the Create Support
command to create the support file, and use FTP to download the support file
from the switch to your workstation as shown in the following example:
SANbox #> create support
Log Msg:[Creating the support file - this will take several seconds]
FTP the dump support file to another machine? (y/n): n
To download the support file from the switch to the workstation, do the following:
1.Open a terminal window and move to the directory where you want to
download the support file.
2.Enter the FTP command and the switch IP address or symbolic name.
>ftp 10.0.0.1
3.When prompted for a user and password, enter the FTP account name and
password (images, images).
user: images
password: images
4.Set binary mode and use the Get command to download the file
(dump_support.tgz).
ftp>bin
ftp>get dump_support.tgz
xxxxx bytes sent in xx secs.
ftp>quit
S
2-659183-01 A
A
2.7
Downloading and Uploading Files
There are several files that reside on the switch that you can download to the
workstation for examination or for safekeeping. These files include the following:
You can upload firmware image files or backup configuration files to the switch to
reinstall firmware or restore a corrupted configuration. The switch uses FTP to
exchange files between the switch and the workstation.
Refer to “Installing Firmware” on page 5-20 for information about installing
firmware.
Refer to “Back Up and Restore a Switch Configuration” on page 5-14 for
information about backing up and restoring a switch configuration.
Refer to “Creating and Downloading a Log File” on page 11 -7 for information
about creating a log file.
Refer to “Creating a Support File” on page 2-5 for information about creating
a support file.
2 – Command Line Interface Usage
Downloading and Uploading Files
To download a file from the switch to the workstation, do the following:
1.Enter the FTP command and the switch IP address or symbolic name.
>ftp 10.0.0.1
2.When prompted for a user and password, enter the FTP account name and
password (images, images).
user: images
password: images
3.Set binary mode and use the Get command to download the file
(configdata).
ftp>bin
ftp>get configdata
xxxxx bytes sent in xx secs.
ftp>quit
59183-01 A2-7
2 – Command Line Interface Usage
Downloading and Uploading Files
To upload a file from the workstation to the switch, do the following
1.Enter the FTP command and the switch IP address or symbolic name.
>ftp 10.0.0.1
2.When prompted for a user and password, enter the FTP account name and
password (images, images).
user:images
password: images
3.Set binary mode and use the Put command to upload the file
(config_switch_169).
ftp>put config_switch_169 configdata
xxxxx bytes sent in xx secs.
ftp>quit
S
2-859183-01 A
Section 3
User Account Configuration
User accounts and their respective passwords are the first line of switch security.
A user account consists of an account name, an authority level, an d an expira tion
date. Switches come from the factory with certain user accounts defined for
special purposes. Table 3-1 describes these accounts, their passwords, and their
purposes. These accounts cannot be deleted from the switch.
Table 3-1. Factory User Accounts
User Account
Name
adminpasswordThis user account provides access to the Telnet
imagesimagesThis user account provides access to the File Trans-
prompromThis user account provides access to the Mainte-
PasswordPurpose
server for managing the switch. Admin is the only
account name that has permission to create and modify other user accounts. To secure your admin user
account, be sure to change the password for this
account.
fer Protocol (FTP) server for exchanging files
between the switch and the workstation.
nance menu while in Maintenance mode to perform
switch recovery tasks. Refer to the SANbox 5000 Series Fibre Channel Switch Installation Guide for
information about using Maintenance mode.
This section describes the following user account configuration tasks:
Displaying User Account Information
Creating User Accounts
Modifying User Accounts and Passwords
59183-01 A3-1
3 – User Account Configuration
Displaying User Account Information
3.1
Displaying User Account Information
You can display all user accounts defined on the switch (User Accounts
command) or just those user accounts that are logged on (User List or
Show Users commands).
The following example displays all user accounts defined on the switch. Account
information includes account name, authority, and expiration date.
SANbox (admin) #> user accounts
Current list of user accounts
-----------------------------
images (admin authority = False, never expires)
admin (admin authority = True , never expires)
chuckca (admin authority = False, expires in < 50 days)
gregj (admin authority = True , expires in < 100 days)
fred (admin authority = True , never expires)
S
The following example displays user accounts that are logged on to the switch:
SANbox (admin) #> user list
User Ethernet Addr-Port Logged in Since
---- ------------------ ---------------
admin@OB-session1 10.20.68.108-1031 day month date time year
admin@OB-session2 10.20.68.108-1034 day month date time year
snmp@OB-session3 Unknown day month date time year
snmp@IB-session4 Unknown day month date time year
admin@OB-session5 Unknown day month date time year
3-259183-01 A
A
3.2
Creating User Accounts
A user account consists of an account name, an authority level, an d an expira tion
date. The account name can be up to 15 characters and must begin with an
alphanumeric character. The authority level grants admin authority (true) or
denies it (false). The expiration date sets the date when the user account exp ires.
Only the Admin user account can create user accounts.
The following example creates a new user account named user1 with admin
authority that expires in 100 days.
SANbox (admin) #> user add
Press 'q' and the ENTER key to abort this command.
account name (1-15 chars) : user1
account password (8-20 chars) : *******
please confirm account password: *******
set account expiration in days (0-2000, 0=never): [0] 100
3 – User Account Configuration
Creating User Accounts
should this account have admin authority? (y/n): [n] y
OK to add user account 'user1' with admin authority
and to expire in 100 days?
Please confirm (y/n): [n] y
59183-01 A3-3
3 – User Account Configuration
Modifying User Accounts and Passwords
3.3
Modifying User Accounts and Passwords
Only the Admin user account can modify a user account, delete a u ser account, or
change the password of another user account. However, all user accounts can
change their own passwords. The User command modifies and deletes user
accounts. The Passwd command changes passwords.
The following example removes the expiration date and admin authority for the
user account named user1.
SANbox (admin) #> user edit
Press 'q' and the ENTER key to abort this command.
account name (1-15 chars) : user1
set account expiration in days (0-2000, 0=never): [0]
should this account have admin authority? (y/n): [n]
OK to modify user account 'user1' with no admin authority
and to expire in 0 days?
S
Please confirm (y/n): [n]
The following example deletes the user account named user3.
SANbox (admin) #> user delete user3
The user account will be deleted. Please confirm (y/n): [n] y
In the following example, the Admin user account changes the password for the
user account named user2.
The network discovery method determines how the switch acquires its IP address.
The IP address can come from the IP address that resides on the switch or from a
server. The switch supports network discovery from the following server types: