620-000134-00011/2001Initial release of Manual
620-000134-10005/2002Updates for E/OS 2.0
620-000134-20008/2002Updates for E/OS 3.0
620-000134-30009/2002Updates for E/OS 4.0
620-000134-40010/2002Updates for E/OS 4.1
620-000134-50010/2002Updates for E/OS 4.1 CD-ROM final
620-000134-6002/2003Updates for E/OS 5.1 and EFCM 7.1
620-000134-6017/2003Updates for E/OS 5.5
620-000134-70010/2003Updates for E/OS 6.0
620-000134-71012/2003Updates for E/OS 6.1
620-000134-7206/2004Updates for E/OS 6.2
620-000134-73001/2005Updates for E/OS 7.0
No part of this publication may be reproduced or distributed in any form or by any means, or stored in a
database or retrieval system, without the prior written consent of McDATA Corporation. The information
contained in this document is subject to change without notice. McDATA Corporation assumes no
responsibility for any errors that may appear.
All computer software programs, including but not limited to microcode, described in this document are
furnished under a license, and may be used or copied only in accordance with the terms of such license.
McDATA either owns or has the right to license the computer software programs described in this document.
McDATA Corporation retains all rights, title and interest in the computer software programs.
McDATA Corporation makes no warranties, expressed or implied, by operation of law or otherwise, relating
to this document, the products or the computer software programs described herein. McDATA
CORPORATION DISCLAIMS ALL IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
A PARTICULAR PURPOSE. In no event shall McDATA Corporation be liable for (a) incidental, indirect,
special, or consequential damages or (b) any damages whatsoever resulting from the loss of use, data or
profits, arising out of this document, even if advised of the possibility of such damages.
Enterprise Operating System Command Line Interface User Manual
property of such parties and are reprinted with limited use permission. All other trademarks are the property
of their respective companies. All specifications subject to change.
Enterprise Operating System Command Line Interface User Manual
iii
iv
Enterprise Operating System Command Line Interface User Manual
B-1Commands and Releases ............................................................................. B-1
Table s
xiii
Tab les
xiv
Enterprise Operating System Command Line Interface User Manual
Preface
This publication is part of the documentation suite that supports the
McDATA® Sphereon™ 3016 Fabric Switch, Sphereon 3032 Fabric
Switch, Sphereon 3216 Fabric Switch, Sphereon 3232 Fabric Switch,
Sphereon 4300 Fabric Switch, Sphereon 4500 Fabric Switch,
Intrepid
®
6064 Director, and Intrepid 6140 Director.
Who Should Use This
Manual
This publication describes the commands that can be entered through
the Command Line Interface (CLI) for the Intrepid
®
6064 Director,
and Intrepid 6140 Director, Sphereon™ 3016 Switch, Sphereon 3032
Switch, Sphereon 3216 Switch, Sphereon 3232 Switch, Sphereon 4300
Switch, and Sphereon 4500 Switch. (A limited number of these
commands are available on the ED-5000 Director.) Access through a
Telnet client is presumed.
This publication is intended for data center administrators and
customer support personnel, who can either enter the commands
manually or write a script containing them. However, the primary
purpose of the Command Line Interface is for scripts written by these
administrators and personnel for use in a host-based scripting
environment. Therefore, this publication presumes that the user is
familiar with:
•Establishing and using a Telnet session
•Using the command line of a terminal
•Writing scripts
•Networking, SAN, and zoning concepts
•McDATA products in the user’s network
Preface
xv
Preface
The publications listed in Related Publications provide considerable
information about both concepts and McDATA products.
Organization of This
Manual
This publication is organized as follows:
•Chapter 1,Introduction, provides an introduction and overview of
the Command Line Interface.
•Chapter 2,CLI Commands, describes the Command Line Interface
commands, including their syntax, purpose, and parameters, as
well as examples of their usage and any output that they
generate.
•Appendix A, Error Messages lists and explains error messages that
may appear while using the CLI.
•Appendix B, Commands and Corresponding Releases lists each
command in the CLI and the release in which the command was
added to the CLI.
•The Glossary defines terms, abbreviations, and acronyms used in
this manual.
•An Index is also provided.
Manual UpdatesCheck the McDATA web site at www.mcdata.com for possible
updates or supplements to this manual.
xvi
Related PublicationsOther publications that provide additional information about the
products mentioned in this manual are:
•Configuration Backup and Restore Utility Installation and User Guide
(958-000370)
•Products in a SAN Environment - Planning Manual (620-000124)
•McDATA ED-5000 Director Element Manager User Manual
(620-000176)
•Intrepid 6064 Director Installation and Service Manual (620-000108)
•Intrepid 6140 and 6064 Directors Element Manager User Manual
(620-000172)
•Intrepid 6140 Director Installation and Service Manual (620-000157)
•E/OSn SNMP Support Manual (620-000226)
•SANpilot User Manual (620-000160)
Enterprise Operating System Command Line Interface User Manual
•Sphereon 3016 and 3216 Fabric Switch Element Manager User Manual
(620-000174)
•Sphereon 3016 and 3216 Fabric Switches Installation and Service Manual (620-000154)
•Sphereon 3032 and 3232 Fabric Switch Element Manager User Manual
(620-000173)
•Sphereon 3032 and 3232 Fabric Switches Installation and Service Manual (620-000155)
•Sphereon 4300 Fabric Switch Installation and Service Manual
(620-000171)
•Sphereon 4500 Fabric Switch Installation and Service Manual
(620-000159)
•Sphereon 4500 Fabric Switch Element Manager User Manual
(620-000175)
Manual ConventionsThe following notational conventions are used in this document:
Preface
ConventionMeaning
BoldKeyboard keys, buttons and switches on hardware products,
and screen prompts for the Command Line Interface.
Italic
Monospaced
NOTE: A note presents important information that is not hazard-related.
ATTENTION! An attention notice presents important information about
activities that could result in loss of equipment function or loss of data.
Outside book references, names of user interface windows,
buttons, and dialog boxes.
Command syntax, examples of commands, output.
Where to Get HelpFor technical support, McDATA end-user customers should call the
phone number located on the service label attached to the front or
rear of the hardware product.
For IBM products, contact IBM for technical support, which includes
hardware support, all product repairs, and ordering of spare parts.
Go to:
http://www.ibm.com/servers/storage/support/san/index.html.
Preface
xvii
Preface
McDATA’s “Best in Class” Solution Center provides a single point of
contact for customers seeking help with McDATA software products.
The Solution Center will research, explore, and resolve inquiries or
service requests regarding McDATA products and services. The
Solution Center is staffed 24 hours a day, 7 days a week, including
holidays.
NOTE: To expedite warranty entitlement, please have your product serial
number available.
McDATA Corporation
380 Interlocken Crescent
Broomfield, CO 80021
NOTE: Customers who purchased the hardware product from a company
other than McDATA should contact that company’s service representative for
technical support.
Forwarding
Publication
Comments
We sincerely appreciate any comments about this publication. Did
you find this manual easy or difficult to use? Did it lack necessary
information? Were there any errors? Could its organization be
improved?
Please send your comments via e-mail, our home page, or FAX.
Identify the manual, and provide page numbers and specific detail.
Thank you.
E-mail:pubsmgr@mcdata.com
Home Page: http://www.mcdata.com
Fax:Technical Communi cation s Manager
(720) 558-8999
Ordering PublicationsTo order a paper copy of this manual, contact your McDATA
representative, or use the contact information listed below.
xviii
Enterprise Operating System Command Line Interface User Manual
Phone: (800) 545-5773 and select the option for information on
McDATA’s complete family of enterprise-to-edge SAN solutions.
Preface
Fax: (720) 558-4193
TrademarksThe following terms, indicated by a registered trademark symbol (®)
or trademark symbol (™) on first use in this publication, are
trademarks of McDATA Corporation in the United States, other
countries, or both:
All other trademarked terms, indicated by a registered trademark
symbol (®) or trademark symbol (™) on first use in this publication,
are trademarks of their respective owners in the United States, other
countries, or both.
Preface
xix
Preface
xx
Enterprise Operating System Command Line Interface User Manual
1
Introduction
This chapter introduces the Command Line Interface (CLI) and
describes the essentials for using the CLI commands.
•Command Line Interface Overview......................................................1-2
•Entering Command Line Interface Commands....................................1-3
•Logging In and Logging Out..............................................................1-14
•Using the commaDelim Command ....................................................1-17
•Handling Command Line Interface Errors.........................................1-18
•Using the Command Line Interface Help...........................................1-19
•Backup and Restoration......................................................................1-23
Introduction
1-1
Command Line Interface Overview
1
Command Line Interface Overview
The Command Line Interface (CLI) is a feature that provides an
alternative to Graphical User Interface (GUI) and web-based (HTTP)
interface products for director and switch management capabilities.
The CLI can only be used through a Telnet client session in an
out-of-band management environment, using the Ethernet port in the
director or switch. Although the primary use of the CLI is in
host-based scripting environments, the CLI commands can also be
entered directly at a command line. Any hardware platform that
supports the Telnet client software can be used.
The primary purpose of the CLI is to automate management of a
large number of switches with the use of scripts.
Because the CLI is not an interactive interface, no prompts are
displayed to guide the user through a task. If an interactive interface
is needed, use the GUI-based or web-based SAN management
applications instead of the CLI.
1-2
Enterprise Operating System Command Line Interface User Manual
Entering Command Line Interface Commands
Entering Command Line Interface Commands
The CLI commands can be entered directly at the command line of a
terminal or coded in a script.
Note that the CLI commands are not case sensitive.
1
Documentation
Conventions
Navigation
Conventions
Throughout this publication, periods are used to separate the
components of a command name. However, the periods cannot be
included when the command is actually entered at the terminal or
coded in a script. (How to enter the commands is explained in
Navigation of the CLI Command Tree on page 1-12.)
Even though the commands cannot be entered with the periods, the
command line prompts do include the periods.
Config.Port>
Basic command line navigation conventions are supported. The
following table includes the asynchronous commands that are
recognized by the CLI.
Table 1-1CLI Command Tree Navigation Conventions
Character SequenceCommon NameAction or Description
<CR>Carriage ReturnPass a completed line to the
parser.
<DEL>DeleteBackspace one character
and delete the character.
<NL>New LinePass a completed line to the
<SP>SpaceUsed to separate keywords.
#Pound SignUsed to designate
?Question MarkProvide help information.
“Quotation MarkUsed to surround a single
^AControl-APosition the cursor to the
parser.
comments in a script.
token.
start of the line.
Introduction
1-3
Entering Command Line Interface Commands
1
Table 1-1CLI Command Tree Navigation Conventions (Continued)
Character SequenceCommon NameAction or Description
^BControl-BPosition the cursor left one
character.
^DControl-DDelete the current character.
^EControl-EPosition the cursor to the
end of the line.
^FControl-FPosition the cursor right one
character.
^HControl-HBackspace one character
and delete the character.
^ITabComplete the current
keyword.
^KControl-KDelete to the end of the line.
^LControl-LRedraw the line.
^NControl-NMove down one line in the
command history.
^PControl-PMove up one line in the
command history.
^RControl-RRedraw the line.
^UControl-UClear the input and reset the
line buffer.
^XControl-XClear the input and reset the
line buffer.
<ESC>[AUp ArrowMove up one line in the
command history.
<ESC>[BDown ArrowMove down one line in the
command history.
<ESC>[CRight ArrowPosition the cursor right one
character.
<ESC>[DLeft ArrowPosition the cursor left one
character.
1-4
Enterprise Operating System Command Line Interface User Manual
Entering Command Line Interface Commands
1
Command Tree
The command tree of the CLI begins from the root. Table 1-2 shows
the CLI command tree. The commands in the four extended branches
(config, maint, perf, and show) are described in Chapter 2,CLI
Commands.
The following commands are not listed in the command tree, but are
globally available and are documented in this chapter:
•login (see login on page 1-15)
•logout (see logout on page 1-16)
•commaDelim (see Using the commaDelim Command on page 1-17)
Table 1-2 shows the command tree hierarchy from the root, reading
from left to right.
Table 1-2CLI Command Tree
config---------- enterpriseFabMode--- setState
features ----------------- enterpriseFabMode
ficonMS
installKey
NPIV
openSysMS
openTrunking
show
fencing------------------- addPolicy
addPort
deletePolicy
removePort
setParams
setState
show
showTypeT able
ficonCUPZoning------- addControlHost
deleteControlHost
setState
show
ficonMS------------------ setMIHPTO
setState
show
Introduction
1-5
Entering Command Line Interface Commands
1
Table 1-2CLI Command Tree (Continued)
ip-------------------------- ethernet
lineSpeed
show
setHostCtrlState
NPIV---------------------maxPortIDs
setState
show
openSysMS------------setState
port ----------------------- blocked
fan
name
rxCredits
show
showPortAddr
speed
swapPortByAddr
swapPortByNum
type