Brocade, Fabric OS, File Lifecycle Manager, MyView, and StorageX are registered trademarks and the Brocade B-wing symbol,
DCX, 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 Headquarters
Brocade Communications Systems, Inc.
1745 Technology Drive
San Jose, CA 95110
Tel: 1-408-333-8000
Fax: 1-408-333-8101
Email: info@brocade.com
European and Latin American Headquarters
Brocade Communications Switzerland Sàrl
Centre Swissair
Tour A - 2ème étage
29, Route de l'Aéroport
Case Postale 105
CH-1215 Genève 15
Switzerland
Tel: +41 22 799 56 40
Fax: +41 22 799 56 41
Email: emea-info@brocade.com
The table below lists all versions of the Fabric OS Command Reference.
Document TitlePublication NumberSummary of ChangesPublication Date
Fabric OS Reference v2.053-0001487-03September 1999
Fabric OS Reference v2.253-0001558-02May 2000
Fabric OS Reference v2.353-0000067-02December 2000
Fabric OS Reference v3.053-0000127-03July 2001
Fabric OS Reference v2.653-0000194-02December 2001
Fabric OS Reference v3.0 / v4.0 53-0000182-02March 2002
Fabric OS Reference v4.0.253-0000182-03September 2002
Fabric OS Reference v3.1.053-0000500-02April 2003
Fabric OS Reference v4.1.053-0000519-02April 2003
Fabric OS Reference v4.1.253-0000519-03May 2003
Fabric OS Reference v4.1.253-0000519-04July 2003
Fabric OS Reference v4.1.253-0000519-05August 2003
Fabric OS Reference v4.1.253-0000519-06October 2003
Fabric OS Reference v4.2.053-0000519-07December 2003
Fabric OS Command Reference 53-0000519-08March 2004
Fabric OS Command Reference 53-0000519-08 Rev. AApril 2004
Fabric OS Command Reference 53-0000519-09September 2004
Fabric OS Command Reference 53-0000519-10April 2005
Fabric OS Command Reference 53-0000519-12July 2005
Fabric OS Command Referenceiii
53-1000599-02
Document TitlePublication NumberSummary of ChangesPublication Date
Fabric OS Command Reference 53-1000240-01September 2006
Fabric OS Command Reference 53-1000436-0115 Jun 2007
Fabric OS Command Reference 53-1000599-01Added 13 new commands,
19 October 2007
Updated 23 commands with
new options in support of v6.0.
Removed 46 obsolete
commands. Edit/revise ~ 150
commands. Added command
syntax conventions to
Preface.Updated FCS, standby
CP, and RBAC tables. Added AD
Type to RBAC table (Appendix
A). Removed licensed
command tables and
SupportShow reference.
Cosmetic edits throughout.
Fabric OS Command Reference 53-1000599-02Added 8 new commands,
12 March 2008
Updated 28 commands to
support new v6.1 functionality.
Removed 20 obsolete
commands. Corrected errors in
~150 commands. Updated
Preface and RBAC/AD table.
(Appendix A). Cosmetic edits
throughout.
This document is a command reference manual written to help system administrators and
technicians operate, maintain, and troubleshoot Brocade storage area network (SAN) products.
“About this document” contains the following sections:
• “How this document is organized,” next
• “Supported hardware and software”on page xvii
• “What is new in this document”on page xviii
• “Document conventions”on page xx
• “Additional information”on page xxii
• “Getting technical help”on page xxiv
• “Document feedback”on page xxv
How this document is organized
This document is organized to help you find the particular information that you want as quickly and
easily as possible.
The document contains the following components:
• “About This Document” provides information about this document.
• Chapter 1, “Using Fabric OS Commands” explains how to use the command line interface to
manage a Brocade SAN and Brocade switches.
• Chapter 2, “Fabric OS Commands” provides command information.
• Chapter 3, “Primary FCS commands” summarizes the subset of commands available when
FCS policy is enabled.
• Chapter 4, “Control Processor Commands” lists the subset of active and standby control
processor (CP) commands on enterprise-class platforms (Brocade 48000 director and DCX
backbone).
• Appendix A, “Command availability,”explains the Role-Based Access Control and Admin
Domain restriction checks used to validate commands.
• The Index points you to the exact pages on which specific information is located.
Supported hardware and software
This document includes updated information specific to new functionality introduced in Fabric OS
6.1.0. The following hardware platforms are supported by this release:
• Brocade 200E switch
Fabric OS Command Referencexvii
53-1000599-02
• Brocade 300 switch
• Brocade 4016 switch
• Brocade 4018 switch
• Brocade 4020 switch
• Brocade 4024 switch
• Brocade 4100 switch
• Brocade 4900 switch
• Brocade 5000 switch
• Brocade 5100 switch
• Brocade 5300 switch
• Brocade 7500 SAN router
• Brocade 7600 switch
• Brocade 48000 director
• Brocade DCX backbone
Procedures or parts of procedures documented here may apply to some hardware platforms, but
not to others. For hardware specific implementation details and restrictions regarding the
commands described in this document and corresponding help pages, refer to the Fabric OS
Administrator’s Guide.
Although many different software and hardware configurations are tested and supported by
Brocade Communications Systems, Inc. for Fabric OS 6.1.0, documenting all possible
configurations and scenarios is beyond the scope of this document.
This document is specific to Fabric OS 6.1.0 To obtain information about an OS version other than
6.1.0, refer to the documentation specific to that OS version.
What is new in this document
New commands that were added since this document was last released for Fabric OS 6.0.0:
• iclCfg
• iodDelayReset
• iodDelaySet
• iodDelayShow
• ldapCfg
• portcfgCreditRecovery
• portTrunkArea
• sshUtil
Commands that were modified since this document was last released to support new features in
Fabric OS 6.1.0:
• ag
• ficconCupSet
• ficconCupShow
xviiiFabric OS Command Reference
53-1000599-02
• fcrresourceshow
NOTE
• fcrlsanmatrix
• firmwareDownload
• licenseShow
• portCfgDefault
• portDisable
• portEnable
• portCfgAlpa
• portCfgExport
• portCfgEport
• portCfgGport
• portCfgISLMode
• portCfgLongDistance
• portCfgLport
• portCfgNPIVPort
• portCfgPersistentDisable
• portCfgPersistentEnable
• portCfgQos
• portCfgTrunkport
• portCfgShow
• portStatsClear
• secCertUtil
• secPolicyCreate
• secPolicyDelete
• zone
Additional edits to approximately 105 commands not included in this list include bug fixes, general
edits, and hardware updates.
Fabric OS versions v6.0.0 and later support the TCP/IP netstat command. Use this command to
show network status, print information on active sockets, routing tables, interfaces, masquerade
connections, or multicast memberships. By default, netstat lists open sockets. For a list of all netstat
options, refer to the UNIX man pages.
Information that was deleted since this document was last released for Fabric OS v6.0.0. Help
pages are removed from the manual when the associated commands are deprecated or no longer
supported on v6.1.0 platforms.
• diagEnv (Not supported on v6.x platforms.)
• diagFailLimit (Not supported on v6.x platforms.)
• diagStatus (Not supported on v6.x platforms.)
• fabStateClear (Deprecated; use fabricLog -c.)
• fabStateResize (Deprecated; use fabricLog -r.)
Fabric OS Command Referencexix
53-1000599-02
• fabStateShow (Deprecated; use fabricLog -s.)
NOTE
• fazoneAdd (Not supported on v6.x platforms.)
• fazoneCreate (Not supported on v6.x platforms.)
• fazoneDelete (Not supported on v6.x platforms.)
• fazoneRemove (Not supported on v6.x platforms.)
• minisPropShow (Internal use only.)
• perfClrAlpaCrc (Deprecated; use perfClearAlpaCrc.)
• perfShowEEMonitor (Deprecated; use perfMonitorShow.)
• perfClearEEMonitor (Deprecated; use perfMonitorClear.)
• perfClearFilterMonitor (Deprecated; use perfMonitorClear.)
• setMediaMode (Not supported on v6.x platforms.)
• setGbicMode (Not supported on v6.x platforms.)
• setSfpMode (Not supported on v6.x platforms.)
• slTest (Not supported on v6.x platforms.)
• switchReboot (Not supported on 6.x platforms)
Automatic page breaks in CLI command output displays are being phased out. Use the “more”
option to display command output with page breaks: command | more. Do not use the “more”
option in conjunction with help pages. Executing help command | more will display a command “no
manual entry for command” message.
Document conventions
This section describes text formatting conventions and important notices formats.
Text formatting
The narrative-text formatting conventions that are used in this document 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 examples, command lettercase is all lowercase. If there are
exceptions, this manual specifically notes those cases in which a command is case-sensitive.
Identifies 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 syntax examples
xxFabric OS Command Reference
53-1000599-02
Command syntax conventions
NOTE
ATTENTION
CAUTION
DANGER
Command syntax in the synopsis section follows these conventions:
commandCommands are printed in bold.
--option, optionCommand options are printed in bold.
-argument, argArguments.
[ ]Optional element.
variableVariables are printed in italics. In the help pages, values are underlined
enclosed in angled brackets < >.
...Repeat the previous element, for example “member[;member...]”
valueFixed values following arguments are printed in plain font. For example,
--show WWN
|Boolean. Elements are exclusive. Example: --show -mode egress | ingress
or
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. Regular help page notes are included under the NOTES side heading.
An Attention statement indicates potential damage to hardware or data.
A Caution statement alerts you to situations that can be potentially hazardous to you.
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.
Key terms
For definitions of SAN-specific terms, visit the Storage Networking Industry Association online
dictionary at http://www.snia.org/education/dictionary.
Fabric OS Command Referencexxi
53-1000599-02
Additional information
This section lists additional Brocade and industry-specific documentation that you might find
helpful.
Brocade resources
The following related documentation is provided on the Brocade Documentation CD-ROM and on
the Brocade Web site, through Brocade Connect.
To get up-to-the-minute information, join Brocade Connect. It is free! Go to
http://www.brocade.com and click Brocade Connect 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
For additional Brocade documentation, visit the Brocade SAN Info Center and click the Resource
Library location:
http://www.brocade.com
Release notes are available on the Brocade Connect Web site and are also bundled with the Fabric
OS firmware.
Other industry resources
• White papers, online demos, and data sheets are available through the Brocade Web site at
http://www.brocade.com/products/software.jhtml
• Best practice guides, white papers, data sheets, and other documentation is available through
the Brocade Partner Web site.
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.fibrechannle.org
Optional Brocade features
The Fabric OS 6.1.0 release includes all basic switch and fabric support software, as well as the
following optionally licensed software that is enabled via license keys:
• Brocade Ports on Demand - Allows customers to instantly scale the fabric by provisioning
additional ports via license key upgrade (applies to some models of switches.)
• Brocade Extended Fabrics - Provides up to 500 km of switched fabric connectivity at full
bandwidth over long distances.
xxiiFabric OS Command Reference
53-1000599-02
• Brocade ISL Trunking - Optimizes performance in multi-switch SAN fabrics. When two or more
adjacent ISLs are used to connect two switches, the switches automatically group the ISLs into
a single logical ISL, or “trunk.” Up to eight ISLs can be combined into a single logical ISL with a
total bandwidth of 32 Gbit/sec that can support any number of devices.
• Brocade Fabric Manager - Enables administration, configuration, and maintenance of fabric
• FICON Management Server- Also known as "CUP" (Control Unit Port), enables host-control of
switches in Mainframe environments. (Available only on FICON-qualified products)
• ICLs, or Inter Chassis Links - Provides dedicated high-bandwidth links between two Brocade
DCX Data Center Directors without consuming valuable front-end 8G ports. Each DCX must
have the ICL license installed in order to enable the ICL connections. (Available on the DCX
only).
• Adaptive Networking with QoS- Ensures that high priority connections obtain the bandwidth
necessary for optimum performance, even in congested environments. This feature is
automatically enabled on all 4G-platforms when upgrading to Fabric OS 6.1.0. Optionally
available on all new platforms. Ingress Rate Limiting and QoS available on new 8G-capable
products.
• FICON Acceleration- Provides performance improvements for FICON Extension on the Brocade
7500 and FR4-18i.
• Integrated Routing - Available for the Brocade DCX, 5300, and 5100. Per-chassis license allows
full use of EX_ports on any port in chassis
• Temporary Lic enses - With Fabric OS 6.1.0, temporary licenses are supported for the following
features:
• Fabric (E_ports)
• Extended Fabric
• Trunking
• FCIP
• Performance Monitoring
The following licensed software is bundled with Brocade hardware. No additional purchase is
necessary:
• Brocade Web Tools-Administration, configuration, and maintenance of fabric switches and
SANs.
• Brocade Zoning-Division of a fabric into virtual private SANs.
• IPSec - IP Security (for the Brocade 7500 and FR4-18i blade in the Brocade 48000 and DCX
backbone).
• NPIV - N-port ID Virtualization, allowing up to 256 virtual addresses per physical port. This
feature is supported only on the Brocade 200E and Brocade 300 in Access Gateway mode.
Fabric OS Command Referencexxiii
53-1000599-02
NOTE
For more information about licensed features refer to the Fabric OS Administrator’s Guide.
Getting technical help
Contact your switch support supplier for hardware, firmware, and software support, including
product repairs and part ordering. To expedite your call, have the following information available:
1. General Information
• Switch model
• Switch operating system version
• Error numbers and messages received
• supportSave command output
• 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
2. Switch Serial Number
The switch serial number and corresponding bar code are provided on the serial number label,
as shown here:
:
*FT00X0054E9
FT00X0054E9
The serial number label is located as follows:
The serial number label is located as follows:
• Brocade 200E, —On the nonport side of the chassis
• Brocade 4016—On the top of the switch module
• Brocade 4018—On the top of the blade
• Brocade 4020 and 4024—On the bottom of the switch module
• Brocade 300, 4100, 4900, 5100, 5300 and 7500—On the switch ID pull-out tab located
inside the chassis on the port side on the left
• Brocade 5000—On the switch ID pull-out tab located on the bottom of the port side of the
switch
• Brocade 7600—On the bottom of the chassis
• Brocade 48000—Inside the chassis next to the power supply bays
• Brocade DCX—On the bottom right on the port side of the chassis
3. World Wide Name (WWN)
Use the wwn command to display the switch WWN.
xxivFabric OS Command Reference
53-1000599-02
If you cannot use the wwn command because the switch is inoperable, you can get the WWN from
the same place as the serial number, except for the Brocade DCX. For the Brocade DCX, access the
numbers on the WWN cards by removing the Brocade logo plate at the top of the nonport side of
the chassis.
For the Brocade 4016, 4018, 4020, and 4024 embedded switches: Provide the license ID. Use the
licenseIDShow command to display the WWN.
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 and as much detail as possible about your issue, including the
topic heading and page number and your suggestions for improvement.
Fabric OS Command Referencexxv
53-1000599-02
xxviFabric OS Command Reference
53-1000599-02
Chapter
Using Fabric OS Commands
This chapter explains how to manage a Brocade SAN and Brocade switches and directors using the
Fabric OS command line interface (CLI). The following topics discussed:
• “Understanding role-based access control” on page 1
• “Understanding admin domain restrictions” on page 2
• “Using the command line interface” on page 2
Refer to the Fabric OS Administrator’s Guide for information regarding optionally licensed features
and configuration and management procedures.
Understanding role-based access control
Fabric OS implements Role-Based Access Control (RBAC) to control access to all Fabric OS
operations.
Seven roles are supported, as defined in Table 1. Role definitions are guided by perceived common
operational situations and the operations and effects a role is permitted to have on a fabric and
individual fabric elements.
TABLE 1Role definitions
Role NameDefinition
1
UserNonadministrative use, such as monitoring system activity
OperatorA subset of administrative tasks typically required for
routine maintenance operations
SwitchAdminAdministrative use excluding security, user management,
and zoning
ZoneAdminZone management only
FabricAdminAdministrative use excluding user management and Admin
Domain managment
BasicSwitchAdminA subset of administrative tasks, typically of a more limited
scope and effect
AdminMay perform all administrative tasks
SecurityAdminAdministrative use including admin, security, user
management, and zoning
Appendix A, “Command availability” explains the Role-Based Access Control checks in place to
validate command execution, and provides the RBAC permissions for the commands included in
this manual.
Fabric OS Command Reference1
53-1000599-02
Understanding admin domain restrictions
1
Understanding admin domain restrictions
A subset of Fabric OS commands is subject to Admin Domain restrictions that may be in place. In
order to execute an AD restricted command on a switch or device, the switch or device must be part
of a given Admin domain, and the user must be logged into that Admin Domain.
Six Admin Domain types are supported, as defined in Table 2.
TABLE 2AD types
AD TypeDefinition
AllowedAllowed to execute in all ADs.
PhysFabricOnlyAllowed to execute only in AD255 context (and the user
should own access to AD0-AD255 and have admin RBAC
privilege).
DisallowedOnly allowed to execute in AD0 or AD255 context, not
allowed in AD1-AD254 context.
PortMemberAll control operation allowed only if the port or the local
switch is part of the current AD. View access allowed if the
device attached to the port is part of current AD.
AD0DisallowedAllowed to execute only in AD255 and AD0 (if no ADs are
configured).
AD0OnlyAllowed to execute only in AD0 when ADs are not
configured.
Refer to Appendix A, “Command availability” for a listing of Admin Domain restrictions that apply to
the commands included in this manual.
Using the command line interface
The Fabric OS command line interface (accessed via Telnet, SSH, or serial console) provides full
management capability on a Brocade switch. The Fabric OS CLI enables an administrator to
monitor and manage individual switches, ports, and entire fabrics from a standard workstation.
Selected commands must be issued from a secure Telnet or SSH session, as indicated in the
command description in this manual.
Access is controlled by a switch-level password for each access level. The commands available
through the CLI are based on the user’s login role and the license keys used to unlock certain
features.
The Fabric OS CLI provides the following capabilities:
• Access to the full range of Fabric OS features, given the license keys installed.
• Assistance with configuration, monitoring, dynamic provisioning, and daily management of
every aspect of storage area networks (SAN).
• A deeper view of the tasks involved in managing a Brocade SAN.
• Identification, isolation, and management of SAN events across every switch in the fabric.
• Management of Brocade licenses.
2Fabric OS Command Reference
53-1000599-02
Using the command line interface
The documentation for each command includes a synopsis of its syntax, a description of command
use, and a set of examples. The same information can be accessed by issuing help command on a
Brocade switch or director. This command displays the help page for the specified command. For
example, to display the help page for ad, type:
switch:admin> help ad
1
Fabric OS Command Reference3
53-1000599-02
Using the command line interface
1
4Fabric OS Command Reference
53-1000599-02
Loading...
+ 736 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.