Brocade, the B-wing symbol, BigIron, DCX, Fabric OS, FastIron, NetIron, SAN Health, ServerIron, and TurboIron are
registered trademarks, and AnyIO, Brocade Assurance, Brocade NET Health, Brocade One, CloudPlex, MLX, VCS, VDX,
and When the Mission Is Critical, the Network Is Brocade are trademarks of Brocade Communications Systems, Inc., in the
United States and/or in other countries. Other brands, products, or service names mentioned are or may be trademarks or
service marks 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.
130 Holger Way
San Jose, CA 95134
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 56 40
Fax: +41 22 799 56 41
Email: 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
Faz: +8620 3891 2111
E-mail: china-info@brocade.com
Document History
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 Reference 53-1000240-01September 2006
Fabric OS Command Reference 53-1000436-01June 2007
Fabric OS Command Reference 53-1000599-01Added 13 new commands.
Updated 23 commands with
new options in support of v6.0.
Removed 46 obsolete
commands. Edited and revised
~ 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 9 new commands.
Updated 28 commands to
support new v6.1 functionality.
Removed 6 operands from 6
commands. Corrected errors in
~150 commands. Updated
Preface and RBAC/AD table
(Appendix A). Cosmetic edits
throughout.
October 2007
March 2008
Fabric OS Command Referenceiii
53-1002746-01
Document titlePublication numberSummary of changesPublication date
Fabric OS Command Reference 53-1000599-03Corrections and updates to 31
commands. Removed “Brocade
Optional Features” from
Preface. Added trademark note
to Preface. Cosmetic edits
throughout.
Fabric OS Command Reference 53-1001115-01 Added 3 new commands to
support Encryption. Modified 1
command. Updated Preface
and RBAC/AD table.
Fabric OS Command Reference 53-1001186-01 Added 14 new commands to
support Logical Fabrics.
Modified 63 commands with
new command operands to
support new Fabric OS v6.2.0
features. Removed 8
deprecated commands.
Miscellaneous edits to ~40
commands to correct edits,
update examples. Removed
standby CP command table.
Updated Preface, surrounding
chapters, and command
availability tables.
Fabric OS Command Reference 53-1001337-01Added 18 new commands.
Modified 27 commands with
new command operands to
support new Fabric OS v6.3.0
features. Removed 6
deprecated command options.
Removed 6 diagnostic
commands that now require
root access. Miscellaneous
edits to ~100 commands to
correct edits, update examples.
Updated Preface, surrounding
chapters, and permission
tables.
Fabric OS Command Reference 53-1001754-01Updated 4 help pages with new
command options. Modified 16
help pages for minor updates
and corrections.
Fabric OS Command Reference 53-1001764-01Added 8 new commands.
Modified 41 commands with
new operands to support Fabric
OS v6.4.0 features. Removed 5
commands and 3 deprecated
command options.
Miscellaneous edits to ~100
commands to correct edits,
update examples, etc. Updated
Preface, surrounding chapters,
and permission tables.
July 2008
August 2008
November 2008
July 2009
January 2010
March 2010
ivFabric OS Command Reference
53-1002746-01
Document titlePublication numberSummary of changesPublication date
Fabric OS Command Reference 53-1002147-01Added 20 new commands.
Modified 102 commands to
support Fabric OS v7.0.0
features. Removed 40
commands. 16 commands have
deprecated command options.
Miscellaneous edits to ~250
additional commands. Updated
Preface, surrounding chapters,
and permission tables.
Fabric OS Command Reference 53-1002447-01Added 2 new commands.
Modified 19 commands to
support Fabric OS v7.0.1
features. Removed 1
command. Updated Preface,
surrounding chapters, and
permission tables.
Fabric OS Command Reference 53-1002746-01Added 7 new commands.
Modified 100 commands to
support Fabric OS v7.1.0
features. Removed 6
commands. Updated Preface,
surrounding chapters, and
permission tables.
This document is organized to help you find the information that you want as quickly and easily as
possible.
The document contains the following components:
•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 an FCS
policy is enabled.
•Appendix A, “Command Availability,” explains the Role-Based Access Control, as well as Virtual
Fabric and Admin Domain restriction checks used to validate commands.
Supported hardware and software
This document includes updated information specific to new functionality introduced in Fabric OS v7.1.0.
Table lists the hardware platforms supported in Fabric OS v7.1 release. ASIC names may be used in this
document to distinguish between types of switches that share certain characteristics.
TABLE 1Supported hardware for Fabric OS v7.1
Hardware PlatformDescriptionASIC
Brocade 3008 Gbit 16-port switchGoldeneye 2
Brocade 51008 Gbit 32-port switchCondor 2
Brocade 53008 Gbit 64-port switchGoldeneye 2
Fabric OS Command Referencexix
53-1002746-01
TABLE 1Supported hardware for Fabric OS v7.1 (Continued)
Although Brocade supports and tests many different software and hardware configurations for Fabric OS
v7.1.0, documenting all possible configurations and scenarios is beyond the scope of this document.
This document is specific to Fabric OS v7.1.0. To obtain information about an OS version other than
v7.1.0, refer to the documentation for that OS version.
xxFabric OS Command Reference
53-1002746-01
What is new in this document
The Fabric OS Command Reference v7.1.0Command supports the current Fabric OS release and the
new hardware platforms.
The Fabric OS command RBAC availability and Admin Domain type table in the appendix chapter is
updated. The table lists the Admin domain, Context and Switch type for the commands.
New commands
The following commands and associated man pages have been added since the publication of the Fabric
OS v7.1.0 release of this manual:
•fabRetryStats - Displays or manages the retry count of fabric commands.
•fcpRlsProbe - Initiates the Fibre Channel Protocol (FCP) Read Link Status (RLS) probing for F_Port
and displays the RLS information.
•gePortErrShow - Displays error statistics of Gigabit Ethernet (GbE) port and XGE ports.
•iflShow - Displays the interfabric link (IFL) information.
•nsDevLog - Manages device history logging.
•nsZoneShow - Displays the zone names.
•portBufferCalc - Calculates the number of buffers required per port.
•rasAdmin - Configures RASlog message generation.
•rasMan - Displays RASlog message text and documentation.
•zoneObjectReplace - Replaces zone members.
Modified commands
The following commands and associated man pages have been modified to remove support for the
platforms Brocade 7500 and FR4-18i in Fabric OS v7.1.0:
•configDefault
•fcipPathTest
•lsCfg
•portCfg
•portCfgShow
•portCmd
•portShow
•portStatsShow
•sfpShow
•slotShow
•statsClear
•supportShow
•supportShowCfgDisable
•supportShowCfgEnable
•supportShowCfgShow
Fabric OS Command Referencexxi
53-1002746-01
The following commands and associated man pages have been corrected or updated with additional
information:
•aaaConfig - Added support for TACACS+.
•ag - Added options to save the configured F_Ports, delete the backup mappings for the given
N_Port, and display the saved mappings for the given N_Port.
•aptPolicy - Added support for Device-based routing in FICON environments.
•auditDump - The CLI audit is captured.
•bottleneckMon - Added option to configure the BE credit Loss Link Reset Threshold.
•cfgShow - Added new option to display the changes in the transactions.
•cfgTransShow- Added new option to display local open transaction token details and the list of
domains with open transactions.
•classConfig - Added the command restriction details dispalyed with the -showcli option.
•cliHistory - Added new new options to display the CLI history of the specified users.
•configureChassis - Added the CS_CTL to virtual channel mapping options.
•dlsSet - The Losseless (or fmsmode) can be enabled when XISL is enabled and vice versa.
•dnsConfig - Added options to set the DNS configuration parameters through the CLI. Also
added options to delete and display the DNS configuration.
•errDump - Added options to display messages for the entire chassis, to display messages
based on count value, to display messages in reversed order, to display messages based on
severity, and to display messages based on slot.
•fcrFabricShow - Added option to display the FC Routers on a backbone fabric with edge fabric
names.
•fcrPhyDevShow - Added the help option.
•ficonCupShow - Added options to display the FICON-CUP missing interrupt handler primary
timeout (MIHPTO) value in seconds, to display the Director Diagnostics Log, to display dignostic
information, and to display HealthCheck Logs for the logical switch.
•ficonShow - Added options to display RNID data in table format, and to display RNID data for
only the specified port.
•ifModeSet - Added options to configure autonegotiation, speed, and capability. Also added the
help option.
•islShow - The output is modified to display the neighbor WWN information even when the ISL is
segmented during exchange link parameter (ELP) or post ELP segmentation phase.
•licensePort - The restriction that the command is supported only on embedded platforms is no
longer applicable.
•nsAliasShow - Added option to display the remote device details for a specific domain. Also
added the help option.
•nsZoneMember - Added help option.
•pathInfo - Added options to specify the source ID of the originator and the destination ID of the
proxy device.
•portCfg - Added option to configure auto-negotiation settings for 1 GbE ports.
•portCfgAutoDisable - Added options to suspend and resume the port autodisable
configuration.
•portCfgCreditRecovery - Command is supported in Access Gateway mode.
xxiiFabric OS Command Reference
53-1002746-01
•portCfgFec - Command is supported in Access Gateway mode. Rewrote the description for this
command to better capture the feature and what it does. Updated examples to reflect latest
output and documented the FEC states.
•portCfgLongDistance - Added options -distance, -buffers, -framesize, -fecenable, and
-fecdisable.
•portEncCompShow - The output displays port speed.
•portShow - Added options fciptunnel --reset,--lifetime and fcipcircuit --reset,--lifetime.
•portSwap - Added option to remove swapping of all ports.
•secCertUtil - Added new options -commonswcert and -commonswcsr.
•setContext - Accepts switch name.
•sshUtil - Added option to delete the known host name or IP address from the file
.ssh/known_hosts.
•switchCfgPersistentDisable - Added options to set the switch in disable state, to disable the
switch persistently, and help option.
•switchName - The switch name must be unique.
•switchShow - The output is modified to display the neighbor WWN information even when the
ISL is segmented during exchange link parameter (ELP) or post ELP segmentation phase.
•zone - Added option to generate a report of potential routing problems in the local Domain.
•zoneAdd - Added wildcard character (asterisk) option to specify members.
•zoneCreate - Added wildcard character (asterisk) option to specify members.
•zoneRemove - Added wildcard character (asterisk) option to specify members.
•zoneShow - Added new option to display the changes in the transactions.
Deprecated commands
The following commands and associated man pages have been removed since this document was
last released.
•fcIpChipTest
•fcrChipTest
•fcrPathTest
•licenseHelp
•policy
•uRouteConfig
•uRouteRemove
CLI usage conventions
•Some Fabric OS show commands display certain switch or fabric components in three-digit decimal
numbers, for example, 003. When you use these numeric identifiers as inputs to other commands,
you must remove the leading zeros; otherwise the commands will either fail or generate incorrect
results. Adding zeros to any decimal number in a command input will cause that number to be
treated as an Octal number.
Fabric OS Command Referencexxiii
53-1002746-01
•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
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
For readability, command names in the command titles and in the narrative portions of this guide are
presented in mixed letter case, for example, switchShow. In examples, command letter case is all
lowercase.
Command syntax conventions
Command syntax in this document follows these conventions:
commandCommands are printed in bold.
--option, optionCommand options are printed in bold.
-argument, argArguments are printed in bold.
[ ]Optional element.
variableVariables are printed in italics. In the help pages, values are underlined
enclosed in angle brackets < >.
...Repeat the previous element, for example “member[;member...]”
valueFixed (literal) values following arguments are printed in plain font. For example,
--show WWN
|Boolean. Elements are exclusive. Example: --show -mode egress | ingress
\Backslash indicates a “soft” line break. If a backslash separates two lines of a
command input, enter the entire command at the prompt without the backslash.
or
xxivFabric OS Command Reference
53-1002746-01
Notes, cautions, and warnings
NOTE
ATTENTION
CAUTION
DANGER
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.
Key terms
For definitions specific to Brocade and Fibre Channel, see the technical glossaries on the Brocade
website. See “Brocade resources” on page xxvi for instructions on accessing the information.
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
CommvaultCommvault Galaxy Data Protection
EMCRSA Data Protection Manager (DPM)
HPSecure Key Manager (SKM) and Enterprise Secure Key Manager
IBMTivoli Key Lifecycle Manager
LegatoLegato Networker
(ESKM)
Fabric OS Command Referencexxv
53-1002746-01
CorporationReferenced Trademarks and Products
Microsoft CorporationWindows, Windows NT, Internet Explorer
NetAppNetApp Lifetime Key Manager (LKM)
Oracle CorporationOracle, Java
SymantecVeritas NetBackup 6.5 Enterprise Server
Red Hat, Inc.Linux
ThalesThales e-Security keyAuthority (TEKA)
Additional information
This section lists additional Brocade and industry-specific documentation that you may find helpful.
Brocade resources
To get up-to-the-minute information, join MyBrocade at no cost to obtain a user ID and password:
http://my.brocade.com
White papers, online demonstrations, and data sheets are available through the Brocade website at:
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 website.
Other industry resources
For additional resource information, visit the Technical Committee T11 website. This website 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 website:
http://www.fibrechannel.org
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:
•General Information
-Switch model
-Switch operating system version
-Error numbers and messages received
xxviFabric OS Command Reference
53-1002746-01
-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
•Switch Serial Number
The switch serial number and corresponding bar code are provided on the serial number label,
as shown here:
Encryption Switch—On the switch ID pull-out tab located inside the chassis on the port side on
the left.
-Brocade 5410, 5424, 5430, 5450, 5460, 5470, 5480—Serial number label attached to the
module.
-DCX, and DCX 8510-8—On the port side of the chassis, on the lower right side and directly
above the cable management comb
-DCX-4S and DCX 8510-4—On the non-port side of the chassis on the lower left side.
•Use the licenseIdShow command to display the switch WWN.
If you cannot use the licenseIdShow command because the switch is inoperable, you can get the WWN
from the same place as the serial number, except for the Brocade DCX, DCX-4S, DCX 8510-8, and DCX 8510-4. On these models, access the numbers on the WWN cards by removing the Brocade logo plate at
the top of the non-port side of the chassis.
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.
• Determining RBAC permissions for a specific command . . . . . . . . . . . . . . . . . . 4
Using the command line interface
The Fabric OS command line interface (CLI), 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.
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 (SANs).
•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.
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 the help command, followed
by the command name on a Brocade switch or director. This command displays the help page for the
specified command. For example, to display the help page for portCfg, enter:
switch:admin> help portCfg
1
Fabric OS Command Reference1
53-1002746-01
Understanding Role-Based Access Control
NOTE
1
Understanding Role-Based Access Control
Fabric OS implements Role-Based Access Control (RBAC) to control access to all Fabric OS operations.
Seven predefined roles are supported, as described in Ta b le 2 . These predefined 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 2Role definitions
Role nameDefinition
UserNon-administrative use, such as monitoring system activity. In Fabric
OperatorA subset of administrative tasks typically required for routine
SwitchAdminAdministrative use excluding security, user management, and zoning.
ZoneAdminZone management only.
FabricAdminAdministrative use excluding user management and Admin Domain
BasicSwitchAdminA subset of administrative tasks, typically of a more limited scope and
AdminAll administrative tasks, including encryption and chassis commands.
SecurityAdminAdministrative use including admin, encryption, security, user
In addition to these predefined roles, Fabric OS v7.0.0 and later provides support for creating
user-defined roles. Refer to the roleConfig command for more information.
Additional command restrictions apply depending on whether Virtual Fabrics or Admin Domains are
enabled in a fabric. Refer to Appendix A, “Command Availability”,
Virtual Fabrics and Admin Domains are mutually exclusive and are not supported at the same time on a
switch. To use Admin Domains, you must first disable Virtual Fabrics; to use Virtual Fabrics, you must first
delete all Admin Domains. Use ad --clear -f to remove all Admin Domains. Refer to the Fabric OS Administrator’s Guide for more information.
OS v6.2.0 and later, the user account gains access to Fabric ID 128.
This is the default logical fabric after a firmware upgrade.
maintenance operations.
management.
effect.
management, and zoning.
Encryption commands and permissions
There are two system RBAC roles that are permitted to perform encryption operations.
•Admin and SecurityAdmin
Users authenticated with the Admin and SecurityAdmin RBAC roles may perform cryptographic
functions assigned to the FIPS Crypto Officer, including the following:
-Perform encryption node initialization.
-Enable cryptographic operations.
-Manage critical security parameters (CSPs) input and output functions.
-Zeroize encryption CSPs.
-Register and configure a key vault.
-Configure a recovery share policy.
2Fabric OS Command Reference
53-1002746-01
Loading...
+ 1138 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.