53-1001337-01
28 July 2009
®
Fabric OS
Command Reference Manual
Supporting Fabric OS v6.3.0
Copyright © 2006-2009 Brocade Communications Systems, Inc. All Rights Reserved.
Brocade, the B-wing symbol, BigIron, DCX, Fabric OS, FastIron, IronPoint, IronShield, IronView, IronWare, JetCore, NetIron,
SecureIron, ServerIron, StorageX, and TurboIron are registered trademarks, and DCFM, Extraordinary Networks, 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 and Latin American 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 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
The table below lists all versions of the Fabric OS Command Reference.
Document Title
Publication Number
Summary of Changes
Publication Date
Fabric OS Reference v2.0
53-0001487-03
Fabric OS Reference v2.2
53-0001558-02
Fabric OS Reference v2.3
53-0000067-02
Fabric OS Reference v3.0
53-0000127-03
Fabric OS Reference v2.6
53-0000194-02
Fabric OS Reference v3.0 / v4.0 53-0000182-02
Fabric OS Reference v4.0.2
53-0000182-03
Fabric OS Reference v3.1.0
53-0000500-02
Fabric OS Reference v4.1.0
53-0000519-02
Fabric OS Reference v4.1.2
53-0000519-03
Fabric OS Reference v4.1.2
53-0000519-04
Fabric OS Reference v4.1.2
53-0000519-05
Fabric OS Reference v4.1.2
53-0000519-06
Fabric OS Reference v4.2.0
53-0000519-07
Fabric OS Command Reference
53-0000519-08
Fabric OS Command Reference
53-0000519-08 Rev. A
Fabric OS Command Reference
53-0000519-09
Fabric OS Command Reference
53-0000519-10
Fabric OS Command Reference
53-0000519-12
September 1999
May 2000
December 2000
July 2001
December 2001
March 2002
September 2002
April 2003
April 2003
May 2003
July 2003
August 2003
October 2003
December 2003
March 2004
April 2004
September 2004
April 2005
July 2005
Fabric OS Command Reference
53-1001337-01
iii
Document Title
Publication Number
Summary of Changes
Publication Date
Fabric OS Command Reference
53-1000240-01
Fabric OS Command Reference
53-1000436-01
Fabric OS Command Reference
53-1000599-01
Fabric OS Command Reference
53-1000599-02
Fabric OS Command Reference
53-1000599-03
Fabric OS Command Reference
53-1001115-01
Fabric OS Command Reference
53-1001186-01
September 2006
June 2007
October 2007
March 2008
July 2008
August 2008
November 2008
Added 13 new commands,
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.
Added 9new 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.
Corrections and updates to 31
commands. Removed
“Brocade Optional Features”
from Preface. Added trademark
note to Preface. Cosmetic edits
throughout.
Added 3 new commands to
support Encryption. Modified 1
command. Updated Preface
and RBAC/AD table.
Added 14 new commands to
support Logical Fabrics.
Modified 34 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 etc. Removed
standby CP command table.
Updated Preface, surrounding
chapters, and command
availability tables.
iv
Fabric OS Command Reference
53-1001337-01
Document Title
Publication Number
Summary of Changes
Publication Date
Fabric OS Command Reference
53-1001337-01
July 2009
Added 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
etc. Updated Preface,
surrounding chapters, and
permission tables.
Fabric OS Command Reference
53-1001337-01
v
vi
Fabric OS Command Reference
53-1001337-01
Contents
About This Document
In this chapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxi
How this document is organized . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxi
Supported hardware and software . . . . . . . . . . . . . . . . . . . . . . . . . . xxi
What is new in this document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiii
Document conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxv
Notice to the reader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxvii
Additional information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxviii
Getting technical help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxviii
Document feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxix
Chapter 1
Using Fabric OS Commands
In this chapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Understanding role-based access control . . . . . . . . . . . . . . . . . . . . . . 1
Understanding Virtual Fabric restrictions . . . . . . . . . . . . . . . . . . . . . . 2
Understanding Admin Domain restrictions . . . . . . . . . . . . . . . . . . . . . 3
Using the command line interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Chapter 2
Fabric OS Commands
aaaConfig. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
ad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
ag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
agAutoMapBalance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36
agshow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39
aliAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
aliCreate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42
aliDelete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43
aliRemove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44
aliShow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45
aptPolicy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46
auditCfg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48
auditDump. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50
Fabric OS Command Reference
53-1001337-01
vii
authUtil . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
bannerSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55
bannerShow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56
bcastShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
bladeCfgGeMode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58
bladeDisable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .60
bladeEnable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62
bladeSwap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64
bootLunCfg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65
bottleneckMon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66
bpPortLoopbackTest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .70
bpTurboRamTest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73
cfgActvShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75
cfgAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
cfgClear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
cfgCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78
cfgDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79
cfgDisable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80
cfgEnable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
cfgMcdtmode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .82
cfgRemove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .83
cfgSave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .84
cfgSaveActiveToDefined . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .85
cfgShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .86
cfgSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .88
cfgTransAbort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .90
cfgTransShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
chassisBeacon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .92
chassisConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .93
chassisDistribute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
chassisEnable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .96
chassisDisable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
chassisName. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .98
chassisShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .99
cliHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101
cmsh. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102
configDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .104
viii
Fabric OS Command Reference
53-1001337-01